X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/dcb52530910306891622bbaff9e039b52e83b0fc..ea8c166a053c3c5f78e4a27f26a59f4bc9011b4e:/doc/plugins/po.mdwn diff --git a/doc/plugins/po.mdwn b/doc/plugins/po.mdwn index cdf3c6abe..98526a55a 100644 --- a/doc/plugins/po.mdwn +++ b/doc/plugins/po.mdwn @@ -55,7 +55,7 @@ Supported languages languages, such as: po_slave_languages => { 'fr' => 'Français', - 'es' => 'Castellano', + 'es' => 'Español', 'de' => 'Deutsch', } @@ -150,24 +150,9 @@ display things only on translatable or translation pages. The `OTHERLANGUAGES` loop provides ways to display other languages' versions of the same page, and the translations' status. -One typically adds the following code to `templates/page.tmpl`: - - -
- -
-
- -The following variables are available inside the loop (for every page in): +An example of its use can be found in the default +`templates/page.tmpl`. In case you want to customize it, the following +variables are available inside the loop (for every page in): * `URL` - url to the page * `CODE` - two-letters language code @@ -178,15 +163,8 @@ The following variables are available inside the loop (for every page in): ### Display the current translation status The `PERCENTTRANSLATED` variable is set to the translation -completeness, expressed in percent, on "slave" pages. - -One can use it this way: - - -
- -
-
+completeness, expressed in percent, on "slave" pages. It is used by +the default `templates/page.tmpl`. Additional PageSpec tests ------------------------- @@ -231,8 +209,8 @@ preferred `$EDITOR`, without needing to be online. Markup languages support ------------------------ -Markdown is well supported. Some other markup languages supported by -ikiwiki mostly work, but some pieces of syntax are not rendered +[[Markdown|mdwn]] is well supported. Some other markup languages supported +by ikiwiki mostly work, but some pieces of syntax are not rendered correctly on the slave pages: * [[reStructuredText|rst]]: anonymous hyperlinks and internal @@ -246,7 +224,7 @@ correctly on the slave pages: Security ======== -[[./security]] contains a detailed security analysis of this plugin +[[po/discussion]] contains a detailed security analysis of this plugin and its dependencies. When using po4a older than 0.35, it is recommended to uninstall @@ -269,41 +247,8 @@ pages. Both were implemented, and reverted in commit ea753782b222bf4ba2fb4683b6363afdd9055b64, which should be reverted once [[intrigeri]]'s `meta` branch is merged. -Robustness tests ----------------- - -### Enabling/disabling the plugin - -* enabling the plugin with `po_translatable_pages` set to blacklist: **OK** -* enabling the plugin with `po_translatable_pages` set to whitelist: **OK** -* enabling the plugin without `po_translatable_pages` set: **OK** -* disabling the plugin: **OK** - -### Changing the plugin config - -* adding existing pages to `po_translatable_pages`: **OK** -* removing existing pages from `po_translatable_pages`: **OK** -* adding a language to `po_slave_languages`: **OK** -* removing a language from `po_slave_languages`: **OK** -* changing `po_master_language`: **OK** -* replacing `po_master_language` with a language previously part of - `po_slave_languages`: needs two rebuilds, but **OK** (this is quite - a perverse test actually) - -### Creating/deleting/renaming pages - -All cases of master/slave page creation/deletion/rename, both via RCS -and via CGI, have been tested. - -### Misc - -* general test with `usedirs` disabled: **OK** -* general test with `indexpages` enabled: **not OK** -* general test with `po_link_to=default` with `userdirs` enabled: **OK** -* general test with `po_link_to=default` with `userdirs` disabled: **OK** - -Misc. bugs ----------- +An integration branch, called `meta-po`, merges [[intrigeri]]'s `po` +and `meta` branches, and thus has thise additional features. Documentation -------------