3 Copyright 2002-2005 The Apache Software Foundation or its licensors,
6 Licensed under the Apache License, Version 2.0 (the "License");
7 you may not use this file except in compliance with the License.
8 You may obtain a copy of the License at
10 http://www.apache.org/licenses/LICENSE-2.0
12 Unless required by applicable law or agreed to in writing, software
13 distributed under the License is distributed on an "AS IS" BASIS,
14 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 See the License for the specific language governing permissions and
16 limitations under the License.
20 Skin configuration file. This file contains details of your project,
21 which will be used to configure the chosen Forrest skin.
24 <!DOCTYPE skinconfig PUBLIC "-//APACHE//DTD Skin Configuration V0.7-1//EN" "http://forrest.apache.org/dtd/skinconfig-v07-1.dtd">
26 <!-- To enable lucene search add provider="lucene" (default is google).
27 Add box-location="alt" to move the search box to an alternate location
28 (if the skin supports it) and box-location="all" to show it in all
29 available locations on the page. Remove the <search> element to show
30 no search box. @domain will enable sitesearch for the specific domain with google.
31 In other words google will search the @domain for the query string.
33 <search name="MyProject" domain="mydomain" provider="google"/>
35 <!-- Disable the print link? If enabled, invalid HTML 4.0.1 -->
36 <disable-print-link>true</disable-print-link>
37 <!-- Disable the PDF link? -->
38 <disable-pdf-link>false</disable-pdf-link>
39 <!-- Disable the POD link? -->
40 <disable-pod-link>true</disable-pod-link>
41 <!-- Disable the Text link? FIXME: NOT YET IMPLEMENETED. -->
42 <disable-txt-link>true</disable-txt-link>
43 <!-- Disable the xml source link? -->
44 <!-- The xml source link makes it possible to access the xml rendition
45 of the source frim the html page, and to have it generated statically.
46 This can be used to enable other sites and services to reuse the
47 xml format for their uses. Keep this disabled if you don't want other
48 sites to easily reuse your pages.-->
49 <disable-xml-link>true</disable-xml-link>
51 <!-- Disable navigation icons on all external links? -->
52 <disable-external-link-image>true</disable-external-link-image>
54 <!-- Disable w3c compliance links?
55 Use e.g. align="center" to move the compliance links logos to
56 an alternate location default is left.
57 (if the skin supports it) -->
58 <disable-compliance-links>false</disable-compliance-links>
60 <!-- Render mailto: links unrecognisable by spam harvesters? -->
61 <obfuscate-mail-links>true</obfuscate-mail-links>
62 <obfuscate-mail-value>.at.</obfuscate-mail-value>
64 <!-- Disable the javascript facility to change the font size -->
65 <disable-font-script>true</disable-font-script>
67 <!-- mandatory project logo
68 default skin: renders it at the top -->
69 <project-name>KiSS Crawler</project-name>
70 <project-description>Automatic recording for KiSS harddisk recorders</project-description>
71 <project-url>http://kiss.wamblee.org</project-url>
72 <project-logo>images/project.png</project-logo>
73 <!-- Alternative static image:
74 <project-logo>images/project-logo.gif</project-logo> -->
76 <!-- optional group logo
77 default skin: renders it at the top-left corner -->
78 <group-name>wamblee.org</group-name>
79 <group-description></group-description>
80 <group-url>http://wamblee.org</group-url>
81 <group-logo>images/group.png</group-logo>
82 <!-- Alternative static image:
83 <group-logo>images/group-logo.gif</group-logo> -->
85 <!-- optional host logo (e.g. sourceforge logo)
86 default skin: renders it at the bottom-left corner -->
88 <host-logo></host-logo>
90 <!-- relative url of a favicon file, normally favicon.ico -->
91 <favicon-url></favicon-url>
93 <!-- The following are used to construct a copyright statement -->
95 <vendor>wamblee.org</vendor>
96 <!-- The optional copyright-link URL will be used as a link in the
98 <copyright-link>http://www.apache.org/licenses/</copyright-link>
101 <!-- Some skins use this to form a 'breadcrumb trail' of links.
102 Use location="alt" to move the trail to an alternate location
103 (if the skin supports it).
104 Omit the location attribute to display the trail in the default location.
105 Use location="none" to not display the trail (if the skin supports it).
106 For some skins just set the attributes to blank.
108 NOTE: If a breadcrumb entry points at a local file the href must
109 be complete, that is it must point to the file itself, not to a
113 <link1 name="wamblee.org" href="http://wamblee.org/"/>
114 <link3 name="KiSS crawler" href="http://kiss.wamblee.org"/>
117 <!-- Configure the TOC, i.e. the Table of Contents.
119 how many "section" levels need to be included in the
120 generated Table of Contents (TOC).
122 Minimum required to create a TOC.
123 @location ("page","menu","page,menu", "none")
124 Where to show the TOC.
126 <toc max-depth="2" min-sections="1" location="page"/>
128 <!-- Heading types can be clean|underlined|boxed -->
129 <headings type="boxed"/>
131 <!-- The optional feedback element will be used to construct a
132 feedback link in the footer with the page pathname appended:
133 <a href="@href">{@to}</a>
135 <feedback to="erik@wamblee.org"
136 href="mailto:erik@wamblee.org?subject=Feedback " >
137 Send feedback about the website to:
140 <!-- Optional message of the day (MOTD).
141 Note: This is only implemented in the pelt skin.
142 If the optional <motd> element is used, then messages will be appended
143 depending on the URI string pattern.
144 motd-option : Specifies a pattern to match and provides small text content.
145 motd-title : This text will be added in brackets after the <html><title>
146 motd-page : This text will be added in a panel on the face of the page,
147 with the "motd-page-url" being the hyperlink "More".
148 Values for the "location" attribute are:
149 page : on the face of the page, e.g. in the spare space of the toc
150 alt : at the bottom of the left-hand navigation panel
155 <motd-option pattern="docs_0_80">
156 <motd-title>v0.8-dev</motd-title>
157 <motd-page location="both">
158 This is documentation for development version v0.8
160 <motd-page-url>/versions/index.html</motd-page-url>
162 <motd-option pattern="docs_0_70">
163 <motd-title>v0.7</motd-title>
164 <motd-page location="both">
165 This is documentation for current version v0.7
167 <motd-page-url>/versions/index.html</motd-page-url>
173 extra-css - here you can define custom css-elements that are
174 A) overriding the fallback elements or
175 B) adding the css definition from new elements that you may have
176 used in your documentation.
179 <!--Example of reason B:
180 To define the css definition of a new element that you may have used
181 in the class attribute of a <p> node.
182 e.g. <p class="quote"/>
187 background-color: #f0f0f0;
188 font-family: monospace;
191 To override the colours of links only in the footer.
193 #footer a { color: #0F3660; }
194 #footer a:visited { color: #009999; }
198 <!-- These values are used for the generated CSS files.
199 They essentially "override" the default colors defined in the chosen skin.
200 There are four duplicate "groups" of colors below, denoted by comments:
201 Color group: Forrest, Krysalis, Collabnet, and Lenya using Pelt.
202 They are provided for example only. To customize the colors of any skin,
203 uncomment one of these groups of color elements and change the values
204 of the particular color elements that you wish to change.
205 Note that by default, all color groups are commented-out which means that
206 the default colors provided by the skin are being used.
209 <!-- Color group: Forrest: example colors similar to forrest.apache.org
210 Some of the element names are obscure, so comments are added to show how
211 the "pelt" skin uses them, other skins might use these elements in a different way.
212 Tip: temporarily change the value of an element to red (#ff0000) and see the effect.
213 pelt: breadtrail: the strip at the top of the page and the second strip under the tabs
214 pelt: header: top strip containing project and group logos
215 pelt: heading|subheading: section headings within the content
216 pelt: navstrip: the strip under the tabs which contains the published date
217 pelt: menu: the left-hand navigation panel
218 pelt: toolbox: the selected menu item
219 pelt: searchbox: the background of the searchbox
220 pelt: border: line border around selected menu item
221 pelt: body: any remaining parts, e.g. the bottom of the page
222 pelt: footer: the second from bottom strip containing credit logos and published date
223 pelt: feedback: the optional bottom strip containing feedback link
226 <color name="breadtrail" value="#cedfef" font="#0F3660" link="#0F3660" vlink="#0F3660" hlink="#000066"/>
227 <color name="header" value="#294563"/>
228 <color name="tab-selected" value="#4a6d8c" link="#0F3660" vlink="#0F3660" hlink="#000066"/>
229 <color name="tab-unselected" value="#b5c7e7" link="#0F3660" vlink="#0F3660" hlink="#000066"/>
230 <color name="subtab-selected" value="#4a6d8c" link="#0F3660" vlink="#0F3660" hlink="#000066"/>
231 <color name="subtab-unselected" value="#4a6d8c" link="#0F3660" vlink="#0F3660" hlink="#000066"/>
232 <color name="heading" value="#294563"/>
233 <color name="subheading" value="#4a6d8c"/>
234 <color name="published" value="#4C6C8F" font="#FFFFFF"/>
235 <color name="feedback" value="#4C6C8F" font="#FFFFFF" align="center"/>
236 <color name="navstrip" value="#4a6d8c" font="#ffffff" link="#0F3660" vlink="#0F3660" hlink="#000066"/>
237 <color name="menu" value="#4a6d8c" font="#cedfef" link="#ffffff" vlink="#ffffff" hlink="#ffcf00"/>
238 <color name="toolbox" value="#4a6d8c"/>
239 <color name="border" value="#294563"/>
240 <color name="dialog" value="#4a6d8c"/>
241 <color name="searchbox" value="#4a6d8c" font="#000000"/>
242 <color name="body" value="#ffffff" link="#0F3660" vlink="#009999" hlink="#000066"/>
243 <color name="table" value="#7099C5"/>
244 <color name="table-cell" value="#f0f0ff"/>
245 <color name="highlight" value="#ffff00"/>
246 <color name="fixme" value="#cc6600"/>
247 <color name="note" value="#006699"/>
248 <color name="warning" value="#990000"/>
249 <color name="code" value="#CFDCED"/>
250 <color name="footer" value="#cedfef"/>
253 <!-- Color group: Krysalis -->
255 <color name="header" value="#FFFFFF"/>
257 <color name="tab-selected" value="#a5b6c6" link="#000000" vlink="#000000" hlink="#000000"/>
258 <color name="tab-unselected" value="#F7F7F7" link="#000000" vlink="#000000" hlink="#000000"/>
259 <color name="subtab-selected" value="#a5b6c6" link="#000000" vlink="#000000" hlink="#000000"/>
260 <color name="subtab-unselected" value="#a5b6c6" link="#000000" vlink="#000000" hlink="#000000"/>
262 <color name="heading" value="#a5b6c6"/>
263 <color name="subheading" value="#CFDCED"/>
265 <color name="navstrip" value="#CFDCED" font="#000000" link="#000000" vlink="#000000" hlink="#000000"/>
266 <color name="toolbox" value="#a5b6c6"/>
267 <color name="border" value="#a5b6c6"/>
269 <color name="menu" value="#F7F7F7" link="#000000" vlink="#000000" hlink="#000000"/>
270 <color name="dialog" value="#F7F7F7"/>
272 <color name="body" value="#ffffff" link="#0F3660" vlink="#009999" hlink="#000066"/>
274 <color name="table" value="#a5b6c6"/>
275 <color name="table-cell" value="#ffffff"/>
276 <color name="highlight" value="#ffff00"/>
277 <color name="fixme" value="#cc6600"/>
278 <color name="note" value="#006699"/>
279 <color name="warning" value="#990000"/>
280 <color name="code" value="#a5b6c6"/>
282 <color name="footer" value="#a5b6c6"/>
285 <!-- Color group: Collabnet -->
287 <color name="header" value="#003366"/>
289 <color name="tab-selected" value="#dddddd" link="#555555" vlink="#555555" hlink="#555555"/>
290 <color name="tab-unselected" value="#999999" link="#ffffff" vlink="#ffffff" hlink="#ffffff"/>
291 <color name="subtab-selected" value="#cccccc" link="#000000" vlink="#000000" hlink="#000000"/>
292 <color name="subtab-unselected" value="#cccccc" link="#555555" vlink="#555555" hlink="#555555"/>
294 <color name="heading" value="#003366"/>
295 <color name="subheading" value="#888888"/>
297 <color name="navstrip" value="#dddddd" font="#555555"/>
298 <color name="toolbox" value="#dddddd" font="#555555"/>
299 <color name="border" value="#999999"/>
301 <color name="menu" value="#ffffff"/>
302 <color name="dialog" value="#eeeeee"/>
304 <color name="body" value="#ffffff"/>
306 <color name="table" value="#ccc"/>
307 <color name="table-cell" value="#ffffff"/>
308 <color name="highlight" value="#ffff00"/>
309 <color name="fixme" value="#cc6600"/>
310 <color name="note" value="#006699"/>
311 <color name="warning" value="#990000"/>
312 <color name="code" value="#003366"/>
314 <color name="footer" value="#ffffff"/>
316 <!-- Color group: Lenya using pelt-->
319 <color name="header" value="#ffffff"/>
321 <color name="tab-selected" value="#E5E4D9" link="#000000" vlink="#000000" hlink="#000000"/>
322 <color name="tab-unselected" value="#F5F4E9" link="#000000" vlink="#000000" hlink="#000000"/>
323 <color name="subtab-selected" value="#000000" link="#000000" vlink="#000000" hlink="#000000"/>
324 <color name="subtab-unselected" value="#E5E4D9" link="#000000" vlink="#000000" hlink="#000000"/>
326 <color name="heading" value="#E5E4D9"/>
327 <color name="subheading" value="#000000"/>
328 <color name="published" value="#000000"/>
329 <color name="navstrip" value="#E5E4D9" font="#000000"/>
330 <color name="toolbox" value="#CFDCED" font="#000000"/>
331 <color name="border" value="#999999"/>
333 <color name="menu" value="#E5E4D9" font="#000000" link="#000000" vlink="#000000" hlink="#000000"/>
334 <color name="dialog" value="#CFDCED"/>
335 <color name="body" value="#ffffff" />
337 <color name="table" value="#ccc"/>
338 <color name="table-cell" value="#ffffff"/>
339 <color name="highlight" value="#ffff00"/>
340 <color name="fixme" value="#cc6600"/>
341 <color name="note" value="#006699"/>
342 <color name="warning" value="#990000"/>
343 <color name="code" value="#003366"/>
345 <color name="footer" value="#E5E4D9"/>
349 <!-- Settings specific to PDF output. -->
352 Supported page sizes are a0, a1, a2, a3, a4, a5, executive,
353 folio, legal, ledger, letter, quarto, tabloid (default letter).
354 Supported page orientations are portrait, landscape (default
356 Supported text alignments are left, right, justify (default left).
358 <page size="letter" orientation="portrait" text-align="left"/>
361 Pattern of the page numbering in the footer - Default is "Page x".
362 first occurrence of '1' digit represents the current page number,
363 second occurrence of '1' digit represents the total page number,
364 anything else is considered as the static part of the numbering pattern.
365 Examples : x is the current page number, y the total page number.
366 <page-numbering-format>none</page-numbering-format> Do not displays the page numbering
367 <page-numbering-format>1</page-numbering-format> Displays "x"
368 <page-numbering-format>p1.</page-numbering-format> Displays "px."
369 <page-numbering-format>Page 1/1</page-numbering-format> Displays "Page x/y"
370 <page-numbering-format>(1-1)</page-numbering-format> Displays "(x-y)"
372 <page-numbering-format>Page 1</page-numbering-format>
375 Margins can be specified for top, bottom, inner, and outer
376 edges. If double-sided="false", the inner edge is always left
377 and the outer is always right. If double-sided="true", the
378 inner edge will be left on odd pages, right on even pages,
379 the outer edge vice versa.
380 Specified below are the default settings.
382 <margins double-sided="false">
385 <inner>1.25in</inner>
390 Print the URL text next to all links going outside the file
392 <show-external-urls>false</show-external-urls>
395 Disable the copyright footer on each page of the PDF.
396 A footer is composed for each page. By default, a "credit" with role=pdf
397 will be used, as explained below. Otherwise a copyright statement
398 will be generated. This latter can be disabled.
400 <disable-copyright-footer>false</disable-copyright-footer>
404 Credits are typically rendered as a set of small clickable
405 images in the page footer.
407 Use box-location="alt" to move the credits to an alternate location
408 (if the skin supports it).
410 For example, pelt skin:
411 - box-location="alt" will place the logo at the end of the
412 left-hand coloured menu panel.
413 - box-location="alt2" will place them underneath that panel
414 in the left-hand whitespace.
415 - Otherwise they are placed next to the compatibility icons
416 at the bottom of the screen.
418 Comment out the whole <credit>-element if you want no credits in the
422 <credit box-location="alt">
423 <name>Built with Apache Forrest</name>
424 <url>http://forrest.apache.org/</url>
425 <image>images/built-with-forrest-button.png</image>
429 <!-- A credit with @role="pdf" will be used to compose a footer
430 for each page in the PDF, using either "name" or "url" or both.
434 <name>Built with Apache Forrest</name>
435 <url>http://forrest.apache.org/</url>