X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2Fmacros.itexi;h=cf58c7890624be0bc4d717684b0c8c618280a4df;hb=5d84bfad4626892bcffd05adcced53c8a2329047;hp=821977dd1baa6ec11552b44c5208ccd4d75e7767;hpb=69f0ec479a6ade46d0a227755bb02562112c6743;p=lilypond.git

diff --git a/Documentation/macros.itexi b/Documentation/macros.itexi
index 821977dd1b..cf58c78906 100644
--- 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 *****
 
@@ -27,9 +40,15 @@
 @ifhtml
 
 @macro warning{TEXT}
-@cartouche
-@b{Note:} \TEXT\
-@end cartouche
+@html
+<div class="warning">
+@end html
+@strong{Note:} \TEXT\
+@c keep the space for proper nesting of </p>
+
+@html
+</div>
+@end html
 @end macro
 
 @end ifhtml
@@ -48,27 +67,139 @@
 
 @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
+@rweb{Manuals}.
+
+If you are missing any manuals, the complete documentation can be
+found at @w{@uref{http://@/lilypond@/.org/}}.
+@end cartouche
+@end macro
+
+
+@macro lilyTitlePage{TITLE}
+@c  This produces the unified index
+@syncodeindex fn cp
+@syncodeindex vr cp
+
+
+@c   ***** Copyright stuff *****
+@ifset FDL
+@copying
+@copyrightDeclare
+
+@quotation
+Permission is granted to copy, distribute and/or modify this document
+under the terms of the GNU Free Documentation License, Version 1.1
+or any later version published by the Free Software Foundation;
+with no Invariant Sections.
+A copy of the license is included in the section entitled ``GNU
+Free Documentation License''.
+@end quotation
+@end copying
+@end ifset
+
+@ifclear FDL
+@copying
+This document has been placed in the public domain.
+@end copying
+@end ifclear
+
+
+
+@c   ***** Title page *****
+@ifnottex
+@node Top
+@top LilyPond --- \TITLE\
+
+@cartouche
+@manualIntro{}
+@end cartouche
+@end ifnottex
+
+@finalout
+
+@titlepage
+@title LilyPond
+@subtitle The music typesetter
+@titlefont{\TITLE\}
+@author The LilyPond development team
+
+@vskip 60pt
+
+@cartouche
+@manualIntro{}
+@end cartouche
+
+@vskip 40pt
+
+@docMain{}
+
+@vskip 0pt plus 1filll
+
+@insertcopying
+
+For LilyPond version @version{}
+@end titlepage
+
+@end macro
 
 
 @c   ***** Headings in a doc subsection *****
 
+@c The next macro is a dummy currently since texinfo doesn't
+@c provide a real ragged-right environment yet.
+@c
 @c Don't insert an empty line after @predefined!  Right now
 @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 The next macro is a dummy currently since texinfo doesn't
-@c provide a real ragged-right environment yet.
-@c
 @c Due to a bug in texi2html (texi2html.pl CVS versions <= 1.245)
-@c the macro must not be empty.
+@c the next macro must not be empty.
 
 @macro endpredefined
-@c
+@c @end raggedright
 @end macro
 
 
@@ -99,12 +230,17 @@
 
 @c  Definitions for references:
 @c
+@c     @rweb
+@c     @ressay
 @c     @rglos
+@c     @rinternals
 @c     @rlearning
-@c     @ruser
-@c     @rprogram
 @c     @rlsr
-@c     @rinternals
+@c     @rprogram
+@c     @ruser
+@c     @rchanges
+@c     @rextend
+@c     @rcontrib
 @c
 @c  All these also have a @...named version which allows to specify the
 @c  displayed text for the reference as second argument.
@@ -151,14 +287,64 @@
 @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}
+@end macro
+
+@macro rchangesnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,changes-big-page,Changes}
+@end macro
+
+@macro rcontrib{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,contributor-big-page,Contributor's Guide}
+@end macro
+
+@macro rcontribnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,contributor-big-page,Contributor's Guide}
+@end macro
+
+@macro rweb{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,web-big-page,General Information}
+@end macro
+
+@macro rwebnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,web-big-page,General Information}
+@end macro
+
+@macro ressay{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,essay-big-page,Essay}
+@end macro
+
+@macro ressaynamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,essay-big-page,Essay}
+@end macro
+
 @macro rprogram{TEXT}
 @vindex \TEXT\
-@ref{\TEXT\,,,application-big-page,Application Usage}
+@ref{\TEXT\,,,usage-big-page,Application Usage}
 @end macro
 
 @macro rprogramnamed{TEXT,DISPLAY}
 @vindex \TEXT\
-@ref{\TEXT\,,\DISPLAY\,application-big-page,Application Usage}
+@ref{\TEXT\,,\DISPLAY\,usage-big-page,Application Usage}
 @end macro
 
 @macro rlsr{TEXT}
@@ -218,14 +404,64 @@
 @ref{\TEXT\,,\DISPLAY\,notation,Notation Reference}
 @end macro
 
+@macro rchanges{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,changes,Changes}
+@end macro
+
+@macro rchangesnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@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}
+@end macro
+
+@macro rcontribnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,contributor,Contributor's Guide}
+@end macro
+
+@macro rweb{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,web,General Information}
+@end macro
+
+@macro rwebnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,web,General Information}
+@end macro
+
+@macro ressay{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,essay,Essay}
+@end macro
+
+@macro ressaynamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,essay,Essay}
+@end macro
+
 @macro rprogram{TEXT}
 @vindex \TEXT\
-@ref{\TEXT\,,,application,Application Usage}
+@ref{\TEXT\,,,usage,Application Usage}
 @end macro
 
 @macro rprogramnamed{TEXT,DISPLAY}
 @vindex \TEXT\
-@ref{\TEXT\,,\DISPLAY\,application,Application Usage}
+@ref{\TEXT\,,\DISPLAY\,usage,Application Usage}
 @end macro
 
 @macro rlsr{TEXT}
@@ -280,14 +516,64 @@
 @ref{\TEXT\,,\DISPLAY\,lilypond-notation,Notation Reference}
 @end macro
 
+@macro rchanges{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-changes,Changes}
+@end macro
+
+@macro rchangesnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@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}
+@end macro
+
+@macro rcontribnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,lilypond-contributor,Contributor's Guide}
+@end macro
+
+@macro rweb{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-web,General Information}
+@end macro
+
+@macro rwebnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,lilypond-web, General Information}
+@end macro
+
+@macro ressay{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-essay,Essay}
+@end macro
+
+@macro ressaynamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,lilypond-essay,Essay}
+@end macro
+
 @macro rprogram{TEXT}
 @vindex \TEXT\
-@ref{\TEXT\,,,lilypond-application,Application Usage}
+@ref{\TEXT\,,,lilypond-usage,Application Usage}
 @end macro
 
 @macro rprogramnamed{TEXT,DISPLAY}
 @vindex \TEXT\
-@ref{\TEXT\,,\DISPLAY\,lilypond-application,Application Usage}
+@ref{\TEXT\,,\DISPLAY\,lilypond-usage,Application Usage}
 @end macro
 
 @macro rlsr{TEXT}
@@ -326,7 +612,7 @@
 @c delimits arguments in the standard way (i.e., with braces).
 
 @tex
-\gdef\lilyvindex#1{\doind{vr}{\code #1}\ignorespaces}
+\gdef\lilyvindex#1{\doind{vr}{\code{#1}}\ignorespaces}
 @end tex
 
 @macro rglos{TEXT}
@@ -359,14 +645,64 @@
 @ref{\TEXT\,,\DISPLAY\,notation,Notation Reference}
 @end macro
 
+@macro rchanges{TEXT}
+@lilyvindex{\TEXT\}
+@ref{\TEXT\,,,changes,Changes}
+@end macro
+
+@macro rchangesnamed{TEXT,DISPLAY}
+@lilyvindex{\TEXT\}
+@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}
+@end macro
+
+@macro rcontribnamed{TEXT,DISPLAY}
+@lilyvindex{\TEXT\}
+@ref{\TEXT\,,\DISPLAY\,contributor,Contributor's Guide}
+@end macro
+
+@macro rweb{TEXT}
+@lilyvindex{\TEXT\}
+@ref{\TEXT\,,,web,General Information}
+@end macro
+
+@macro rwebnamed{TEXT,DISPLAY}
+@lilyvindex{\TEXT\}
+@ref{\TEXT\,,\DISPLAY\,web,General Information}
+@end macro
+
+@macro ressay{TEXT}
+@lilyvindex{\TEXT\}
+@ref{\TEXT\,,,essay,Essay}
+@end macro
+
+@macro ressaynamed{TEXT,DISPLAY}
+@lilyvindex{\TEXT\}
+@ref{\TEXT\,,\DISPLAY\,essay,Essay}
+@end macro
+
 @macro rprogram{TEXT}
 @lilyvindex{\TEXT\}
-@ref{\TEXT\,,,application,Application Usage}
+@ref{\TEXT\,,,usage,Application Usage}
 @end macro
 
 @macro rprogramnamed{TEXT,DISPLAY}
 @lilyvindex{\TEXT\}
-@ref{\TEXT\,,\DISPLAY\,application,Application Usage}
+@ref{\TEXT\,,\DISPLAY\,usage,Application Usage}
 @end macro
 
 @macro rlsr{TEXT}
@@ -390,3 +726,77 @@
 @end macro
 
 @end iftex
+
+@c  ***** Macros specific to the web site *****
+
+@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
+Tux the Linux Penguin was created by
+@uref{mailto:lewing@@isc.tamu.edu, lewing@@isc.tamu.edu} with
+@uref{http://www.isc.tamu.edu/~lewing/gimp/, the Gnu Image
+Manipulation Program}.
+
+@end macro
+
+@macro logoLegalFreeBSD
+The FreeBSD logo is a registered trademark of
+@uref{http://www.freebsd.org/, The FreeBSD Foundation}.
+
+@end macro
+
+@macro logoLegalMacOSX
+The @qq{X image} is not a registered trademark.  It was created by
+@uref{http://en.wikipedia.org/wiki/User:Nihonjoe, Nihonjoe} and
+@uref{http://en.wikipedia.org/wiki/User:CyberSkull, CyberSkull}, and
+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 Wikimedia Commons page}.
+
+@end macro
+
+@macro logoLegalWindows
+The @qq{four colored rectangles image} is not a registered
+trademark.  It was created by
+@uref{http://en.wikipedia.org/wiki/User:Rohitbd, Rohitbd} and
+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 Wikimedia Commons page}.
+
+@end macro
+
+@end ifset