Blob Blame History Raw
<refentry xmlns="http://docbook.org/ns/docbook"
          xmlns:xlink="http://www.w3.org/1999/xlink"
          xmlns:xi="http://www.w3.org/2001/XInclude"
          xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"
          xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
          version="5.0" xml:id="mark.optional.procedure.steps">
<refmeta>
<refentrytitle>mark.optional.procedure.steps</refentrytitle>
<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
</refmeta>
<refnamediv>
<refname>mark.optional.procedure.steps</refname>
<refpurpose>Specifies whether to mark optional procedure steps</refpurpose>
</refnamediv>

<refsynopsisdiv>
  <src:fragment xml:id="mark.optional.procedure.steps.frag">
    <xsl:param name="mark.optional.procedure.steps">1</xsl:param>
  </src:fragment>
</refsynopsisdiv>

<refsection><info><title>Description</title></info>

<para>This parameter specifies whether a procedure step
with attribute <tag>performance</tag> set to <literal>optional</literal>
should be marked.  If set to 1 (the default value), then the
text "(Optional)" appears at the start of the first paragraph.
If set to zero, then no text is generated.</para>

<para>The text can be customized in the gentext element with 
key="optional-step".</para>

</refsection>
</refentry>