| 73 | == Macro help text == |
| 74 | |
| 75 | Following chapter contains the help text found at [WikiMacros#TranslatedPages-macro] on systems with macro installed. |
| 76 | |
| 77 | Macro to show the translated pages list. |
| 78 | |
| 79 | Simply calling that macro in a page adds a menu linking to all available translations of a page. |
| 80 | |
| 81 | A language page (usually !TracLanguages) must provide the language codes as a table |
| 82 | with following entries: |
| 83 | {{{ |
| 84 | ||<language code>||<language name>||<english name>||<description>|| |
| 85 | }}} |
| 86 | The description contains the text displayed above language links in that language |
| 87 | (usually a variant of 'Other languages'). |
| 88 | A table title line starting with {{{||=}}} is not parsed. |
| 89 | |
| 90 | The Macro accepts arguments as well: |
| 91 | * '''revision=<num>''' to specify the version of the base page when last translated, a negative revision indicates that a page needs updating in the status overview table |
| 92 | * '''outdated=<text>''' mark the page as outdated with given comment |
| 93 | * '''silent''' don't output empty chapter for show options when nothing is shown |
| 94 | |
| 95 | * '''showoutdated''' to show all pages, where revision does not match base revision |
| 96 | * '''showmissing''' to show all pages, where translation is missing |
| 97 | * '''showproblems''' to show all pages which have problems |
| 98 | * '''showuntranslated''' to show all untranslated pages |
| 99 | * '''showstatus''' to show one big status table |
| 100 | * '''lang=<code>''' to restrict output of show outdated, status or missing to a specific language |
| 101 | |
| 102 | == Additional descriptions and comments == |
| 103 | |
| 104 | * The status table uses following colors (note status table may require a lot of calculation time depending on number of pages and languages). |
| 105 | * Red: There is an error with this page (shown in error list) |
| 106 | * Yellow: Page needs update |
| 107 | * Green: Everything up-to-date |
| 108 | * Grey: Page is missing |
| 109 | |
| 110 | * The {{{outdated}}} parameter is useful when a page is known to be outdated, but there is no time to fix it immediately. The page is marked yellow in the status table and the text argument is displayed on the page itself. |
| 111 | * The macro also works without the {{{revision}}} parameter on the translated pages, but it is a very helpful tool to keep original and translations in sync. |
| 112 | |