X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2Fmacros.itexi;h=cf58c7890624be0bc4d717684b0c8c618280a4df;hb=HEAD;hp=33b154ea0cfc55ef5337602bf4939c0d951114ad;hpb=99dc90bbc369722cf4d3bb9f30b7288762f2167f;p=lilypond.git diff --git a/Documentation/macros.itexi b/Documentation/macros.itexi index 33b154ea0c..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 ***** @@ -31,6 +44,8 @@
@end html @strong{Note:} \TEXT\ +@c keep the space for proper nesting of

+ @html
@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 +
+@end html +@strong{Advanced note:} \TEXT\ +@c keep the space for proper nesting of

+ +@html +
+@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 @@ -70,9 +114,11 @@ found at @w{@uref{http://@/www@/.lilypond@/.org/}}. @syncodeindex fn cp @syncodeindex vr cp + +@c ***** Copyright stuff ***** +@ifset FDL @copying -Copyright @copyright{} 1999, 2000, 2001, 2002, 2003, 2004, 2005, -2006, 2007, 2008, 2009 by the authors. +@copyrightDeclare @quotation Permission is granted to copy, distribute and/or modify this document @@ -83,9 +129,17 @@ 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 +@c ***** Title page ***** @ifnottex @node Top @top LilyPond --- \TITLE\ @@ -115,7 +169,7 @@ Free Documentation License''. @vskip 0pt plus 1filll -@insertcopying{} +@insertcopying For LilyPond version @version{} @end titlepage @@ -132,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 @@ -172,7 +230,7 @@ For LilyPond version @version{} @c Definitions for references: @c -@c @rgeneral +@c @rweb @c @ressay @c @rglos @c @rinternals @@ -181,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 @@ -228,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} @@ -248,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} @@ -270,12 +339,12 @@ For LilyPond version @version{} @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} @@ -345,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} @@ -355,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} @@ -377,12 +456,12 @@ For LilyPond version @version{} @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} @@ -447,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} @@ -457,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} @@ -479,12 +568,12 @@ For LilyPond version @version{} @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} @@ -523,7 +612,7 @@ For LilyPond version @version{} @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} @@ -566,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} @@ -576,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} @@ -598,12 +697,12 @@ For LilyPond version @version{} @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} @@ -632,6 +731,36 @@ For LilyPond version @version{} @ifset web +@macro exampleImage{IMAGE-FILE} +@html +
+ + \IMAGE-FILE\ + +

+ (click to enlarge) +

+
+@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 +
+ + Help wanted: + \TEXT\ +
+@end html +@end macro + + @c LEGALESE @macro logoLegalLinux @@ -655,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 @@ -666,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