From: James Lowe Date: Thu, 25 Feb 2016 06:59:07 +0000 (+0000) Subject: Doc: CG - Updates for building the LP Docs using XeLaTex X-Git-Tag: release/2.19.38-1~6^2~1 X-Git-Url: https://git.donarmstrong.com/?p=lilypond.git;a=commitdiff_plain;h=f2f2ed7bd177ed22334c9d3bc1ab3352050557e7 Doc: CG - Updates for building the LP Docs using XeLaTex Issue 4780 Updates to the CG for building the LP Docs using XeLaTex - instead of the default pdfTex - where certain symbols (asterix, pilcrow, section obelix and diesis signs) are not printed in the PDF output. An @warning{} has been added with explanation on how to install texlive-xetex. Note: This does not mean XeTeX is a mandatory requirement, unlike the main TexLive packages already documented. This patch also includes additional small typos and grammar fixes. --- diff --git a/Documentation/contributor/issues.itexi b/Documentation/contributor/issues.itexi index 09925d4208..46587e07dd 100644 --- a/Documentation/contributor/issues.itexi +++ b/Documentation/contributor/issues.itexi @@ -187,7 +187,7 @@ Monday: Federico Bruni Tuesday: Simon Albrecht Wednesday: Simon Albrecht Thursday: Colin Campbell -Friday: Ralph Palmer +Friday: Saturday: Colin Campbell Sunday: @end example diff --git a/Documentation/included/compile.itexi b/Documentation/included/compile.itexi index 7253087c70..896fa0cb3c 100644 --- a/Documentation/included/compile.itexi +++ b/Documentation/included/compile.itexi @@ -159,8 +159,9 @@ check and a full make doc. - James @node Fedora @unnumberedsubsubsec Fedora -The following instructions were tested on @q{Fedora 22} and include all -the software to both compile LilyPond and build the documenation. +The following instructions were tested on @q{Fedora} versions 22 & 23 +and will download all the software required to both compile LilyPond and +build the documentation. @itemize @@ -226,14 +227,27 @@ See @ruser{lily-git}. @end itemize +@warning{By default, when building LilyPond's documentation, +@code{pdfTeX} is be used. However ligatures (fi, fl, ff etc.) may not +be printed in the PDF output. In this case XeTeX can be used instead. +Download and install the @code{texlive-xetex} package. + +@example +sudo dnf install texlive-xetex +@end example + +The scripts used to build the LilyPond documentation will use +@code{XeTex} instead of @code{pdfTex} to generate the PDF documents if +it is available. No additional configuration is required.} + @node Linux Mint @unnumberedsubsubsec Linux Mint The following instructions were tested on @q{Linux Mint 17.1} and -@q{LMDE - Betsy} and include all the software to both compile LilyPond -and build the documenation. +@q{LMDE - Betsy} and will download all the software required to both +compile LilyPond and build the documentation.. @itemize @@ -296,12 +310,26 @@ Also see @ruser{lily-git}. @end itemize +@warning{By default, when building LilyPond's documentation, +@code{pdfTeX} is be used. However ligatures (fi, fl, ff etc.) may not +be printed in the PDF output. In this case XeTeX can be used instead. +Download and install the @code{texlive-xetex} package. + +@example +sudo apt-get install texlive-xetex +@end example + +The scripts used to build the LilyPond documentation will use +@code{XeTex} instead of @code{pdfTex} to generate the PDF documents if +it is available. No additional configuration is required.} + @node OpenSUSE @unnumberedsubsubsec OpenSUSE -The following instructions were tested on @q{OpenSUSE 13.2} and include -all the software to both compile LilyPond and build the documenation. +The following instructions were tested on @q{OpenSUSE 13.2} and will +download all the software required to both compile LilyPond and build +the documentation. @itemize @@ -334,7 +362,7 @@ contribute to LilyPond (codebase or help improve the documentation) then it is recommended that you also need to install @code{git}. @example -sudo apt-get install git +sudo zypper install git @end example Also see @ruser{Starting with Git}. @@ -350,14 +378,25 @@ Also see @ruser{lily-git}. @end itemize +@warning{By default, when building LilyPond's documentation, +@code{pdfTeX} is be used. However ligatures (fi, fl, ff etc.) may not +be printed in the PDF output. In this case XeTeX can be used instead. +Download and install the @code{texlive-xetex} package. +@example +sudo zypper install texlive-xetex +@end example + +The scripts used to build the LilyPond documentation will use +@code{XeTex} instead of @code{pdfTex} to generate the PDF documents if +it is available. No additional configuration is required.} @node Ubuntu @unnumberedsubsubsec Ubuntu The following commands were tested on Ubuntu versions @code{14.04 LTS}, -@code{14.10} and @code{15.04} and include all the software to both -compile LilyPond and build the documenation. +@code{14.10} and @code{15.04} and will download all the software +required to both compile LilyPond and build the documentation. @itemize @@ -398,6 +437,19 @@ Also see @ruser{lily-git}. @end itemize +@warning{By default, when building LilyPond's documentation, +@code{pdfTeX} is be used. However ligatures (fi, fl, ff etc.) may not +be printed in the PDF output. In this case XeTeX can be used instead. +Download and install the @code{texlive-xetex} package. + +@example +sudo apt-get install texlive-xetex +@end example + +The scripts used to build the LilyPond documentation will use +@code{XeTex} instead of @code{pdfTex} to generate the PDF documents if +it is available. No additional configuration is required.} + @node Other @unnumberedsubsubsec Other @@ -508,10 +560,10 @@ is available online at you can also build them locally from the source code. This process requires some additional tools and packages. -@warning{If you have used the instructions for one of the Linux -distributions explicitly listed in the previous section -(@rcontrib{Requirements for compiling LilyPond}) then the following can -be ignored as the software should already be installed.} +@warning{If the instructions for one of the previously listed Linux +in the previous section (@rcontrib{Requirements for compiling LilyPond}) +have been used, then the following can be ignored as the software should +already be installed.} @itemize @@ -571,6 +623,13 @@ ttf-xfree86-nonfree @end itemize +@warning{By default, when building LilyPond's documentation, +@code{pdfTeX} is be used. However ligatures (fi, fl, ff etc.) may not +be printed in the PDF output. In this case XeTeX can be used instead. +Download and install the @code{texlive-xetex} package. The scripts used +to build the LilyPond documentation will use @code{XeTex} instead of +@code{pdfTex} to generate the PDF documents if it is available. No +additional configuration is required.} @node Getting the source code