aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJonas Smedegaard <dr@jones.dk>2018-12-01 21:36:04 +0100
committerJonas Smedegaard <dr@jones.dk>2018-12-01 21:36:04 +0100
commit0d774178d4236711a1255c7c457e9d2135b4dfd1 (patch)
treebb71f08d03278d226fb729476f117c19c683d7de
parentc7a5e10a230084b8854644abd434ae9a805ac4ec (diff)
Fix Capitalization. Thanks to Siri Reiter. Add TODO note on weak example. Expand section Compilation to cover i18n.
-rw-r--r--SETUP.md40
1 files changed, 39 insertions, 1 deletions
diff --git a/SETUP.md b/SETUP.md
index 2eb908d..1b02e0f 100644
--- a/SETUP.md
+++ b/SETUP.md
@@ -64,7 +64,7 @@ for refinements unsuitable for general reuse.
### Example: Account
-feature "account" vary in documentation
+Feature "account" vary in documentation
(e.g. welcome page for new users)
as well as maintenance routines
(e.g. for account creation, expiry, and backup),
@@ -81,6 +81,8 @@ mail, and/or filesharing.
+ `box-print` Boxer profile for in-house print queue service
4. Redpill: Generic guides to printing
+TODO: Rewrite examples to not confusingly reference specific networks.
+
## Localization
@@ -94,3 +96,39 @@ tracked using `po4a`.
Features are compiled together
using `mkdocs` and `po4a`
to form a coherent documentation bundle.
+
+### Internationalisation
+
+A gettext template (a.k.a. a pot) file is generated using `po4a`,
+extracting all strings from master documents:
+
+ make pot
+
+The generated gettext template file should be tracked in the git.
+
+
+### Localisation
+
+For each localized language,
+Create/update a corresponding gettext (a.k.a. po) file
+using a gettext editor.
+
+TODO: Recommend gettext editors for various operating systems.
+
+The edited gettext file should be tracked in the git.
+
+
+### Publication
+
+Localised markdown files are generated using `po4a`,
+and a website is generated using `mkdocs`.
+
+Local preview:
+
+ make watch
+
+Publish:
+
+ make
+
+TODO: Actually implement above commands for all features.