Difference between revisions of "Command/defineenumeration"

From Wiki
Jump to navigation Jump to search
m (Add See Also)
Line 30: Line 30:
 
\defineenumeration
 
\defineenumeration
 
[remark]
 
[remark]
[location=top,
+
[location=top,     % use alternative=top in MKIV
 
text=Remark,        % Display header as "Remark 1"
 
text=Remark,        % Display header as "Remark 1"
 
headstyle=bold,    % Bold remark headers
 
headstyle=bold,    % Bold remark headers
Line 39: Line 39:
 
This creates the new commands <code>\remark</code>, <code>\resetremark</code>, <code>\nextremark</code>, and <code>\startremark</code> ... <code>\stopremark</code>, as well as the same commands for <code>subremark</code> and <code>subsubremark</code>.
 
This creates the new commands <code>\remark</code>, <code>\resetremark</code>, <code>\nextremark</code>, and <code>\startremark</code> ... <code>\stopremark</code>, as well as the same commands for <code>subremark</code> and <code>subsubremark</code>.
  
== Example ==
+
== Examples ==
  
 
<context source="yes" text="Gives:">
 
<context source="yes" text="Gives:">
Line 66: Line 66:
  
 
   \subsubremark Presto!
 
   \subsubremark Presto!
 +
 +
\stoptext
 +
</context>
 +
 +
The heading can be placed on the same line as the text that follows by using location (or alternative in MKIV) 'left'. The width of the header is controlled by the 'width' parameter, and the spacing to the text by the 'distance' parameter. The text on the left side of the number is defined by 'left' and the text on the right by the 'right' parameter. Below the chapter number is appended before the enumeration number. The text before the number can be overridden with the 'text' parameter. Before we override the default text 'remark' with no value.
 +
 +
<context source="yes" text="Gives:">
 +
\starttext
 +
 +
\chapter[chpt1]{Chapter 1}
 +
 +
\defineenumeration[remark]
 +
    [location=left,left={\in[chpt1]}.,right=:,width=0.3in,distance=0.02in,text=]
 +
 +
  \remark
 +
    An enumeration (\tex{remark}, in this case) takes the paragraph that follows
 +
    it as its argument.
 +
 +
  \remark
 +
    This is the first paragraph after \tex{remark}. It is part of the remark.
 +
 +
    This is the second paragraph after \tex{remark}. It is not part of the remark.
 +
 +
  \startremark
 +
    This is the first paragraph inside \tex{startremark}. It is part of the remark.
 +
 +
    This is the second paragraph inside \tex{startremark}. It is part of the remark. 
 +
  \stopremark
  
 
\stoptext
 
\stoptext

Revision as of 14:42, 1 May 2013

\defineenumeration

Syntax

\defineenumeration[...,...,...][...][...,...=...,...]
[...,...,...] name
[...] name
[...,...=...,...] see \setupenumerations


Description

With \defineenumeration you can define the commands for a numbered text element, like remarks or questions. For example, if you want numbered remarks in your document you can define the environment as follows:

\defineenumeration
[remark]
[location=top,      % use alternative=top in MKIV
text=Remark,        % Display header as "Remark 1"
headstyle=bold,     % Bold remark headers
inbetween={\blank[nowhite]},   % No blank line between remark header and remark
after=\blank]       % Blank line after the remark.

This creates the new commands \remark, \resetremark, \nextremark, and \startremark ... \stopremark, as well as the same commands for subremark and subsubremark.

Examples


\setupindenting[yes,small,first]

\defineenumeration
  [remark]
  [location=top,text=Remark,inbetween={\blank[nowhite]},after=\blank,headstyle=bold,margin=1in]

\starttext
  \remark
    An enumeration (\tex{remark}, in this case) takes the paragraph that follows 
    it as its argument.

  \remark
    This is the first paragraph after \tex{remark}. It is part of the remark.

    This is the second paragraph after \tex{remark}. It is not part of the remark.

  \startremark
    This is the first paragraph inside \tex{startremark}. It is part of the remark.

    This is the second paragraph inside \tex{startremark}. It is part of the remark.   
  \stopremark

  \subsubremark Presto!

\stoptext

Gives:

The heading can be placed on the same line as the text that follows by using location (or alternative in MKIV) 'left'. The width of the header is controlled by the 'width' parameter, and the spacing to the text by the 'distance' parameter. The text on the left side of the number is defined by 'left' and the text on the right by the 'right' parameter. Below the chapter number is appended before the enumeration number. The text before the number can be overridden with the 'text' parameter. Before we override the default text 'remark' with no value.

\starttext

\chapter[chpt1]{Chapter 1}

\defineenumeration[remark]
    [location=left,left={\in[chpt1]}.,right=:,width=0.3in,distance=0.02in,text=]

  \remark
    An enumeration (\tex{remark}, in this case) takes the paragraph that follows 
    it as its argument.

  \remark
    This is the first paragraph after \tex{remark}. It is part of the remark.

    This is the second paragraph after \tex{remark}. It is not part of the remark.

  \startremark
    This is the first paragraph inside \tex{startremark}. It is part of the remark.

    This is the second paragraph inside \tex{startremark}. It is part of the remark.   
  \stopremark

\stoptext

Gives:

See also

Help from ConTeXt-Mailinglist/Forum

All issues with: