summaryrefslogtreecommitdiff
path: root/doc/yelp-xsl/C/html.output.page
blob: c7924cc277becde6bd0edeb0bb39cb9e4e89edaa (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
<?xml version="1.0" encoding="utf-8"?>
<page xmlns="http://projectmallard.org/1.0/" style="xslt-template" id="html.output">
 <info>
  <link type="guide" xref="html" group="templates"/>
  <link type="guide" xref="templates" group="html"/>
  <desc>Create an HTML output file.</desc>
  <revision version="1.0" date="2010-05-26" status="final"/>
 </info>
 <title>html.output</title>
 <synopsis>
  <title>Parameters</title>
  <terms>
   <item>
    <title><code>$node</code></title>
    <p>The node to create an output file for.</p>
   </item>
   <item>
    <title><code>$href</code></title>
    <p>The output filename.</p>
   </item>
  </terms>
 </synopsis>
 <p>This template creates an HTML output file for the source element <code>$node</code>. It
 uses <sys>exsl:document</sys> to output the file, and calls <code xref="html.page">html.page</code> with the
 <code>$node</code> parameter to output the actual HTML contents.</p>
 <p>If <code>$href</code> is not provided, this template will attempt to generate a base
 filename and append <code xref="html.extension">html.extension</code> to it. The base filename is generated
 as follows:</p>
 <list>
  <item>
   <p>If an <sys>xml:id</sys> attribute is present, it is used.</p>
  </item>
  <item>
   <p>Otherwise, if an <sys>id</sys> attribute is present, it is used.</p>
  </item>
  <item>
   <p>Otherwise, if <code>$node</code> is the root element, <code xref="html.basename">html.basename</code> is used.</p>
  </item>
  <item>
   <p>Otherwise, <sys>generate-id()</sys> is called.</p>
  </item>
 </list>
 <p>This template prepends <code xref="html.output.prefix">html.output.prefix</code> to the value of <code>$href</code> when
 it calls <sys>exsl:document</sys>, regardless of whether <code>$href</code> was passed in or
 generated automatically.</p>
 <p>After calling <sys>exsl:document</sys>, this template calls the <code xref="html.output.after.mode">html.output.after.mode</code>
 mode on <code>$node</code>. Importing stylesheets that create multiple output files can
 use this to process output files without blocking earlier output.</p>
 <list style="compact">
  <title>Calls Parameters</title>
  <item>
   <p><link xref="color.bg"/></p>
  </item>
  <item>
   <p><link xref="color.bg.blue"/></p>
  </item>
  <item>
   <p><link xref="color.bg.dark"/></p>
  </item>
  <item>
   <p><link xref="color.bg.gray"/></p>
  </item>
  <item>
   <p><link xref="color.bg.green"/></p>
  </item>
  <item>
   <p><link xref="color.bg.red"/></p>
  </item>
  <item>
   <p><link xref="color.bg.yellow"/></p>
  </item>
  <item>
   <p><link xref="color.blue"/></p>
  </item>
  <item>
   <p><link xref="color.fg"/></p>
  </item>
  <item>
   <p><link xref="color.fg.blue"/></p>
  </item>
  <item>
   <p><link xref="color.fg.dark"/></p>
  </item>
  <item>
   <p><link xref="color.fg.gray"/></p>
  </item>
  <item>
   <p><link xref="color.fg.green"/></p>
  </item>
  <item>
   <p><link xref="color.fg.orange"/></p>
  </item>
  <item>
   <p><link xref="color.fg.purple"/></p>
  </item>
  <item>
   <p><link xref="color.fg.red"/></p>
  </item>
  <item>
   <p><link xref="color.fg.yellow"/></p>
  </item>
  <item>
   <p><link xref="color.gray"/></p>
  </item>
  <item>
   <p><link xref="color.red"/></p>
  </item>
  <item>
   <p><link xref="color.yellow"/></p>
  </item>
  <item>
   <p><link xref="html.basename"/></p>
  </item>
  <item>
   <p><link xref="html.extension"/></p>
  </item>
  <item>
   <p><link xref="html.sidebar.left"/></p>
  </item>
  <item>
   <p><link xref="html.sidebar.right"/></p>
  </item>
  <item>
   <p><link xref="html.syntax.highlight"/></p>
  </item>
  <item>
   <p><link xref="html.xhtml"/></p>
  </item>
  <item>
   <p><link xref="icons.size.quote"/></p>
  </item>
 </list>
 <list style="compact">
  <title>Calls Templates</title>
  <item>
   <p><link xref="html.page"/></p>
  </item>
 </list>
 <list style="compact">
  <title>Calls Modes</title>
  <item>
   <p><link xref="html.output.after.mode"/></p>
  </item>
 </list>
</page>