@chapter Website work
@menu
-* Introduction to website work::
+* Introduction to website work::
* Uploading and security::
+* Debugging website and docs locally::
* Translating the website::
@end menu
link to any pieces of automatically generated documentation, like
the IR or certain NR appendices.
+@item
+The bibliography in Community->Publications is generated automatically
+from @file{.bib} files; formatting is done automatically by
+@file{texi-web.bst}.
+
+@item
@dots{}
@item
@subheading Initial setup
You should symlink your own @file{~/lilypond/} to
-@file{~graham/@/lilypond/}
+@file{~graham/lilypond/}
If this directory does not exist, make it. Git master should go
-in @file{~/lilypond/@/lilypond@/-git/} but make sure you enable:
+in @file{~/lilypond/lilypond-git/} but make sure you enable:
@example
git config core.filemode false
@end example
-If you have created any files in @file{~graham/@/lilypond/} then
+If you have created any files in @file{~graham/lilypond/} then
please run:
@example
@end example
To reduce the CPU burden on the shared host (as well as some
-security concerns), the @file{Documentation/@/pictures/} and
-@file{Documentation/@/web/@/ly-examples/} directories are
+security concerns), the @file{Documentation/pictures/} and
+@file{Documentation/web/ly-examples/} directories are
@strong{not} compiled. You need to upload them, and if they ever
change, a user in the @code{lilypond} group must upload them to
-@file{~graham/@/media} on the host.
+@file{~graham/lilypond/media} on the host.
Upload latest pictures/ and ly-examples/ (local script):
EXAMPLES=$BUILD_DIR/Documentation/web/ly-examples/out-www/
cd $BUILD_DIR
-rsync -a $PICS graham@lilypond.org:media/pictures
-rsync -a $EXAMPLES graham@lilypond.org:ly-examples
+rsync -a $PICS graham@lilypond.org:lilypond/media/pictures
+rsync -a $EXAMPLES graham@lilypond.org:lilypond/media/ly-examples
@end verbatim
@end verbatim
Check for any updates to trusted scripts / files:
-
+@smallexample
@verbatim
### check-git.sh
#!/bin/sh
cp $GIT/Documentation/web/server/lilypond.org.htaccess $DEST/lilypond.org.htaccess
cp $GIT/Documentation/web/server/website-dir.htaccess $DEST/website-dir.htaccess
@end verbatim
+@end smallexample
Build the website:
@subsubheading Additional information
Some information about the website is stored in
-@file{~graham/@/lilypond/@/*.txt}; this information should not be
+@file{~graham/lilypond/*.txt}; this information should not be
shared with people without trusted access to the server.
+@node Debugging website and docs locally
+@section Debugging website and docs locally
+
+@itemize
+@item
+Install apache2, or any other http server. These instructions
+assume that you also enable @code{mod_userdir}, and use
+@code{$HOME/public_html} as the location.
+
+@item
+Build the online docs and website:
+
+@example
+make WEB_TARGETS="offline online" doc
+make website
+@end example
+
+
+@item
+Move the built stuff into those directories. It's highly
+recommended to have your build dir and www dir on the same
+partition. (make @code{$HOME/public_html/} a symlink if
+necessary)
+
+@example
+mv out-website/website/ $HOME/public_html
+mv $HOME/public_html/website/pictures $HOME/public_html/
+mkdir -p $HOME/public_html/doc/v2.13/
+mv out-www/online-root/* $HOME/public_html/doc/v2.13/
+@end example
+
+@end itemize
+
+
@node Translating the website
@section Translating the website
however, please note that this command is not designed for being
run multiple times. If you see unexpected output (mainly the page
footers getting all messed up), then delete your
-@file{out@/-website} directory and run @code{make website} again.
+@file{out-website} directory and run @code{make website} again.
@item
Some of the translation infrastructure is defined in python files;
@item
Translations are not included by default in @code{make website}.
To test your translation, edit the @code{WEB_LANGS} line in
-@file{make/@/website@/.make}. Do not submit a patch to add your language
+@file{make/website.make}. Do not submit a patch to add your language
to this file unless @code{make website} completes with less than 5
warnings.