OLD | NEW |
| (Empty) |
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="activate.external.olinks"> | |
7 <refmeta> | |
8 <refentrytitle>activate.external.olinks</refentrytitle> | |
9 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
10 </refmeta> | |
11 <refnamediv> | |
12 <refname>activate.external.olinks</refname> | |
13 <refpurpose>Make external olinks into active links</refpurpose> | |
14 </refnamediv> | |
15 | |
16 <refsynopsisdiv> | |
17 <src:fragment xml:id="activate.external.olinks.frag"> | |
18 <xsl:param name="activate.external.olinks" select="1"/> | |
19 </src:fragment> | |
20 </refsynopsisdiv> | |
21 | |
22 <refsection><info><title>Description</title></info> | |
23 | |
24 <para>If <parameter>activate.external.olinks</parameter> is nonzero | |
25 (the default), then any olinks that reference another document | |
26 become active links that can be clicked on to follow the link. | |
27 If the parameter is set to zero, then external olinks | |
28 will have the appropriate link text generated, but the link is | |
29 not made active. Olinks to destinations in | |
30 the current document remain active.</para> | |
31 | |
32 <para>To make an external olink active for HTML | |
33 outputs, the link text is wrapped in an <tag>a</tag> | |
34 element with an <tag>href</tag> attribute. To | |
35 make an external olink active for FO outputs, the link text is | |
36 wrapped in an <tag>fo:basic-link</tag> element with an | |
37 <tag>external-destination</tag> attribute.</para> | |
38 | |
39 <para>This parameter is useful when you need external olinks | |
40 to resolve but not be clickable. For example, if documents | |
41 in a collection are available independently of each other, | |
42 then having active links between them could lead to | |
43 unresolved links when a given target document is missing.</para> | |
44 | |
45 <para>The epub stylesheets set this parameter to zero by default | |
46 because there is no standard linking mechanism between Epub documents.</para> | |
47 | |
48 <para>If external links are made inactive, you should | |
49 consider setting the | |
50 stylesheet parameter <parameter>olink.doctitle</parameter> | |
51 to <literal>yes</literal>. That will append the external document's | |
52 title to the link text, making it easier for the user to | |
53 locate the other document.</para> | |
54 | |
55 <para>An olink is considered external when the | |
56 <parameter>current.docid</parameter> stylesheet parameter | |
57 is set to some value, and the olink's <tag>targetdoc</tag> | |
58 attribute has a different value. If the two values | |
59 match, then the link is considered internal. If the | |
60 <parameter>current.docid</parameter> parameter is blank, or | |
61 the <tag>olink</tag> element does not have a <tag>targetdoc</tag> attribute, | |
62 then the link is considered to be internal and will become | |
63 an active link.</para> | |
64 | |
65 <para>See also <parameter>olink.doctitle</parameter>, | |
66 <parameter>prefer.internal.olink</parameter>.</para> | |
67 | |
68 </refsection> | |
69 </refentry> | |
OLD | NEW |