X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/3937e1fb1679ab6ebdf3a00f52187e3581691f3f..c440a39ba4ba6726ab67b0e1d04b064ae84f67ef:/doc/plugins/po.mdwn?ds=inline diff --git a/doc/plugins/po.mdwn b/doc/plugins/po.mdwn index 5cac86d26..d16d13edc 100644 --- a/doc/plugins/po.mdwn +++ b/doc/plugins/po.mdwn @@ -198,14 +198,18 @@ Also, when the plugin has just been enabled, or when a page has just been declared as being translatable, the needed POT and PO files are created, and the PO files are checked into version control. -Discussion pages ----------------- +Discussion pages and other sub-pages +------------------------------------ Discussion should happen in the language in which the pages are written for real, *i.e.* the "master" one. If discussion pages are enabled, "slave" pages therefore link to the "master" page's discussion page. +Likewise, "slave" pages are not supposed to have sub-pages; +[[WikiLinks|wikilink]] that appear on a "slave" page therefore link to +the master page's sub-pages. + Translating ----------- @@ -496,20 +500,32 @@ gettext/po4a rough corners into the Pot file, and let it propagate; should be fixed in `773de05a7a1ee68d2bed173367cf5e716884945a`, time will tell. -Page titles in links --------------------- +Better links +------------ + +### Page title in links -To use the page titles set with the [meta](plugins/meta) plugin when +To use the page titles set with the [[meta|plugins/meta]] plugin when rendering links would be very much nicer, than the current "filename.LL" format. This is actually a duplicate for [[bugs/pagetitle_function_does_not_respect_meta_titles]]. +Going to work on this in my `meta` branch. + +### Translation status in links + +See [[contrib/po]]. + +### Backlinks + +They are not updated when the source page changes (e.g. meta title). + Page formats ------------ Markdown is well supported, great, but what about others? -The [po](plugins/po) uses `Locale::Po4a::Text` for every page format; +The [[po|plugins/po]] uses `Locale::Po4a::Text` for every page format; this can be expected to work out of the box with most other wiki-like formats supported by ikiwiki. Some of their ad-hoc syntax might be parsed in a strange way, but the worst problems I can imagine would be @@ -535,14 +551,24 @@ A new `cansave` type of hook would be needed to implement this. Note: committing to the underlying repository is a way to bypass this check. -Broken links ------------- +Creating new pages on the web +----------------------------- See [[contrib/po]]. +Robustness tests +---------------- + +- adding and removing pages from `po_translatable_pages` +- creating and removing pages listed in `po_translatable_pages` +- enabling the plugin, with and without `po_translatable_pages` set +- disabling the plugin +- test with `usedirs` disabled +- test with `indexpages` enabled + Documentation ------------- Maybe write separate documentation depending on the people it targets: -translators, wiki administrators, hackers. This plugin is maybe -complex enough to deserve this. +translators, wiki administrators, hackers. This plugin may be complex +enough to deserve this.