1 @c -*- coding: us-ascii; mode: texinfo; -*-
6 * Introduction to website work::
7 * Uploading and security::
8 * Translating the website::
12 @node Introduction to website work
13 @section Introduction to website work
15 The website is @emph{not} written directly in HTML;
16 instead, the source is Texinfo, which is then generated into HTML,
17 PDF, and Info formats. The sources are
20 Documentation/web.texi
21 Documentation/web/*.texi
24 Unless otherwise specified, follow the instructions and policies
25 given in @ref{Documentation work}. That chapter also contains a
26 quick introduction to Texinfo; consulting an external Texinfo
27 manual should be not necessary.
29 @subheading Exceptions to the documentation policies
34 Sectioning: the website only uses chapters and sections; no
35 subsections or subsubsections.
40 For anything not listed here, just follow the same style as the
41 existing texinfo files.
46 @node Uploading and security
47 @section Uploading and security
49 FIXME: currently these are plans, not yet completely implemented.
50 Hey, I'm doing the reponsible "write documentation first, then
51 code" thing! I rock! -gp
53 The website is generated hourly by user @code{graham} the host
54 @code{lilypond.org}. For security reasons, we do not use the
55 makefiles and scripts directly from git; copies of the relevant
56 scripts (below) are examined and copied to
57 @file{~graham/trusted-scripts} on the host.
61 scripts/build/extract_texi_filenames.py
64 To reduce the CPU burden on the shared host (as well as some
65 security concerns), the @file{Documentation/pictures/} and
66 @file{Documentation/web/ly-examples/} directories are @strong{not}
67 compiled. If you modify any files in those directories, a user in
68 the @code{lilypond} group must upload them to @file{~graham/media}
69 on the host. This is done by running (locally) @code{make doc},
70 followed by @code{scripts/build/upload-web-media.sh}.
74 @node Translating the website
75 @section Translating the website
77 As it has much more audience, the website should be translated before
78 the documentation; see @ref{Translating the documentation}.