← Back to branch summary

~ubuntu-branches/ubuntu/raring/libjboss-remoting-java/raring

« back to all changes in this revision

Viewing changes to docs/guide/support/support/docbook-xsl/params/generate.id.attributes.xml

  • Committer: Package Import Robot
  • Author(s): Torsten Werner
  • Date: 2011-09-09 14:01:03 UTC
  • mto: This revision was merged to the branch mainline in revision 9.
  • Revision ID: package-import@ubuntu.com-20110909140103-o8ucrolqt5g25k57
Tags: upstream-2.5.3.SP1
Import upstream version 2.5.3.SP1

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/guide/support/support/docbook-xsl/params/generate.id.attributes.xml
 
1
<refentry id="generate.id.attributes">
 
2
<refmeta>
 
3
<refentrytitle>generate.id.attributes</refentrytitle>
 
4
<refmiscinfo role="type"></refmiscinfo>
 
5
</refmeta>
 
6
<refnamediv>
 
7
<refname>generate.id.attributes</refname>
 
8
<refpurpose></refpurpose>
 
9
</refnamediv>
 
10
 
 
11
<refsynopsisdiv>
 
12
<src:fragment id='generate.id.attributes.frag'>
 
13
<xsl:param name="generate.id.attributes" select="0"/>
 
14
</src:fragment>
 
15
</refsynopsisdiv>
 
16
 
 
17
<refsect1><title>Description</title>
 
18
 
 
19
<para>If non-zero, the HTML stylesheet will generate ID attributes on
 
20
containers. For example, the markup:</para>
 
21
 
 
22
<screen><![CDATA[<section id="foo"><title>Some Title</title>
 
23
<para>Some para.</para>
 
24
</section>]]></screen>
 
25
 
 
26
<para>might produce:</para>
 
27
 
 
28
<screen><![CDATA[<div class="section" id="foo">
 
29
<h2>Some Title</h2>
 
30
<p>Some para.</p>
 
31
</div>]]></screen>
 
32
 
 
33
<para>The alternative is to generate anchors:</para>
 
34
 
 
35
<screen><![CDATA[<div class="section">
 
36
<h2><a name="foo"></a>Some Title</h2>
 
37
<p>Some para.</p>
 
38
</div>]]></screen>
 
39
 
 
40
<para>Because the <sgmltag class="attribute">name</sgmltag> attribute of
 
41
the <sgmltag>a</sgmltag> element and the <sgmltag class="attribute">id</sgmltag>
 
42
attribute of other tags are both of type <quote>ID</quote>, producing both
 
43
generates invalid documents.</para>
 
44
 
 
45
<para>As of version 1.50, you can use this switch to control which type of
 
46
identifier is generated. For backwards-compatibility, generating
 
47
<sgmltag>a</sgmltag> anchors is preferred.</para>
 
48
 
 
49
<para>Note: at present, this switch is incompletely implemented.
 
50
Disabling ID attributes will suppress them, but enabling ID attributes
 
51
will not suppress the anchors.</para>
 
52
 
 
53
</refsect1>
 
54
</refentry>