3,899
edits
Changes
Command/startuserdata (view source)
Revision as of 10:16, 14 September 2023
, 10:16, 14 September 2023Created page with "Documentation for \startuserdata ... \stopuserdata"
<cd:commandgroup name="userdata" type="environment" xmlns:cd="http://wiki.contextgarden.net/commanddoc/20200807">
<cd:shortdesc>The environment <tt>\startuserdata ... \stopuserdata</tt> is used for user-defined environments with arguments
</cd:shortdesc>
<cd:variants>
<cd:command category="structure" file="strc-usr.mkiv" interfacedate="2020-07-14T09:24" interfacefile="i-userdata.xml" keywords="buffer" level="document" name="userdata" type="environment" variantnumber="1">
<cd:arguments>
<cd:keywords optional="yes" ordinal="1">
<cd:keywordsdoc></cd:keywordsdoc>
<cd:constant type="cd:name"></cd:constant>
</cd:keywords>
<cd:assignments list="yes" optional="yes" ordinal="2">
<cd:assignmentsdoc></cd:assignmentsdoc>
<cd:parameter name="cd:key">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:value"></cd:constant>
</cd:parameter>
</cd:assignments>
</cd:arguments>
</cd:command>
</cd:variants>
<cd:description>The <code>userdata</code> environments provides a optional argument which let you unlike the the <code>\start ... \stop</code> environment pass your own values to the content of the environment.
New layouts for the environment can be created with the <code>\defineuserdataalternative</code> command.
</cd:description>
<cd:examples><cd:example title=""><context source="yes">
\defineuserdataalternative [epigraph] [renderingsetup=userdata:epigraph]
\startsetups [userdata:epigraph]
\startframedtext [location=right,frame=off,align={flushleft,broad},style=\tfx,offset=.25ex,width=.5\textwidth]
\begstrut\getinlineuserdata\endstrut
\hairline
\wordright{\userdataparameter{author}}
\stopframedtext
\stopsetups
\defineuserdata
[epigraph]
[alternative=epigraph]
\startuserdata [epigraph] [author={Sean B. Carrol}]
The fraction of fossil olfactory receptor genes is significantly higher in
all species with full color vision. This suggests that the evolution of
trichromatic vision --- which allows these primates to detect food, mates,
and danger with visual cues --- has reduced their reliance on the sense of
smell.
\stopuserdata
</context></cd:example></cd:examples>
<cd:notes></cd:notes>
<cd:seealso>
<cd:source file="strc-usr.mkiv" originator="system"></cd:source>
<cd:wikipage originator="system" page="Category:Structure"></cd:wikipage>
<cd:wikipage originator="system" page="Keywords:Buffer"></cd:wikipage>
<cd:commandref name="defineuserdata"></cd:commandref>
<cd:commandref name="defineuserdataalternative"></cd:commandref></cd:seealso>
</cd:commandgroup>
<cd:shortdesc>The environment <tt>\startuserdata ... \stopuserdata</tt> is used for user-defined environments with arguments
</cd:shortdesc>
<cd:variants>
<cd:command category="structure" file="strc-usr.mkiv" interfacedate="2020-07-14T09:24" interfacefile="i-userdata.xml" keywords="buffer" level="document" name="userdata" type="environment" variantnumber="1">
<cd:arguments>
<cd:keywords optional="yes" ordinal="1">
<cd:keywordsdoc></cd:keywordsdoc>
<cd:constant type="cd:name"></cd:constant>
</cd:keywords>
<cd:assignments list="yes" optional="yes" ordinal="2">
<cd:assignmentsdoc></cd:assignmentsdoc>
<cd:parameter name="cd:key">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:value"></cd:constant>
</cd:parameter>
</cd:assignments>
</cd:arguments>
</cd:command>
</cd:variants>
<cd:description>The <code>userdata</code> environments provides a optional argument which let you unlike the the <code>\start ... \stop</code> environment pass your own values to the content of the environment.
New layouts for the environment can be created with the <code>\defineuserdataalternative</code> command.
</cd:description>
<cd:examples><cd:example title=""><context source="yes">
\defineuserdataalternative [epigraph] [renderingsetup=userdata:epigraph]
\startsetups [userdata:epigraph]
\startframedtext [location=right,frame=off,align={flushleft,broad},style=\tfx,offset=.25ex,width=.5\textwidth]
\begstrut\getinlineuserdata\endstrut
\hairline
\wordright{\userdataparameter{author}}
\stopframedtext
\stopsetups
\defineuserdata
[epigraph]
[alternative=epigraph]
\startuserdata [epigraph] [author={Sean B. Carrol}]
The fraction of fossil olfactory receptor genes is significantly higher in
all species with full color vision. This suggests that the evolution of
trichromatic vision --- which allows these primates to detect food, mates,
and danger with visual cues --- has reduced their reliance on the sense of
smell.
\stopuserdata
</context></cd:example></cd:examples>
<cd:notes></cd:notes>
<cd:seealso>
<cd:source file="strc-usr.mkiv" originator="system"></cd:source>
<cd:wikipage originator="system" page="Category:Structure"></cd:wikipage>
<cd:wikipage originator="system" page="Keywords:Buffer"></cd:wikipage>
<cd:commandref name="defineuserdata"></cd:commandref>
<cd:commandref name="defineuserdataalternative"></cd:commandref></cd:seealso>
</cd:commandgroup>