Difference between revisions of "Command/setupdescription"
< Command
Jump to navigation
Jump to search
(Created page with "Documentation for \setupdescription") |
|||
| (One intermediate revision by the same user not shown) | |||
| Line 22: | Line 22: | ||
</cd:parameter> | </cd:parameter> | ||
<cd:parameter name="text"> | <cd:parameter name="text"> | ||
| − | <cd:paramdoc></cd:paramdoc> | + | <cd:paramdoc>Text before a head.</cd:paramdoc> |
<cd:constant type="cd:text"></cd:constant> | <cd:constant type="cd:text"></cd:constant> | ||
</cd:parameter> | </cd:parameter> | ||
| Line 30: | Line 30: | ||
</cd:parameter> | </cd:parameter> | ||
<cd:parameter name="before"> | <cd:parameter name="before"> | ||
| − | <cd:paramdoc></cd:paramdoc> | + | <cd:paramdoc>Key that defines what happens before the enumeration starts. With this key and the <cd:iref name="after"/> key on can achieve the same effect as in itemize with the option "packed"</cd:paramdoc> |
<cd:constant type="cd:command"></cd:constant> | <cd:constant type="cd:command"></cd:constant> | ||
</cd:parameter> | </cd:parameter> | ||
<cd:parameter name="after"> | <cd:parameter name="after"> | ||
| − | <cd:paramdoc></cd:paramdoc> | + | <cd:paramdoc>Key that defines what happens after an enumeration stops.</cd:paramdoc> |
<cd:constant type="cd:command"></cd:constant> | <cd:constant type="cd:command"></cd:constant> | ||
</cd:parameter> | </cd:parameter> | ||
<cd:parameter name="inbetween"> | <cd:parameter name="inbetween"> | ||
| − | <cd:paramdoc></cd:paramdoc> | + | <cd:paramdoc>This key is used when the title is on top. The key controls what can be placed between title and text.</cd:paramdoc> |
<cd:constant type="cd:command"></cd:constant> | <cd:constant type="cd:command"></cd:constant> | ||
</cd:parameter> | </cd:parameter> | ||
| Line 78: | Line 78: | ||
</cd:parameter> | </cd:parameter> | ||
<cd:parameter name="indentnext"> | <cd:parameter name="indentnext"> | ||
| − | <cd:paramdoc></cd:paramdoc> | + | <cd:paramdoc>control the indentation of the following paragraph.</cd:paramdoc> |
<cd:constant type="yes"></cd:constant> | <cd:constant type="yes"></cd:constant> | ||
<cd:constant type="no"></cd:constant> | <cd:constant type="no"></cd:constant> | ||
| Line 84: | Line 84: | ||
</cd:parameter> | </cd:parameter> | ||
<cd:parameter name="width"> | <cd:parameter name="width"> | ||
| − | <cd:paramdoc></cd:paramdoc> | + | <cd:paramdoc>Width of the description head. |
| − | <cd:constant type="fit"></cd:constant> | + | </cd:paramdoc> |
| − | <cd:constant type="broad"></cd:constant> | + | <cd:constant type="fit">equal to the head width</cd:constant> |
| + | <cd:constant type="broad">equal to the head width plus distance option</cd:constant> | ||
<cd:constant type="line"></cd:constant> | <cd:constant 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="distance"> | <cd:parameter name="distance"> | ||
| − | <cd:paramdoc></cd:paramdoc> | + | <cd:paramdoc>See <cd:iref name="width" type="broad"/>.</cd:paramdoc> |
<cd:constant type="none"></cd:constant> | <cd:constant type="none"></cd:constant> | ||
<cd:constant type="cd:dimension"></cd:constant> | <cd:constant type="cd:dimension"></cd:constant> | ||
| Line 109: | Line 110: | ||
<cd:constant type="none"></cd:constant> | <cd:constant type="none"></cd:constant> | ||
<cd:constant type="margin"></cd:constant> | <cd:constant type="margin"></cd:constant> | ||
| − | <cd:constant type="cd:number"></cd:constant> | + | <cd:constant type="cd:number">stop indentation of the left edge after this many lines</cd:constant> |
</cd:parameter> | </cd:parameter> | ||
<cd:parameter name="closesymbol"> | <cd:parameter name="closesymbol"> | ||
| Line 132: | Line 133: | ||
</cd:parameter> | </cd:parameter> | ||
<cd:parameter name="sample"> | <cd:parameter name="sample"> | ||
| − | <cd:paramdoc></cd:paramdoc> | + | <cd:paramdoc>Text that defines the width of the paragraph.</cd:paramdoc> |
<cd:constant type="cd:text"></cd:constant> | <cd:constant type="cd:text"></cd:constant> | ||
</cd:parameter> | </cd:parameter> | ||
<cd:parameter name="margin"> | <cd:parameter name="margin"> | ||
| − | <cd:paramdoc></cd:paramdoc> | + | <cd:paramdoc>Overall (head and paragraph) left edge indenting.</cd:paramdoc> |
<cd:constant type="yes"></cd:constant> | <cd:constant type="yes"></cd:constant> | ||
<cd:constant type="no"></cd:constant> | <cd:constant type="no"></cd:constant> | ||
| Line 179: | Line 180: | ||
<cd:commandref name="setupindenting" originator="system"></cd:commandref> | <cd:commandref name="setupindenting" originator="system"></cd:commandref> | ||
<cd:source file="strc-des.mkvi" originator="system"></cd:source> | <cd:source file="strc-des.mkvi" originator="system"></cd:source> | ||
| − | <cd:wikipage originator="system" page="Category:Structure"></cd:wikipage></cd:seealso> | + | <cd:wikipage originator="system" page="Category:Structure"></cd:wikipage> |
| + | <cd:wikipage page="Description"></cd:wikipage></cd:seealso> | ||
</cd:commandgroup> | </cd:commandgroup> | ||
Latest revision as of 12:48, 29 October 2021
Contents
\setupdescription
Summary
The command \setupdescription is used to setup description environments
Settings
| \setupdescription[...,...][...=...,...] | |
| [...,...] | name |
| title | yes no |
| level | number |
| text | text |
| headcommand | oneargument |
| before | command |
| after | command |
| inbetween | command |
| alternative | left right inmargin inleft inright margin leftmargin rightmargin innermargin outermargin serried hanging top empty command name |
| align | see \setupalign |
| headalign | see \setupalign |
| indenting | see \setupindenting |
| display | yes no |
| indentnext | yes no auto |
| width | fit broad line dimension |
| distance | none dimension |
| stretch | number |
| shrink | number |
| hang | fit broad none margin number |
| closesymbol | command |
| closecommand | oneargument |
| expansion | yes no xml |
| referenceprefix | + - text |
| sample | text |
| margin | yes no standard dimension |
| style | style command |
| color | color |
| headstyle | style command |
| headcolor | color |
| aligntitle | yes no |
| Option | Explanation | ||||||
|---|---|---|---|---|---|---|---|
| text |
| ||||||
| before |
| ||||||
| after |
| ||||||
| inbetween |
| ||||||
| indentnext |
| ||||||
| width |
| ||||||
| distance |
| ||||||
| hang |
| ||||||
| sample |
| ||||||
| margin |
| ||||||
