Difference between revisions of "Command/ margindata"
< Command
Jump to navigation
Jump to search
(Created page with "Documentation for \<i>margindata</i>") |
(new page) |
||
Line 4: | Line 4: | ||
<cd:shortdesc> | <cd:shortdesc> | ||
<!-- a short command summary goes here --> | <!-- a short command summary goes here --> | ||
− | The instances of <tt>\<i>margindata</i></tt> are used for | + | The instances of <tt>\<i>margindata</i></tt> are used for placing fragments outside of the regular running text. |
</cd:shortdesc> | </cd:shortdesc> | ||
<cd:sequence> | <cd:sequence> | ||
Line 10: | Line 10: | ||
</cd:sequence> | </cd:sequence> | ||
<cd:instances> | <cd:instances> | ||
− | <cd:constant value="inleftmargin"></cd:constant> | + | <cd:constant value="inleftmargin">defined as {{cmd|definemargindata|2=[inleftmargin][left][margin=margin,width=\leftmarginwidth,style=,color=]}}</cd:constant> |
− | <cd:constant value="inrightmargin"></cd:constant> | + | <cd:constant value="inrightmargin">defined as {{cmd|definemargindata|2=[inrightmargin][right][margin=margin,width=\rightmarginwidth,style=,color=]}}</cd:constant> |
− | <cd:constant value="inoutermargin"></cd:constant> | + | <cd:constant value="inoutermargin">defined as {{cmd|definemargindata|2=[inoutermargin][outer][margin=margin,width=\outermarginwidth,style=,color=]}}</cd:constant> |
− | <cd:constant value="ininnermargin"></cd:constant> | + | <cd:constant value="ininnermargin">defined as {{cmd|definemargindata|2=[ininnermargin][inner][margin=margin,width=\innermarginwidth,style=,color=]}}</cd:constant> |
− | <cd:constant value="inleftedge"></cd:constant> | + | <cd:constant value="inleftedge">defined as {{cmd|definemargindata|2=[inleftedge][left][margin=edge,width=\leftedgewidth,style=,color=,category=edge]}}</cd:constant> |
− | <cd:constant value="inrightedge"></cd:constant> | + | <cd:constant value="inrightedge">defined as {{cmd|definemargindata|2=[inrightedge][right][margin=edge,width=\rightedgewidth,style=,color=,category=edge]}}</cd:constant> |
− | <cd:constant value="inouteredge"></cd:constant> | + | <cd:constant value="inouteredge">defined as {{cmd|definemargindata|2=[inouteredge][outer][margin=edge,width=\outeredgewidth,style=,color=,category=edge]}}</cd:constant> |
− | <cd:constant value="ininneredge"></cd:constant> | + | <cd:constant value="ininneredge">defined as {{cmd|definemargindata|2=[ininneredge][inner][margin=edge,width=\inneredgewidth,style=,color=,category=edge]}}</cd:constant> |
− | <cd:constant value="atleftmargin"></cd:constant> | + | <cd:constant value="atleftmargin">defined as {{cmd|definemargindata|2=[atleftmargin][left][margin=normal,width=\leftmarginwidth,style=,color=]}}</cd:constant> |
− | <cd:constant value="atrightmargin"></cd:constant> | + | <cd:constant value="atrightmargin">defined as {{cmd|definemargindata|2=[atrightmargin][right][margin=normal,width=\rightmarginwidth,style=,color=]}}</cd:constant> |
− | <cd:constant value="inleft"></cd:constant> | + | <cd:constant value="inleft">defined as {{cmd|definemargindata|2=[inleft][left][margin=margin,width=\leftmarginwidth,align=flushright]}}</cd:constant> |
− | <cd:constant value="inright"></cd:constant> | + | <cd:constant value="inright">defined as {{cmd|definemargindata|2=[inright][right][margin=margin,width=\rightmarginwidth,align=flushleft]}}</cd:constant> |
− | <cd:constant value="inouter"></cd:constant> | + | <cd:constant value="inouter">defined as {{cmd|definemargindata|2=[inouter][outer][margin=margin,width=\outermarginwidth,align=inner]}}</cd:constant> |
− | <cd:constant value="ininner"></cd:constant> | + | <cd:constant value="ininner">defined as {{cmd|definemargindata|2=[ininner][inner][margin=margin,width=\innermarginwidth,align=outer]}}</cd:constant> |
− | <cd:constant value="inmargin"></cd:constant> | + | <cd:constant value="inmargin">defined as {{cmd|definemargindata|2=[inmargin][left][margin=margin,width=\leftmarginwidth,align=flushright]}}</cd:constant> |
− | <cd:constant value="inother"></cd:constant> | + | <cd:constant value="inother">defined as {{cmd|definemargindata|2=[inother][right][margin=margin,width=\rightmarginwidth,align=flushleft]}}</cd:constant> |
− | <cd:constant value="margintext"></cd:constant> | + | <cd:constant value="margintext">defined as {{cmd|definemargindata|2=[margintext][left][margin=margin,width=\leftmarginwidth,align=flushright,stack=yes]}}</cd:constant> |
</cd:instances> | </cd:instances> | ||
<cd:variants> | <cd:variants> | ||
Line 48: | Line 48: | ||
</cd:variants> | </cd:variants> | ||
<cd:description> | <cd:description> | ||
− | + | Place a paragraph in the margin or edge region. | |
</cd:description> | </cd:description> | ||
<cd:examples> | <cd:examples> | ||
− | < | + | <cd:example> |
− | <cd:example title=""> | + | <texcode> |
+ | \inmargin{\externalfigure | ||
+ | [hass23g] | ||
+ | [width=\marginwidth]} | ||
+ | </texcode> | ||
+ | |||
+ | </cd:example> | ||
+ | |||
+ | <cd:example title="margintext example"> | ||
+ | <context source="yes"> | ||
+ | \setuppapersize[A8,landscape][A8,landscape] | ||
+ | \setuplayout[leftmargin=2.5cm, | ||
+ | leftmargindistance=0.2cm, | ||
+ | backspace=2.9cm, | ||
+ | width=4cm, | ||
+ | rightmargin=0cm] | ||
+ | \showframe | ||
+ | |||
+ | \starttext | ||
+ | \margintext{I have discovered a truly | ||
+ | marvelous proof ... but | ||
+ | this margin is too narrow | ||
+ | to contain it.} | ||
+ | There is no \math{n > 2} to solve | ||
+ | \startformula | ||
+ | a^n + b^n = c^n. | ||
+ | \stopformula | ||
+ | \stoptext | ||
+ | </context> | ||
+ | |||
+ | </cd:example> | ||
+ | <cd:example title="Use in titles"> | ||
+ | Hans wrote that "using inmargin inside a title is sort of unpredictable" and that for titles {{cmd|margintitle}} is the way to go. | ||
+ | <context source="yes"> | ||
+ | \setuppapersize[A8,landscape][A8,landscape] | ||
+ | \setuplayout[leftmargin=2.5cm, | ||
+ | leftmargindistance=0.2cm, | ||
+ | backspace=2.9cm, | ||
+ | width=4cm, | ||
+ | rightmargin=0cm] | ||
+ | \showframe | ||
+ | |||
+ | \starttext | ||
+ | \margintitle{a special command} | ||
+ | \section{section title} | ||
+ | \stoptext | ||
+ | </context> | ||
</cd:example> | </cd:example> | ||
− | |||
</cd:examples> | </cd:examples> | ||
<cd:notes> | <cd:notes> | ||
− | + | <cd:note author="[[User:Taco|Taco]] ([[User talk:Taco|talk]])" date="20:50, 20 August 2020 (CEST)">In [[MkII]] {{cmd|setupmargindata}} was called <code>\setupinmargin</code> | |
− | <cd:note author=" | ||
</cd:note> | </cd:note> | ||
− | |||
</cd:notes> | </cd:notes> | ||
<cd:seealso> | <cd:seealso> | ||
Line 75: | Line 118: | ||
<cd:source file="typo-mar.mkiv" originator="system"></cd:source> | <cd:source file="typo-mar.mkiv" originator="system"></cd:source> | ||
<cd:wikipage originator="system" page="Category:Structure"></cd:wikipage> | <cd:wikipage originator="system" page="Category:Structure"></cd:wikipage> | ||
+ | <cd:wikipage page="Layout"></cd:wikipage> | ||
+ | <cd:commandref name="margintitle"></cd:commandref> | ||
</cd:seealso> | </cd:seealso> | ||
</cd:commandgroup> | </cd:commandgroup> |
Revision as of 18:52, 20 August 2020
Contents
\margindata
Summary
The instances of \margindata are used for placing fragments outside of the regular running text.
Instances
\inleftmargin | defined as \definemargindata[inleftmargin][left][margin=margin,width=\leftmarginwidth,style=,color=] |
\inrightmargin | defined as \definemargindata[inrightmargin][right][margin=margin,width=\rightmarginwidth,style=,color=] |
\inoutermargin | defined as \definemargindata[inoutermargin][outer][margin=margin,width=\outermarginwidth,style=,color=] |
\ininnermargin | defined as \definemargindata[ininnermargin][inner][margin=margin,width=\innermarginwidth,style=,color=] |
\inleftedge | defined as \definemargindata[inleftedge][left][margin=edge,width=\leftedgewidth,style=,color=,category=edge] |
\inrightedge | defined as \definemargindata[inrightedge][right][margin=edge,width=\rightedgewidth,style=,color=,category=edge] |
\inouteredge | defined as \definemargindata[inouteredge][outer][margin=edge,width=\outeredgewidth,style=,color=,category=edge] |
\ininneredge | defined as \definemargindata[ininneredge][inner][margin=edge,width=\inneredgewidth,style=,color=,category=edge] |
\atleftmargin | defined as \definemargindata[atleftmargin][left][margin=normal,width=\leftmarginwidth,style=,color=] |
\atrightmargin | defined as \definemargindata[atrightmargin][right][margin=normal,width=\rightmarginwidth,style=,color=] |
\inleft | defined as \definemargindata[inleft][left][margin=margin,width=\leftmarginwidth,align=flushright] |
\inright | defined as \definemargindata[inright][right][margin=margin,width=\rightmarginwidth,align=flushleft] |
\inouter | defined as \definemargindata[inouter][outer][margin=margin,width=\outermarginwidth,align=inner] |
\ininner | defined as \definemargindata[ininner][inner][margin=margin,width=\innermarginwidth,align=outer] |
\inmargin | defined as \definemargindata[inmargin][left][margin=margin,width=\leftmarginwidth,align=flushright] |
\inother | defined as \definemargindata[inother][right][margin=margin,width=\rightmarginwidth,align=flushleft] |
\margintext | defined as \definemargindata[margintext][left][margin=margin,width=\leftmarginwidth,align=flushright,stack=yes] |
Settings instance
\MARGINDATA[...=...,...][...=...,...]{...} | |
reference | reference |
...=...,... | inherits from \setupmargindata |
...=...,... | inherits from \setupmarginframed |
{...} | content |
Description
Place a paragraph in the margin or edge region.
Examples
Example 1
\inmargin{\externalfigure [hass23g] [width=\marginwidth]}
margintext example
\setuppapersize[A8,landscape][A8,landscape] \setuplayout[leftmargin=2.5cm, leftmargindistance=0.2cm, backspace=2.9cm, width=4cm, rightmargin=0cm] \showframe \starttext \margintext{I have discovered a truly marvelous proof ... but this margin is too narrow to contain it.} There is no \math{n > 2} to solve \startformula a^n + b^n = c^n. \stopformula \stoptext
Use in titles
Hans wrote that "using inmargin inside a title is sort of unpredictable" and that for titles \margintitle is the way to go.
\setuppapersize[A8,landscape][A8,landscape] \setuplayout[leftmargin=2.5cm, leftmargindistance=0.2cm, backspace=2.9cm, width=4cm, rightmargin=0cm] \showframe \starttext \margintitle{a special command} \section{section title} \stoptext
Notes
- In MkII \setupmargindata was called
\setupinmargin
See also
Help from ConTeXt-Mailinglist/Forum
All issues with:
- \inleftmargin on the mailing list (all results)
- \inleftmargin on the mailing list (subject only)
- \inleftmargin on stack exchange
- \inleftmargin in ConTeXt's source
- \inrightmargin on the mailing list (all results)
- \inrightmargin on the mailing list (subject only)
- \inrightmargin on stack exchange
- \inrightmargin in ConTeXt's source
- \inoutermargin on the mailing list (all results)
- \inoutermargin on the mailing list (subject only)
- \inoutermargin on stack exchange
- \inoutermargin in ConTeXt's source
- \ininnermargin on the mailing list (all results)
- \ininnermargin on the mailing list (subject only)
- \ininnermargin on stack exchange
- \ininnermargin in ConTeXt's source
- \inleftedge on the mailing list (all results)
- \inleftedge on the mailing list (subject only)
- \inleftedge on stack exchange
- \inleftedge in ConTeXt's source
- \inrightedge on the mailing list (all results)
- \inrightedge on the mailing list (subject only)
- \inrightedge on stack exchange
- \inrightedge in ConTeXt's source
- \inouteredge on the mailing list (all results)
- \inouteredge on the mailing list (subject only)
- \inouteredge on stack exchange
- \inouteredge in ConTeXt's source
- \ininneredge on the mailing list (all results)
- \ininneredge on the mailing list (subject only)
- \ininneredge on stack exchange
- \ininneredge in ConTeXt's source
- \atleftmargin on the mailing list (all results)
- \atleftmargin on the mailing list (subject only)
- \atleftmargin on stack exchange
- \atleftmargin in ConTeXt's source
- \atrightmargin on the mailing list (all results)
- \atrightmargin on the mailing list (subject only)
- \atrightmargin on stack exchange
- \atrightmargin in ConTeXt's source
- \inleft on the mailing list (all results)
- \inleft on the mailing list (subject only)
- \inleft on stack exchange
- \inleft in ConTeXt's source
- \inright on the mailing list (all results)
- \inright on the mailing list (subject only)
- \inright on stack exchange
- \inright in ConTeXt's source
- \inouter on the mailing list (all results)
- \inouter on the mailing list (subject only)
- \inouter on stack exchange
- \inouter in ConTeXt's source
- \ininner on the mailing list (all results)
- \ininner on the mailing list (subject only)
- \ininner on stack exchange
- \ininner in ConTeXt's source
- \inmargin on the mailing list (all results)
- \inmargin on the mailing list (subject only)
- \inmargin on stack exchange
- \inmargin in ConTeXt's source