Rietveld Code Review Tool
Help | Bug tracker | Discussion group | Source code | Sign in
(595)

Side by Side Diff: Documentation/notation/input.itely

Issue 5315053: Doc: NR Added new node for Custom Footnotes (Closed)
Patch Set: Draft number 5 - still incomplete though Created 12 years, 4 months ago
Left:
Right:
Use n/p to move between diff chunks; N/P to move between comments. Please Sign in to add in-line comments.
Jump to:
View unified diff | Download patch
« no previous file with comments | « no previous file | no next file » | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 @c -*- coding: utf-8; mode: texinfo; -*- 1 @c -*- coding: utf-8; mode: texinfo; -*-
2 2
3 @ignore 3 @ignore
4 Translation of GIT committish: FILL-IN-HEAD-COMMITTISH 4 Translation of GIT committish: FILL-IN-HEAD-COMMITTISH
5 5
6 When revising a translation, copy the HEAD committish of the 6 When revising a translation, copy the HEAD committish of the
7 version that you are working on. For details, see the Contributors' 7 version that you are working on. For details, see the Contributors'
8 Guide, node Updating translation committishes.. 8 Guide, node Updating translation committishes..
9 @end ignore 9 @end ignore
10 10
(...skipping 501 matching lines...) Expand 10 before | Expand all | Expand 10 after
512 512
513 @node Titles and headers 513 @node Titles and headers
514 @section Titles and headers 514 @section Titles and headers
515 515
516 Almost all printed music includes a title and the composer's name; 516 Almost all printed music includes a title and the composer's name;
517 some pieces include a lot more information. 517 some pieces include a lot more information.
518 518
519 @menu 519 @menu
520 * Creating titles headers and footers:: 520 * Creating titles headers and footers::
521 * Custom headers footers and titles:: 521 * Custom headers footers and titles::
522 * Creating footnotes::
522 * Reference to page numbers:: 523 * Reference to page numbers::
523 * Table of contents:: 524 * Table of contents::
524 @end menu 525 @end menu
525 526
526 527
527 @node Creating titles headers and footers 528 @node Creating titles headers and footers
528 @subsection Creating titles headers and footers 529 @subsection Creating titles headers and footers
529 530
530 @menu 531 @menu
531 * Title blocks explained:: 532 * Title blocks explained::
(...skipping 474 matching lines...) Expand 10 before | Expand all | Expand 10 after
1006 \new Staff { s1 \break s1 \break s1 } 1007 \new Staff { s1 \break s1 \break s1 }
1007 } 1008 }
1008 } 1009 }
1009 @end lilypond 1010 @end lilypond
1010 1011
1011 @seealso 1012 @seealso
1012 Notation Reference: 1013 Notation Reference:
1013 @ref{Title blocks explained}, 1014 @ref{Title blocks explained},
1014 @ref{Default layout of book and score title blocks}. 1015 @ref{Default layout of book and score title blocks}.
1015 1016
1017 @node Creating footnotes
1018 @subsection Creating footnotes
1019
1020 There are two types of footnotes that can be created; automatic
1021 footnotes and manual footnotes.
1022
1023 @menu
1024 * Footnotes overview::
1025 * Automatic footnotes::
1026 * Manual footnotes::
1027 @end menu
1028
1029 @node Footnotes overview
1030 @unnumberedsubsubsec Footnotes overview
1031
1032 Automatic footnotes create default superscript numbers which indicate
1033 the footnote at the bottom of the page, whereas manual footnotes allow a
1034 custom indicator to be created instead.
1035
1036 @example
1037 \autoFootnoteGrob #'@var{Layout Object} #'@var{(x . y)}
1038 \markup @{footnote@}
1039 @end example
1040
1041 All grobs, top-level @code{\markup} and chorded notes can be annotated.
1042 When annotating grobs, the command that you use must come @emph{before}
1043 the grob that the footnote is being attached to. The order in which
1044 each grob is drawn determines the order in which each footnote is
1045 created during compilation.
1046
1047 Offset values of zero are taken from the center of the grob that is
1048 being footnoted whereas negative and positive values are taken from the
1049 @qq{bottom left} and @qq{top right} of the grob respectively.
1050
1051 @node Automatic footnotes
1052 @unnumberedsubsubsec Automatic footnotes
1053
1054 The two commands used to create automatic footnotes are
1055 @code{\autoFootnote} for chorded notes and @code{\autoFootnoteGrob} for
1056 individual grobs (i.e. note heads, stems and slurs) including
1057 @code{\markup} when using @code{TextScripts}.
1058
1059 To annotate chorded notes:
1060
1061 @lilypond[verbatim,quote,ragged-right,papersize=a8]
1062 \book {
1063 \header { tagline = ##f }
1064 \relative c' {
1065 <
1066 c-\autoFootnote #'(1 . -1.25) "This is a C"
1067 es-\autoFootnote #'(2 . -0.25) \markup \italic "Here is an E-flat"
1068 g-\autoFootnote #'(2 . 3) \markup \bold "This is a G"
1069 >1
1070 }
1071 }
1072 @end lilypond
1073
1074 Here is an example of a variety of automatically footnoted grobs showing
1075 the relative position of the footnotes to the default tagline and the
1076 copyright line.
1077
1078 @lilypond[verbatim,quote,ragged-right,papersize=a8]
1079 \book {
1080 \header { copyright = \markup { "Copyright 1970" } }
1081 \relative c' {
1082 \autoFootnoteGrob #'DynamicText #'(-3 . 0)
1083 \markup { \bold Forte }
1084
1085 \autoFootnoteGrob #'Slur #'(0 . 1.5)
1086 \markup { A slur }
1087 a'4\f(
1088
1089 \autoFootnoteGrob #'Beam #'(0 . -2)
1090 \markup { Beam }
1091 b8)[ e]
1092
1093 \autoFootnoteGrob #'Stem #'(1 . -1)
1094 \markup { \teeny { This is a stem } }
1095 c4
1096
1097 \autoFootnoteGrob #'AccidentalCautionary #'(0 . 0.5)
1098 \markup \italic { A cautionary accidental }
1099 \autoFootnoteGrob #'TextScript #'(0.5 . -0.5)
1100 \markup \italic { Slow Down }
1101 dis?4_"rit."
1102 }
1103 }
1104 @end lilypond
1105
1106 Automatic footnotes cannot be used for top-level @code{\markup}; in this
1107 case use @ref{Manual footnotes}.
1108
1109 @node Manual footnotes
1110 @unnumberedsubsubsec Manual footnotes
1111
1112 @funindex \footnote
1113 @funindex \footnoteGrob
1114 @cindex footnotes, manual
1115
1116 There are two commands used to create manual footnotes; @code{\footnote}
1117 for top-level @code{\markup} and chorded notes, and @code{\footnoteGrob}
1118 for individual grobs (including @code{\markup} when using
1119 @code{TextScripts}).
1120
1121 @example
1122 \footnote @var{indicator} @var{footnote}
1123 @end example
1124
1125 This example shows how to manually footnote top-level markups;
1126
1127 @lilypond[verbatim,quote,ragged-right,papersize=a8]
1128 \book {
1129 \markup {
1130 \bold \italic { Andante }
1131 \footnote \super 1 "At walking pace"
1132 }
1133 \relative c' {
1134 a'4\f( b8)[ e] c4_"rit." dis?4
1135 \breathe
1136 }
1137 }
1138 @end lilypond
1139
1140 To annotate chorded notes;
1141
1142 @lilypond[verbatim,quote,ragged-right,papersize=a8]
1143 \book {
1144 \header { tagline = ##f }
1145 \relative c' {
1146 <
1147 c-\footnote #'(1 . -1.25) \markup "1" "1. C"
1148 es-\footnote #'(2 . -0.25) \markup "2" "2. E-flat"
1149 g-\footnote #'(2 . 3) \markup "3" "3. G"
1150 >1
1151 }
1152 }
1153 @end lilypond
1154
1155 @example
1156 \footnoteGrob #'@var{Layout Object} #'@var{(x . y)}
1157 \markup @{indicator@} \markup @{footnote@}
1158 @end example
1159
1160 Here is an example of a variety of manually footnoted grobs;
1161
1162 @lilypond[verbatim,quote,ragged-right,papersize=a8]
1163 \book {
1164 \header { tagline = ##f }
1165 \relative c' {
1166 \footnoteGrob #'DynamicText #'(-3 . 0)
1167 \markup { \teeny 1 }
1168 \markup { 1. \bold Forte }
1169
1170 \footnoteGrob #'Slur #'(0 . 1.5)
1171 \markup { \teeny b }
1172 \markup { b. A slur }
1173 a'4\f(
1174
1175 \footnoteGrob #'Beam #'(0 . -2)
1176 \markup { \teeny 3 }
1177 \markup { 3. Beam }
1178 b8)[ e]
1179
1180 \footnoteGrob #'Stem #'(1 . -1)
1181 \markup { \teeny 4 }
1182 \markup { 4. \teeny { This is a stem } }
1183 c4
1184
1185 \footnoteGrob #'AccidentalCautionary #'(0 . 0.5)
1186 \markup \concat \teeny { "sharp (v)" }
1187 \markup \italic { v. A cautionary accidental }
1188 \footnoteGrob #'TextScript #'(0.5 . -0.5)
1189 \markup \concat \teeny { "a" }
1190 \markup \italic { a. Slow Down }
1191 dis?4_"rit."
1192
1193 \breathe
1194 \footnoteGrob #'BreathingSign #'(1.5 . -0.25)
1195 \markup { \teeny \musicglyph #"rests.4" }
1196 \markup { \null }
1197 }
1198 }
1199 @end lilypond
1200
1201 @seealso
1202 Learning Manual:
1203 @rlearning{Objects and interfaces}.
1204
1205 Notation Reference:
1206 @ref{Balloon help},
1207 @ref{Page layout},
1208 @ref{Text marks},
1209 @ref{Text scripts},
1210 @ref{Titles and headers}.
1211
1212 Internals Reference:
1213 @rinternals{FootnoteEvent},
1214 @rinternals{FootnoteItem},
1215 @rinternals{FootnoteSpanner},
1216 @rinternals{Footnote_engraver}.
1217
1218 @knownissues
1219 Multiple footnotes for the same page can only be stacked, one on top of
1220 the other, and cannot be printed on the same line. Footnotes cannot be
1221 attached to @code{MultiMeasureRests} and may collide with staff, markup
1222 objects and even other footnote annotations. When using any manual
1223 footnote command a @code{@bs{}paper} block containing
1224 @code{footnote-auto-number = ##f} is required.
1225
1016 1226
1017 @node Reference to page numbers 1227 @node Reference to page numbers
1018 @subsection Reference to page numbers 1228 @subsection Reference to page numbers
1019 1229
1020 A particular place of a score can be marked using the @code{\label} 1230 A particular place of a score can be marked using the @code{\label}
1021 command, either at top-level or inside music. This label can then be 1231 command, either at top-level or inside music. This label can then be
1022 referred to in a markup, to get the number of the page where the marked 1232 referred to in a markup, to get the number of the page where the marked
1023 point is placed, using the @code{\page-ref} markup command. 1233 point is placed, using the @code{\page-ref} markup command.
1024 1234
1025 @lilypond[verbatim] 1235 @lilypond[verbatim]
(...skipping 1688 matching lines...) Expand 10 before | Expand all | Expand 10 after
2714 2924
2715 2925
2716 @knownissues 2926 @knownissues
2717 2927
2718 Not all lilypond music events are supported by 2928 Not all lilypond music events are supported by
2719 @file{event-listener.ly}. It is intended to be a well-crafted 2929 @file{event-listener.ly}. It is intended to be a well-crafted
2720 @qq{proof of concept}. If some events that you want to see are 2930 @qq{proof of concept}. If some events that you want to see are
2721 not included, copy @file{event-listener.ly} into your lilypond 2931 not included, copy @file{event-listener.ly} into your lilypond
2722 directory and modify the file so that it outputs the information 2932 directory and modify the file so that it outputs the information
2723 you want. 2933 you want.
OLDNEW
« no previous file with comments | « no previous file | no next file » | no next file with comments »

Powered by Google App Engine
RSS Feeds Recent Issues | This issue
This is Rietveld f62528b