Difference between revisions of "Command/setupcombination"

From Wiki
Jump to navigation Jump to search
m (Taco moved page Command/setupcombinations to Command/setupcombination: The main command is \setupcombination, \setupcombinations is just an alias)
(clean up page)
 
Line 1: Line 1:
 
{{Reference
 
{{Reference
|name=setupcombinations
+
|name=setupcombination
 
|attributes=
 
|attributes=
 
}}
 
}}
  
 
== [[Help:Reference|Syntax]] (autogenerated) ==
 
== [[Help:Reference|Syntax]] (autogenerated) ==
<syntax>setupcombinations</syntax>
+
<syntax>setupcombination</syntax>
== [[Help:Reference|Syntax]] ==
+
 
 +
== Settings ==
 
<table cellspacing="4" cellpadding="2" class="cmd">
 
<table cellspacing="4" cellpadding="2" class="cmd">
   <tr>
+
   <tr valign="top" class="first">
    <td colspan="2" class="cmd">\setupcombinations<span class="first" >[...,...=...,...]</span></td>
+
    <td class="cmd">[[Command/keyword:name|name]]</td>
  </tr>
+
     <td colspan="2">Named combinations are defined with {{cmd|definecombination}}</td>
  <tr>
 
     <td colspan="2" class="cmd">\setupcombination<span class="second">[''name defined with {{cmd|definecombination}}'']</span><span class="first" >[...,...=...,...]</span></td>
 
 
   </tr>
 
   </tr>
   <tr valign="top" class="first">
+
   <tr valign="top" class="second">
 
     <td class="cmd">[[Command/keyword:before|before]]</td>
 
     <td class="cmd">[[Command/keyword:before|before]]</td>
     <td>[[Command/value:command|''command'']] to be executed before each item-caption pair</td>
+
     <td>[[Command/value:command|''command'']]</td>
 +
    <td>to be executed before each item-caption pair</td>
 
   </tr>
 
   </tr>
   <tr valign="top" class="first">
+
   <tr valign="top" class="second">
 
     <td class="cmd">[[Command/keyword:nx|nx]]</td>
 
     <td class="cmd">[[Command/keyword:nx|nx]]</td>
     <td>[[Command/value:nx|''number'']] of columns in the combination (default: 2)</td>
+
     <td>[[Command/value:nx|''number'']]</td>
 +
    <td>of columns in the combination (default: 2)</td>
 
   </tr>
 
   </tr>
   <tr valign="top" class="first">
+
   <tr valign="top" class="second">
 
     <td class="cmd">[[Command/keyword:ny|ny]]</td>
 
     <td class="cmd">[[Command/keyword:ny|ny]]</td>
     <td>[[Command/value:ny|''number'']] of rows in the combination (default: as many as needed)</td>
+
     <td>[[Command/value:ny|''number'']]</td>
 +
    <td>of rows in the combination (default: as many as needed)</td>
 
   </tr>
 
   </tr>
  
   <tr valign="top" class="first">
+
   <tr valign="top" class="second">
 
     <td class="cmd">[[Command/keyword:inbetween|inbetween]]</td>
 
     <td class="cmd">[[Command/keyword:inbetween|inbetween]]</td>
     <td>[[Command/value:command|''command'']] to be executed between each item and its caption</td>
+
     <td>[[Command/value:command|''command'']]</td>
 +
    <td>to be executed between each item and its caption</td>
 
   </tr>
 
   </tr>
   <tr valign="top" class="first">
+
   <tr valign="top" class="second">
 
     <td class="cmd">[[Command/keyword:after|after]]</td>
 
     <td class="cmd">[[Command/keyword:after|after]]</td>
     <td>[[Command/value:command|''command'']] to be executed after each item-caption pair</td>
+
     <td>[[Command/value:command|''command'']]</td>
  </tr>
+
    <td>to be executed after each item-caption pair</td>
  <tr valign="top" class="first">
 
    <td class="cmd">[[Command/keyword:distance|distance]]</td>
 
    <td>[[Command/value:dimension|dimension]] </td>
 
  </tr>
 
  <tr valign="top" class="first">
 
    <td class="cmd">[[Command/keyword:height|height]]</td>
 
    <td>[[Command/value:dimension|dimension]] [[Command/value:fit|fit]] </td>
 
  </tr>
 
  <tr valign="top" class="first">
 
    <td class="cmd">[[Command/keyword:width|width]]</td>
 
    <td>[[Command/value:dimension|dimension]] [[Command/value:fit|fit]] </td>
 
  </tr>
 
  <tr valign="top" class="first">
 
    <td class="cmd">[[Command/keyword:location|location]]</td>
 
    <td>[[Command/value:top|top]] [[Command/value:middle|middle]] [[Command/value:bottom|bottom]] [[Command/value:left|left]] [[Command/value:right|right]] </td>
 
  </tr>
 
  <tr valign="top" class="first">
 
    <td class="cmd">[[Command/keyword:align|align]]</td>
 
    <td>[[Command/value:no|no]] [[Command/value:left|left]] [[Command/value:right|right]] [[Command/value:middle|middle]] [[Command/value:normal|normal]] </td>
 
 
   </tr>
 
   </tr>
   <tr valign="top" class="first">
+
   <tr valign="top" class="second">
     <td class="cmd">[[Command/keyword:style|style]]</td>
+
     <td class="cmd" rowspan="2">[[Command/keyword:alternative|alternative]]</td>
     <td>[[Command/value:normal|normal]] [[Command/value:bold|bold]] [[Command/value:slanted|slanted]] [[Command/value:boldslanted|boldslanted]] [[Command/value:type|type]] [[Command/value:cap|cap]] [[Command/value:small... |small]] [[Command/value:command|command]] </td>
+
     <td>text</td>
 +
    <td>interpret every second item in the combination as a caption</td>
 
   </tr>
 
   </tr>
   <tr valign="top" class="first">
+
   <tr valign="top" class="second">
     <td class="cmd">[[Command/keyword:color|color]]</td>
+
     <td>label</td>
     <td>[[Command/value:name|name]] </td>
+
     <td>interpret every item as a figure; labels are automatically added.</td>
 
   </tr>
 
   </tr>
   <tr valign="top" class="first">
+
   <tr valign="top" class="second">
     <td class="cmd">[[Command/keyword:alternative|alternative]]</td>
+
     <td class="cmd" rowspan="2">[[Command/keyword:continue|continue]]</td>
     <td>
+
     <td>yes</td>
{| class="wikitable"
+
    <td>If alternative=label, label numbers (i.e. subfigure numbers) do not reset at the start of each combination</td>
|-
 
| text || interpret every second item in the combination as a caption
 
|-
 
| label || interpret every item as a figure; labels are automatically added.
 
|}</td>
 
 
   </tr>
 
   </tr>
   <tr valign="top" class="first">
+
   <tr valign="top" class="second">
     <td class="cmd">[[Command/keyword:continue|continue]]</td>
+
     <td>no</td>
     <td>
+
     <td>If alternative=label, label numbers reset at the start of each new combination</td>
{| class="wikitable"
 
|-
 
| yes || If alternative=label, label numbers (i.e. subfigure numbers) do not reset at the start of each combination
 
|-
 
| no || If alternative=label, label numbers reset at the start of each new combination
 
|}</td>
 
 
   </tr>
 
   </tr>
 
</table>
 
</table>
Line 99: Line 73:
  
 
The distance between the content and its caption entry is set with the 'inbetween' parameter.
 
The distance between the content and its caption entry is set with the 'inbetween' parameter.
 +
 +
({{cmd|setupcombinations}} is an alias of {{cmd|setupcombination}}, but it looks more natural to use that when adjusting anonymous combination settings.)
 +
  
 
== See also ==
 
== See also ==
 +
* {{cmd|definecombination}} for how to create a named instance of a combination
 
* {{cmd|startcombination}} for an example of {{code|alternative=label}}
 
* {{cmd|startcombination}} for an example of {{code|alternative=label}}
 
* {{cmd|placefloat}} to float a combination
 
* {{cmd|placefloat}} to float a combination
Line 109: Line 87:
 
{{Forum|{{SUBPAGENAME}}}}
 
{{Forum|{{SUBPAGENAME}}}}
  
[[Category:Command/Floating|setupcombinations]]
+
[[Category:Command/Floating|setupcombination]]

Latest revision as of 08:06, 29 June 2020

\setupcombination

Syntax (autogenerated)

\setupcombination[...,...][...=...,...]
[...,...]name
nxnumber
nynumber
widthfit dimension
heightfit dimension
locationleft middle right top bottom
distancedimension
alternativelabel text
alignsee \setupalign
continueyes no
beforecommand
aftercommand
inbetweencommand
stylestyle command
colorcolor


Settings

name Named combinations are defined with \definecombination
before command to be executed before each item-caption pair
nx number of columns in the combination (default: 2)
ny number of rows in the combination (default: as many as needed)
inbetween command to be executed between each item and its caption
after command to be executed after each item-caption pair
alternative text interpret every second item in the combination as a caption
label interpret every item as a figure; labels are automatically added.
continue yes If alternative=label, label numbers (i.e. subfigure numbers) do not reset at the start of each combination
no If alternative=label, label numbers reset at the start of each new combination


Description

Set up the behaviour of \startcombination or \startcombination[mycombination]. These parameters may also be used ad-hoc in the options parameter of \startcombination.

Example

  • Suppressing both the horizontal and vertical gap between cells:
\setupcombinations[distance=0mm,after=]
  • a 10mm horizontal and vertical gap between cells:
\setupcombinations[distance=10mm,after={\blank[10mm]}]

The distance between the content and its caption entry is set with the 'inbetween' parameter.

(\setupcombinations is an alias of \setupcombination, but it looks more natural to use that when adjusting anonymous combination settings.)


See also

Help from ConTeXt-Mailinglist/Forum

All issues with: