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="generate.consistent.ids">
|
---|
7 | <refmeta>
|
---|
8 | <refentrytitle>generate.consistent.ids</refentrytitle>
|
---|
9 | <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
|
---|
10 | </refmeta>
|
---|
11 | <refnamediv>
|
---|
12 | <refname>generate.consistent.ids</refname>
|
---|
13 | <refpurpose>Generate consistent id values if document is unchanged</refpurpose>
|
---|
14 | </refnamediv>
|
---|
15 |
|
---|
16 | <refsynopsisdiv>
|
---|
17 | <src:fragment xml:id="generate.consistent.ids.frag">
|
---|
18 | <xsl:param name="generate.consistent.ids" select="0"/>
|
---|
19 | </src:fragment>
|
---|
20 | </refsynopsisdiv>
|
---|
21 |
|
---|
22 | <refsection><info><title>Description</title></info>
|
---|
23 |
|
---|
24 | <para>When the stylesheet assigns an id value to an output element,
|
---|
25 | the generate-id() function may be used. That function may not
|
---|
26 | produce consistent values between runs. Version control
|
---|
27 | systems may misidentify the changing id values as changes
|
---|
28 | to the document.</para>
|
---|
29 |
|
---|
30 | <para>If you set this parameter's value to 1, then the
|
---|
31 | template named <literal>object.id</literal> will replace
|
---|
32 | the use of the function generate-id() with
|
---|
33 | <literal><xsl:number level="multiple" count="*"/></literal>.
|
---|
34 | This counts preceding elements to generate a unique number for
|
---|
35 | the id value.</para>
|
---|
36 |
|
---|
37 | <caution>
|
---|
38 | <para>This param does not associate permanent unique id values
|
---|
39 | with particular elements.
|
---|
40 | The id values are consistent only as long as the document
|
---|
41 | structure does not change.
|
---|
42 | If the document structure changes, then the counting
|
---|
43 | of elements changes, and all id values after
|
---|
44 | the first such change may be different, even when there is
|
---|
45 | no change to the element itself or its output.
|
---|
46 | </para>
|
---|
47 | </caution>
|
---|
48 |
|
---|
49 | <para>The default value of this parameter is zero, so generate-id() is used
|
---|
50 | by default.</para>
|
---|
51 |
|
---|
52 | </refsection>
|
---|
53 | </refentry>
|
---|