Command/setuphead

From Wiki
< Command
Revision as of 17:51, 30 January 2021 by Garulfo (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search


\setuphead

Summary

\setuphead is used to configure headings and titles. Being structuring elements of any document, the possibilities are quite extensive.

Settings

\setuphead[...,...][...=...,...]
[...,...]section
frontpartlabelname
bodypartlabelname
appendixlabelname
backpartlabelname
expansionyes no xml
catcodesname
sectionresetsetname
sectionseparatorsetname
sectionconversionsetname
conversionname
sectionstartercommand processor->command
sectionstoppercommand processor->command
sectionsetname
sectionsegmentsnumber number:number number:* number:all section section:section section:* section:all current
referenceprefix+ - text
stylestyle command
colorcolor
textstylestyle command
textcolorcolor
numberstylestyle command
numbercolorcolor
couplingsection
ownnumberyes no
beforesectioncommand
aftersectioncommand
insidesectioncommand
incrementnumberyes no list empty
placeheadyes no hidden empty section
numberyes no
pagesee \page
markingpage reset
headerstart stop high none normal empty nomarking name
textstart stop high none normal empty nomarking name
footerstart stop high none normal empty nomarking name
beforecommand
aftercommand
inbetweencommand
continueyes no
aligntitleyes no float
interlinespacename
interactionlist reference
internalgridname
gridnormal standard yes strict tolerant top bottom both broad fit first last high one low none line strut box min max middle math math:line math:halfline math:-line math:-halfline name
alignsee \setupalign
tolerancesee \setuptolerance
strutyes no
hangline broad fit none number
margindimension
indentnextyes no auto
alternativetext paragraph normal margin inmargin top middle bottom reverse margintext name
widthdimension
numberwidthdimension
textwidthdimension
distancedimension
textdistancedimension
commandbeforecommand
commandaftercommand
commandtwoarguments
textcommandoneargument
deeptextcommandoneargument
numbercommandoneargument
deepnumbercommandoneargument
locationname
criteriumstrict positive all
hidenumberyes no

OptionExplanation
expansion
yes expands the xml reference to actual content for title and bookmark

\xmlatt {xml:name::4}{title}First section, see TUC file.

To expand userdata also use \normalexpanded{\startsection[title=\xmlatt{#1}{title}]} instead of expansion=yes.

\normalexpanded{} and are not in conflict, so you can use both.
no no expansion, xml reference is used
xml  ?
sectionsegments
which level(s) should be included, e. g. when head is numbered. Note, ":" specifies a range (e. g. "chapter:subsubsection")
style
See manual Context: an excursion" section 33, Fonts and font switches, e.g. for large, bold, sans serif section headers use style=\tfa\bf\ss.
number
yes Include number before chapter/section title
no Do not include number before chapter/section title
page
- yes: The section header must be on the top of a new page

- left: The section header must be on the top of an even page

- right: The section header must be on the top of an odd page
header
Set a particular header style, see \setupheader.
continue
yes If the section immediately follows a chapter it will be on the same page even though page=yes.
no If the section immediately follows a chapter it will start on a new page.
aligntitle
yes use the current local hsize; flush side float first
no use the current global hsize
float use the current local hsize; do not flush side floats

Description

To headings is associated the text, i.e. the content of the heading, but can also be associated numbers.

These data can be processed for typesetting :

  • add a dot between the text and the number,
  • add a generic text before the "pure text"
  • appearance can be different for the text if we use it in the headers / footers, or in the Table of Content.
  • add vertical spaces before or after the text
  • add rules before or after the whole section under the heading
  • select if the title should appear on a right or a left page.


Examples

First example

\setuppapersize[A5]
\setuplabeltext[chapter=CHAPTER~]

\setuphead[chapter][
	header=empty,
	alternative=middle,
	style=bold,
	numbercommand=\groupedcommand{}{\blank[2cm]},
	after={\blank[3cm]},
	]

\starttext

\chapter{Title of chapter}

The first paragraph begins 3 cm below the title. In this chapter, we will discuss...

\stoptext

produces

Big space before a smaller space behind the heading


\setuphead
  [subject]
  [before={\blank[2*big]},
   after={\blank[big]},
   style=bold]

\starttext

\subject{Headline 1}
text text text text text text text text text text text text text text text vtext text text text text text text text text text text text text\par
\subject{Headline 2}
text text text text text text text text text text text text text text text vtext text text text text text text text text text text text text\par

\stoptext

produces

Setting label of a new section head

\definehead[mychapter][chapter][bodypartlabel=mychapter]

\setuplabeltext[en][mychapter=My Chapter~]

\starttext
\mychapter{Animals}
\stoptext

produces

Inline headings similar to LaTeX &squo;s \paragraph{}

Modified from (https://tex.stackexchange.com/questions/375922/paragraph-title-in-context-similar-to-latex-paragraph).

\definehead[paragraph][subsubsubsubject]
\setuphead [paragraph]
           [
             textdistance=0pt,
             commandafter={.},
             alternative=text,
             style=sc,
          ]

\startparagraph[title=Knuth quote]
  \input knuth
\stopparagraph

produces

Setting label of a part

In MkIV, if you want parts to be labeled as "Part 1" etc., the following isn't sufficient (but works in MkII):

\setuphead[part][placehead=yes]

\starttext
\part{A part}

\stoptext

because it produces

For MkIV, add bodypartlabel=part to the setuphead:

\setuphead[part][placehead=yes, bodypartlabel=part]

\starttext
\part{A part}

\stoptext

(Thanks to Wolfgang Schuster on the mailing list for this information.)

Example of hidden sections

\setupheadnumber[section]      [8]
\setupheadnumber[subsection]   [3]
\setupheadnumber[subsubsection][5]

\setuphead[section,subsection][placehead=hidden]
\setuphead[subsubsection]     [placehead=yes]

\starttext

\section{} % hidden 8th section

\subsection{} % hidden 3rd section

\subsubsection{This is complete numbering of subsubsection} % view 9.4.6 subsubsection

\stoptext

produces

Modifying the page before a chapter

Here is an example which shows how you can change the background color of an empty page before the chapter title.

% next five lines just to show the effect on this wiki
\setuppapersize[A8][A5,landscape]
\setuppaper[nx=4, ny=2]
\setuplayout[page][location=middle, marking=on]
\setuparranging [XY]
\setupbodyfont[6pt]

% actual example starts here
\setuppagenumbering
  [alternative=doublesided]

\startsetups [chapter:before]
  \doifoddpageelse
    {}
    {\pushbackground[page]
     \setupbackgrounds[page][background=color,backgroundcolor=gray]
     \page[right]
     \popbackground}
\stopsetups

\setuphead
  [chapter]
  [page=yes,
   before=\directsetup{chapter:before}]

\starttext

\startchapter[title={Knuth}]
\dorecurse{2}{\samplefile{knuth}}
\stopchapter

\startchapter[title={Ward}]
\dorecurse{1}{\samplefile{ward}}
\stopchapter

\startchapter[title={Zapf}]
\dorecurse{2}{\samplefile{zapf}}
\stopchapter


\stoptext

produces

The command \pushbackground stores the values of the background which is modified. After the execution of \page[right] the old values of background are restored by \popbackground.

Notes

See also

Help from ConTeXt-Mailinglist/Forum

All issues with: