Difference between revisions of "Command/setupinitial"
< Command
Jump to navigation
Jump to search
Line 23: | Line 23: | ||
</cd:parameter> | </cd:parameter> | ||
<cd:parameter name="before"> | <cd:parameter name="before"> | ||
− | <cd:paramdoc> | + | <cd:paramdoc>contains any commands that you would like to do prior to placing the initial. This parameter is empty by default. |
+ | |||
+ | For example, to insert 2 big space before placement of the initial, | ||
<code>before={\blank[2*big]}]</code></cd:paramdoc> | <code>before={\blank[2*big]}]</code></cd:paramdoc> | ||
<cd:constant type="cd:command"></cd:constant> | <cd:constant type="cd:command"></cd:constant> | ||
</cd:parameter> | </cd:parameter> | ||
<cd:parameter name="distance"> | <cd:parameter name="distance"> | ||
− | <cd:paramdoc>"offsets the following text" or "distance to the following text"</cd:paramdoc> | + | <cd:paramdoc>is 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. |
+ | |||
+ | Another description can be "offsets the following text", or "distance to the following text"</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>shift the initial horizontally, on the | + | <cd:paramdoc>is the distance to the left (into the left margin) that the initial should be shifted from its default position. This defaults to 0pt. |
+ | |||
+ | Another description can be "shift the initial horizontally, on the left (positive value) or on the right (negative value)"</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>shift the initial vertically, down (positive value) or up (negative value). | + | <cd:paramdoc>is the distance downward from its default position that the initial should be shifted. This defaults to 0pt. |
+ | |||
+ | Another description can be "shift the initial vertically, down (positive value) or up (negative value). | ||
+ | |||
Value 0pt gives a "top" alignment.</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> | ||
Line 47: | Line 56: | ||
</cd:parameter> | </cd:parameter> | ||
<cd:parameter name="color"> | <cd:parameter name="color"> | ||
− | <cd:paramdoc>color, for example <code>color=darkred</code></cd:paramdoc> | + | <cd:paramdoc>which defaults to the current color, for example <code>color=darkred</code></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, for example <code>font=Bold at 32pt</code></cd:paramdoc> | + | <cd:paramdoc>font specification which defaults to boldface scaled to the number of text lines that the initial occupies, 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> |
Revision as of 17:06, 12 December 2020
Contents
\setupinitial
Summary
The command
\setupinitial
is used for providing a decorative or ornate first letter to prose at the start of chapters, sections, 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 |
| ||
location |
|
Description
Examples
Notes
See also
- \defineinitial placeinitial
- typo-drp.mkiv
- \placeinitial placeinitial