Project:Article versioning - Revision history

Khepri Contractor: /* Quick Links */

2010-05-13T23:58:16Z

Quick Links

← Older revision		Revision as of 16:58, 13 May 2010
Line 72:		Line 72:

	<div align="center">{{L10n/table}}</div>		<div align="center">{{L10n/table}}</div>

	~~{{Hilite\|Note that these categories aren't cleaned yet.}}~~

	== Related Links ==		== Related Links ==

Khepri Contractor: /* The Implementation */

2010-05-13T21:58:22Z

The Implementation

← Older revision		Revision as of 14:58, 13 May 2010
Line 24:		Line 24:
	to their [[Special:MyPage/monobook.css\|User:Firstname Lastname/monobook.css]] (e.g.: [[User:Khepri Contractor/monobook.css]]).		to their [[Special:MyPage/monobook.css\|User:Firstname Lastname/monobook.css]] (e.g.: [[User:Khepri Contractor/monobook.css]]).

	{{KBnote\|User CSS are currently turned off due to [http://lists.wikimedia.org/pipermail/mediawiki-announce/2010-April/000090.html a recent MediaWiki exploit]. A MediaWiki upgrade is planned but might not be deployed before mid June.}}		{{KBnote\|User CSS are currently turned off due to [http://lists.wikimedia.org/pipermail/mediawiki-announce/2010-April/000090.html a recent MediaWiki exploit]. A MediaWiki upgrade is planned but might not be deployed before mid June.<br>Please use the MediaWiki skin named '''''Modern''''' to reveal the L10n-meta-info meanwhile. In order to do so, go to [[Special:Preferences]], change to the "Skins" tab, click the radio button next to "Modern" and save your changes by pressing the {{K\|Save}} button.}}

	=== English Source Articles (Doc Team) ===		=== English Source Articles (Doc Team) ===

Khepri Contractor: /* The Implementation */ User CSS turned off...

2010-05-11T13:15:08Z

The Implementation: User CSS turned off...

← Older revision		Revision as of 06:15, 11 May 2010
Line 23:		Line 23:
	<css>.L10n-hidden { display:block; }</css>		<css>.L10n-hidden { display:block; }</css>
	to their [[Special:MyPage/monobook.css\|User:Firstname Lastname/monobook.css]] (e.g.: [[User:Khepri Contractor/monobook.css]]).		to their [[Special:MyPage/monobook.css\|User:Firstname Lastname/monobook.css]] (e.g.: [[User:Khepri Contractor/monobook.css]]).

			{{KBnote\|User CSS are currently turned off due to [http://lists.wikimedia.org/pipermail/mediawiki-announce/2010-April/000090.html a recent MediaWiki exploit]. A MediaWiki upgrade is planned but might not be deployed before mid June.}}

	=== English Source Articles (Doc Team) ===		=== English Source Articles (Doc Team) ===

Khepri Contractor at 00:13, 10 May 2010

2010-05-10T00:13:39Z

← Older revision		Revision as of 17:13, 9 May 2010
Line 1:		Line 1:
	~~{{hint~~		{{Navbox/Wiki}}
	~~\|mode=note~~
	~~\|desc=This is currently a draft / work-in-progress.~~
	}}{{Navbox/Wiki}}

	This page provides information on a versioning process, introduced in relation to the localization (L10n) efforts within this wiki. See [[Project:Languages]] for general L10n guidelines and the [[Community Translation Project]]s for ongoing official projects.		This page provides information on a versioning process, introduced in relation to the localization (L10n) efforts within this wiki. See [[Project:Languages]] for general L10n guidelines and the [[Community Translation Project]]s for ongoing official projects.
Line 74:		Line 71:
	<div align="center">{{L10n/table}}</div>		<div align="center">{{L10n/table}}</div>

	{{Hilite\|Note that these categories aren't ~~populated~~ yet.}}		{{Hilite\|Note that these categories aren't cleaned yet.}}

	== Related Links ==		== Related Links ==

Khepri Contractor: changing terminology

2010-03-29T17:52:47Z

changing terminology

Khepri Contractor at 23:54, 25 March 2010

2010-03-25T23:54:46Z

← Older revision		Revision as of 16:54, 25 March 2010
Line 32:		Line 32:

	<nowiki> {{multi-lang/Version		<nowiki> {{multi-lang/Version
	\|1 <!-- The version number. Supports floating point like 1.5 etc. -->		\|version=1 <!-- The version number. Supports floating point like 1.5 etc. -->
	\|priority= <!-- Leave empty for no priority. Set to 3 for low, 2 for middle, 1 for high. -->		\|priority= <!-- Leave empty for no priority. Set to 3 for low, 2 for middle, 1 for high. -->
	\|~~Needs Update <!-- Can leave this as is -->~~		\|notes=Initial creation <!-- What changed within the last versions? Make it easy for translators. -->
	\|3=Initial creation <!-- What changed within the last versions? Make it easy for translators. ~~Don't touch the "3=" :)~~ -->
	}}</nowiki>		}}</nowiki>

	The first section contains the version number. Increase this number, whenever a substantial edit to the base page took place (never decrease this number).<br />		The first section contains the version number. Increase this number, whenever a substantial edit to the base page took place (never decrease this number).<br />
	The second section gives the option to specify a priority for the update. This can be interpreted as a counterpart of JIRA priorities and tells the localization team how important it is that the translated articles receive this update as well.<br />		The second section gives the option to specify a priority for the update. This can be interpreted as a counterpart of JIRA priorities and tells the localization team how important it is that the translated articles receive this update as well.<br />
	~~The 3rd part specifies a headline for the boxes shown in the translated articles. Since these are only visible for translators, the line can be left as is.<br />~~
	The last section provides space to specify which changes took place within the last updates. It would be nice to have some short statement per version number in this place. Nothing verbose... All details can be retrieved from the articles history. Just a short note on what to expect.		The last section provides space to specify which changes took place within the last updates. It would be nice to have some short statement per version number in this place. Nothing verbose... All details can be retrieved from the articles history. Just a short note on what to expect.

Line 46:		Line 44:

	<nowiki> {{multi-lang/Version		<nowiki> {{multi-lang/Version
	\|3		\|version=3
	\|priority=1		\|priority=1
	\|~~Needs Update~~		\|notes=
	\|3=
	*Version 1: Initial creation		*Version 1: Initial creation
	*Version 2: Added paragraph foo		*Version 2: Added paragraph foo

Khepri Contractor: /* The Implementation */

2010-03-24T22:05:45Z

The Implementation

← Older revision		Revision as of 15:05, 24 March 2010
Line 23:		Line 23:
	This system is implemented as part of [[Template:Multi-lang]] and added to [[Template:KBmaster]].		This system is implemented as part of [[Template:Multi-lang]] and added to [[Template:KBmaster]].

	Edit-links and information boxes were added, ~~while those~~ are hidden from the default view. In order to see them, interested users need to add		Edit-links and information boxes were added, but are hidden from the default view. In order to see them, interested users need to add
	<css>.L10n-hidden { display:block; }</css>		<css>.L10n-hidden { display:block; }</css>
	to their [[Special:MyPage/monobook.css\|User:Firstname Lastname/monobook.css]] (e.g.: [[User:Khepri Contractor/monobook.css]]).		to their [[Special:MyPage/monobook.css\|User:Firstname Lastname/monobook.css]] (e.g.: [[User:Khepri Contractor/monobook.css]]).

Khepri Contractor: /* Quick Links */

2010-03-24T21:39:03Z

Quick Links

← Older revision		Revision as of 14:39, 24 March 2010
Line 76:		Line 76:

	<div align="center">{{L10n/table}}</div>		<div align="center">{{L10n/table}}</div>

			{{Hilite\|Note that these categories aren't populated yet.}}

	== Related Links ==		== Related Links ==

Khepri Contractor: Created page with '{{hint |mode=note |desc=This is currently a draft / work-in-progress. }}{{Navbox/Wiki}} This page provides information on a versioning process, introduced in relation to the loc...'

2010-03-24T21:36:58Z

Created page with '{{hint |mode=note |desc=This is currently a draft / work-in-progress. }}{{Navbox/Wiki}} This page provides information on a versioning process, introduced in relation to the loc...'

New page

{{hint
|mode=note
|desc=This is currently a draft / work-in-progress.
}}{{Navbox/Wiki}}

This page provides information on a versioning process, introduced in relation to the localization (L10n) efforts within this wiki. See [[Project:Languages]] for general L10n guidelines and the [[Community Translation Project]]s for ongoing official projects.

== The Problem ==

One goal of the L10n project is, to translate articles and to keep them in sync with their English base pages. In order to reach this goal, it is important to know which base articles received updates after their initial translation. These articles are out-of-sync and in need for an update. The problem is, to identify these articles and to inform translators and coordinators about them.

== The Solution ==

A possible solution to this problem is a versioning scheme:
* Every base article receives an arbitrary version number.
* Every substantial update to an article increases the version number.
When a translated article is in sync with version number '''n''', it receives the same version number. When the version number of the base page is increased to '''n+1''', the translated article is automatically marked as out-of-sync and added to a dedicated category, until it is updated to '''n+1''' as well.

The readers are informed via a warning box, while the translators/coordinators are informed via the categories.

== The Implementation ==

This system is implemented as part of [[Template:Multi-lang]] and added to [[Template:KBmaster]].

Edit-links and information boxes were added, while those are hidden from the default view. In order to see them, interested users need to add
<css>.L10n-hidden { display:block; }</css>
to their [[Special:MyPage/monobook.css|User:Firstname Lastname/monobook.css]] (e.g.: [[User:Khepri Contractor/monobook.css]]).

=== English Base Articles (Doc Team) ===

When the above CSS settings are set, every English KB article containing [[Template:KBmaster]] displays either a change version number or add versioning link in the upper right, beneath the [[Template:Seal|Seal]]. Clicking this link will prompt the editor to a page where the version numbering can be set. Such a page looks like follows:

<nowiki> {{multi-lang/Version
|1 
|priority= 
|Needs Update 
|3=Initial creation 
}}</nowiki>

The first section contains the version number. Increase this number, whenever a substantial edit to the base page took place (never decrease this number). 
The second section gives the option to specify a priority for the update. This can be interpreted as a counterpart of JIRA priorities and tells the localization team how important it is that the translated articles receive this update as well. 
The 3rd part specifies a headline for the boxes shown in the translated articles. Since these are only visible for translators, the line can be left as is. 
The last section provides space to specify which changes took place within the last updates. It would be nice to have some short statement per version number in this place. Nothing verbose... All details can be retrieved from the articles history. Just a short note on what to expect.

Here is an example how such a page could look like:

<nowiki> {{multi-lang/Version
|3
|priority=1
|Needs Update
|3=
*Version 1: Initial creation
*Version 2: Added paragraph foo
*Version 3: Removed paragraph bar, edited section baz
}}</nowiki>

The above example would fit to a page which had 3 major updates, while the most recent is a critical update that should be translated as soon as possible.

=== Localized Child Articles (Loc Team) ===

Localized KB articles in need of an update appear in a special category, named Category:Articles in need of updating/KB/ISO-639-1-Code. For example: [[:Category:Articles in need of updating/KB/fr]] for French.

These articles display a localized warning message for every reader. {{Hilite|to be implemented}}

Those who modified the above mentioned CSS file will also see a box containing the specified editor notes. When an article is updated to be in sync with the English base page, the version number of the translated article needs to be set to the same value the English page has. This will hide the warning box and will take the article off the update-category. In order to set the version number of a page, alter the included [[Template:KBmaster]] on top of the localized article. The template would therefor look like

<nowiki>{{KBmaster|English Base Page|/ISO-639-1-Code|version=</nowiki>NUMBER}}

Here an example for a French translation of [[What is the Second Life Destination Guide?]], in case it would need version number 2:

<nowiki>{{KBmaster|What is the Second Life Destination Guide?|/fr|</nowiki>version=2}}

== Quick Links ==

The following table presents the update links with respective localized KBs in a clearly arranged way:

<div align="center">{{L10n/table}}</div>

== Related Links ==
* [[Project:L10n]]
* [[Project:Languages]]

[[Category:Localization]]

← Older revision		Revision as of 10:52, 29 March 2010
Line 8:		Line 8:
	== The Problem ==		== The Problem ==

	One goal of the L10n project is, to translate articles and to keep them in sync with their English ~~base~~ pages. In order to reach this goal, it is important to know which ~~base~~ articles received updates after their initial translation. These articles are out-of-sync and in need for an update. The problem is, to identify these articles and to inform translators and coordinators about them.		One goal of the L10n project is, to translate articles and to keep them in sync with their English source pages. In order to reach this goal, it is important to know which source articles received updates after their initial translation. These articles are out-of-sync and in need for an update. The problem is, to identify these articles and to inform translators and coordinators about them.

	== The Solution ==		== The Solution ==

	A possible solution to this problem is a versioning scheme:		A possible solution to this problem is a versioning scheme:
	* Every ~~base~~ article receives an arbitrary version number.		* Every source article receives an arbitrary version number.
	* Every substantial update to an article increases the version number.		* Every substantial update to an article increases the version number.
	When a translated article is in sync with version number '''n''', it receives the same version number. When the version number of the ~~base~~ page is increased to '''n+1''', the translated article is automatically marked as out-of-sync and added to a dedicated category, until it is updated to '''n+1''' as well.		When a translated article is in sync with version number '''n''', it receives the same version number. When the version number of the source page is increased to '''n+1''', the translated article is automatically marked as out-of-sync and added to a dedicated category, until it is updated to '''n+1''' as well.

	The readers are informed via a warning box, while the translators/coordinators are informed via the categories.		The readers are informed via a warning box, while the translators/coordinators are informed via the categories.
Line 27:		Line 27:
	to their [[Special:MyPage/monobook.css\|User:Firstname Lastname/monobook.css]] (e.g.: [[User:Khepri Contractor/monobook.css]]).		to their [[Special:MyPage/monobook.css\|User:Firstname Lastname/monobook.css]] (e.g.: [[User:Khepri Contractor/monobook.css]]).

	=== English ~~Base~~ Articles (Doc Team) ===		=== English Source Articles (Doc Team) ===

	When the above CSS settings are set, every English KB article containing [[Template:KBmaster]] displays either a <font color="blue"><u>change version number</u></font> or <font color="blue"><u>add versioning</u></font> link in the upper right, beneath the [[Template:Seal\|Seal]]. Clicking this link will prompt the editor to a page where the version numbering can be set. Such a page looks like follows:		When the above CSS settings are set, every English KB article containing [[Template:KBmaster]] displays either a <font color="blue"><u>change version number</u></font> or <font color="blue"><u>add versioning</u></font> link in the upper right, beneath the [[Template:Seal\|Seal]]. Clicking this link will prompt the editor to a page where the version numbering can be set. Such a page looks like follows:
Line 37:		Line 37:
	}}</nowiki>		}}</nowiki>

	The first section contains the version number. Increase this number, whenever a substantial edit to the ~~base~~ page took place (never decrease this number).<br />		The first section contains the version number. Increase this number, whenever a substantial edit to the source page took place (never decrease this number).<br />
	The second section gives the option to specify a priority for the update. This can be interpreted as a counterpart of JIRA priorities and tells the localization team how important it is that the translated articles receive this update as well.<br />		The second section gives the option to specify a priority for the update. This can be interpreted as a counterpart of JIRA priorities and tells the localization team how important it is that the translated articles receive this update as well.<br />
	The last section provides space to specify which changes took place within the last updates. It would be nice to have some short statement per version number in this place. Nothing verbose... All details can be retrieved from the articles history. Just a short note on what to expect.		The last section provides space to specify which changes took place within the last updates. It would be nice to have some short statement per version number in this place. Nothing verbose... All details can be retrieved from the articles history. Just a short note on what to expect.
Line 60:		Line 60:
	These articles display a localized warning message for every reader. {{Hilite\|to be implemented}}		These articles display a localized warning message for every reader. {{Hilite\|to be implemented}}

	Those who modified the above mentioned CSS file will also see a box containing the specified editor notes. When an article is updated to be in sync with the English ~~base~~ page, the version number of the translated article needs to be set to the same value the English page has. This will hide the warning box and will take the article off the update-category. In order to set the version number of a page, alter the included [[Template:KBmaster]] on top of the localized article. The template would therefor look like		Those who modified the above mentioned CSS file will also see a box containing the specified editor notes. When an article is updated to be in sync with the English source page, the version number of the translated article needs to be set to the same value the English page has. This will hide the warning box and will take the article off the update-category. In order to set the version number of a page, alter the included [[Template:KBmaster]] on top of the localized article. The template would therefor look like

	<nowiki>{{KBmaster\|English ~~Base~~ Page\|/ISO-639-1-Code\|version=</nowiki><font color="blue">NUMBER</font>}}		<nowiki>{{KBmaster\|English Source Page\|/ISO-639-1-Code\|version=</nowiki><font color="blue">NUMBER</font>}}

	Here an example for a French translation of [[What is the Second Life Destination Guide?]], in case it would need version number 2:		Here an example for a French translation of [[What is the Second Life Destination Guide?]], in case it would need version number 2: