Doc build: fix xref include dirs.

[lilypond.git] / Documentation / contributor / doc-work.itexi

diff --git a/Documentation/contributor/doc-work.itexi b/Documentation/contributor/doc-work.itexi
index 0ca1fcb5b6dfe7e89dabdc82b1cb48f8c5fbcea7..02ecf2fc1d29594f6f93e05f2bf193463b26c58f 100644 (file)
--- a/Documentation/contributor/doc-work.itexi
+++ b/Documentation/contributor/doc-work.itexi
@@ -19,6 +19,7 @@ Version Control System (VCS) called git, previously discussed in
 * Documentation policy::
 * Tips for writing docs::
 * Updating docs with convert-ly::
+* Docstrings in scheme::
 * Translating the documentation::
 @end menu
 
@@ -200,7 +201,7 @@ so on); list the subdirectory of each manual to determine the filename
 of the specific chapter you wish to modify.
 
 Developer manuals live in @file{Documentation/} too.  Currently there is
-only one: the Contributors' Guide @file{contrib-guide.texi} you are
+only one: the Contributor's Guide @file{contrib-guide.texi} you are
 reading.
 
 Snippet files are part of documentation, and the Snippet List (SL) lives
@@ -535,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
@@ -577,47 +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@{@} - normal references (type the exact node name inside the
-@{@}).
+@@rextend@{@} - link to Extending LilyPond.
+
+@item
+@@rglos@{@} - link to the Music Glossary.
 
 @item
-@@ruser@{@} - link to the NR.
+@@rinternals@{@} - link to the Internals Reference.
 
 @item
-@@rlearning@{@} - link to the LM.
+@@rlearning@{@} - link to Learning Manual.
 
 @item
-@@rglos@{@} - link to the MG.
+@@rlsr@{@} - link to a Snippet section.
 
 @item
-@@rprogram@{@} - link to the AU.
+@@rprogram@{@} - link to Application Usage.
 
 @item
-@@rlsr@{@} - link to a Snippet section.
+@@ruser@{@} - link to Notation Reference.
 
 @item
-@@rinternals@{@} - link to the IR.
+@@rweb@{@} - link to General Informaion.
+
+@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"
 
 @item
 @@uref@{@} - link to an external url.
 
+@item
+@@var - Use for variables.
+
+@item
+@@warning@{@} - produces a "Note: " box. Use for important messages.
+
 @end itemize
 
 
@@ -811,6 +829,9 @@ Notation Reference:
 Application Usage:
 @@rprogram@{blah@}.
 
+Extending LilyPond:
+@@rextend@{frob@}.
+
 Installed Files:
 @@file@{path/to/dir/blahz@}.
 
@@ -1083,6 +1104,18 @@ This also updates translated documentation.
 
 
 
+@node Docstrings in scheme
+@section Docstrings in scheme
+
+Material in the Internals reference is generated automatically
+from our source code.  Any doc work on Internals therefore
+requires modifying files in @file{scm/*.scm}.  Texinfo is allowed
+in these docstrings.
+
+Most documentation writers never touch these, though.  If you want
+to work on them, please ask for help.
+
+
 @node Translating the documentation
 @section Translating the documentation