Left: | ||
Right: |
LEFT | RIGHT |
---|---|
1 @c -*- coding: utf-8; mode: texinfo; -*- | 1 @c -*- coding: utf-8; mode: texinfo; -*- |
2 @node Documentation work | 2 @node Documentation work |
3 @chapter Documentation work | 3 @chapter Documentation work |
4 | 4 |
5 There are currently 11 manuals for LilyPond, not including the | 5 There are currently 11 manuals for LilyPond, not including the |
6 translations. Each book is available in HTML, PDF, and info. The | 6 translations. Each book is available in HTML, PDF, and info. The |
7 documentation is written in a language called @code{texinfo} -- | 7 documentation is written in a language called @code{texinfo} -- |
8 this allows us to generate different output formats from a single | 8 this allows us to generate different output formats from a single |
9 set of source files. | 9 set of source files. |
10 | 10 |
(...skipping 293 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
304 @end example | 304 @end example |
305 | 305 |
306 If using any combination of @code{\header@{@}}, @code{\score@{@}} or | 306 If using any combination of @code{\header@{@}}, @code{\score@{@}} or |
307 @code{\layout@{@}} in your example, then you must omit the | 307 @code{\layout@{@}} in your example, then you must omit the |
308 @code{relative} variable and either use absolute entry mode or an | 308 @code{relative} variable and either use absolute entry mode or an |
309 explicit @code{\relative@{@}} construction. | 309 explicit @code{\relative@{@}} construction. |
310 | 310 |
311 If using @code{\book@{@}} in your example then you must also omit the | 311 If using @code{\book@{@}} in your example then you must also omit the |
312 @code{relative} variable and either use absolute entry mode or an | 312 @code{relative} variable and either use absolute entry mode or an |
313 explicit @code{\relative@{@}} construction. However, you must also | 313 explicit @code{\relative@{@}} construction. However, you must also |
314 inlcude the @code{papersize=X} variable, where @code{X} is an defined | 314 include the @code{papersize=X} variable, where @code{X} is a defined |
Graham Percival (old account)
2011/04/27 16:39:05
typo.
pkx166h
2011/04/28 13:06:22
Done.
| |
315 paper size from within @file{scm/paper.scm}. This is to avoid the | 315 paper size from within @file{scm/paper.scm}. This is to avoid the |
316 default @code{a4} paper size being used and leaving too much unnecessary | 316 default @code{a4} paper size being used and leaving too much unnecessary |
317 whitespace and potentially awkward page breaks in the PDFs. | 317 whitespace and potentially awkward page breaks in the PDFs. |
318 | 318 |
319 The preferred @code{papersize}s are @code{a5}, @code{a6} or | 319 The preferred @code{papersize}s are @code{a5}, @code{a6} or |
320 @code{c9landscape}. | 320 @code{a8landscape}. |
321 | 321 |
322 @code{c9landscape} works best for a single measure with a single title | 322 @code{a8landscape} works best for a single measure with a single title |
323 and/or single @code{tagline}. | 323 and/or single @code{tagline}: |
Trevor Daniels
2011/04/27 22:46:32
lose the fullstop
Graham Percival (old account)
2011/04/28 11:43:05
If the period is removed, it needs to be replaced
pkx166h
2011/04/28 13:06:22
Colon it is.
| |
324 | 324 |
325 @lilypond[papersize=c9landscape,verbatim] | 325 @lilypond[papersize=a8landscape,verbatim] |
Graham Percival (old account)
2011/05/03 12:36:26
this is a .itexi, not a .itely, so you can't use @
| |
326 \book { | 326 \book { |
327 \header{ | 327 \header { |
328 title = "A scale in LilyPond" | 328 title = "A scale in LilyPond" |
329 } | 329 } |
330 \relative { | 330 \relative { |
331 c d e f | 331 c d e f |
332 } | 332 } |
333 } | 333 } |
334 @end lilypond | 334 @end lilypond |
335 | 335 |
336 and can also be used to easily show features that require page breaks | 336 and can also be used to easily show features that require page breaks |
337 (i.e. page numbers) without taking large amounts of space within the | 337 (i.e. page numbers) without taking large amounts of space within the |
338 documentation. Do not use the @code{quote} option with this paper size. | 338 documentation. Do not use the @code{quote} option with this paper size. |
Graham Percival (old account)
2011/04/27 16:39:05
Could I see a Tiny example of why it's bad to use
pkx166h
2011/04/28 13:06:22
I'll send you some examples in a separate email.
| |
339 | 339 |
340 @code{a5} or @code{a6} paper sizes are best used for examples that have | 340 @code{a5} or @code{a6} paper sizes are best used for examples that have |
341 more than two measures of music or require multiple staffs (i.e. to | 341 more than two measures of music or require multiple staves (i.e. to |
Trevor Daniels
2011/04/27 22:46:32
staves
pkx166h
2011/04/28 13:06:22
Done.
| |
342 illustrate cross-staff features, RH and LH parts etc.) and where | 342 illustrate cross-staff features, RH and LH parts etc.) and where |
343 @code{\book@{@}} constructions are required or where @code{c9landscape} | 343 @code{\book@{@}} constructions are required or where @code{a8landscape} |
344 produces an example that is too cramped. Depending on the example the | 344 produces an example that is too cramped. Depending on the example the |
345 @code{quote} option may need to be omitted. | 345 @code{quote} option may need to be omitted. |
Graham Percival (old account)
2011/04/27 16:39:05
What are the considerations about whether to use q
pkx166h
2011/04/28 13:06:22
Well it was hard to articulate but if you used quo
| |
346 | 346 |
347 In rare cases, other options may be used (or omitted), but ask first. | 347 In rare cases, other options may be used (or omitted), but ask first. |
348 | 348 |
349 @item | 349 @item |
350 Please avoid using extra spacing either after or within the | 350 Please avoid using extra spacing either after or within the |
351 @code{@@lilypond} parameters. | 351 @code{@@lilypond} parameters. |
352 | 352 |
353 @example | 353 @example |
354 not: @@lilypond [verbatim, quote, relative=1] | 354 not: @@lilypond [verbatim, quote, relative=1] |
355 but instead: @@lilypond[verbatim,quote,relative=1] | 355 but instead: @@lilypond[verbatim,quote,relative=1] |
356 @end example | 356 @end example |
357 | 357 |
358 @item | 358 @item |
359 Inspirational headwords are produced with | 359 Inspirational headwords are produced with: |
360 | 360 |
361 @example | 361 @example |
362 @@lilypondfile[quote,ragged-right,line-width=16\cm,staffsize=16] | 362 @@lilypondfile[quote,ragged-right,line-width=16\cm,staffsize=16] |
363 @{pitches-headword.ly@} | 363 @{pitches-headword.ly@} |
364 @end example | 364 @end example |
365 | 365 |
366 @item | 366 @item |
367 LSR snippets are linked with | 367 LSR snippets are linked with: |
368 | 368 |
369 @example | 369 @example |
370 @@lilypondfile[verbatim,lilyquote,ragged-right,texidoc,doctitle] | 370 @@lilypondfile[verbatim,lilyquote,ragged-right,texidoc,doctitle] |
371 @{filename.ly@} | 371 @{filename.ly@} |
372 @end example | 372 @end example |
373 | 373 |
374 @item | 374 @item |
375 Use two spaces for indentation in lilypond examples (no tabs). | 375 Use two spaces for indentation in lilypond examples (no tabs). |
376 | 376 |
377 @item | 377 @item |
(...skipping 1909 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
2287 @item @file{buildlib.py} -- common functions (read piped output | 2287 @item @file{buildlib.py} -- common functions (read piped output |
2288 of a shell command, use Git), | 2288 of a shell command, use Git), |
2289 @item @file{postprocess_html.py} (module imported by @file{www_post.py}) -- add footer and | 2289 @item @file{postprocess_html.py} (module imported by @file{www_post.py}) -- add footer and |
2290 tweak links in HTML pages. | 2290 tweak links in HTML pages. |
2291 @end itemize | 2291 @end itemize |
2292 | 2292 |
2293 And finally | 2293 And finally |
2294 @itemize | 2294 @itemize |
2295 @item @file{python/langdefs.py} -- language definitions module | 2295 @item @file{python/langdefs.py} -- language definitions module |
2296 @end itemize | 2296 @end itemize |
LEFT | RIGHT |