From: Greg Swinford Date: Fri, 1 Jan 2016 13:01:33 +0000 (+0000) Subject: Doc: CG - Minor typos and corrections X-Git-Tag: release/2.19.35-1~6 X-Git-Url: https://git.donarmstrong.com/?a=commitdiff_plain;h=66322a1a82d9586b56b3faee18588bbe04e82799;p=lilypond.git Doc: CG - Minor typos and corrections Issue 4707 Capitalisation of Git to match their website. Capitalisation of HTML to match policy at CG 5.4.7. Issue 4705 Minor corrections to CG 2.1. --- diff --git a/Documentation/contributor/doc-work.itexi b/Documentation/contributor/doc-work.itexi index 70fd22660d..f8ea33932e 100644 --- a/Documentation/contributor/doc-work.itexi +++ b/Documentation/contributor/doc-work.itexi @@ -9,7 +9,7 @@ this allows us to generate different output formats from a single set of source files. To organize multiple authors working on the documentation, we use a -Version Control System (VCS) called git, previously discussed in +Version Control System (VCS) called Git, previously discussed in @ref{Starting with Git}. @menu @@ -291,12 +291,12 @@ five, levels. @item Level 5: @@subsubsubheading @end itemize -The first three levels are numbered in html, the last two are not. -Numbered sections correspond to a single html page in the split html +The first three levels are numbered in HTML, the last two are not. +Numbered sections correspond to a single HTML page in the split HTML documents. The first four levels always have accompanying nodes so they can be -referenced and are also included in the ToC in html. +referenced and are also included in the ToC in HTML. Most of the manual is written at level 4 under headings created with @@ -681,7 +681,7 @@ command ;) Enter the exact @code{@@node} name of the target reference between the brackets (eg.@tie{}@w{@samp{@@ref@{Syntax survey@}}}). Do not split a cross-reference across two lines -- this causes the -cross-reference to be rendered incorrectly in html documents. +cross-reference to be rendered incorrectly in HTML documents. @itemize @item @@ -1516,10 +1516,12 @@ the difficulty. @unnumberedsubsubsec Building only one section of the documentation In order to save build time, a script is available to build only -one section of the documentation in English with a default html +one section of the documentation in English with a default HTML appearance. -You can build a section of the documentation with: +If you do not yet have a @file{build/} subdirectory within the LilyPond +Git tree, you should create this first. You can then build a section of +the documentation with the following command: @example scripts/auxiliar/doc-section.sh MANUAL SECTION @@ -1538,12 +1540,12 @@ scripts/auxiliar/doc-section.sh notation pitches You can then see the generated document for the section at @example -tempdocs/pitches/out/pitches.html +build/tempdocs/pitches/out/pitches.html @end example According to @uref{http://code.google.com/p/lilypond/issues/detail?id=1236,Lilypond issue 1236}, -the location of the lilypond git tree is taken from @code{$LILYPOND_GIT} +the location of the LilyPond Git tree is taken from @code{$LILYPOND_GIT} if specified, otherwise it is auto-detected. It is assumed that compilation takes place in the @file{build/} @@ -1555,7 +1557,7 @@ overridden by setting the environment variable @code{LILYPOND_TEMPDOCS}. This script will not work for building sections of the -Contributors' guide. For building sections of the Contributors' +Contributors' Guide. For building sections of the Contributors' Guide, use: @example @@ -1564,7 +1566,7 @@ scripts/auxiliar/cg-section.sh SECTION @noindent where @code{SECTION} is the name of the file containing the sections -to be built. For example, to build section 4 of the Contributors' guide, +to be built. For example, to build section 4 of the Contributors' Guide, use: @example diff --git a/Documentation/contributor/quick-start.itexi b/Documentation/contributor/quick-start.itexi index b515eff1de..9d8018692e 100644 --- a/Documentation/contributor/quick-start.itexi +++ b/Documentation/contributor/quick-start.itexi @@ -28,7 +28,7 @@ LilyPond, the documentation and the website (also see @warning{LilyDev does not include the software for the Grand Unified Builder -- also see @ref{Grand Unified Builder (GUB)}.} -While compiling LilyPond on MacOs and Windows is possible, both +While compiling LilyPond on Mac OS and Windows is possible, both environments are complex to set up. LilyDev can be easily installed and run inside a @q{virtual machine} on either of these operating systems relatively easily using readily available virtualization @@ -39,8 +39,8 @@ The LilyDev disk image can also be written to a USB device or @q{burnt} to a DVD -- it is approximately 900 MB in size -- and installed just like any standard GNU/Linux distribution. -The current image is based on a 32bit version of Debian 8 (@q{Jessie}) -and the Disk image was generated using Debian +The current image is based on a 32-bit version of Debian 8 (@q{Jessie}) +and the disk image was generated using Debian @uref{http://live.debian.net/, live-build 4}. @noindent @@ -295,7 +295,7 @@ directory and the entire source code will start to be downloaded into it. @warning{Be patient! There is no progress bar in the lily-git UI but the -complete source is around 180@tie{}Mb.} +complete source is around 180@tie{}MB.} @noindent When the source code has been downloaded, the @qq{command output} window