gardener, Interface administrators, Administrators
1,539
edits
Changes
Jump to navigation
Jump to search
renewed from non-template page
<cd:commandgroup name="setupinteraction" xmlns:cd="http://wiki.contextgarden.net/commanddoc/20200807">
<cd:shortdesc><!-- a short command summary goes here -->
The command <tt>\setupinteraction</tt> is used for ...
</cd:shortdesc>
<cd:variants>
<cd:command category="pdf" file="scrn-ini.mkvi" interfacedate="2020-07-14T09:24" interfacefile="i-interaction.xml" level="style" name="setupinteraction" variantnumber="1">
<cd:arguments>
<cd:keywords list="yes" optional="yes" ordinal="1">
<cd:keywordsdoc></cd:keywordsdoc>
<cd:constant type="cd:name"></cd:constant>
</cd:keywords>
<cd:assignments list="yes" ordinal="2">
<cd:assignmentsdoc></cd:assignmentsdoc>
<cd:parameter name="state">
<cd:paramdoc>Enable/disable interaction, i.e. clickable links</cd:paramdoc>
<cd:constant type="start"></cd:constant>
<cd:constant default="yes" type="stop"></cd:constant>
</cd:parameter>
<cd:parameter name="style">
<cd:paramdoc>style of links; use `style=,` to disable styling of links</cd:paramdoc>
<cd:constant type="cd:style"></cd:constant>
<cd:constant type="cd:command"></cd:constant>
</cd:parameter>
<cd:parameter name="color">
<cd:paramdoc>This color is used if the destination of the reference is on a different page from the reference itself.</cd:paramdoc>
<cd:constant type="cd:color"></cd:constant>
</cd:parameter>
<cd:parameter name="contrastcolor">
<cd:paramdoc>This color is used if the destination of the reference is on the same page as the reference itself.</cd:paramdoc>
<cd:constant type="cd:color"></cd:constant>
</cd:parameter>
<cd:parameter name="title">
<cd:paramdoc>PDF metadata “title”</cd:paramdoc>
<cd:constant type="cd:text"></cd:constant>
</cd:parameter>
<cd:parameter name="subtitle">
<cd:paramdoc>PDF metadata “subject”, i.e. goes into the <tt>/Subject</tt> field of the document information dictionary.</cd:paramdoc>
<cd:constant type="cd:color"></cd:constant>
</cd:parameter>
<cd:parameter name="author">
<cd:paramdoc>PDF metadata “author”</cd:paramdoc>
<cd:constant type="cd:text"></cd:constant>
</cd:parameter>
<cd:parameter name="date">
<cd:paramdoc>PDF metadata “creation date”</cd:paramdoc>
<cd:constant type="cd:text"></cd:constant>
</cd:parameter>
<cd:parameter name="keyword">
<cd:paramdoc>PDF metadata "keywords"</cd:paramdoc>
<cd:constant type="cd:text"></cd:constant>
</cd:parameter>
<cd:parameter name="focus">
<cd:paramdoc>link target behaviour</cd:paramdoc>
<cd:constant type="standard">Make PDF links open in current zoom setting. (When the PDF viewer is in 'scroll' mode, this setting jumps directly to the target rather than to the page it is on. Omitting <code>focus=standard</code> causes the viewer to jump to the page, regardless of whether in scroll mode or not.)</cd:constant>
<cd:constant type="frame"></cd:constant>
<cd:constant type="width">Make PDF links open in 'Fit width' mode</cd:constant>
<cd:constant type="minwidth"></cd:constant>
<cd:constant type="height">Make PDF links open in 'Fit height' mode</cd:constant>
<cd:constant type="minheight"></cd:constant>
<cd:constant default="yes" type="fit">Make PDF links open in 'Fit page' mode</cd:constant>
<cd:constant type="tight"></cd:constant>
</cd:parameter>
<cd:parameter name="menu">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="on"></cd:constant>
<cd:constant default="yes" type="off"></cd:constant>
</cd:parameter>
<cd:parameter name="fieldlayer">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="auto"></cd:constant>
<cd:constant type="cd:name"></cd:constant>
</cd:parameter>
<cd:parameter name="calculate">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:reference"></cd:constant>
</cd:parameter>
<cd:parameter name="click">
<cd:paramdoc>Hyperlink highlighting when clicked (<tt>/H</tt> <tt>/N</tt>)</cd:paramdoc>
<cd:constant type="yes"></cd:constant>
<cd:constant type="no"></cd:constant>
</cd:parameter>
<cd:parameter name="display">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="normal"></cd:constant>
<cd:constant type="new"></cd:constant>
</cd:parameter>
<cd:parameter name="page">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="yes"></cd:constant>
<cd:constant default="yes" type="no"></cd:constant>
<cd:constant type="page"></cd:constant>
<cd:constant type="name"></cd:constant>
<cd:constant type="auto"></cd:constant>
</cd:parameter>
<cd:parameter name="openaction">
<cd:paramdoc>- <code>FitWidth</code> Make the PDF open in 'Fit width' mode
- <code>FitHeight</code> Make the PDF open in 'Fit height' mode
- <code>ToggleViewer</code> Make the PDF open in fullscreen mode.
</cd:paramdoc>
<cd:constant type="cd:reference"></cd:constant>
</cd:parameter>
<cd:parameter name="closeaction">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:reference"></cd:constant>
</cd:parameter>
<cd:parameter name="openpageaction">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:reference"></cd:constant>
</cd:parameter>
<cd:parameter name="closepageaction">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:reference"></cd:constant>
</cd:parameter>
<cd:parameter name="symbolset">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:name"></cd:constant>
</cd:parameter>
<cd:parameter name="height">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:dimension"></cd:constant>
</cd:parameter>
<cd:parameter name="depth">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:dimension"></cd:constant>
</cd:parameter>
<cd:parameter name="focusoffset">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:dimension"></cd:constant>
</cd:parameter>
</cd:assignments>
</cd:arguments>
</cd:command>
<cd:command category="pdf" file="scrn-ini.mkvi" interfacedate="2020-07-14T09:24" interfacefile="i-interaction.xml" level="style" name="setupinteraction" variant="name" variantnumber="2">
<cd:arguments>
<cd:keywords optional="yes" ordinal="1">
<cd:keywordsdoc></cd:keywordsdoc>
<cd:constant type="cd:name"></cd:constant>
</cd:keywords>
</cd:arguments>
</cd:command>
</cd:variants>
<cd:description><!-- the long description of the command goes here -->
</cd:description>
<cd:examples><cd:example title=""><texcode>
\setupinteraction
[state=start,
color=green,
style=bold]
</texcode>
</cd:example></cd:examples>
<cd:notes></cd:notes>
<cd:seealso>
<cd:commandref name="defineinteraction" originator="system"></cd:commandref>
<cd:source file="scrn-ini.mkvi" originator="system"></cd:source>
<cd:wikipage originator="system" page="Category:Pdf"></cd:wikipage>
<cd:wikipage page="Interaction"></cd:wikipage>
<cd:commandref name="setupinteractionscreen"></cd:commandref>
<cd:commandref name="setupmetadata"></cd:commandref></cd:seealso>
</cd:commandgroup>
<cd:shortdesc><!-- a short command summary goes here -->
The command <tt>\setupinteraction</tt> is used for ...
</cd:shortdesc>
<cd:variants>
<cd:command category="pdf" file="scrn-ini.mkvi" interfacedate="2020-07-14T09:24" interfacefile="i-interaction.xml" level="style" name="setupinteraction" variantnumber="1">
<cd:arguments>
<cd:keywords list="yes" optional="yes" ordinal="1">
<cd:keywordsdoc></cd:keywordsdoc>
<cd:constant type="cd:name"></cd:constant>
</cd:keywords>
<cd:assignments list="yes" ordinal="2">
<cd:assignmentsdoc></cd:assignmentsdoc>
<cd:parameter name="state">
<cd:paramdoc>Enable/disable interaction, i.e. clickable links</cd:paramdoc>
<cd:constant type="start"></cd:constant>
<cd:constant default="yes" type="stop"></cd:constant>
</cd:parameter>
<cd:parameter name="style">
<cd:paramdoc>style of links; use `style=,` to disable styling of links</cd:paramdoc>
<cd:constant type="cd:style"></cd:constant>
<cd:constant type="cd:command"></cd:constant>
</cd:parameter>
<cd:parameter name="color">
<cd:paramdoc>This color is used if the destination of the reference is on a different page from the reference itself.</cd:paramdoc>
<cd:constant type="cd:color"></cd:constant>
</cd:parameter>
<cd:parameter name="contrastcolor">
<cd:paramdoc>This color is used if the destination of the reference is on the same page as the reference itself.</cd:paramdoc>
<cd:constant type="cd:color"></cd:constant>
</cd:parameter>
<cd:parameter name="title">
<cd:paramdoc>PDF metadata “title”</cd:paramdoc>
<cd:constant type="cd:text"></cd:constant>
</cd:parameter>
<cd:parameter name="subtitle">
<cd:paramdoc>PDF metadata “subject”, i.e. goes into the <tt>/Subject</tt> field of the document information dictionary.</cd:paramdoc>
<cd:constant type="cd:color"></cd:constant>
</cd:parameter>
<cd:parameter name="author">
<cd:paramdoc>PDF metadata “author”</cd:paramdoc>
<cd:constant type="cd:text"></cd:constant>
</cd:parameter>
<cd:parameter name="date">
<cd:paramdoc>PDF metadata “creation date”</cd:paramdoc>
<cd:constant type="cd:text"></cd:constant>
</cd:parameter>
<cd:parameter name="keyword">
<cd:paramdoc>PDF metadata "keywords"</cd:paramdoc>
<cd:constant type="cd:text"></cd:constant>
</cd:parameter>
<cd:parameter name="focus">
<cd:paramdoc>link target behaviour</cd:paramdoc>
<cd:constant type="standard">Make PDF links open in current zoom setting. (When the PDF viewer is in 'scroll' mode, this setting jumps directly to the target rather than to the page it is on. Omitting <code>focus=standard</code> causes the viewer to jump to the page, regardless of whether in scroll mode or not.)</cd:constant>
<cd:constant type="frame"></cd:constant>
<cd:constant type="width">Make PDF links open in 'Fit width' mode</cd:constant>
<cd:constant type="minwidth"></cd:constant>
<cd:constant type="height">Make PDF links open in 'Fit height' mode</cd:constant>
<cd:constant type="minheight"></cd:constant>
<cd:constant default="yes" type="fit">Make PDF links open in 'Fit page' mode</cd:constant>
<cd:constant type="tight"></cd:constant>
</cd:parameter>
<cd:parameter name="menu">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="on"></cd:constant>
<cd:constant default="yes" type="off"></cd:constant>
</cd:parameter>
<cd:parameter name="fieldlayer">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="auto"></cd:constant>
<cd:constant type="cd:name"></cd:constant>
</cd:parameter>
<cd:parameter name="calculate">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:reference"></cd:constant>
</cd:parameter>
<cd:parameter name="click">
<cd:paramdoc>Hyperlink highlighting when clicked (<tt>/H</tt> <tt>/N</tt>)</cd:paramdoc>
<cd:constant type="yes"></cd:constant>
<cd:constant type="no"></cd:constant>
</cd:parameter>
<cd:parameter name="display">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="normal"></cd:constant>
<cd:constant type="new"></cd:constant>
</cd:parameter>
<cd:parameter name="page">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="yes"></cd:constant>
<cd:constant default="yes" type="no"></cd:constant>
<cd:constant type="page"></cd:constant>
<cd:constant type="name"></cd:constant>
<cd:constant type="auto"></cd:constant>
</cd:parameter>
<cd:parameter name="openaction">
<cd:paramdoc>- <code>FitWidth</code> Make the PDF open in 'Fit width' mode
- <code>FitHeight</code> Make the PDF open in 'Fit height' mode
- <code>ToggleViewer</code> Make the PDF open in fullscreen mode.
</cd:paramdoc>
<cd:constant type="cd:reference"></cd:constant>
</cd:parameter>
<cd:parameter name="closeaction">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:reference"></cd:constant>
</cd:parameter>
<cd:parameter name="openpageaction">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:reference"></cd:constant>
</cd:parameter>
<cd:parameter name="closepageaction">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:reference"></cd:constant>
</cd:parameter>
<cd:parameter name="symbolset">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:name"></cd:constant>
</cd:parameter>
<cd:parameter name="height">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:dimension"></cd:constant>
</cd:parameter>
<cd:parameter name="depth">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:dimension"></cd:constant>
</cd:parameter>
<cd:parameter name="focusoffset">
<cd:paramdoc></cd:paramdoc>
<cd:constant type="cd:dimension"></cd:constant>
</cd:parameter>
</cd:assignments>
</cd:arguments>
</cd:command>
<cd:command category="pdf" file="scrn-ini.mkvi" interfacedate="2020-07-14T09:24" interfacefile="i-interaction.xml" level="style" name="setupinteraction" variant="name" variantnumber="2">
<cd:arguments>
<cd:keywords optional="yes" ordinal="1">
<cd:keywordsdoc></cd:keywordsdoc>
<cd:constant type="cd:name"></cd:constant>
</cd:keywords>
</cd:arguments>
</cd:command>
</cd:variants>
<cd:description><!-- the long description of the command goes here -->
</cd:description>
<cd:examples><cd:example title=""><texcode>
\setupinteraction
[state=start,
color=green,
style=bold]
</texcode>
</cd:example></cd:examples>
<cd:notes></cd:notes>
<cd:seealso>
<cd:commandref name="defineinteraction" originator="system"></cd:commandref>
<cd:source file="scrn-ini.mkvi" originator="system"></cd:source>
<cd:wikipage originator="system" page="Category:Pdf"></cd:wikipage>
<cd:wikipage page="Interaction"></cd:wikipage>
<cd:commandref name="setupinteractionscreen"></cd:commandref>
<cd:commandref name="setupmetadata"></cd:commandref></cd:seealso>
</cd:commandgroup>
