Skip to content

Commit

Permalink
docs: Update the description of commands for managing running headers
Browse files Browse the repository at this point in the history
  • Loading branch information
Omikhleia authored and Didier Willis committed Aug 17, 2023
1 parent 0080e23 commit 34d908c
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions examples/manual-classes/classes.sil
Original file line number Diff line number Diff line change
Expand Up @@ -229,10 +229,21 @@ The class also defines two commands for manipulating the page headers.
\cell[valign=top]{\autodoc:command{\odd-running-header{<content>}}}
\cell[valign=top]{Registers the content to be used in odd running headers.}
\end{row}
\begin{row}
\cell[valign=top]{\autodoc:command{\even-tracked-header{<content>}}}
\cell[valign=top]{Registers the content to be used in even running headers, tracked.}
\end{row}
\begin{row}
\cell[valign=top]{\autodoc:command{\odd-tracked-header{<content>}}}
\cell[valign=top]{Registers the content to be used in odd running headers, tracked.}
\end{row}
\end{ptable}
\caption{Commands for manipulating page headers.}
\end{table}

The “tracked” variants ensure the content is tracked per page (using “info nodes”), which is usually what you want for section headers.
The other versions do not introduce info nodes, are intended to be used with direct content (such as a document title) or content already tracked elsewhere.

Page headers rely on the functionality provided by the \autodoc:package{resilient.headers} package,
so the \autodoc:command{\noheaders}, \autodoc:command{\noheaderthispage} and \autodoc:command{\headers}
commands are available, as well as \autodoc:command{\header:rule}.
Expand Down

0 comments on commit 34d908c

Please sign in to comment.