From 973fb1c7951f923d6a9c66d1a91d586719416f51 Mon Sep 17 00:00:00 2001 From: Federico Bruni Date: Sun, 17 Jul 2016 17:37:22 +0200 Subject: [PATCH] Doc: specify which \header blocks generate PDF metadata Issue 4921 --- Documentation/notation/input.itely | 26 ++++++++++++++++---------- 1 file changed, 16 insertions(+), 10 deletions(-) diff --git a/Documentation/notation/input.itely b/Documentation/notation/input.itely index a23943c16c..c4224727ed 100644 --- a/Documentation/notation/input.itely +++ b/Documentation/notation/input.itely @@ -1207,14 +1207,20 @@ Installed Files: In addition to being shown in the printed output, @code{\header} variables are also used to set PDF metadata (the information displayed by PDF readers -as the @code{properties} of the PDF file). For example, setting the -@code{title} property of the @code{header} block @q{Symphony I} will also give -this title to the PDF document. +as the @code{properties} of the PDF file). As metadata are applied per +output file, only @code{\header} blocks located at top level or within an +explicit @code{\book} block will be used to generate PDF metadata; while +@code{\header} variables in a @code{\bookpart} or @code{\score} block +will be reflected in the printed output of the respective blocks, the +document-wide PDF metadata will not be affected by headers at that level. + +For example, setting the @code{title} property of the @code{header} block +@q{Symphony I} will also give this title to the PDF document. @example - \header@{ - title = "Symphony I" - @} +\header@{ + title = "Symphony I" +@} @end example If you want to set the title of the printed output to one value, but have the @@ -1222,10 +1228,10 @@ title property of the PDF to have a different value, you can use @code{pdftitle}, as below. @example - \header@{ - title = "Symphony I" - pdftitle = "Symphony I by Beethoven" - @} +\header@{ + title = "Symphony I" + pdftitle = "Symphony I by Beethoven" +@} @end example The variables @code{title}, @code{subject}, @code{keywords}, -- 2.39.2