Changes between Version 30 and Version 31 of TranslatedPagesMacro


Ignore:
Timestamp:
Mar 5, 2015, 1:38:25 PM (9 years ago)
Author:
figaro
Comment:

Cosmetic changes, tagged with license

Legend:

Unmodified
Added
Removed
Modified
  • TranslatedPagesMacro

    v30 v31  
    11[[PageOutline(2-5,Contents,pullout)]]
    2 = Show translated versions of wiki page =
    32
    4 == Description ==
     3= Show translated versions of wiki page
    54
    6 A 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
     5== Description
     6
     7A macro to output a list of translated versions of a current page. The base language page should use the wiki name without language code, and the translated wiki pages use a configurable version including language code. The `[[TranslatedPages]]` macro generates a list of languages like
    78
    89[[Image(translated_pages_1.0_sample_english.png)]]
     
    1011to direct to translated versions of wiki pages.
    1112
    12 Each 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.
     13Each 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 a 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.
    1314
    14 == Bugs/Feature Requests ==
     15== Bugs/Feature Requests
    1516
    1617Existing bugs and feature requests for TranslatedPagesMacro are [report:9?COMPONENT=TranslatedPagesMacro here].
     
    1819If you have any issues, create a [http://trac-hacks.org/newticket?component=TranslatedPagesMacro&owner=stoecker new ticket].
    1920
    20 == Get the Plugin ==
     21The are the following known issues:
     22
     23[[TicketQuery(component=TranslatedPagesMacro,status=!closed)]]
     24
     25[[TicketQuery(component=TranslatedPagesMacro,group=type,format=progress)]]
     26
     27== Installation
    2128
    2229See the [wiki:TracPlugins#Requirements Trac plugin requirements] for instructions on installing `setuptools`.  `Setuptools` includes the `easy_install` application which you can use to install the TranslatedPagesMacro:
     
    4047''[http://trac-hacks.org/svn/translatedpagesmacro/0.11/#egg=TranslatedPages-dev This is a link for setuptools to find the SVN download]''
    4148
    42 == Upgrading from older version 0.3 ==
     49== Upgrading from plugin version 0.3
    4350
    44 The macro enhanced a lot since version 0.3. A major change is the layout of the pages. Version 0.3 hardcoded the format {{{page/<lang>}}}. The new version has {{{<lang>:page}}} as default which is used more often for wikis.
     51The macro has been enhanced since version 0.3. A major change is the layout of the pages. Version 0.3 hardcoded the format {{{page/<lang>}}}. The new version has {{{<lang>:page}}} as default which is more often used for wikis.
    4552
    46 For existing installations using the old schema following settings must be used:
     53For existing installations that use the old schema the following settings must be used:
    4754{{{
    4855#!ini
     
    5461Also the layout of the language specification page changed (more entries required tables style design).
    5562
    56 == Example ==
     63== Example
    5764
    5865An example of the required language specification page can be found at [wiki:TranslatedPagesMacro/TracLanguages].
     
    7279An example of an actively used installation can be found at [http://josm.openstreetmap.de/wiki/Translations].
    7380
    74 == Macro help text ==
     81== Macro help text
    7582
    7683Following chapter contains the help text found at [WikiMacros#TranslatedPages-macro] on systems with macro installed.
     
    101108 * '''lang=<code>'''      to restrict output of show outdated, status or missing to a specific language
    102109
    103 == Additional descriptions and comments ==
     110== Additional descriptions and comments
    104111
    105112 * The status table uses following colors (note status table may require a lot of calculation time depending on number of pages and languages).
     
    113120 * When using the '''show...''' parameters, no translation message link box is created. You need to add another instance of the macro if you want to have these texts and the page links.
    114121
    115 == Troubleshooting ==
     122== Troubleshooting
    116123
    117124When you setup the macro and it does not work:
    118125
    119  * Check if the macro text is in the WikiMacros page as told above. If not installation is broken.
    120  * Check if [TranslatedPagesMacro/TracLanguages TracLanguages] pages is available and in correct format.
     126 * Check if the macro text is in the WikiMacros page as explained above. If it is not, then the installation is broken.
     127 * Check if [TranslatedPagesMacro/TracLanguages TracLanguages] pages is available and in the correct format.
    121128 * If you created pages with language code and macro inserted, adding {{{[[TranslatedPages(showproblems)]]}}} to any page and then previewing (no need to save) should tell you existing problems.
    122129
    123 == Known Issues ==
    124 
    125 [[TicketQuery(component=TranslatedPagesMacro,status=!closed)]]
    126 
    127 == Recent Changes ==
     130== Recent Changes
    128131
    129132[[ChangeLog(translatedpagesmacro, 3)]]
    130133
    131 == Author/Contributors ==
     134== Author/Contributors
    132135
    133136'''Author:''' [wiki:ftofficer] [[BR]]