`po_slave_languages` is used to set the list of supported "slave"
languages, such as:
- po_slave_languages => { 'fr' => { 'name' => 'Français', },
- 'es' => { 'name' => 'Castellano', },
- 'de' => { 'name' => 'Deutsch', }
+ po_slave_languages => { 'fr' => 'Français',
+ 'es' => 'Castellano',
+ 'de' => 'Deutsch',
}
+Decide which pages are translatable
+-----------------------------------
-Server support
-==============
-
-Apache
-------
-
-Using `mod_negotiation` makes it really easy to have Apache serve the
-page in the client's preferred language, if available. This is the
-default Debian Apache configuration.
-
-When `usedirs` is enabled, one has to set `DirectoryIndex index` for
-the wiki context.
-
-Setting `DefaultLanguage LL` (replace `LL` with your default MIME
-language) for the wiki context can be needed, to ensure
-`bla/page/index.en.html` is served as `Content-Language: LL`.
-**FIXME**: is it still needed with the new `.en.html` naming convention?
-
-lighttpd
---------
-
-lighttpd unfortunately does not support content negotiation.
-
-**FIXME**: does `mod_magnet` provide the functionality needed to
- emulate this?
-
+The `po_translatable_pages` setting configures what pages are
+translatable. It is a [[ikiwiki/PageSpec]], so you have lots of
+control over what kind of pages are translatable.
-TODO
-====
+The `*.LL.po` translations files are anyway not considered as being
+translatable, so you don't need to worry about excluding them manually
+from this [[ikiwiki/PageSpec]].
Internal links
--------------
### Default linking behavior
If `po_link_to` is unset, or set to `default`, ikiwiki's default
-linking behavior is preserved: `[[page]]` links to the master
+linking behavior is preserved: `\[[page]]` links to the master
language's page.
### Link to negotiated language
-If `po_link_to` is set to `negotiated`, `[[page]]` links to the
+If `po_link_to` is set to `negotiated`, `\[[page]]` links to the
negotiated preferred language, *i.e.* `foo/page/`.
(In)compatibility notes:
### Link to current language
If `po_link_to` is set to `current` and the destination page is either
-a translatable page or a translation, `[[page]]` links to the current
+a translatable page or a translation, `\[[page]]` links to the current
page's language, *i.e.*:
- `foo/page/index.LL.html` if `usedirs` is enabled
- `foo/page.LL.html` if `usedirs` is disabled
-Display available translations
-------------------------------
-The [[linguas|plugins/contrib/linguas]] plugin has some code that can
-be used as a basis to display the existing translations, and allow to
-navigate between them.
+Templates
+---------
+
+The `OTHERLANGUAGES` loop provides ways to display the existing
+translations and/or master page. One typically adds the following code
+to `templates/page.tmpl`:
+
+ <TMPL_IF NAME="OTHERLANGUAGES">
+ <div id="otherlanguages">
+ <ul>
+ <TMPL_LOOP NAME="OTHERLANGUAGES">
+ <li>
+ <a href="<TMPL_VAR NAME="URL">"
+ class="is_master_<TMPL_VAR NAME="MASTER">">
+ <TMPL_VAR NAME="LANGUAGE">
+ </a>
+ </li>
+ </TMPL_LOOP>
+ </ul>
+ </div>
+ </TMPL_IF>
+
+
+Server support
+==============
+
+Apache
+------
+
+Using `mod_negotiation` makes it really easy to have Apache serve the
+page in the client's preferred language, if available. This is the
+default Debian Apache configuration.
+
+When `usedirs` is enabled, one has to set `DirectoryIndex index` for
+the wiki context.
+
+Setting `DefaultLanguage LL` (replace `LL` with your default MIME
+language) for the wiki context can be needed, to ensure
+`bla/page/index.en.html` is served as `Content-Language: LL`.
+**FIXME**: is it still needed with the new `.en.html` naming convention?
+
+lighttpd
+--------
+
+lighttpd unfortunately does not support content negotiation.
+
+**FIXME**: does `mod_magnet` provide the functionality needed to
+ emulate this?
+
+
+TODO
+====
+
+Link relationships
+------------------
+
+Should pages using the `OTHERLANGUAGES` template loop be declared as
+linking to the same page in other versions?
View translation status
-----------------------
This should not be too hard using gettext tools. If this is
implemented as a
-[[HTML::Template|http://search.cpan.org/search?mode=dist&query=HTML%3A%3ATemplate]]
+[HTML::Template](http://search.cpan.org/search?mode=dist&query=HTML%3A%3ATemplate)
loop, a page using it should depend on any "master" and "slave" pages
whose status is being displayed.
-Decide which pages are translatable
------------------------------------
-
-The subset of "master" pages subject to translation must be
-configurable:
-
-- a `[[!translatable ]]` directive, when put on a page, makes it
- translatable
-- to set at once a bunch of pages as being translatable, use this
- [[ikiwiki/directive]] with the `match=PageSpec` argument.
+If it's not too heavy to compute, this status data may be made
+available in the `OTHERLANGUAGES` template loop; else, a dedicated
+loop would be needed.
Automatic PO files update
-------------------------
Committing changes to a "master" page must:
-1. update the POT file and the PO files for the supported languages,
- before putting them under version control
-2. trigger a refresh of the corresponding HTML slave pages
-
-The former is to be done at a time when:
+1. update the POT file and the PO files for the supported languages;
+ this is done in the `needsbuild` hook; the updated PO files must
+ then be put under version control
-- we know which "master" page was modified, and thus, which POT/PO
- files have to be updated: the `needsbuild` hook is the first one to
- run that provides us with the necessary information
-- we can modify the list of pages needing a refresh; this is
- `needsbuild` hook's job
+2. trigger a refresh of the corresponding HTML slave pages: this is
+ achieved by making any "slave" page dependent on the corresponding
+ "master" page, in the `needsbuild` hook.
-The latter can be implemented by making any "slave" page depend on the
-corresponding "master" page. The `add_depends` function can achieve
-this, if used in a **FIXME** hook.
+Also, when the plugin has just been enabled, all the needed POT and PO
+files have to be created.
UI consistency: rename "Edit" button on slave pages
---------------------------------------------------
sipb-www / ikiwiki.git / blobdiff