This time, I used the correct branch (2.2.x) instead of 2.0.x. This patch
makes more sense, showing just 215 insertions(+), 31 deletions(-).
Again, please CC me (colinnkee...@gmail.com) because I have not subscribed
to this list.
From 91b6fb3daf89fcfdca66fa61baea5ebb9ee96403 Mon Sep 17 00:00:00 2001
From: Colin Keenan <colinnkee...@gmail.com>
Date: Wed, 22 Jun 2016 23:07:23 -0500
Subject: [PATCH] improved Customized Page Headers and Footers section of User
Guide 2.2.x
---
lib/doc/UserGuide.lyx | 246 +++++++++++++++++++++++++++++++++++++++++++-------
1 file changed, 215 insertions(+), 31 deletions(-)
diff --git a/lib/doc/UserGuide.lyx b/lib/doc/UserGuide.lyx
index 0c8517d..4795e5c 100644
--- a/lib/doc/UserGuide.lyx
+++ b/lib/doc/UserGuide.lyx
@@ -3,7 +3,7 @@
\begin_document
\begin_header
\save_transient_properties true
-\origin /systemlyxdir/doc/
+\origin unavailable
\textclass scrbook
\begin_preamble
% DO NOT ALTER THIS PREAMBLE!!!
@@ -31006,19 +31006,15 @@ Settings\SpecialChar menuseparator
Modules
\family default
the module
-\begin_inset Quotes eld
-\end_inset
-
+\emph on
Custom Header/Footerlines
-\begin_inset Quotes erd
-\end_inset
-
+\emph default
.
This module offers the following 6
\begin_inset space ~
\end_inset
-styles:
+environments:
\end_layout
\begin_layout Description
@@ -31071,6 +31067,37 @@ Footer
\begin_layout Standard
for the different positions in the header/footer.
+ These 6
+\begin_inset space ~
+\end_inset
+
+environments can be found in the same
+\family sans
+Environment choice
+\family default
+ box where typical environments such as
+\emph on
+Standard
+\emph default
+ or
+\emph on
+Section
+\emph default
+ can be found.
+ (The
+\family sans
+Environment choice
+\family default
+ box is located on the left end of the toolbar and looks like this:
+\begin_inset Graphics
+ filename /usr/share/lyx/doc/clipart/ToolbarEnvBox.png
+ scale 75
+ clip
+
+\end_inset
+
+.
+ It indicates in which environment you are currently writing.)
\end_layout
\begin_layout Standard
@@ -31318,13 +31345,17 @@ Definition
\end_layout
\begin_layout Standard
-To define your header line, add all three header styles.
- The things you add to the styles appear on odd numbered pages, the things
- in the optional arguments on even numbered pages.
+To define your header line, add all three header environments from the
+\family sans
+Environment choice
+\family default
+ box.
+ The things you add to each environment appear on odd numbered pages, the
+ things in the optional arguments on even numbered pages.
For single-sided documents, the optional arguments will not be used and
can be omitted.
- If you leave a style or its argument empty, nothing appears in the output.
- Defining the footer line works similarly.
+ If you leave a header environment or its argument empty, nothing appears
+ in the output.
\end_layout
\begin_layout Standard
@@ -31396,7 +31427,7 @@ The custom header/footer is not empty by default.
The default header contains the chapter and section title and the center
footer has the page number.
In order to remove unwanted entries from the header/footer, include the
- relevant header/footer style in your document, but leave it blank.
+ relevant header/footer environment in your document, but leave it blank.
So, if you do not want a page number in the footer, include a blank
\family sans
Center
@@ -31405,7 +31436,7 @@ Center
Footer
\family default
- style.
+ environment.
\end_layout
\begin_layout Subsection
@@ -31415,8 +31446,8 @@ Appearance
\begin_layout Standard
The header and footer will appear on normal pages.
Some pages are different.
- The title page has a style of its own, and so does any page that starts
- a new part or chapter in your book.
+ The title page has a header/footer environment of its own, and so does
+ any page that starts a new part or chapter in your book.
Such pages will not have the custom headers/footers, but that is normal.
There is for example no need to print a header with the chapter name on
the chapter page where the chapter heading is in big bold letters anyway.
@@ -31432,7 +31463,17 @@ By default, you get a 0.4
\end_inset
pt thick line below the header and no footer line.
- This can be changed in the document preamble with the commands
+ This can be changed in
+\family sans
+Document\SpecialChar menuseparator
+Settings\SpecialChar menuseparator
+LaTeX
+\begin_inset space ~
+\end_inset
+
+Preamble
+\family default
+ with the commands
\series bold
\backslash
@@ -31492,15 +31533,125 @@ key "Mittelbach"
\end_layout
\begin_layout Subsubsection
-Several header/footer lines
+Larger header/footer with multiple lines of text
+\end_layout
+
+\begin_layout Standard
+In case you need more than one line of text as a header/footer, you can
+ do this by adding a normal line break (
+\noun on
+CTRL
+\noun default
++
+\noun on
+Enter
+\noun default
+) in the header environment definition.
+ However, the default height of the header/footer is only big enough for
+ one line of text.
+ Expand the header height from the menu
+\family sans
+Document\SpecialChar menuseparator
+
+\family default
+Settings
+\family sans
+\SpecialChar menuseparator
+
+\family default
+Page
+\begin_inset space ~
+\end_inset
+
+Margins.
+ In that Page
+\begin_inset space ~
+\end_inset
+
+Margins dialog, make sure
+\emph on
+Default
+\begin_inset space ~
+\end_inset
+
+margins
+\emph default
+ is not selected, then adjust
+\emph on
+Top
+\emph default
+,
+\emph on
+Head sep,
+\emph default
+ and
+\emph on
+Head height
+\emph default
+ so that
+\emph on
+Top
+\emph default
+ is at least as big as
+\emph on
+Head height
+\emph default
+ +
+\emph on
+Head sep
+\emph default
+.
+ For example, if you had a 3
+\begin_inset space ~
+\end_inset
+
+cm header and wanted the space between the header and following text to
+ be 0.5
+\begin_inset space ~
+\end_inset
+
+cm, then you could set
+\emph on
+Top:
+\emph default
+ 3.5 cm,
+\emph on
+Head sep:
+\emph default
+ 0.5
+\begin_inset space ~
+\end_inset
+
+cm, and
+\emph on
+ Head height:
+\emph default
+ 3.0
+\begin_inset space ~
+\end_inset
+
+cm.
+ However, that would put the top of the header at the very top edge of the
+ paper, which is probably not printable or desirable.
+ In this situation, it would be more realistic to set
+\emph on
+Top:
+\emph default
+ 5
+\begin_inset space ~
+\end_inset
+
+cm, leaving 1.5
+\begin_inset space ~
+\end_inset
+
+cm blank space above the header.
+
\end_layout
\begin_layout Standard
-In case you need more than one text line as a header/footer, you can do
- this by adding a normal line break in the style definition.
- However, the default height of the header/footer is only the one of one
- text line.
- To expand the height, redefine the \SpecialChar LaTeX
+Another method for expanding the header/footer height is to redefine the
+ \SpecialChar LaTeX
length
\series bold
@@ -31513,7 +31664,7 @@ headheight
\backslash
footheight
\series default
- in this entry in
+ in
\family sans
Document\SpecialChar menuseparator
Settings\SpecialChar menuseparator
@@ -31537,9 +31688,25 @@ headheight}{height}
\end_layout
\begin_layout Standard
-where height is a size in standard units.
- If you don't know which amount of space is needed for the height, define
- your header/footer and preview your document as a PDF.
+where
+\series bold
+height
+\series default
+ is a size in standard units like
+\emph on
+em
+\emph default
+,
+\emph on
+ex
+\emph default
+, or
+\emph on
+cm
+\emph default
+.
+ If you don't know how much space is needed for the height, define your
+ header/footer and preview your document as a PDF.
Then open the \SpecialChar LaTeX
logfile with the menu
\family sans
@@ -31554,7 +31721,11 @@ Next
Warning
\family default
- to see if you can find a warning about the package
+ to see if you can find a warning about the
+\series bold
+geometry
+\series default
+ or package
\series bold
fancyhdr
\series default
@@ -31570,8 +31741,10 @@ status collapsed
\end_inset
.
- If there is such a warning, it contains the space that you need at least
- for your header/footer.
+ If there is such a warning, scroll down to see the smallest space that
+ you can use for your header/footer.
+ If there are other warnings, you may have to correct those before it will
+ show the warning you are looking for.
\end_layout
\begin_layout Subsection
@@ -31580,6 +31753,17 @@ This example
\begin_layout Standard
This example demonstrates what can be done with custom header/footers.
+ If reading this in \SpecialChar LyX
+, you can see the actual definitions in their Environments
+ just above
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:Customized-Page-Headers"
+
+\end_inset
+
+ (right-click to go to label and then scroll up), and you can see the results
+ on these pages between those definitions and the end of this section.
Don't use it for your document as it is just an example.
This example consists of the following definition:
\end_layout
--
2.9.0
