Edit Markup: Difference between revisions

Revision as of 07:10, 9 July 2010

Prepare a Page for Translation

Under Construction

This is a new page, currently under construction!

Available Tools

Typographical_Guidelines standardises markup for use in translation, either to official manuals (DocBook) or to other languages. Please refer to this frequently, as markup will be refined to match translators' needs.

Workflow

Check that every heading for sections and subsections has an empty line following it.
Many pages have multiple indents set. This was included in earlier mediawiki documentation, but is not longer acceptable as it causes problems for exporting to other formats, so please re-arrange, using single indents only. Bullets can continue to be used nested.
Ascii smilies cause problems and must be removed. They can be replaced by oxygen icons in a small size (11px?). Many more are available from Wikimedia Commons - details to be added here.
Internal links in the form [[Translation Workflow]] should be edited to the complete form, showing link, then visible text such as [[Translation_Workflow|Translation Workflow]]
Many styles have been used to display input text, including <code>, <pre> and tables and boxes. Text intended to be input by the user should use the Input template, {Input|1=input text (can be multi-line or single)}}
Output from terminal and error messages have been similarly marked with a variety of methods. These should be replaced with the Output template, {{Output|1=terminal output}}
Every page should end with a Category statement. These must be standardised categories. A current list of categories can be found on any of the translators' pages linked from this language page

@@ Line 1: / Line 1: @@
 ==Prepare a Page for Translation==
+{{Construction}}
 ===Available Tools===
 * [[Typographical_Guidelines]] standardises markup for use in translation, either to official manuals (DocBook) or to other languages. Please refer to this frequently, as markup will be refined to match translators' needs.
 ===Workflow===
+* Check that every heading for sections and subsections has an empty line following it.
+* Many pages have multiple indents set.  This was included in earlier mediawiki documentation, but is not longer acceptable as it causes problems for exporting to other formats, so please re-arrange, using single indents only.  Bullets can continue to be used nested.
+* Ascii smilies cause problems and must be removed.  They can be replaced by oxygen icons in a small size (11px?).  Many more are available from Wikimedia Commons - details to be added here.
+* Internal links in the form <nowiki>[[Translation Workflow]]</nowiki> should be edited to the complete form, showing link, then visible text such as <nowiki>[[Translation_Workflow|Translation Workflow]]</nowiki>
+* Many styles have been used to display input text, including <nowiki><code>, <pre></nowiki> and tables and boxes. Text intended to be input by the user should use the Input template, <nowiki>{Input|1=input text (can be multi-line or single)}}</nowiki>
+* Output from terminal and error messages have been similarly marked with a variety of methods.  These should be replaced with the Output template, <nowiki>{{Output|1=terminal output}}</nowiki>
+* Every page should end with a Category statement.  These must be standardised categories.  A current list of categories can be found on any of the translators' pages linked from [[Translation_Help_Needed|this language page]]