Help:Tracking changes: Difference between revisions

From FlightGear wiki
Jump to navigation Jump to search
(Done with page elements; + Illustrative screenshots)
(+- Lead section. More to the point; + Explanation of the recent changes list; + Clarification that diff is for difference; + Mentioning Template:Unsigned in regard to finding a specific edit)
(18 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{WIP}}
{{tip|
Giving a comprehensive and concise edit summary will help other understand the revision history.


This '''tutorial''' is mainly aimed at people new to the [[Main Page|FlightGear wiki]], but might also be useful for the more experienced users from time to time.
'''Why''' the edit was done is more useful than '''what''' was edited — a diff will show '''what''' was edited but not '''why'''.}}
{{tip|
You can help fighting spam by checking [[Special:RecentChanges|recent changes]] when you log in on the wiki.}}


The main purpose here is to explain how to use the wiki software, how it is structured, where you can learn more about it, and not less important, how to interact with the part of the FlightGear community that is directly involved with the wiki.
{{Wiki help navbar}}


== The very basics ==
'''Tracking changes''' on the wiki is relatively easy.  One of the main characteristics of the MediaWiki software the FlightGear wiki is using is that the revision history of all pages are preserved and available to everyone.   This allows for very transparent collaboration.
=== For readers new to a wiki ===
A wiki is a place for collaboration.  There are many like it but this is ours.  As with most wikis they allow readers to browse through the ''articles'' and other ''pages'' making up the content of the wiki.  Pages can also be found by using ''links'', traversing ''categories'' and ''searching''. But lets start by describing what you can see on a typical wiki page.


=== Elements of a wiki page ===
== Recent changes ==
While there are two ways to view wiki pages, the ''desktop view'' and the ''mobile view'', we will go through the ''desktop'' view here as the mobile view hides many features for the sake of simplicity.  The features are described as seen with the default Vector skin.
The page [[Special:RecentChanges]] is a list of all the recent changes on the wiki.


From the top you have ''user links'' on the top right.  These are related to your account (if you have one).  On top of the content of the page there are some ''page tabs'' related to the page.  On the left is the ''sidebar'' with navigation links, links to various tools and links to other language versions of a page.  On the bottom of the contents of a page is a ''category link'' a link to a ''category page'' listing other pages in the category.
If you want to have a feel about what is going on on the wiki you could start your wiki session by having a peek at that page.


==== User links ====
Some of the things visible there are:
[[File:FlightGear wiki user links.png|frame|none|The user links for a logged in user]]


If you have an account and is logged in the ''user links'' to the very top right are related to you user account:
* Edits to pages
* Creation of new pages
* File uploads, usually images
* Creation of new users
* Pages being protected
* Deletion of pages or files


:; Your user page
As it shows all the latest changes it is often the place where one will find any spam, vandalism or other unwanted edits.
:: Your user page, where you are encouraged to describe who you are and what ambitions you have on the wiki.
:: You can also add subpages to your user page with for example drafts and other wiki projects.
:; Talk
:: You user discussion page, where other users may be able to take contact with you.
:: If your discussion page have been edited, you will get a notice when you load any wiki page.
:; Preferences
:: Your wiki preferences, where you can adjust and customize some settings.
:; Watchlist
:: Your watchlist, which list changes on pages you have "starred" and are watching.
:; Contributions
:: A summary of your contributions and uploads to the wiki.
:; Log out
:: Through which you log out from your account.


==== Page tabs ====
One days changes will for example look like below:
[[File:FlightGear wiki page tabs.png|frame|none|The page tabs for a logged in admin (who can additionally delete and protect pages)]]


On top of the page content there is a set of tabs:
[[File:FlightGear wiki recent changes.png|none|frame|Recent changes on the wiki.  Only some users have rights to block users.]]


:; An article or page tab
For each row you will see
:: For viewing the article if you are on another tab or for going directly to the page if you have been redirected.
* A mark indicating for example '''N''' for new pages and '''m''' for minor changes (if the user marked that checkbox when saving his edit of the page)
:: The page tab also gives an indication about what kind of page you are on.
* The time of the revision (in the time zone set in your preferences (see [[Special:Preferences|Preferences]] link on the top right of every page)
:; A discussion tab
* A link with the title of the page to the revision of the page
:: With the discussion page for a wiki page or a user.
* A link "cur" linking to a [[#Diffs|diff]] comparing the revision with the current revision
* A link "prev" linking to a diff comparing the revision with the previous revision
* The number of characters added or removed in the edit
* A link with the name of the user who did the edit linking to his user page
* A link "talk" linking to the users discussion page
* A link "contrib" linking to to a list of the users contributions
* A link to the article section that was edited if the user edited a specific section (click the right arrow)
* The edit summary if the user wrote one


:; A read tab
If there is several edits to one page on the same day they are grouped together.  They can be shown as separate lines if you click on the triangle.
:: With the exact same function as the page tab
:; An edit or source tab
:: Which will allow you to edit a page on the wiki when logged in or see the page source if not.
:; A history tab
:: Which will show the edit history for a wiki page.
:; A star tab
:: That will add or remove a page to or from your watchlist.
:; A more tab
:: That hide some more functions, in particular a function to move pages.  Wiki admins also have a protect and a delete function.


==== Search box ====
If there is a huge amount of minor edits you can hide them by clicking ''Hide minor edits'' in the ''Recent changes options'' box at the top of the page.
[[File:FlightGear wiki search box.png|frame|none|The search box]]


On the top left above the page content and to the left of the page tabs is a search box.
== Watchlist ==
The ''watchlist'' will help you keep track of interesting pages if the recent changes page is too busy.


==== Sidebar ====
The watchlist presents changes the same way as the recent changes page.
[[File:FlightGear wiki sidebar.png|frame|right|The sidebar]]


To the near top left is the ''sidebar'' with:
The watchlist is accessible from a link in the top right corner of every wiki pages when you have logged in.


:; Navigation links
At first the watchlist will at first be empty, but pages can be added to it either by clicking the ''watch tab'' (the star icon tab) or by clicking the "Watch this page" box below the edit summary text box when editing or creating a new page.
:: To some pages deemed important enough to link to from every page:
::; The main page of the wiki
::: Where you end up when going to http://wiki.flightgear.org
::; The recent changes page
::: Listing all the latest changes on the wiki
::; A random article
::; The village pump
::: The [[FlightGear wiki:Village pump|village pump]] is the page for wiki discussion not related to a particular page or user.
::; The summary of help pages
::; The portal pages
:; Links to other FlightGear web sites
:; Some useful tools
:: Slightly dependent on the type of page you are viewing
::* A summary of pages linking to the page you are viewing
::* A summary of edits related to the page you are viewing
::* The [[Help:Upload wizard|upload wizard]]
::* A set of special pages
::* A more printer-friendly version of the page
::* A link to the particular version of the page you are viewing.
::* Information about the page you are viewing
:; Language links
:: To versions of the page in other languages


==== Category links ====
== Page revision history ==
[[File:FlightGear wiki category links.png|frame|none|The category links]]
The ''revision history'' of a page, accessible from the history tab, holds all the changes to a page.  Some data regarding deleted revisions is only available to users with sufficient rights.
At the bottom of the page should be links to one or more category pages, which are listing pages in that category.


==== Page footer ====
[[File:FlightGear wiki revision history.png|none|frame|The top of the revision history of a page]]
[[File:FlightGear wiki page footer.png|frame|none|The page footer]]
The page footer have some information related to the page and to the wiki in general, such as the license, privacy policy and terms of use.


Through the "Mobile view"/"Desktop view" links one can change between the desktop and mobile views.
The revision history allow you to look at and compare selected revisions using ''page diffs'' (or often just ''diffs''), as well as link to a certain revision or comparison of revisions.


== Wiki features ==
== Diffs ==
Some things this tutorial could be about is for example
{{tip|If you need to compare two separate pages you can do so with [[Special:ComparePages]].}}
* What are those links to the right?
{{tip|By pressing the ''Show changes'' button when you edit a page you can see your changes as a diff. It can be useful when writing the edit summary.}}
* Why should I write a summary?
* What is a diff?
* What is a category?
* What are permalinks?


A ''diff'' is comparison showing the differences between two revisions of a page, much like the <code>diff</code> utility in some operating systems. With them you can see what was changed, added or removed in a revision.


----
A diff page is typically shown with the actual diff at the top of the page and the rendered page as of the latter revision at the bottom of the page.


'''Welcome to the FlightGear Wiki!'''
The diff itself is split into two columns: Typically the old one to the left and new one to the right.


There are two main considerations for contributing here, one is using the [[Mediawiki]] software and the other is the nature ofthe FlightGear wiki. The FlightGear wiki is collaborative volunteer written documentation relating to [[FlightGear]], licensed under the [[GPL|GNU GPL Version 2]].
On top you have the dates and usernames as well as the edit summaries added before saving the revisions. Below that are the changed chunks of lines and a few lines surrounding them.


FlightGear wiki is not the same as an encyclopedia or research paper, so there is no requirement to have primary and secondary sources to publish content, unless you are citing something. In fact, much of what needs to be written does not exist anywhere at all!
[[File:FlightGear wiki diff.png|none|frame|The diff part of a diff page]]


Original research, opinions, and first hand accounts are the majority of the content here, but please do not plagiarize. If you are going to copy or cite something then provide a reference (like you might for a school paper). Other than that, the standards and specific goals of the FlightGear are still in flux and development.  
{{tip|If [[User:Johan G|Johan G]] above had used the ''Show preview'' button more he might have remembered to add the other changes as well.}}


==About the FlightGear wiki==
== Finding a specific edit ==
The FlightGear wiki is currently small, technically oriented, and international. In addition to all sorts of people, regular volunteers include pilots, 3D modelers, professors, and programmers from around the world sharing an interest in FlightGear documentation.  
[[File:Finding an edit using successive approximation.png|left|thumb|200 px|Finding an edit through successive approximation.]]


Articles tend to be about whatever someone sees as important, useful, or fun enough to write about!
If you are looking for when a particular section of text was edited, you can use ''binary search''/''successive approximation''.


==Using the software==
Start by comparing the revision ''between'' the oldest and newest possible revision with ''its previous'' revision.  Then in ''halfway steps'' compare revisions with their previous ones till you find the edit.


Writing and editing with Mediawiki code (currently using version {{CURRENTVERSION}}) can take some getting used depending on your background, because unlike most word processors you can see and type software code used for formating and linking. If you already know HTML or a programming language then what are you doing reading this! If you have just used [[Open Office]], then it is still easy to get started. Try using the formating buttons at the top of the edit window to format your text.
This can come in handy for example if you want to discuss a confusing phrasing with the user who added it, if you want to sign an unsigned comment on a discussion page with {{tl|unsigned}}, or if you are an administrator and need to find a specific user due to spam etc.
 
*[[Help:Tutorial]] to learn how to format your article.
 
==More on what to write==
The FlightGear wiki has {{NUMBEROFARTICLES}} articles (although only a few dozen of these are well developed) and only a handful of active contributors, with most days only a dozen or so edits being made.
 
If you are interested in working or building on what has already been done:
 
Currently the wiki has three main areas that need to be maintained.
*[[Portal:Developer]] related- these are mostly technical articles aimed at people working on FlightGear.
*Help documentation related- on the User side, articles about how to get started, how to use features, FAQ, etc..(like [[FAQ]])
*Official aircraft- keeping the aircraft up to date with those on CVS. (like [[Table of models]])
 
Also, there are the [[:Category:Stubs|Stubs]], [[:Category:Afd|Considered for deletion]] and [[:Category:Cleanup|Cleanup]] categories. These articles have been noted as needing more information, a cleanup and/or other additions. Great to start your wiki-career or if you don't like to start a completely new article!
 
Other interesting pages include things like [[Real Life Experience]], [[Linux software audio mixing with FlightGear]], [[Current events]], or [[Presentation Recipe]]!
 
Well that sounds exciting! Good luck!
 
==Creating a new article==
Fill your new articles name in the search box and press '''Go'''. If the article doesn't exist yet, you can click the red link in the sentence that appears like:
:'''Create the page [[Title of your article]] on this wiki!'''.


[[Category:Help]]
[[Category:Help]]

Revision as of 12:14, 24 May 2019

Tip 

Giving a comprehensive and concise edit summary will help other understand the revision history.

Why the edit was done is more useful than what was edited — a diff will show what was edited but not why.

Tip 

You can help fighting spam by checking recent changes when you log in on the wiki.

Wiki help
Reading
Editing
Advanced editing
Writing about specific topics


Tracking changes on the wiki is relatively easy. One of the main characteristics of the MediaWiki software the FlightGear wiki is using is that the revision history of all pages are preserved and available to everyone. This allows for very transparent collaboration.

Recent changes

The page Special:RecentChanges is a list of all the recent changes on the wiki.

If you want to have a feel about what is going on on the wiki you could start your wiki session by having a peek at that page.

Some of the things visible there are:

  • Edits to pages
  • Creation of new pages
  • File uploads, usually images
  • Creation of new users
  • Pages being protected
  • Deletion of pages or files

As it shows all the latest changes it is often the place where one will find any spam, vandalism or other unwanted edits.

One days changes will for example look like below:

Recent changes on the wiki. Only some users have rights to block users.

For each row you will see

  • A mark indicating for example N for new pages and m for minor changes (if the user marked that checkbox when saving his edit of the page)
  • The time of the revision (in the time zone set in your preferences (see Preferences link on the top right of every page)
  • A link with the title of the page to the revision of the page
  • A link "cur" linking to a diff comparing the revision with the current revision
  • A link "prev" linking to a diff comparing the revision with the previous revision
  • The number of characters added or removed in the edit
  • A link with the name of the user who did the edit linking to his user page
  • A link "talk" linking to the users discussion page
  • A link "contrib" linking to to a list of the users contributions
  • A link to the article section that was edited if the user edited a specific section (click the right arrow)
  • The edit summary if the user wrote one

If there is several edits to one page on the same day they are grouped together. They can be shown as separate lines if you click on the triangle.

If there is a huge amount of minor edits you can hide them by clicking Hide minor edits in the Recent changes options box at the top of the page.

Watchlist

The watchlist will help you keep track of interesting pages if the recent changes page is too busy.

The watchlist presents changes the same way as the recent changes page.

The watchlist is accessible from a link in the top right corner of every wiki pages when you have logged in.

At first the watchlist will at first be empty, but pages can be added to it either by clicking the watch tab (the star icon tab) or by clicking the "Watch this page" box below the edit summary text box when editing or creating a new page.

Page revision history

The revision history of a page, accessible from the history tab, holds all the changes to a page. Some data regarding deleted revisions is only available to users with sufficient rights.

The top of the revision history of a page

The revision history allow you to look at and compare selected revisions using page diffs (or often just diffs), as well as link to a certain revision or comparison of revisions.

Diffs

Tip  If you need to compare two separate pages you can do so with Special:ComparePages.
Tip  By pressing the Show changes button when you edit a page you can see your changes as a diff. It can be useful when writing the edit summary.

A diff is comparison showing the differences between two revisions of a page, much like the diff utility in some operating systems. With them you can see what was changed, added or removed in a revision.

A diff page is typically shown with the actual diff at the top of the page and the rendered page as of the latter revision at the bottom of the page.

The diff itself is split into two columns: Typically the old one to the left and new one to the right.

On top you have the dates and usernames as well as the edit summaries added before saving the revisions. Below that are the changed chunks of lines and a few lines surrounding them.

The diff part of a diff page
Tip  If Johan G above had used the Show preview button more he might have remembered to add the other changes as well.

Finding a specific edit

Finding an edit through successive approximation.

If you are looking for when a particular section of text was edited, you can use binary search/successive approximation.

Start by comparing the revision between the oldest and newest possible revision with its previous revision. Then in halfway steps compare revisions with their previous ones till you find the edit.

This can come in handy for example if you want to discuss a confusing phrasing with the user who added it, if you want to sign an unsigned comment on a discussion page with {{unsigned}}, or if you are an administrator and need to find a specific user due to spam etc.

Retrieved from "https://wiki.flightgear.org/w/index.php?title=Help:Tracking_changes&oldid=118408"