Difference between revisions of "Command/columnbreak"

From Wiki
Jump to navigation Jump to search
(Created page with "Documentation for \columnbreak")
 
 
Line 7: Line 7:
 
   <cd:arguments>
 
   <cd:arguments>
 
     <cd:keywords list="yes" optional="yes" ordinal="1">
 
     <cd:keywords list="yes" optional="yes" ordinal="1">
     <cd:keywordsdoc></cd:keywordsdoc>
+
     <cd:keywordsdoc>Many of the options only work in [[Columns#Column_Sets|column set]] environments
     <cd:constant type="yes"></cd:constant>
+
 
 +
A missing argument is the same as 'yes'.
 +
</cd:keywordsdoc>
 +
     <cd:constant type="yes">move to the next column</cd:constant>
 
     <cd:constant type="no"></cd:constant>
 
     <cd:constant type="no"></cd:constant>
     <cd:constant type="preference"></cd:constant>
+
     <cd:constant type="preference">inserts a {{cmd|goodbreak}}</cd:constant>
     <cd:constant type="local"></cd:constant>
+
     <cd:constant type="local">move to the next nested column instead of the global column (only works in column sets)</cd:constant>
     <cd:constant type="force"></cd:constant>
+
     <cd:constant type="force">just in case it doesn't work right away ...</cd:constant>
     <cd:constant type="first"></cd:constant>
+
     <cd:constant type="first">move to the first column (only works in column sets forces a page break first)</cd:constant>
     <cd:constant type="last"></cd:constant>
+
     <cd:constant type="last">move to the last column (only works in column sets)</cd:constant>
     <cd:constant type="cd:number"></cd:constant>
+
     <cd:constant type="cd:number">move to this column number (only works in column sets, forces a page break first)</cd:constant>
     <cd:constant type="cd:name"></cd:constant>
+
     <cd:constant type="cd:name">move to this named column (only works in column sets)</cd:constant>
 
     </cd:keywords>
 
     </cd:keywords>
 
   </cd:arguments>
 
   </cd:arguments>
 
   </cd:command>
 
   </cd:command>
 
</cd:variants>
 
</cd:variants>
<cd:description><!-- the long description of the command goes here -->
+
<cd:description>Go to the next column in a {{cmd|startcolumns}} environment or in a [[Columns#Column_Sets|column set]] environment.
 
</cd:description>
 
</cd:description>
<cd:examples></cd:examples>
+
<cd:examples><cd:example title=""><context source="yes">
 +
\setuppapersize[A6]
 +
\setupwhitespace[big]
 +
 
 +
Below, we have two separate columns; but up here, for the nonce, we have but the one.
 +
 
 +
\startcolumns[n=2]  % Two columns, please
 +
    Text, text, text \dots
 +
    all in the first column
 +
\column
 +
    Words, words, words \dots
 +
    all in the second column.
 +
    And look ye here! Even more words!
 +
\stopcolumns
 +
</context></cd:example></cd:examples>
 
<cd:notes></cd:notes>
 
<cd:notes></cd:notes>
 
<cd:seealso>
 
<cd:seealso>
 
<cd:source file="page-brk.mkiv" originator="system"></cd:source>
 
<cd:source file="page-brk.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 originator="system" page="Keywords:Columns"></cd:wikipage></cd:seealso>
+
<cd:wikipage originator="system" page="Keywords:Columns"></cd:wikipage>
 +
<cd:commandref name="page">to move to the next page</cd:commandref>
 +
<cd:commandref name="startcolumns">for the columns environment</cd:commandref>
 +
<cd:commandref name="paragraph">to move to the next column in a {{cmd|startparagraph}} environment.</cd:commandref></cd:seealso>
 
</cd:commandgroup>
 
</cd:commandgroup>

Latest revision as of 13:15, 16 December 2020


\columnbreak

Summary

The command \columnbreak is used to break a column in multicolumn environments

Settings

\columnbreak[...,...]
[...,...]yes no preference local force first last number name

OptionExplanation
Many of the options only work in column set environments

A missing argument is the same as 'yes'.

yes move to the next column
preference inserts a \goodbreak
local move to the next nested column instead of the global column (only works in column sets)
force just in case it doesn't work right away ...
first move to the first column (only works in column sets forces a page break first)
last move to the last column (only works in column sets)
number move to this column number (only works in column sets, forces a page break first)
name move to this named column (only works in column sets)

Description

Go to the next column in a \startcolumns environment or in a column set environment.

Examples

Example 1

\setuppapersize[A6]
\setupwhitespace[big]

Below, we have two separate columns; but up here, for the nonce, we have but the one.

\startcolumns[n=2]  % Two columns, please
    Text, text, text \dots
    all in the first column
\column
    Words, words, words \dots
    all in the second column.
    And look ye here! Even more words!
\stopcolumns

Notes

See also

Help from ConTeXt-Mailinglist/Forum

All issues with: