1 @c -*- coding: utf-8; 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.
38 @@ref@{@}s to other manuals (@@ruser, @@rlearning, etc): you can't
39 link to any pieces of automatically generated documentation, like
40 the IR or certain NR appendices.
45 For anything not listed here, just follow the same style as the
46 existing texinfo files.
51 @node Uploading and security
52 @section Uploading and security
54 The website is generated hourly by user @code{graham} the host
55 @code{lilypond.org}. For security reasons, we do not use the
56 makefiles and scripts directly from git; copies of the relevant
57 scripts are examined and copied to
58 @code{~graham/lilypond/trusted-scripts/}
60 Get latest source code:
67 git merge origin/master
70 Check for any updates to trusted scripts / files:
75 GIT=$HOME/src/lilypond
76 DEST=$HOME/lilypond/trusted-scripts
77 diff -u $DEST/website.make $GIT/make/website.make
78 diff -u $DEST/lilypond-texi2html.init $GIT/Documentation/lilypond-texi2html.init
79 diff -u $DEST/extract_texi_filenames.py $GIT/scripts/build/extract_texi_filenames.py
80 diff -u $DEST/create-version-itexi.py $GIT/scripts/build/create-version-itexi.py
81 diff -u $DEST/create-weblinks-itexi.py $GIT/scripts/build/create-weblinks-itexi.py
82 diff -u $DEST/mass-link.py $GIT/scripts/build/mass-link.py
83 diff -u $DEST/website_post.py $GIT/scripts/build/website_post.py
84 diff -u $DEST/lilypond.org.htaccess $GIT/Documentation/web/server/lilypond.org.htaccess
85 diff -u $DEST/website-dir.htaccess $GIT/Documentation/web/server/website-dir.htaccess
88 If the changes look ok, make them trusted:
93 GIT=$HOME/src/lilypond
94 DEST=$HOME/lilypond/trusted-scripts
95 cp $GIT/make/website.make $DEST/website.make
96 cp $GIT/Documentation/lilypond-texi2html.init $DEST/lilypond-texi2html.init
97 cp $GIT/scripts/build/extract_texi_filenames.py $DEST/extract_texi_filenames.py
98 cp $GIT/scripts/build/create-version-itexi.py $DEST/create-version-itexi.py
99 cp $GIT/scripts/build/create-weblinks-itexi.py $DEST/create-weblinks-itexi.py
100 cp $GIT/scripts/build/mass-link.py $DEST/mass-link.py
101 cp $GIT/scripts/build/website_post.py $DEST/website_post.py
102 cp $GIT/Documentation/web/server/lilypond.org.htaccess $DEST/lilypond.org.htaccess
103 cp $GIT/Documentation/web/server/website-dir.htaccess $DEST/website-dir.htaccess
112 cd $HOME/src/build-website
113 cp $HOME/lilypond/trusted-scripts/website.make .
115 make -f make/website.make WEBSITE_ONLY_BUILD=1 website
116 rsync -ra $HOME/src/build-website/out-website/website/ $DEST/website/
117 cp $HOME/src/build-website/out-website/pictures $DEST
118 cp $HOME/src/build-website/out-website/.htaccess $DEST
121 Cronjob to automate the trusted portions:
124 # website-rebuild.cron
125 11 * * * * $HOME/lilypond/trusted-scripts/update-git.sh >/dev/null 2>&1
126 22 * * * * $HOME/lilypond/trusted-scripts/make-website.sh >/dev/null 2>&1
130 To reduce the CPU burden on the shared host (as well as some
131 security concerns), the @file{Documentation/pictures/} and
132 @file{Documentation/web/ly-examples/} directories are @strong{not}
133 compiled. If you modify any files in those directories, a user in
134 the @code{lilypond} group must upload them to @file{~graham/media}
137 Upload latest pictures/ and ly-examples/ (local script):
140 ### upload-lily-web-media.sh
142 BUILD_DIR=$HOME/src/build-lilypond
144 PICS=$BUILD_DIR/Documentation/pictures/out-www/
145 EXAMPLES=$BUILD_DIR/Documentation/web/ly-examples/out-www/
148 rsync -a $PICS graham@lilypond.org:media/pictures
149 rsync -a $EXAMPLES graham@lilypond.org:ly-examples
153 @node Translating the website
154 @section Translating the website
156 As it has much more audience, the website should be translated before
157 the documentation; see @ref{Translating the documentation}.
159 In addition to the normal documentation translation practices,
160 there are a few additional things to note:
165 Build the website with:
172 however, please note that this command is not designed for being
173 run multiple times. If you see unexpected output (mainly the page
174 footers getting all messed up), then delete your
175 @file{out-website} directory and run @code{make website} again.
178 Some of the translation infrastructure is defined in python files;
179 you must look at the @code{### translation data} sections in:
182 scripts/build/create-weblinks-itexi.py
183 scripts/build/website_post.py
187 Translations are not included by default in @code{make website}.
188 To test your translation, edit the @code{WEB_LANGS} line in
189 @file{make/website.make}. Do not submit a patch to add your language
190 to this file unless @code{make website} completes with less than 5
194 Links to manuals are done with macros like
195 @code{@@manualDevelLearningSplit}. To get translated links, you
196 must change that to @code{@@manualDevelLearningSplit-es} (for
197 es/Spanish translations, for example).