X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/e1e936d27c919d6dde1a6f0c2405ca3ac7122b54..6be874612539d3148d288fc6a4c47743a7c0c8fc:/doc/plugins/po.mdwn
diff --git a/doc/plugins/po.mdwn b/doc/plugins/po.mdwn
index 1f57418b5..031188a67 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',
}
@@ -114,7 +114,8 @@ Apache
Using Apache `mod_negotiation` makes it really easy to have Apache
serve any page in the client's preferred language, if available.
-This is the default Debian Apache configuration.
+
+Add 'Options MultiViews' to the wiki directory's configuration in Apache.
When `usedirs` is enabled, one has to set `DirectoryIndex index` for
the wiki context.
@@ -123,6 +124,8 @@ Setting `DefaultLanguage LL` (replace `LL` with your default MIME
language code) for the wiki context can help to ensure
`bla/page/index.en.html` is served as `Content-Language: LL`.
+For details, see [Apache's documentation](http://httpd.apache.org/docs/2.2/content-negotiation.html).
+
lighttpd
--------
@@ -150,24 +153,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`:
-
-
-
-
-
- -
- ">
-
- ( %)
-
-
-
-
-
-
-
-
+completeness, expressed in percent, on "slave" pages. It is used by
+the default `templates/page.tmpl`.
Additional PageSpec tests
-------------------------
@@ -246,7 +227,7 @@ correctly on the slave pages:
Security
========
-[[po/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
@@ -270,43 +251,106 @@ ea753782b222bf4ba2fb4683b6363afdd9055b64, which should be reverted
once [[intrigeri]]'s `meta` branch is merged.
An integration branch, called `meta-po`, merges [[intrigeri]]'s `po`
-and `meta` branches, and thus has thise additional features.
+and `meta` branches, and thus has this additional features.
+
+Language display order
+----------------------
+
+Jonas pointed out that one might want to control the order that links to
+other languages are listed, for various reasons. Currently, there is no
+order, as `po_slave_languages` is a hash. It would need to be converted
+to an array to support this. (If twere done, twere best done quickly.)
+--[[Joey]]
+
+Pagespecs
+---------
+
+I was suprised that, when using the map directive, a pagespec of "*"
+listed all the translated pages as well as regular pages. That can
+make a big difference to an existing wiki when po is turned on,
+and seems generally not wanted.
+(OTOH, you do want to match translated pages by
+default when locking pages.) --[[Joey]]
+
+Edit links on untranslated pages
+--------------------------------
+
+If a page is not translated yet, the "translated" version of it
+displays wikilinks to other, existing (but not yet translated?)
+pages as edit links, as if those pages do not exist.
+
+That's really confusing, especially as clicking such a link
+brings up an edit form to create a new, english page.
-Robustness tests
-----------------
+This is with po_link_to=current or negotiated. With default, it doesn't
+happen..
-### Enabling/disabling the plugin
+Also, this may only happen if the page being linked to is coming from an
+underlay, and the underlays lack translation to a given language.
+--[[Joey]]
-* 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**
+Double commits of po files
+--------------------------
-### Changing the plugin config
+When adding a new english page, the po files are created, committed,
+and then committed again. The second commit makes this change:
-* 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)
+ -"Content-Type: text/plain; charset=utf-8\n"
+ -"Content-Transfer-Encoding: ENCODING"
+ +"Content-Type: text/plain; charset=UTF-8\n"
+ +"Content-Transfer-Encoding: ENCODING\n"
-### Creating/deleting/renaming pages
+Same thing happens when a change to an existing page triggers a po file
+update. --[[Joey]]
-All cases of master/slave page creation/deletion/rename, both via RCS
-and via CGI, have been tested.
+Ugly messages with empty files
+------------------------------
-### Misc
+If there are empty .mdwn files, the po plugin displays some ugly messages.
-* 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**
+Translation of directives
+-------------------------
+
+If a translated page contains a directive, it may expand to some english
+text, or text in whatever single language ikiwiki is configured to "speak".
+
+Maybe there could be a way to switch ikiwiki to speaking another language
+when building a non-english page? Then the directives would get translated.
+
+Created page type
+-----------------
+
+The interdiction to create pages of type po was broken by the new
+`page_types` code. This is fixed in my po branch by
+commit 1914ae2fd24e1e802.
+
+While I was there, I also added some code to set a new default value
+to the type select field in case it was previously set to "po".
+This code favors the type of the linking page's masterpage on page
+creation (when `from=page.LL`). This is commit c9301d2c296f682.
+--[[intrigeri]]
+
+> Both cherry picked. --[[Joey]]
+
+inline's post form's rootpage
+-----------------------------
+
+When a translatable page (say it is called "bugs") contains an
+[[inline directive|ikiwiki/directive/inline]] with `postform` enabled,
+the rootpage is l10n'd on translations pages (e.g. "bugs.fr" gets
+a `rootpage` value of `bugs.fr`). This is usually not what's expected,
+as translation pages are not supposed to have subpages. My po branch
+has code (e671e72053e81fa, which depends on 72ac9821e56637) that fixes
+this. --[[intrigeri]]
+
+link() pagespec on translation pages
+------------------------------------
-Misc. bugs
-----------
+The `link()` pagespec, on translation pages, currently tests whether
+a given page links to the *current translation page*, rather than
+whether it links to its master page. I believe the later is generally
+expected. Commit 646c9a4c95a480 in my po branch fixes this.
+--[[intrigeri]]
Documentation
-------------