params/mark.optional.procedure.steps.xml

   1 <refentry xmlns="http://docbook.org/ns/docbook"
   2           xmlns:xlink="http://www.w3.org/1999/xlink"
   3           xmlns:xi="http://www.w3.org/2001/XInclude"
   4           xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"
   5           xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
   6           version="5.0" xml:id="mark.optional.procedure.steps">
   7 <refmeta>
   8 <refentrytitle>mark.optional.procedure.steps</refentrytitle>
   9 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  10 </refmeta>
  11 <refnamediv>
  12 <refname>mark.optional.procedure.steps</refname>
  13 <refpurpose>Specifies whether to mark optional procedure steps</refpurpose>
  14 </refnamediv>
  15
  16 <refsynopsisdiv>
  17   <src:fragment xml:id="mark.optional.procedure.steps.frag">
  18     <xsl:param name="mark.optional.procedure.steps">1</xsl:param>
  19   </src:fragment>
  20 </refsynopsisdiv>
  21
  22 <refsection><info><title>Description</title></info>
  23
  24 <para>This parameter specifies whether a procedure step
  25 with attribute <tag>performance</tag> set to <literal>optional</literal>
  26 should be marked.  If set to 1 (the default value), then the
  27 text "(Optional)" appears at the start of the first paragraph.
  28 If set to zero, then no text is generated.</para>
  29
  30 <para>The text can be customized in the gentext element with
  31 key="optional-step".</para>
  32
  33 </refsection>
  34 </refentry>