X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2Fmacros.itexi;h=8031024c3b5806dcd63fc4c1bc34bb927f941a0f;hb=08666d43e1dd61b654c40a77d5785544065af423;hp=9660ab33acad3b33fc4d637b7f6fa22d2c422126;hpb=0026bb1f0a09781b13514b208fa605bd649f4027;p=lilypond.git diff --git a/Documentation/macros.itexi b/Documentation/macros.itexi index 9660ab33ac..8031024c3b 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 ***** @@ -31,6 +44,8 @@
@end html @strong{Note:} \TEXT\ +@c keep the space for proper nesting of

+ @html
@end html @@ -57,16 +72,87 @@ @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 @uref{http://@/www@/.lilypond@/.org/}. +found at @w{@uref{http://@/www@/.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. @@ -76,11 +162,8 @@ found at @uref{http://@/www@/.lilypond@/.org/}. @subsubheading Predefined commands @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 @@ -114,7 +197,7 @@ found at @uref{http://@/www@/.lilypond@/.org/}. @c Definitions for references: @c -@c @rgeneral +@c @rweb @c @ressay @c @rglos @c @rinternals @@ -123,6 +206,7 @@ found at @uref{http://@/www@/.lilypond@/.org/}. @c @rprogram @c @ruser @c @rchanges +@c @rextend @c @rcontrib @c @c All these also have a @...named version which allows to specify the @@ -170,6 +254,16 @@ found at @uref{http://@/www@/.lilypond@/.org/}. @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} @@ -190,14 +284,14 @@ found at @uref{http://@/www@/.lilypond@/.org/}. @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} @@ -212,12 +306,12 @@ found at @uref{http://@/www@/.lilypond@/.org/}. @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} @@ -287,6 +381,16 @@ found at @uref{http://@/www@/.lilypond@/.org/}. @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} @@ -297,14 +401,14 @@ found at @uref{http://@/www@/.lilypond@/.org/}. @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} @@ -319,12 +423,12 @@ found at @uref{http://@/www@/.lilypond@/.org/}. @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} @@ -389,6 +493,16 @@ found at @uref{http://@/www@/.lilypond@/.org/}. @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} @@ -399,14 +513,14 @@ found at @uref{http://@/www@/.lilypond@/.org/}. @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} @@ -421,12 +535,12 @@ found at @uref{http://@/www@/.lilypond@/.org/}. @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} @@ -465,7 +579,7 @@ found at @uref{http://@/www@/.lilypond@/.org/}. @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} @@ -508,6 +622,16 @@ found at @uref{http://@/www@/.lilypond@/.org/}. @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} @@ -518,14 +642,14 @@ found at @uref{http://@/www@/.lilypond@/.org/}. @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} @@ -540,12 +664,12 @@ found at @uref{http://@/www@/.lilypond@/.org/}. @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} @@ -574,6 +698,36 @@ found at @uref{http://@/www@/.lilypond@/.org/}. @ifset web +@macro exampleImage{IMAGE-FILE} +@html +
+ + \IMAGE-FILE\ + +

+ (click to enlarge) +

+
+@end html +@iftex +@image{ly-examples/\IMAGE-FILE\-small,,,\IMAGE-FILE\,png} +@end iftex +@ifinfo +@image{lilypond/ly-examples/\IMAGE-FILE\,,,\IMAGE-FILE\,png} +@end ifinfo +@end macro + +@macro help{TEXT} +@html +
+ + Help wanted: + \TEXT\ +
+@end html +@end macro + + @c LEGALESE @macro logoLegalLinux @@ -597,7 +751,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 @@ -608,7 +762,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