procedure

- SourceForge
- Home Page
- Samples

- Reference Contents |
- Download & Install |
- User Guides |
- Notes, E-mail & Bugs |
- Q&A

Suggestions
Search:
Next: procedure/title
Up: Procedures procedure.mod.xsl

Reference Section

## Name

procedure — Process `procedure` [2.0.9] elements

## Synopsis

    <xsl:template match="procedure" name="procedure">
    <xsl:param name="mode" select="''"/>
    <xsl:param name="environment">
    			<xsl:choose>
    				<xsl:when test="$mode='custom'">
    					<xsl:text>description</xsl:text>
    				</xsl:when>
    				<xsl:otherwise>
    					<xsl:text>enumerate</xsl:text>
    				</xsl:otherwise>
    			</xsl:choose>
    		</xsl:param>
    <xsl:variable name="placement">
    			<xsl:call-template name="generate.formal.title.placement">
    				<xsl:with-param name="object" select="local-name(.)"/>
    			</xsl:call-template>
    		</xsl:variable>
    <xsl:variable name="preamble" select="node()[not(self::blockinfo or self::title or self::subtitle or self::titleabbrev or self::step)]"/>
      ...
    </xsl:template>

## A. Description

Format a titled, enumerated list of steps.

## B. Pertinent Variables

- formal.title.placement

## C. Template Parameters

mode
  Although the `mode` parameter is normally empty, this template recognises a special value of “custom”. This influences the type of environment and the method of labelling `steps` [2.0.9].
environment
  This determines the LaTeX environment that will be used for each `step` [2.0.9]'s `\item`. When the `mode` is “custom”, this parameter defaults to “description”. Otherwise, the default is “enumerate”.

## D. DocBook Compliance and LaTeX Notes

By default, the LaTeX `\begin{enumerate}` environment is used and any `step` [2.0.9]'s `title` [2.0.9] will be typeset after its automatic step number. However, when the `mode` variable is equal to “custom”, the `\begin{description}` environment will be used and step titles will be typeset instead of step numbers.

Although the procedure is a formal, titled block, is is not typeset using `\subsection`.

## E. Samples and Tests

`test_book.pdf` from `test_book/test.xml`, `test_chemistry.pdf` from `test_chemistry/test.xml`, `test_procedure.pdf` from `test_procedure/test.xml`

## F. Further Reading

- procedure/title

Prev | Up | Next
Procedures procedure.mod.xsl | Home | procedure/title