stylesheets/evergreen_docbook_files/docbook-xsl-1.75.2/params/generate.id.attributes.xml

   1 <refentry xmlns="http://docbook.org/ns/docbook"\r
   2           xmlns:xlink="http://www.w3.org/1999/xlink"\r
   3           xmlns:xi="http://www.w3.org/2001/XInclude"\r
   4           xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"\r
   5           xmlns:xsl="http://www.w3.org/1999/XSL/Transform"\r
   6           version="5.0" xml:id="generate.id.attributes">\r
   7 <refmeta>\r
   8 <refentrytitle>generate.id.attributes</refentrytitle>\r
   9 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>\r
  10 </refmeta>\r
  11 <refnamediv>\r
  12 <refname>generate.id.attributes</refname>\r
  13 <refpurpose>Generate ID attributes on container elements?</refpurpose>\r
  14 </refnamediv>\r
  15 \r
  16 <refsynopsisdiv>\r
  17 <src:fragment xml:id="generate.id.attributes.frag">\r
  18 <xsl:param name="generate.id.attributes" select="0"/>\r
  19 </src:fragment>\r
  20 </refsynopsisdiv>\r
  21 \r
  22 <refsection><info><title>Description</title></info>\r
  23 \r
  24 <para>If non-zero, the HTML stylesheet will generate ID attributes on\r
  25 containers. For example, the markup:</para>\r
  26 \r
  27 <screen>&lt;section id="foo"&gt;&lt;title&gt;Some Title&lt;/title&gt;\r
  28 &lt;para&gt;Some para.&lt;/para&gt;\r
  29 &lt;/section&gt;</screen>\r
  30 \r
  31 <para>might produce:</para>\r
  32 \r
  33 <screen>&lt;div class="section" id="foo"&gt;\r
  34 &lt;h2&gt;Some Title&lt;/h2&gt;\r
  35 &lt;p&gt;Some para.&lt;/p&gt;\r
  36 &lt;/div&gt;</screen>\r
  37 \r
  38 <para>The alternative is to generate anchors:</para>\r
  39 \r
  40 <screen>&lt;div class="section"&gt;\r
  41 &lt;h2&gt;&lt;a name="foo"&gt;&lt;/a&gt;Some Title&lt;/h2&gt;\r
  42 &lt;p&gt;Some para.&lt;/p&gt;\r
  43 &lt;/div&gt;</screen>\r
  44 \r
  45 <para>Because the <tag class="attribute">name</tag> attribute of\r
  46 the <tag>a</tag> element and the <tag class="attribute">id</tag>\r
  47 attribute of other tags are both of type <quote>ID</quote>, producing both\r
  48 generates invalid documents.</para>\r
  49 \r
  50 <para>As of version 1.50, you can use this switch to control which type of\r
  51 identifier is generated. For backwards-compatibility, generating\r
  52 <tag>a</tag> anchors is preferred.</para>\r
  53 \r
  54 <para>Note: at present, this switch is incompletely implemented.\r
  55 Disabling ID attributes will suppress them, but enabling ID attributes\r
  56 will not suppress the anchors.</para>\r
  57 \r
  58 </refsection>\r
  59 </refentry>\r