]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/translation.mdwn
add news item for ikiwiki 3.20140227
[git.ikiwiki.info.git] / doc / translation.mdwn
index 449ad4710cec06c7e9e36ac1842cfd18849f5559..9d874d98e8b537a1cbeac21d7e4d95938a961189 100644 (file)
@@ -1,10 +1,10 @@
 If you want to translate your wiki into another language, there are
 If you want to translate your wiki into another language, there are
-essentailly three peices needed for a complete translation:
+essentially three pieces needed for a complete translation:
 
 1. The messages in the ikiwiki program itself need to be translated.
    Ikiwiki is internationalised, and most such messages are already marked
 
 1. The messages in the ikiwiki program itself need to be translated.
    Ikiwiki is internationalised, and most such messages are already marked
-   with `gettext()`. Building from source creates a `po/ikiwiki.pot` that
-   can be copied and translated as a po file. All very standard.
+   with `gettext()`. The source tarball includes a `po/ikiwiki.pot`
+   that can be copied and translated as a po file. All very standard.
 
    Note that a few things in the source are not currently translated. These
    include:
 
    Note that a few things in the source are not currently translated. These
    include:
@@ -22,11 +22,25 @@ essentailly three peices needed for a complete translation:
    * The names and values of parameters, both to the program, in the setup
      file, and in preprocessor directives.
 
    * The names and values of parameters, both to the program, in the setup
      file, and in preprocessor directives.
 
+1. The [[basewiki]] needs to be translated. The
+   [[plugins/po]] ikiwiki plugin will allow translating
+   wikis using po files and can be used for this.
+
+   There is now a website, [l10n.ikiwiki.info](http://l10n.ikiwiki.info)
+   that both demos the translated basewiki, and allows easy translation of
+   it.
+
+   To generate the po and pot files for translating the basewiki,
+   get ikiwiki's source, edit the `po/underlay.setup` file,
+   adding your language. Then run 'make -C po underlays`.
+   This will generate many po files under `po/underlays`. The first
+   ones you'll want to translate are in the `po/underlays/basewiki` directory,
+   which is really not very large, just a few thousand words.
+   After that is done, you can tackle those under
+   `po/underlays/directives`, which are a much larger (tens of
+   thousands of words).
+
 1. The templates also need to be translated. Some work has been done on an
    infrastructure for maintaining translated templates, as documented in
 1. The templates also need to be translated. Some work has been done on an
    infrastructure for maintaining translated templates, as documented in
-   [[patchqueue/l10n]], but until that's complete, you'd need to copy and
+   [[todo/l10n]], but until that's complete, you'd need to copy and
    translate the templates by hand.
    translate the templates by hand.
-
-1. The basewiki itself needs to be translated. Whether to only translate
-   the page contents, or also translate the page names, is an open
-   question.