Changes between Version 15 and Version 16 of TranslatedPagesMacro


Ignore:
Timestamp:
Jun 22, 2011, 5:03:26 PM (3 years ago)
Author:
stoecker
Comment:

Updated

Legend:

Unmodified
Added
Removed
Modified
  • TranslatedPagesMacro

    v15 v16  
    44== Description ==
    55
    6 A macro to output a list of translated versions of in current page. The English page should use the wiki name without language code, and translated wiki pages use a configurable version including language code. The `[[TranslatedPages]]` macro generates a list of languages like
     6A macro to output a list of translated versions of in current page. The base language page should use the wiki name without language code, and translated wiki pages use a configurable version including language code. The `[[TranslatedPages]]` macro generates a list of languages like
    77
    88[[Image(translated_pages_1.0_sample_english.png)]]
    99
    1010to direct to translated versions of wiki pages.
     11
     12Each translated page has the same macro, but containing the revision of the base page.  When the revision of the base page is newer than the translated revision (someone updated English page), then below the language links in menu an new menu point appears showing the translated revisions and newest one. When clicking on that link, the differences between that revision are displayed. These can then be used to update the translation. During updating the revision in the translated page needs to be increased to the newest one and the additional links disappears.
    1113
    1214== Bugs/Feature Requests ==
     
    6971An example of an actively used installation can be found at [http://josm.openstreetmap.de/wiki/Translations].
    7072
     73== Macro help text ==
     74
     75Following chapter contains the help text found at [WikiMacros#TranslatedPages-macro] on systems with macro installed.
     76
     77Macro to show the translated pages list.
     78
     79Simply calling that macro in a page adds a menu linking to all available translations of a page.
     80
     81A language page (usually !TracLanguages) must provide the language codes as a table
     82with following entries:
     83{{{
     84||<language code>||<language name>||<english name>||<description>||
     85}}}
     86The description contains the text displayed above language links in that language
     87(usually a variant of 'Other languages').
     88A table title line starting with {{{||=}}} is not parsed.
     89
     90The 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
    71113== Known Issues ==
    72114