diff options
Diffstat (limited to 'SETUP.md')
| -rw-r--r-- | SETUP.md | 40 |
1 files changed, 39 insertions, 1 deletions
@@ -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. |