Difference between revisions of "Command/setupinitial"

From Wiki
Jump to navigation Jump to search
Line 23: Line 23:
 
     </cd:parameter>
 
     </cd:parameter>
 
     <cd:parameter name="before">
 
     <cd:parameter name="before">
       <cd:paramdoc>for example, to insert 2 big space before placement of the initial,
+
       <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 "left" (positive value) or on the right (negative value)</cd:paramdoc>
+
       <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


\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
nnumber
mnumber
beforecommand
distancedimension
hoffsetdimension
voffsetline dimension
stylestyle command
colorcolor
fontfont
texttext
locationmargin text
methodfirst last auto none

OptionExplanation
n
the number of lines in the paragraph that the initial should occupy. It defaults to 3. Another description can be "line where footline of dropcapital"
m
number of letters to capitalize
before
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,

before={\blank[2*big]}]
distance
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"
hoffset
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)"
voffset
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.
style
style of the initial, for example style=\tex{bfd} for large bold
color
which defaults to the current color, for example color=darkred
font
font specification which defaults to boldface scaled to the number of text lines that the initial occupies, for example font=Bold at 32pt
location
default is text, but initial can be placed in the margin with location=margin

Description

Examples

Notes

See also

Help from ConTeXt-Mailinglist/Forum

All issues with: