From 10622b048b593fb3e8d6e23a15d0701a0417708c Mon Sep 17 00:00:00 2001 From: Carl Sorensen Date: Sun, 20 Dec 2009 07:36:40 -0700 Subject: [PATCH] Doc -- Contributor: Add all @r* macros to texinfo page, alphabetize --- Documentation/contributor/basic-compile.itexi | 1 + Documentation/contributor/doc-work.itexi | 62 ++++++++++++------- 2 files changed, 39 insertions(+), 24 deletions(-) diff --git a/Documentation/contributor/basic-compile.itexi b/Documentation/contributor/basic-compile.itexi index a93e77c4d8..fba3a03dee 100644 --- a/Documentation/contributor/basic-compile.itexi +++ b/Documentation/contributor/basic-compile.itexi @@ -357,6 +357,7 @@ be triggered as they should be; a workaround is to force rebuilding by touching appropriate files, e.g. @example +touch Documentation/extend.texi touch Documentation/notation/*.itely touch Documentation/snippets/*.ly @end example diff --git a/Documentation/contributor/doc-work.itexi b/Documentation/contributor/doc-work.itexi index ea17b08de9..02ecf2fc1d 100644 --- a/Documentation/contributor/doc-work.itexi +++ b/Documentation/contributor/doc-work.itexi @@ -536,34 +536,41 @@ enclose it with @subsection Syntax survey @itemize +@item +@@bs - Generates a backslash inside @@warning. + Any `\' used inside @@warning (and @@q or @@qq) must be written as `@@bs@{@}' + (texinfo would also allow \\, but this breaks with PDF output). + @item @@c - single line comments "@@c NOTE:" is a comment which should remain in the final version. (gp only command ;) -@item -@@ignore ... @@end ignore - multi-line comment @item @@cindex - General index. Please add as many as you can. Don't capitalize the first word. + @item -@@funindex - is for a \lilycommand. +@@code@{@} - typeset in a tt-font. Use for actual lilypond code or + property/context names. If the name contains a space, wrap + the entire thing inside @@w@{@@code@{ @}@}. @item @@example ... @@end example - example text that should be set as a blockquote. Any @{@} must be escaped with @@@{ @}@@ +@item +@@funindex - is for a \lilycommand. + +@item +@@ignore ... @@end ignore - multi-line comment + @item @@itemize @@item A @@item B ... @@end itemize - for bulleted lists. Do not compress vertically like this. -@item -@@code@{@} - typeset in a tt-font. Use for actual lilypond code or - property/context names. If the name contains a space, wrap - the entire thing inside @@w@{@@code@{ @}@}. - @item @@notation@{@} - refers to pieces of notation, e.g. "@@notation@{cres.@}". Also use to specific lyrics ("the @@ -578,50 +585,57 @@ B ... @@end itemize - for bulleted lists. introducing special input modes. @item -@@tie@{@} - Variables or numbers which consist of a single character - (probably followed by a punctuation mark) should be tied - properly, either to the previous or the next word. Example: - "The letter@@tie@{@}@@q@{I@} is skipped" +@@rchanges@{@} - link to Changes. @item -@@var - Use for variables. +@@rcontrib@{@} - link to Contributor's Guide. @item -@@warning@{@} - produces a "Note: " box. Use for important messages. +@@ref@{@} - link within current manual (type the exact node name inside the +@{@}). @item -@@bs - Generates a backslash inside @@warning. - Any `\' used inside @@warning (and @@q or @@qq) must be written as `@@bs@{@}' - (texinfo would also allow \\, but this breaks with PDF output). +@@ressay@{@} - link to Engraving Essay. @item -@@ref@{@} - link within current manual (type the exact node name inside the -@{@}). +@@rextend@{@} - link to Extending LilyPond. @item -@@ruser@{@} - link to Notation Reference. +@@rglos@{@} - link to the Music Glossary. + +@item +@@rinternals@{@} - link to the Internals Reference. @item @@rlearning@{@} - link to Learning Manual. @item -@@rglos@{@} - link to the Music Glossary. +@@rlsr@{@} - link to a Snippet section. @item @@rprogram@{@} - link to Application Usage. @item -@@rlsr@{@} - link to a Snippet section. +@@ruser@{@} - link to Notation Reference. @item -@@rinternals@{@} - link to the Internals Reference. +@@rweb@{@} - link to General Informaion. @item -@@rextend@{@} - link to Extending LilyPond. +@@tie@{@} - Variables or numbers which consist of a single character + (probably followed by a punctuation mark) should be tied + properly, either to the previous or the next word. Example: + "The letter@@tie@{@}@@q@{I@} is skipped" @item @@uref@{@} - link to an external url. +@item +@@var - Use for variables. + +@item +@@warning@{@} - produces a "Note: " box. Use for important messages. + @end itemize -- 2.39.5