Difference between revisions of "Command/defineenumeration"

From ConTeXt wiki
m (Description)
m
 
(20 intermediate revisions by 7 users not shown)
Line 19: Line 19:
 
   <tr valign="top" class="third">
 
   <tr valign="top" class="third">
 
     <td class="cmd">[...,...=...,...]</td>
 
     <td class="cmd">[...,...=...,...]</td>
     <td>see [[Reference/en/setupenumerations|\setupenumerations]] </td>
+
     <td>see [[Command/setupenumerations|\setupenumerations]] </td>
 
   </tr>
 
   </tr>
 
</table>
 
</table>
Line 25: Line 25:
  
 
== Description ==  
 
== Description ==  
With <code>\defineenumeration</code> you can number text elements like remarks or questions.
+
With <code>\defineenumeration</code> 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:
  
For example, if you want to make numbered remarks in your document you use:
 
 
== setup ==
 
 
<texcode>
 
<texcode>
 
\defineenumeration
 
\defineenumeration
 
[remark]
 
[remark]
[location=top,
+
[location=top,     % use alternative=top in MKIV
text=Remark,
+
text=Remark,       % Display header as "Remark 1"
inbetween=\blank,
+
headstyle=bold,    % Bold remark headers
after=\blank]
+
inbetween={\blank[nowhite]},   % No blank line between remark header and remark
 +
after=\blank]       % Blank line after the remark.
 
</texcode>
 
</texcode>
  
You can also vary the layout of Remark and Subremark in the example above by:
+
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>.
 +
 
 +
== Examples ==
 +
 
 +
<context source="yes" text="Gives:">
 +
 
 +
\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
 +
</context>
 +
 
 +
The heading can be placed on the same line as the text that follows by using the value 'left' for the location property (or alternative in MKIV). 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
  
<texcode>
+
\stoptext
\setupenumeration[remark][headstyle=bold]
+
</context>
\setupenumeration[subremark][headstyle=slanted]
+
 
</texcode>
+
Having the chapter number automatically prefixed can also be achieved using the "prefix" key (instead of putting in the text with the "left" key):
  
Now the new commands \remark, \subremark, \resetremark and \nextremark are available. If the remark contains more than one paragraph you will have to use the command
+
<context source="yes" text="This code produces the following document:">
pair \startremark ... \stopremark that becomes available after defining Remark with;
+
\setuphead[chapter][page=no] % to fit example on one page
 +
\defineenumeration[problem][way=bychapter, prefix=chapter, text=Problem]
  
<texcode>\defineenumeration[remark]</texcode>
+
\starttext
  
=== multiple paragraph ===
+
\chapter{Chapter One}
So the example above would look like this:
 
  
<texcode>
+
\startproblem
\startremark
+
Easy problem.
In the early medieval times Hasselt was a place of pilgrimage. The
+
\stopproblem
{\em Heilige Stede} (Holy Place) was torn down during the
 
Reformation.
 
After 300 years in 1930 the {\em Heilige Stede} was reopened.
 
Nowadays the {\em Heilige Stede} is closed again but once a year an
 
open air service is held on the same spot.
 
\stopremark
 
</texcode>
 
  
== input ==
+
\startproblem
<texcode>
+
Hard problem.
\remark In the early medieval times Hasselt was a place of
+
\stopproblem
pilgrimage. The {\em Heilige Stede} (Holy Place) was torn down during
 
the Reformation. In 1930, after 300 years the {\em Heilige Stede} was
 
reopened.
 
\subremark Nowadays the {\em Heilige Stede} is closed again but once
 
a year an open air service is held on the same spot.
 
</texcode>
 
  
== output ==
+
\chapter{Chapter Two}
<pre>
 
<b>Remark 1</b>
 
In the early medieval times Hasselt was a place of pilgrimage. The Heilige Stede (Holy
 
Place) was torn down during the Reformation. In 1930, after 300 years the Heilige Stede
 
was reopened.
 
<b>Remark 1.1</b>
 
Nowadays the Heilige Stede is closed again but once a year an open air service is held on
 
the same spot.
 
</pre>
 
  
 +
\startproblem
 +
Easy problem in chapter 2.
 +
\stopproblem
  
== Example ==
+
\stoptext
<!-- Please fill in an example if you can -->
+
</context>
  
 
== See also ==
 
== See also ==
<!-- something like [[cmd:goto|\goto]] -->
+
* {{cmd|defineenumeration}} for creating new kinds of numbered objects.
 +
* {{cmd|setupenumerations}} for setting up looks and behaviour.
 +
* {{cmd|enumeration}} for single-paragraph numbered objects.
 +
* {{cmd|startenumeration}} for multiple-paragraph numbered objects.
 +
* {{cmd|defineseparatorset}} for formatting sets.
 +
 
 +
== Help from ConTeXt-Mailinglist/Forum ==
 +
All issues with:
 +
{{Forum|{{SUBPAGENAME}}}}
  
[[Category:Reference/en|defineenumeration]]
+
[[Category:Command/Numbered objects|defineenumeration]]

Latest revision as of 02:55, 15 March 2014

\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 the value 'left' for the location property (or alternative in MKIV). 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:

Having the chapter number automatically prefixed can also be achieved using the "prefix" key (instead of putting in the text with the "left" key):

\setuphead[chapter][page=no]  % to fit example on one page
\defineenumeration[problem][way=bychapter, prefix=chapter, text=Problem]

\starttext

\chapter{Chapter One}

\startproblem
Easy problem.
\stopproblem

\startproblem
Hard problem.
\stopproblem

\chapter{Chapter Two}

\startproblem
Easy problem in chapter 2.
\stopproblem

\stoptext

This code produces the following document:

See also

Help from ConTeXt-Mailinglist/Forum

All issues with: