Changes between Version 31 and Version 32 of TranslatedPagesMacro


Ignore:
Timestamp:
Aug 20, 2015, 8:27:28 AM (9 years ago)
Author:
figaro
Comment:

Cosmetic changes

Legend:

Unmodified
Added
Removed
Modified
  • TranslatedPagesMacro

    v31 v32  
    55== Description
    66
    7 A 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
     7This is a 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 as follows:
    88
    99[[Image(translated_pages_1.0_sample_english.png)]]
    10 
    11 to direct to translated versions of wiki pages.
    1210
    1311Each 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.
     
    1715Existing bugs and feature requests for TranslatedPagesMacro are [report:9?COMPONENT=TranslatedPagesMacro here].
    1816
    19 If you have any issues, create a [http://trac-hacks.org/newticket?component=TranslatedPagesMacro&owner=stoecker new ticket].
    20 
    21 The are the following known issues:
    22 
    23 [[TicketQuery(component=TranslatedPagesMacro,status=!closed)]]
     17If you have any issues, create a [/newticket?component=TranslatedPagesMacro new ticket].
    2418
    2519[[TicketQuery(component=TranslatedPagesMacro,group=type,format=progress)]]
    2620
     21== Download
     22
     23Download the [download:translatedpagesmacro zipped source].
     24
     25== Source
     26
     27You can obtain the code from the Trac Subversion repository:
     28{{{#!sh
     29svn co http://trac-hacks.org/svn/translatedpagesmacro
     30}}}
     31
     32You can also [source:translatedpagesmacro browse the source in Trac].
     33
    2734== Installation
    2835
    29 See 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:
    30 {{{
    31 #!sh
     36General instructions on installing Trac plugins can be found on the [TracPlugins#InstallingaTracplugin TracPlugins] page.
     37
     38See 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:
     39{{{#!sh
    3240easy_install TranslatedPagesMacro
    3341}}}
    3442
    35 You can also obtain the code from the Trac Subversion repository:
    36 {{{
    37 #!sh
    38 svn co http://trac-hacks.org/svn/translatedpagesmacro
    39 }}}
     43There is also this [http://trac-hacks.org/svn/translatedpagesmacro/0.11/#egg=TranslatedPages-dev link for setuptools to find the SVN download].
    4044
    41 or download [download:translatedpagesmacro zipped source].
    42 
    43 See TracPlugins for instructions on building and installing plugins.
    44 
    45 You can [source:translatedpagesmacro browse the source in Trac].
    46 
    47 ''[http://trac-hacks.org/svn/translatedpagesmacro/0.11/#egg=TranslatedPages-dev This is a link for setuptools to find the SVN download]''
    48 
    49 == Upgrading from plugin version 0.3
     45=== Upgrading from plugin version 0.3
    5046
    5147The 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.
    5248
    53 For existing installations that use the old schema the following settings must be used:
    54 {{{
    55 #!ini
     49For existing installations that use the old schema, the following settings must be used in `trac.ini`:
     50{{{#!ini
    5651[translatedpages]
    5752template = {page}/{lang}
     
    8176== Macro help text
    8277
    83 Following chapter contains the help text found at [WikiMacros#TranslatedPages-macro] on systems with macro installed.
     78Following chapter contains the help text found at [WikiMacros#TranslatedPages-macro] on systems with the macro installed.
    8479
    8580Macro to show the translated pages list.
     
    8782Simply calling that macro in a page adds a menu linking to all available translations of a page.
    8883
    89 A language page (usually [TranslatedPagesMacro/TracLanguages TracLanguages]) (location is wiki/TracLanguages in installed system) must provide the language codes as a table
    90 with following entries:
     84A language page (usually [TranslatedPagesMacro/TracLanguages TracLanguages]) (location is wiki/TracLanguages in installed system) must provide the language codes as a table with the following entries:
    9185{{{
    9286||<language code>||<language name>||<english name>||<description>||
    93 }}}
    94 The description contains the text displayed above language links in that language
    95 (usually a variant of 'Other languages').
    96 A table title line starting with {{{||=}}} is not parsed.
     87}}}
     88
     89The description contains the text displayed above language links in that language, usually a variant of 'Other languages'. A table title line starting with {{{||=}}} is not parsed.
    9790
    9891The Macro accepts arguments as well:
     
    135128
    136129'''Author:''' [wiki:ftofficer] [[BR]]
    137 '''Maintainer:''' [wiki:stoecker Dirk Stöcker] [[BR]]
     130'''Maintainer:''' [[Maintainer]] [[BR]]
    138131'''Contributors:''' [wiki:dottedmag]