the Notation Reference, the Program Reference, and the Music
Glossary.
-* Learning Manual: long, chatty, friendly explanations go here.
- This is aimed at users learning something for the first time --
- not necessarily just learning lilypond notation, but also things
- like learning how to deal with projects, tweaking, preparing parts
- for orchestras, etc. Less formal language may be used here.
+* Learning Manual:
+ The LM is written in a tutorial style which introduces the most
+ important concepts, structure and syntax of the elements of a
+ LilyPond score in a carefully graded sequence of steps.
+ Explanations of all musical concepts used in the Manual can be
+ found in the Music Glossary, and readers are assumed to have no
+ prior knowledge of LilyPond. The objective is to take readers to
+ a level where the Notation Reference can be understood and
+ employed to both adapt the templates in the Appendix to their
+ needs and to begin to construct their own scores. Commonly used
+ tweaks are introduced and explained. Examples are provided
+ throughout which, while being focussed on the topic being
+ introduced, are long enough to seem real in order to retain the
+ readers' interest. Each example builds on the previous material,
+ and comments are used liberally. Every new aspect is thoroughly
+ explained before it is used.
Users are encouraged to read the complete Learning Manual from
start-to-finish.
* You _must_ include a @seealso. The order of items inside the
@seealso section is
- Music glossary: @rglos{foo}, @rglos{bar}.
+ Music Glossary: @rglos{foo}, @rglos{bar}.
Learning Manual: @rlearning{baz}, @rlearning{foozle}
Application Usage: @rprogram{blah}.
- Installed files: @file{path/to/dir/blahz}.
+ Installed Files: @file{path/to/dir/blahz}.
Snippets: @lsrdir{section}, @lsr{specific/example-name.ly}.
(if there is only one entry, omit a final period. If there
("Snippets" is REQUIRED; the others are optional)
+ Any new concepts or links which require an explanation should go
+ as a full sentence(s) in the main text.
+
* To create links, use @ref{} if the link is within the same
manual.
Both index commands should go in front of the actual material.
+ @cindex should not be capitalized.
+
* Preferred terms:
- in general, use the American spellings. The internal
lilypond property names use this spelling.
- list of specific terms:
-canceled,
+canceled
+simultaenous NOT concurrent
+measure: the unit of music
+bar line: the symbol delimiting a measure
+
%%%%% TECHNICAL WRITING STYLE