diff options
Diffstat (limited to 'contrib/pp/README')
-rw-r--r-- | contrib/pp/README | 58 |
1 files changed, 58 insertions, 0 deletions
diff --git a/contrib/pp/README b/contrib/pp/README new file mode 100644 index 0000000..d221b14 --- /dev/null +++ b/contrib/pp/README | |||
@@ -0,0 +1,58 @@ | |||
1 | This directory contains the privacy policy (template) for Anastasis | ||
2 | operators. | ||
3 | |||
4 | |||
5 | Dependencies | ||
6 | ============ | ||
7 | |||
8 | Generating a new Privacy Policy requires Sphinx, LaTeX with babel | ||
9 | packages for all supported languages. On Debian, you should | ||
10 | at least install: | ||
11 | |||
12 | $ apt install python3-sphinx sphinx-intl texlive-lang-german texlive-lang-english | ||
13 | |||
14 | (NOTE: List may be incomplete.) | ||
15 | |||
16 | |||
17 | Updating the Privacy Policy | ||
18 | =========================== | ||
19 | |||
20 | The master file with the Privacy Policy is 'pp.rst'. | ||
21 | |||
22 | If you make substantial changes, you MUST change the "PP_VERSION" | ||
23 | in contrib/Makefile.am to the new Etag. | ||
24 | |||
25 | To begin the translation into other languages after editing the master | ||
26 | file, run | ||
27 | |||
28 | $ make gettext | ||
29 | |||
30 | to generate the master PO file. Then, run | ||
31 | |||
32 | $ sphinx-intl update -p _build/locale/ -l de -l fr -l it | ||
33 | |||
34 | to update the PO files for the various languages (extend the list of | ||
35 | languages as necessary). The PO files for the translators are kept | ||
36 | at locale/$LANG/LC_MESSAGES/pp.po for the language $LANG. | ||
37 | |||
38 | Once all PO files have been updated with new translations, run | ||
39 | |||
40 | $ make update-pp | ||
41 | |||
42 | in the "contrib/" directory to generate all of the formats. The | ||
43 | respective make rule calls the '../update-pp.sh' script in the | ||
44 | contrib/ directory, which calls the 'Makefile' in the pp/ | ||
45 | directory for the various supported languages and file formats | ||
46 | and then moves the generated files to the target directory | ||
47 | ('contrib/pp/$LANG/$VERSION.$FORMAT') | ||
48 | |||
49 | |||
50 | Adding a new language | ||
51 | ===================== | ||
52 | |||
53 | To add a new language $LANG, add $LANG to "PP_LANGUAGES" in | ||
54 | 'contrib/Makefile.am' and run | ||
55 | |||
56 | $ sphinx-intl update -p _build/gettext -l $LANG | ||
57 | |||
58 | to generate the PO template. | ||