Merge commit 'origin'

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

diff --git a/Documentation/devel/doc-work.itexi b/Documentation/devel/doc-work.itexi
index c7bb20d8f5aab06bd61375fa93e67761511a94cc..b6bbe63d3cfc79db3c4a1c2accb3a05bd6089480 100644 (file)
--- a/Documentation/devel/doc-work.itexi
+++ b/Documentation/devel/doc-work.itexi
@@ -57,6 +57,7 @@ limited documentation help.
 
 @menu
 * Texinfo introduction::        
+* Documentation files::         
 * Sectioning commands::         
 * LilyPond formatting::         
 * Text formatting::             
@@ -82,6 +83,26 @@ You can learn most of what you need to know from this; if you want
 to do anything fancy, discuss it on @code{lilypond-devel} first.}
 
 
+@node Documentation files
+@subsection Documentation files
+
+The user manuals lives in @file{Documentation/user/}.  In
+particular, the files @file{lilypond-learning.ly} (LM),
+@file{lilypond.itely} (NR), @file{music-glossary.tely} (MG), and
+@file{lilypond-program} (AU).  Each chapter is written in a
+separate file (ending in @file{.itely} for files containing
+lilypond code, and @file{.itexi} for files without lilypond code);
+see the @qq{main} file for each manual to determine the filename
+of the specific chapter you wish to modify.
+
+Developer manuals live in @file{Documentation/devel}.  Currently
+there is only one; @file{contrib-guide.texi}.
+
+Although snippets are part of documentation, they are not
+(directly) part of the manuals.  For information about how to
+modify them, see @ref{LSR work}.
+
+
 @node Sectioning commands
 @subsection Sectioning commands
 
@@ -440,6 +461,13 @@ B ... @@end itemize - for bulleted lists.
     Any `\' used inside @@warning (and @@q or @@qq) must be written as `@@bs@{@}' 
     (texinfo would also allow \\, but this breaks with PDF output).
 
+@item
+@@ref@{@} - normal references (type the exact node name inside the
+@{@}).  @@ruser@{@} - link to the NR.  @@rlearning@{@} - link to
+the LM.  @@rglos@{@} - link to the MG.  @@rprogram@{@} - link to
+the AU.  @@rlsr@{@} - link to a Snippet section.  @@rinternals@{@}
+- link to the IR.
+
 @end itemize
 
 
@@ -849,7 +877,7 @@ lilypond examples.  Making easily-understandable examples is much
 harder than it looks.
 
 
-@subsubheading TWEAKS
+@subsubheading Tweaks
 
 In general, any \set or \override commands should go in the
 @qq{select snippets} section, which means that they should go in
@@ -887,6 +915,10 @@ or upgrading tweaks is creating tweaks to deal with known issues.  It
 would be ideal if every significant known issue had a workaround to avoid
 the difficulty.
 
+@seealso
+
+@ref{Adding and editing snippets}.
+
 
 @node Updating docs with convert-ly
 @section Updating doc with @command{convert-ly}