Improve documentation of the multilingual addon.

FossilOrigin-Name: bcab7c11b76c7ce4db57ec65ea9dde6bdd6e0cc47865824407820d794f2a4154
programandala-net · Sep 2, 2022 · 01e0c3b · 01e0c3b
1 parent 0b62cd4
commit 01e0c3b
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 10 deletions.
diff --git a/VERSION.fs b/VERSION.fs
@@ -3,6 +3,6 @@
 \ This file is part of Fendo
 \ (http://programandala.net/en.program.fendo.html).
 
-: fendo_version ( -- ca len ) s" 0.6.0-pre.83+20220902T2032CEST" ;
+: fendo_version ( -- ca len ) s" 0.6.0-pre.84+20220902T2142CEST" ;
 
 \ vim: filetype=gforth
diff --git a/fendo.addon.multilingual.fs b/fendo.addon.multilingual.fs
@@ -6,10 +6,10 @@
 \ This file creates some low-level tools to manage multilingual
 \ websites. See the manual for details.
 
-\ Last modified 20211023T1637+0200.
+\ Last modified 20220902T2140+0200.
 \ See change log at the end of the file.
 
-\ Copyright (C) 2013,2017,2018,2019,2020,2021 Marcos Cruz (programandala.net)
+\ Copyright (C) 2013,2017,2018,2019,2020,2021,2022 Marcos Cruz (programandala.net)
 
 \ Fendo is free software; you can redistribute
 \ it and/or modify it under the terms of the GNU General
@@ -182,12 +182,19 @@ true to multilingual?
   \ s" Hello" s" Saluton" s" Hola"
   \ l10n-string multilingual-salute$
   \ ----
+
+  \ WARNING: the name of the language identifiers must have the format
+  \ "XXX_language", where "XXX" is the ISO code used in the website
+  \ (in word names and page prefixes). The reason is those identifiers
+  \ need to be calculated by ``pid#>lang#``. This limitation will be
+  \ solved in a future version.
   \
   \ NOTE: ``l10n-string`` is deprecated. It has been superseded by
-  \ `begin-translation`, which makes it easier to add new
-  \ translations gradually and maintain them.
+  \ ``begin-translation`` (provided by the Galope library), which
+  \ makes it easier to add new translations gradually and maintain
+  \ them.
   \
-  \ See also: `begin-translation`, `noname-l10n-string`, `langs`.
+  \ See also: `noname-l10n-string`, `langs`.
   \
   \ }doc
 
@@ -207,10 +214,11 @@ true to multilingual?
   \ language of the current page.
   \
   \ NOTE: ``noname-l10n-string`` is deprecated. It has been superseded
-  \ by `begin-translation`, which makes it easier to add new
-  \ translations gradually and maintain them.
+  \ by ``begin-translation`` (provided by the Galope library), which
+  \ makes it easier to add new translations gradually and maintain
+  \ them.
   \
-  \ See also: `begin-translation`, `l10n-string`.
+  \ See also: ``l10n-string`.
   \
   \ }doc
 
@@ -332,6 +340,8 @@ end-translation
 \ `begin-translation`: now its Galope module is included in the
 \ sources used to build the manual.
 \
-\ 2021-10-23: Replace "See:" with "See also:" in the documentation.
+\ 2021-10-23: Replace "See:" with "See also:" in the documentation.a
+\
+\ 2022-09-02: Improve documentation.
 
 \ vim: filetype=gforth