Issue 5167/6: Changes: show \markup xxx = ... \etc assignments

[lilypond.git] / Documentation / macros.itexi

diff --git a/Documentation/macros.itexi b/Documentation/macros.itexi
index ecf01b062ca56de42ab5aab236809250eb3613d5..cf58c7890624be0bc4d717684b0c8c618280a4df 100644 (file)
--- a/Documentation/macros.itexi
+++ b/Documentation/macros.itexi
@@ -1,15 +1,28 @@
-@c -*- coding: us-ascii; mode: texinfo; -*-
+@c -*- coding: utf-8; mode: texinfo; -*-
 @ignore
     Translation of GIT committish: FILL-IN-HEAD-COMMITTISH
 
     When revising a translation, copy the HEAD committish of the
-    version that you are working on.  See TRANSLATION for details.
+    version that you are working on.  For details, see the Contributors'
+    Guide, node Updating translation committishes..
 @end ignore
 
 
 @include version.itexi
 @include common-macros.itexi
 
+@ignore
+****************************
+MACRO DEFINITIONS GUIDELINES
+****************************
+
+This file should contain macro definitions which are common to all
+languages, i.e. all macro definitions which do not contain text that
+should be translated (namely text visible in the output).
+
+Macro definitions which contain text that should be translated in
+translations should be in macros.itexi.
+@end ignore
 
 @c   ***** Displaying text *****
 
@@ -31,6 +44,8 @@
 <div class="warning">
 @end html
 @strong{Note:} \TEXT\
+@c keep the space for proper nesting of </p>
+
 @html
 </div>
 @end html
@@ -52,15 +67,44 @@
 
 @end ifnothtml
 
+@c do not translate the following macro -- it is used in
+@c an untranslated manual.
+
+@ifhtml
+
+@macro advanced{TEXT}
+@html
+<div class="advanced">
+@end html
+@strong{Advanced note:} \TEXT\
+@c keep the space for proper nesting of </p>
+
+@html
+</div>
+@end html
+@end macro
+
+@end ifhtml
+
+@ifnothtml
+
+@macro advanced{TEXT}
+@quotation
+@b{Advanced note:} \TEXT\
+@end quotation
+@end macro
+
+@end ifnothtml
+
 
 @macro docMain
 @cartouche
 For more information about how this manual fits with the other
 documentation, or to read this manual in other formats, see
-@rgeneral{Manuals}.
+@rweb{Manuals}.
 
 If you are missing any manuals, the complete documentation can be
-found at @w{@uref{http://@/www@/.lilypond@/.org/}}.
+found at @w{@uref{http://@/lilypond@/.org/}}.
 @end cartouche
 @end macro
 
@@ -125,7 +169,7 @@ This document has been placed in the public domain.
 
 @vskip 0pt plus 1filll
 
-@insertcopying{}
+@insertcopying
 
 For LilyPond version @version{}
 @end titlepage
@@ -142,16 +186,20 @@ For LilyPond version @version{}
 @c it doesn't matter, but a future implementation will probably
 @c add some code which needs this restriction.
 
+@c @raggedright can be enabled as soon as texinfo 5.x or larger
+@c is in use for Gub and LilyDev 3.
+
 @macro predefined
 @noindent
 @subsubheading Predefined commands
+@c @raggedright
 @end macro
 
 @c Due to a bug in texi2html (texi2html.pl CVS versions <= 1.245)
 @c the next macro must not be empty.
 
 @macro endpredefined
-@c
+@c @end raggedright
 @end macro
 
 
@@ -182,7 +230,7 @@ For LilyPond version @version{}
 
 @c  Definitions for references:
 @c
-@c     @rgeneral
+@c     @rweb
 @c     @ressay
 @c     @rglos
 @c     @rinternals
@@ -191,6 +239,7 @@ For LilyPond version @version{}
 @c     @rprogram
 @c     @ruser
 @c     @rchanges
+@c     @rextend
 @c     @rcontrib
 @c
 @c  All these also have a @...named version which allows to specify the
@@ -238,6 +287,16 @@ For LilyPond version @version{}
 @ref{\TEXT\,,\DISPLAY\,notation-big-page,Notation Reference}
 @end macro
 
+@macro rextend{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,extending-big-page,Extending}
+@end macro
+
+@macro rextendnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,extending-big-page,Extending}
+@end macro
+
 @macro rchanges{TEXT}
 @vindex \TEXT\
 @ref{\TEXT\,,,changes-big-page,Changes}
@@ -258,14 +317,14 @@ For LilyPond version @version{}
 @ref{\TEXT\,,\DISPLAY\,contributor-big-page,Contributor's Guide}
 @end macro
 
-@macro rgeneral{TEXT}
+@macro rweb{TEXT}
 @vindex \TEXT\
-@ref{\TEXT\,,,general-big-page,General Information}
+@ref{\TEXT\,,,web-big-page,General Information}
 @end macro
 
-@macro rgeneralnamed{TEXT,DISPLAY}
+@macro rwebnamed{TEXT,DISPLAY}
 @vindex \TEXT\
-@ref{\TEXT\,,\DISPLAY\,general-big-page,General Information}
+@ref{\TEXT\,,\DISPLAY\,web-big-page,General Information}
 @end macro
 
 @macro ressay{TEXT}
@@ -355,6 +414,16 @@ For LilyPond version @version{}
 @ref{\TEXT\,,\DISPLAY\,changes,Changes}
 @end macro
 
+@macro rextend{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,extending,Extending}
+@end macro
+
+@macro rextendnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,extending,Extending}
+@end macro
+
 @macro rcontrib{TEXT}
 @vindex \TEXT\
 @ref{\TEXT\,,,contributor,Contributor's Guide}
@@ -365,14 +434,14 @@ For LilyPond version @version{}
 @ref{\TEXT\,,\DISPLAY\,contributor,Contributor's Guide}
 @end macro
 
-@macro rgeneral{TEXT}
+@macro rweb{TEXT}
 @vindex \TEXT\
-@ref{\TEXT\,,,general,General Information}
+@ref{\TEXT\,,,web,General Information}
 @end macro
 
-@macro rgeneralnamed{TEXT,DISPLAY}
+@macro rwebnamed{TEXT,DISPLAY}
 @vindex \TEXT\
-@ref{\TEXT\,,\DISPLAY\,general,General Information}
+@ref{\TEXT\,,\DISPLAY\,web,General Information}
 @end macro
 
 @macro ressay{TEXT}
@@ -457,6 +526,16 @@ For LilyPond version @version{}
 @ref{\TEXT\,,\DISPLAY\,lilypond-changes,Changes}
 @end macro
 
+@macro rextend{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-extending,Extending}
+@end macro
+
+@macro rextendnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,lilypond-extending,Extending}
+@end macro
+
 @macro rcontrib{TEXT}
 @vindex \TEXT\
 @ref{\TEXT\,,,lilypond-contributor,Contributor's Guide}
@@ -467,14 +546,14 @@ For LilyPond version @version{}
 @ref{\TEXT\,,\DISPLAY\,lilypond-contributor,Contributor's Guide}
 @end macro
 
-@macro rgeneral{TEXT}
+@macro rweb{TEXT}
 @vindex \TEXT\
-@ref{\TEXT\,,,lilypond-general,General Information}
+@ref{\TEXT\,,,lilypond-web,General Information}
 @end macro
 
-@macro rgeneralnamed{TEXT,DISPLAY}
+@macro rwebnamed{TEXT,DISPLAY}
 @vindex \TEXT\
-@ref{\TEXT\,,\DISPLAY\,lilypond-general, General Information}
+@ref{\TEXT\,,\DISPLAY\,lilypond-web, General Information}
 @end macro
 
 @macro ressay{TEXT}
@@ -576,6 +655,16 @@ For LilyPond version @version{}
 @ref{\TEXT\,,\DISPLAY\,changes,Changes}
 @end macro
 
+@macro rextend{TEXT}
+@lilyvindex{\TEXT\}
+@ref{\TEXT\,,,extending,Extending}
+@end macro
+
+@macro rextendnamed{TEXT,DISPLAY}
+@lilyvindex{\TEXT\}
+@ref{\TEXT\,,\DISPLAY\,extending,Extending}
+@end macro
+
 @macro rcontrib{TEXT}
 @lilyvindex{\TEXT\}
 @ref{\TEXT\,,,contributor,Contributor's Guide}
@@ -586,14 +675,14 @@ For LilyPond version @version{}
 @ref{\TEXT\,,\DISPLAY\,contributor,Contributor's Guide}
 @end macro
 
-@macro rgeneral{TEXT}
+@macro rweb{TEXT}
 @lilyvindex{\TEXT\}
-@ref{\TEXT\,,,general,General Information}
+@ref{\TEXT\,,,web,General Information}
 @end macro
 
-@macro rgeneralnamed{TEXT,DISPLAY}
+@macro rwebnamed{TEXT,DISPLAY}
 @lilyvindex{\TEXT\}
-@ref{\TEXT\,,\DISPLAY\,general,General Information}
+@ref{\TEXT\,,\DISPLAY\,web,General Information}
 @end macro
 
 @macro ressay{TEXT}
@@ -642,6 +731,36 @@ For LilyPond version @version{}
 
 @ifset web
 
+@macro exampleImage{IMAGE-FILE}
+@html
+<div class="float-center example-image-wrapper">
+  <a class="clickable" href="ly-examples/\IMAGE-FILE\.png">
+    <img src="ly-examples/\IMAGE-FILE\-small.png" alt="\IMAGE-FILE\">
+  </a>
+  <p style="text-align: center">
+    (click to enlarge)
+  </p>
+</div>
+@end html
+@iftex
+@image{ly-examples/\IMAGE-FILE\,6in,,\IMAGE-FILE\,png}
+@end iftex
+@ifinfo
+@image{lilypond/ly-examples/\IMAGE-FILE\,,,\IMAGE-FILE\,png}
+@end ifinfo
+@end macro
+
+@macro help{TEXT}
+@html
+<div class="help">
+<strong>
+  <span style="text-decoration:blink">Help wanted:</span>
+</strong> \TEXT\
+</div>
+@end html
+@end macro
+
+
 @c LEGALESE
 
 @macro logoLegalLinux
@@ -665,7 +784,7 @@ The @qq{X image} is not a registered trademark.  It was created by
 placed under the GNU Free Documentation License version 1.2 or later.
 We found the image on
 @uref{http://commons.wikimedia.org/wiki/File:Mac_OS_X_Userbox_X.png,
-this Wikipedia Commons page}.
+this Wikimedia Commons page}.
 
 @end macro
 
@@ -676,7 +795,7 @@ trademark.  It was created by
 placed under the GNU Free Documentation License version 1.2.  We
 found the image on
 @uref{http://commons.wikimedia.org/wiki/Category:Microsoft_Windows_logos,
-this Wikipedia Commons page}.
+this Wikimedia Commons page}.
 
 @end macro