summaryrefslogtreecommitdiff
path: root/contrib/pp/README
blob: e03b8a059ccd5a0199bd338419c18f4a12a7c6f7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
This directory contains the privacy policy (template) for exchange
operators.


Dependencies
============

Generating a new Privacy Policy requires Sphinx, LaTeX with babel
packages for all supported languages.  On Debian, you should
at least install:

$ apt install python3-sphinx sphinx-intl texlive-lang-german texlive-lang-english

(NOTE: List may be incomplete.)


Updating the Privacy Policy
===========================

The master file with the Privacy Policy is 'pp.rst'.

If you make substantial changes, you MUST change the "PP_VERSION"
in contrib/Makefile.am to the new Etag.

To begin the translation into other languages after editing the master
file, run

$ make gettext

to generate the master PO file. Then, run

$ sphinx-intl update -p _build/locale/ -l de -l fr -l it

to update the PO files for the various languages (extend the list of
languages as necessary). The PO files for the translators are kept
at locale/$LANG/LC_MESSAGES/pp.po for the language $LANG.

Once all PO files have been updated with new translations, run

$ make update-pp

in the "contrib/" directory to generate all of the formats.  The
respective make rule calls the '../update-pp.sh' script in the
contrib/ directory, which calls the 'Makefile' in the pp/
directory for the various supported languages and file formats
and then moves the generated files to the target directory
('contrib/pp/$LANG/$VERSION.$FORMAT')


Adding a new language
=====================

To add a new language $LANG, add $LANG to "PP_LANGUAGES" in
'contrib/Makefile.am' and run

$ sphinx-intl update -p _build/gettext -l $LANG

to generate the PO template.