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

Delta Between Two Patch Sets: Documentation/notation/input.itely

Issue 5315053: Doc: NR Added new node for Custom Footnotes (Closed)
Left Patch Set: Third Draft with corrections from GP Created 12 years, 5 months ago
Right 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:
Left: Side by side diff | Download
Right: Side by side diff | Download
« no previous file with change/comment | « no previous file | no next file » | no next file with change/comment »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
LEFTRIGHT
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 998 matching lines...) Expand 10 before | Expand all | Expand 10 after
1009 } 1009 }
1010 @end lilypond 1010 @end lilypond
1011 1011
1012 @seealso 1012 @seealso
1013 Notation Reference: 1013 Notation Reference:
1014 @ref{Title blocks explained}, 1014 @ref{Title blocks explained},
1015 @ref{Default layout of book and score title blocks}. 1015 @ref{Default layout of book and score title blocks}.
1016 1016
1017 @node Creating footnotes 1017 @node Creating footnotes
1018 @subsection Creating footnotes 1018 @subsection Creating footnotes
1019 1019
Graham Percival 2011/10/31 06:37:05 technically there should be a 1-2 sentence introdu
pkx166h 2011/11/02 06:10:38 I took the first sentence of the next following pa
1020 There are two types of footnotes that can be created; automatic
1021 footnotes and manual footnotes.
1022
1020 @menu 1023 @menu
1021 * Footnotes overview:: 1024 * Footnotes overview::
1022 * Automatic footnotes:: 1025 * Automatic footnotes::
1023 * Manual footnotes:: 1026 * Manual footnotes::
1024 @end menu 1027 @end menu
1025 1028
1026 @node Footnotes overview 1029 @node Footnotes overview
1027 @unnumberedsubsubsec Footnotes overview 1030 @unnumberedsubsubsec Footnotes overview
1028 1031
1029 There are two types of footnotes that can be used; automatic footnotes 1032 Automatic footnotes create default superscript numbers which indicate
1030 and manual footnotes. Automatic footnotes create default superscript 1033 the footnote at the bottom of the page, whereas manual footnotes allow a
1031 numbers which flag the footnote whereas manual footnotes allow a custom 1034 custom indicator to be created instead.
1032 flag to be created. 1035
1036 @example
1037 \autoFootnoteGrob #'@var{Layout Object} #'@var{(x . y)}
1038 \markup @{footnote@}
1039 @end example
1033 1040
1034 All grobs, top-level @code{\markup} and chorded notes can be annotated. 1041 All grobs, top-level @code{\markup} and chorded notes can be annotated.
1035 When annotating grobs, the command that you use must come @emph{before} 1042 When annotating grobs, the command that you use must come @emph{before}
1036 the grob that the footnote is being attached to. The order in which 1043 the grob that the footnote is being attached to. The order in which
1037 each grob is drawn determines the order in which each footnote is 1044 each grob is drawn determines the order in which each footnote is
1038 created during compilation. 1045 created during compilation.
1039 1046
1040 Offset values of zero are taken from the center of the grob that is 1047 Offset values of zero are taken from the center of the grob that is
1041 being footnoted whereas negative and positive values are taken from the 1048 being footnoted whereas negative and positive values are taken from the
1042 @qq{bottom left} and @qq{top right} of the grob respectively. 1049 @qq{bottom left} and @qq{top right} of the grob respectively.
1043 1050
1044 @node Automatic footnotes 1051 @node Automatic footnotes
1045 @unnumberedsubsubsec Automatic footnotes 1052 @unnumberedsubsubsec Automatic footnotes
1046 1053
1047 The two commands used to create automatic footnotes are 1054 The two commands used to create automatic footnotes are
1048 @code{\autoFootnote} for chorded notes and @code{\autoFootnoteGrob} for 1055 @code{\autoFootnote} for chorded notes and @code{\autoFootnoteGrob} for
1049 individual grobs (i.e. note heads, stems and slurs) including 1056 individual grobs (i.e. note heads, stems and slurs) including
1050 @code{\markup} when using @code{TextScripts}. 1057 @code{\markup} when using @code{TextScripts}.
1051 1058
1052 To annotate chorded notes; 1059 To annotate chorded notes:
1053 1060
1054 @lilypond[verbatim,quote,ragged-right,papersize=a8] 1061 @lilypond[verbatim,quote,ragged-right,papersize=a8]
1055 \book { 1062 \book {
1056 \header { tagline=##f } 1063 \header { tagline = ##f }
1057 \relative c' { 1064 \relative c' {
1058 < 1065 <
1059 c-\autoFootnote #'(1 . -1.25) "This is a C" 1066 c-\autoFootnote #'(1 . -1.25) "This is a C"
1060 es-\autoFootnote #'(2 . -0.25) \markup \italic "Here is an E-flat" 1067 es-\autoFootnote #'(2 . -0.25) \markup \italic "Here is an E-flat"
1061 g-\autoFootnote #'(2 . 3) \markup \bold "This is a G" 1068 g-\autoFootnote #'(2 . 3) \markup \bold "This is a G"
1062 >1 1069 >1
1063 } 1070 }
1064 } 1071 }
1065 @end lilypond 1072 @end lilypond
1066 1073
1067 @example 1074 Here is an example of a variety of automatically footnoted grobs showing
Graham Percival 2011/10/31 06:37:05 move this @example up to immediately after the fir
pkx166h 2011/11/02 06:10:38 Done.
1068 \autoFootnoteGrob #'@var{Layout Object} #'@var{(x . y)} 1075 the relative position of the footnotes to the default tagline and the
1069 \markup @{footnote@} 1076 copyright line.
1070 @end example
1071 1077
1072 @lilypond[verbatim,quote,ragged-right,papersize=a8] 1078 @lilypond[verbatim,quote,ragged-right,papersize=a8]
Graham Percival 2011/10/31 06:37:05 what does this example show? could we have a 1-2
pkx166h 2011/11/02 06:10:38 Done.
1073 \book { 1079 \book {
1074 \header { copyright = \markup { "Copyright" \char ##x00A9 "1970" } } 1080 \header { copyright = \markup { "Copyright 1970" } }
Graham Percival 2011/10/31 06:37:05 why do you want the tagline visible here? and why
pkx166h 2011/11/02 06:10:38 This is the first time that users would see a foot
1075 \relative c' { 1081 \relative c' {
1076 \autoFootnoteGrob #'DynamicText #'(-3 . 0) 1082 \autoFootnoteGrob #'DynamicText #'(-3 . 0)
1077 \markup { \bold Forte } 1083 \markup { \bold Forte }
1078 1084
1079 \autoFootnoteGrob #'Slur #'(0 . 1.5) 1085 \autoFootnoteGrob #'Slur #'(0 . 1.5)
1080 \markup { A slur } 1086 \markup { A slur }
1081 a'4\f( 1087 a'4\f(
1082 1088
1083 \autoFootnoteGrob #'Beam #'(0 . -2) 1089 \autoFootnoteGrob #'Beam #'(0 . -2)
1084 \markup { Beam } 1090 \markup { Beam }
1085 b8)[ e] 1091 b8)[ e]
1086 1092
1087 \autoFootnoteGrob #'Stem #'(1 . -1) 1093 \autoFootnoteGrob #'Stem #'(1 . -1)
1088 \markup { \teeny { This is a stem } } 1094 \markup { \teeny { This is a stem } }
1089 c4 1095 c4
1090 1096
1091 \autoFootnoteGrob #'AccidentalCautionary #'(0 . 0.5) 1097 \autoFootnoteGrob #'AccidentalCautionary #'(0 . 0.5)
1092 \markup \italic { A cautionary accidental } 1098 \markup \italic { A cautionary accidental }
1093 \autoFootnoteGrob #'TextScript #'(0.5 . -0.5) 1099 \autoFootnoteGrob #'TextScript #'(0.5 . -0.5)
1094 \markup \italic { Slow Down } 1100 \markup \italic { Slow Down }
1095 dis?4_"rit." 1101 dis?4_"rit."
1096 } 1102 }
1097 } 1103 }
1098 @end lilypond 1104 @end lilypond
1099 1105
1100 Automatic footnotes cannot be used for top-level @code{\markup}; in this 1106 Automatic footnotes cannot be used for top-level @code{\markup}; in this
1101 case use the manual @code{\footnote} command below. 1107 case use @ref{Manual footnotes}.
Graham Percival 2011/10/31 06:37:05 replace with "in this case, use @ref{Manual footno
pkx166h 2011/11/02 06:10:38 Done.
1102 1108
1103 @node Manual footnotes 1109 @node Manual footnotes
1104 @unnumberedsubsubsec Manual footnotes 1110 @unnumberedsubsubsec Manual footnotes
1105 1111
1106 @funindex \footnote 1112 @funindex \footnote
1107 @funindex \footnoteGrob 1113 @funindex \footnoteGrob
1108 @cindex footnotes, manual 1114 @cindex footnotes, manual
1109 1115
1110 There are two commands used to create manual footnotes; @code{\footnote} 1116 There are two commands used to create manual footnotes; @code{\footnote}
1111 for top-level @code{\markup} and chorded notes, and @code{\footnoteGrob} 1117 for top-level @code{\markup} and chorded notes, and @code{\footnoteGrob}
1112 for individual grobs (including @code{\markup} when using 1118 for individual grobs (including @code{\markup} when using
1113 @code{TextScripts}). 1119 @code{TextScripts}).
1114 1120
1115 @example 1121 @example
1116 \footnote @var{indicator} @var{footnote} 1122 \footnote @var{indicator} @var{footnote}
1117 @end example 1123 @end example
1118 1124
1125 This example shows how to manually footnote top-level markups;
1126
1119 @lilypond[verbatim,quote,ragged-right,papersize=a8] 1127 @lilypond[verbatim,quote,ragged-right,papersize=a8]
Graham Percival 2011/10/31 06:37:05 1-2 intro for this @lilypond? even if it's obviou
pkx166h 2011/11/02 06:10:38 Done.
1120 \book { 1128 \book {
1121 \markup { 1129 \markup {
Graham Percival 2011/10/31 06:37:05 why do you want a tagline in this @lilypond?
pkx166h 2011/11/02 06:10:38 No particular reason. Just less lines in the @lily
1122 \bold \italic { Poco } 1130 \bold \italic { Andante }
1123 \footnote \super 1 \italic "1. Little" 1131 \footnote \super 1 "At walking pace"
1124 \bold \italic { a }
1125 \footnote \super 2 \bold "2. by"
1126 \bold \italic { poco }
1127 \footnote \super 3 "3. little"
1128 } 1132 }
1129 \relative c' { 1133 \relative c' {
1130 a'4\f( b8)[ e] c4_"rit." dis?4 1134 a'4\f( b8)[ e] c4_"rit." dis?4
1131 \breathe 1135 \breathe
1132 } 1136 }
1133 } 1137 }
1134 @end lilypond 1138 @end lilypond
1135 1139
1136 To annotate chorded notes; 1140 To annotate chorded notes;
1137 1141
1138 @lilypond[verbatim,quote,ragged-right,papersize=a8] 1142 @lilypond[verbatim,quote,ragged-right,papersize=a8]
1139 \book { 1143 \book {
1140 \header { tagline=##f } 1144 \header { tagline = ##f }
1141 \relative c' { 1145 \relative c' {
1142 < 1146 <
1143 c-\footnote #'(1 . -1.25) \markup "1" "1. C" 1147 c-\footnote #'(1 . -1.25) \markup "1" "1. C"
1144 es-\footnote #'(2 . -0.25) \markup "2" "2. E-flat" 1148 es-\footnote #'(2 . -0.25) \markup "2" "2. E-flat"
1145 g-\footnote #'(2 . 3) \markup "3" "3. G" 1149 g-\footnote #'(2 . 3) \markup "3" "3. G"
1146 >1 1150 >1
1147 } 1151 }
1148 } 1152 }
1149 @end lilypond 1153 @end lilypond
1150 1154
1151 @example 1155 @example
1152 \footnoteGrob #'@var{Layout Object} #'@var{(x . y)} 1156 \footnoteGrob #'@var{Layout Object} #'@var{(x . y)}
1153 \markup @{indicator@} \markup @{footnote@} 1157 \markup @{indicator@} \markup @{footnote@}
1154 @end example 1158 @end example
1155 1159
1160 Here is an example of a variety of manually footnoted grobs;
1161
1156 @lilypond[verbatim,quote,ragged-right,papersize=a8] 1162 @lilypond[verbatim,quote,ragged-right,papersize=a8]
Graham Percival 2011/10/31 06:37:05 introduce this @lilypond as well
pkx166h 2011/11/02 06:10:38 Done.
1157 \book { 1163 \book {
1158 \header { copyright = \markup { "Copyright" \char ##x00A9 "1970" } } 1164 \header { tagline = ##f }
1159 \relative c' { 1165 \relative c' {
1160 \footnoteGrob #'DynamicText #'(-3 . 0) 1166 \footnoteGrob #'DynamicText #'(-3 . 0)
1161 \markup { \teeny 1 } 1167 \markup { \teeny 1 }
1162 \markup { 1. \bold Forte } 1168 \markup { 1. \bold Forte }
1163 1169
1164 \footnoteGrob #'Slur #'(0 . 1.5) 1170 \footnoteGrob #'Slur #'(0 . 1.5)
1165 \markup { \teeny b } 1171 \markup { \teeny b }
1166 \markup { b. A slur } 1172 \markup { b. A slur }
1167 a'4\f( 1173 a'4\f(
1168 1174
(...skipping 1749 matching lines...) Expand 10 before | Expand all | Expand 10 after
2918 2924
2919 2925
2920 @knownissues 2926 @knownissues
2921 2927
2922 Not all lilypond music events are supported by 2928 Not all lilypond music events are supported by
2923 @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
2924 @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
2925 not included, copy @file{event-listener.ly} into your lilypond 2931 not included, copy @file{event-listener.ly} into your lilypond
2926 directory and modify the file so that it outputs the information 2932 directory and modify the file so that it outputs the information
2927 you want. 2933 you want.
LEFTRIGHT
« no previous file | no next file » | Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Toggle Comments ('s')

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