]> git.stg.codes - stg.git/blob - doc/xslt/params/img.src.path.xml
Ticket 37. The changePolicy() parameter added in the struct
[stg.git] / doc / xslt / params / img.src.path.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="img.src.path">
7 <refmeta>
8 <refentrytitle>img.src.path</refentrytitle>
9 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10 </refmeta>
11 <refnamediv>
12 <refname>img.src.path</refname>
13 <refpurpose>Path to HTML/FO image files</refpurpose>
14 </refnamediv>
15
16 <refsynopsisdiv>
17 <src:fragment xml:id="img.src.path.frag"><xsl:param name="img.src.path"/></src:fragment>
18 </refsynopsisdiv>
19
20 <refsection><info><title>Description</title></info>
21
22 <para>Add a path prefix to the value of the <tag class="attribute">fileref</tag> 
23 attribute of <tag>graphic</tag>, <tag>inlinegraphic</tag>, and <tag>imagedata</tag> elements. The resulting 
24 compound path is used in the output as the value of the <tag class="attribute">src</tag> 
25 attribute of <tag class="element">img</tag> (HTML) or <tag class="element">external-graphic</tag> (FO).
26 </para>
27
28 <para>
29 The path given by <literal>img.src.path</literal> could be relative to the directory where the HTML/FO
30 files are created, or it could be an absolute URI.
31 The default value is empty.
32 Be sure to include a trailing slash if needed.
33 </para>
34
35 <para>This prefix is not applied to any filerefs that start
36 with "/" or contain "//:".
37 </para>
38
39 </refsection>
40 </refentry>