Difference between revisions of "Command/setupinitial"
< Command
Jump to navigation
Jump to search
Line 16: | Line 16: | ||
<cd:assignmentsdoc></cd:assignmentsdoc> | <cd:assignmentsdoc></cd:assignmentsdoc> | ||
<cd:parameter name="n"> | <cd:parameter name="n"> | ||
− | <cd:paramdoc> | + | <cd:paramdoc>number of lines in the paragraph that the initial should occupy. It defaults to 3. The size of the initial is adapted accordingly, but it can be changed with font parameter."</cd:paramdoc> |
− | |||
− | |||
<cd:constant type="cd:number"></cd:constant> | <cd:constant type="cd:number"></cd:constant> | ||
</cd:parameter> | </cd:parameter> | ||
Line 33: | Line 31: | ||
</cd:parameter> | </cd:parameter> | ||
<cd:parameter name="distance"> | <cd:parameter name="distance"> | ||
− | <cd:paramdoc> | + | <cd:paramdoc>the horizontal distance which initial line(s) of the paragraph should be indented beyond the space needed for the letter. It defaults to 0pt, and it can be negative.</cd:paramdoc> |
− | |||
− | |||
<cd:constant type="cd:dimension"></cd:constant> | <cd:constant type="cd:dimension"></cd:constant> | ||
</cd:parameter> | </cd:parameter> | ||
<cd:parameter name="hoffset"> | <cd:parameter name="hoffset"> | ||
− | <cd:paramdoc> | + | <cd:paramdoc>the distance to the left (into the left margin), or to the right, that the initial should be shifted from its default position. This defaults to 0pt. |
− | + | </cd:paramdoc> | |
− | |||
<cd:constant type="cd:dimension"></cd:constant> | <cd:constant type="cd:dimension"></cd:constant> | ||
</cd:parameter> | </cd:parameter> | ||
<cd:parameter name="voffset"> | <cd:parameter name="voffset"> | ||
− | <cd:paramdoc> | + | <cd:paramdoc>the distance downward, or upward (negative value), from its default position that the initial should be shifted. This defaults to 0pt. |
− | + | Value 0pt gives a "top" alignment, i.e. corresponding with the first line of the paragraph.</cd:paramdoc> | |
− | |||
− | Value 0pt gives a "top" alignment.</cd:paramdoc> | ||
<cd:constant default="yes" type="line"></cd:constant> | <cd:constant default="yes" type="line"></cd:constant> | ||
<cd:constant type="cd:dimension"></cd:constant> | <cd:constant type="cd:dimension"></cd:constant> | ||
</cd:parameter> | </cd:parameter> | ||
<cd:parameter name="style"> | <cd:parameter name="style"> | ||
− | <cd:paramdoc>style of the initial, for example <code>style=\ | + | <cd:paramdoc>style of the initial, for example <code>style=\it</code> for italic.</cd:paramdoc> |
<cd:constant type="cd:style"></cd:constant> | <cd:constant type="cd:style"></cd:constant> | ||
<cd:constant type="cd:command"></cd:constant> | <cd:constant type="cd:command"></cd:constant> | ||
</cd:parameter> | </cd:parameter> | ||
<cd:parameter name="color"> | <cd:parameter name="color"> | ||
− | <cd:paramdoc> | + | <cd:paramdoc>for example <code>color=darkred</code>. It defaults to the current color </cd:paramdoc> |
<cd:constant type="cd:color"></cd:constant> | <cd:constant type="cd:color"></cd:constant> | ||
</cd:parameter> | </cd:parameter> | ||
<cd:parameter name="font"> | <cd:parameter name="font"> | ||
− | <cd:paramdoc>font specification | + | <cd:paramdoc>font specification. It defaults to boldface scaled to the number of text lines that the initial occupies, but can be customized, for example: <code>font=Bold at 32pt</code>.</cd:paramdoc> |
<cd:constant type="cd:font"></cd:constant> | <cd:constant type="cd:font"></cd:constant> | ||
</cd:parameter> | </cd:parameter> | ||
Line 76: | Line 69: | ||
</cd:parameter> | </cd:parameter> | ||
<cd:parameter name="method"> | <cd:parameter name="method"> | ||
− | <cd:paramdoc> | + | <cd:paramdoc>to be determined.</cd:paramdoc> |
<cd:constant type="first"></cd:constant> | <cd:constant type="first"></cd:constant> | ||
<cd:constant type="last"></cd:constant> | <cd:constant type="last"></cd:constant> | ||
Line 86: | Line 79: | ||
</cd:command> | </cd:command> | ||
</cd:variants> | </cd:variants> | ||
− | <cd:description> | + | <cd:description> |
− | |||
− | |||
</cd:description> | </cd:description> | ||
<cd:examples><cd:example title="color, distance, before + variations on n, m , location">The following example produces an awful-looking initial, but it illustrates how some of these parameters work. | <cd:examples><cd:example title="color, distance, before + variations on n, m , location">The following example produces an awful-looking initial, but it illustrates how some of these parameters work. | ||
Line 256: | Line 247: | ||
</context></cd:example></cd:examples> | </context></cd:example></cd:examples> | ||
− | <cd:notes></cd:notes> | + | <cd:notes> |
+ | <cd:note author="Garulfo" date="2020-12-12T22:46:03+0100"> | ||
+ | Because the space carved out for the initial is rectangular, initials work best with a font with rectangular ornaments around the letter. | ||
+ | |||
+ | |||
+ | |||
+ | </cd:note></cd:notes> | ||
<cd:seealso> | <cd:seealso> | ||
<cd:commandref name="defineinitial" originator="system">placeinitial </cd:commandref> | <cd:commandref name="defineinitial" originator="system">placeinitial </cd:commandref> |
Revision as of 21:48, 12 December 2020
Contents
\setupinitial
Summary
Initials (also known as drop caps, dropped caps, or versals) can be made in ConTeXt using the \placeinitial command.
The command \setupinitial
is used to customize this decorative or ornate first letter(s) to prose at the start of chapters, sections, paragraphs, and so forth.
Settings
\setupinitial[...,...][...=...,...] | |
[...,...] | name |
n | number |
m | number |
before | command |
distance | dimension |
hoffset | dimension |
voffset | line dimension |
style | style command |
color | color |
font | font |
text | text |
location | margin text |
method | first last auto none |
Option | Explanation | ||
---|---|---|---|
n |
| ||
m |
| ||
before |
| ||
distance |
| ||
hoffset |
| ||
voffset |
| ||
style |
| ||
color |
| ||
font |
| ||
text |
| ||
location |
| ||
method |
|
Description
Examples
color, distance, before + variations on n, m , location
The following example produces an awful-looking initial, but it illustrates how some of these parameters work.
\definepapersize[sheet][width=120mm,height=200mm] \setuppapersize[sheet] \setuppagenumbering[location=] \setuplayout[width=100mm,backspace=15mm,topspace=0mm,header=0mm,headerdistance=0mm,footer=0mm,footerdistance=0mm] \starttext \setupinitial [color=darkred, distance=10mm, before={\blank[big]\hairline\blank[big]}] \type[option=context]{\setupinitial[color=darkred,distance=10mm,before={\blank[big]\hairline\blank[big]}]} and \type[option=context]{\setupinitial[n=2, m=2]} \setupinitial[n=2, m=2] \placeinitial \input knuth \blank[big] or \type[option=context]{\setupinitial[n=3, m=4]} \setupinitial[n=3, m=4] \placeinitial \input knuth \blank[big] or \type[option=context]{\setupinitial[location=margin,n=3, m=1,distance=5mm]} \setupinitial[location=margin,n=3, m=1,distance=5mm] \placeinitial \input knuth \stoptext
hoffset
\definepapersize[sheet][width=120mm,height=200mm] \setuppapersize[sheet] \setuppagenumbering[location=] \setuplayout[width=100mm,backspace=15mm,topspace=0mm,header=0mm,headerdistance=0mm,footer=0mm,footerdistance=0mm] \starttext Here is some text 1. \setupinitial[color=darkred] \placeinitial \input knuth \blank[big] \type[option=context]{\setupinitial[hoffset=0mm]} \setupinitial[hoffset=0mm] \placeinitial \input knuth \blank[big] \type[option=context]{\setupinitial[hoffset=5mm]} \setupinitial[hoffset=5mm] \placeinitial \input knuth \blank[big] \type[option=context]{\setupinitial[hoffset=-5mm]} \setupinitial[hoffset=-5mm] \placeinitial \input knuth \stoptext
voffset
\definepapersize[sheet][width=120mm,height=200mm] \setuppapersize[sheet] \setuppagenumbering[location=] \setuplayout[width=100mm,backspace=15mm,topspace=0mm,header=0mm,headerdistance=0mm,footer=0mm,footerdistance=0mm] \starttext Here is some text 1. \setupinitial[color=darkred] \placeinitial \input knuth \blank[big] \type[option=context]{\setupinitial[voffset=0mm]} \setupinitial[voffset=0mm] \placeinitial \input knuth \blank[big] \type[option=context]{\setupinitial[voffset=5mm]} \setupinitial[voffset=5mm] \placeinitial \input knuth \blank[big] \type[option=context]{\setupinitial[voffset=-5mm]} \setupinitial[voffset=-5mm] \placeinitial \input knuth \stoptext
font
\definepapersize[sheet][width=120mm,height=150mm] \setuppapersize[sheet] \setuppagenumbering[location=] \setuplayout[width=100mm,backspace=15mm,topspace=0mm,header=0mm,headerdistance=0mm,footer=0mm,footerdistance=0mm] \starttext Here is some text 1. \setupinitial[color=darkred] \placeinitial \input knuth \blank[big] \type[option=context]{\setupinitial[font=Bold at 45pt]} \setupinitial[font=Bold at 45pt] \placeinitial \input knuth \blank[big] \type[option=context]{\setupinitial[font=SansBold at 45pt]} \setupinitial[font=SansBold at 45pt] \placeinitial \input knuth \stoptext
text
\definepapersize[sheet][width=120mm,height=80mm] \setuppapersize[sheet] \setuppagenumbering[location=] \setuplayout[width=100mm,backspace=15mm,topspace=0mm,header=0mm,headerdistance=0mm,footer=0mm,footerdistance=0mm] \starttext \type[option=context]{\setupinitial[text=Here]} \setupinitial[color=darkred,text=Here] \placeinitial \input knuth \stoptext
Notes
- By Garulfo on 2020-12-12T22:46:03+0100:
- Because the space carved out for the initial is rectangular, initials work best with a font with rectangular ornaments around the letter.
See also
- \defineinitial placeinitial
- typo-drp.mkiv
- \placeinitial placeinitial