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="Lucene Java" provider="Lucene"/>
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>true</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>true</disable-compliance-links>
60 <!-- Render mailto: links unrecognisable by spam harvesters? -->
61 <obfuscate-mail-links>false</obfuscate-mail-links>
62 <obfuscate-mail-value> ... </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>Lucene</project-name>
70 <project-description>Apache Lucene is a high-performance, full-featured text search engine library written entirely in
71 Java. It is a technology suitable for nearly any application that requires full-text search, especially cross-platform.</project-description>
72 <project-url>http://lucene.apache.org/java/</project-url>
73 <project-logo>http://lucene.apache.org/images/lucene_green_300.gif</project-logo>
74 <!-- http://lucene.apache.org/images/lucene_green_300.gif -->
75 <!-- Alternative static image:
76 <project-logo>images/project-logo.gif</project-logo> -->
78 <!-- optional group logo
79 default skin: renders it at the top-left corner -->
81 <group-name>Lucene</group-name>
82 <group-description>Apache Lucene</group-description>
83 <group-url>http://lucene.apache.org/</group-url>
84 <group-logo>http://www.apache.org/images/asf_logo_simple.png</group-logo>
86 <!-- Alternative static image:
87 <group-logo>images/group-logo.gif</group-logo> -->
89 <!-- optional host logo (e.g. sourceforge logo)
90 default skin: renders it at the bottom-left corner -->
92 <host-logo></host-logo>
94 <!-- relative url of a favicon file, normally favicon.ico -->
95 <favicon-url>images/favicon.ico</favicon-url>
97 <!-- The following are used to construct a copyright statement -->
99 <vendor>The Apache Software Foundation.</vendor>
100 <copyright-link>http://www.apache.org/licenses/</copyright-link>
102 <!-- Some skins use this to form a 'breadcrumb trail' of links.
103 Use location="alt" to move the trail to an alternate location
104 (if the skin supports it).
105 Omit the location attribute to display the trail in the default location.
106 Use location="none" to not display the trail (if the skin supports it).
107 For some skins just set the attributes to blank.
109 NOTE: If a breadcrumb entry points at a local file the href must
110 be complete, that is it must point to the file itself, not to a
114 <link1 name="Apache" href="http://www.apache.org/"/>
115 <link2 name="Lucene" href="http://lucene.apache.org/"/>
116 <link3 name="" href="/"/>
119 <!-- Configure the TOC, i.e. the Table of Contents.
121 how many "section" levels need to be included in the
122 generated Table of Contents (TOC).
124 Minimum required to create a TOC.
125 @location ("page","menu","page,menu", "none")
126 Where to show the TOC.
128 <toc max-depth="2" min-sections="1" location="page"/>
130 <!-- Heading types can be clean|underlined|boxed -->
131 <headings type="boxed"/>
133 <!-- The optional feedback element will be used to construct a
134 feedback link in the footer with the page pathname appended:
135 <a href="@href">{@to}</a>
138 <feedback to="webmaster@foo.com"
139 href="mailto:webmaster@foo.com?subject=Feedback " >
140 Send feedback about the website to:
144 <!-- Optional message of the day (MOTD).
145 Note: This is only implemented in the pelt skin.
146 If the optional <motd> element is used, then messages will be appended
147 depending on the URI string pattern.
148 motd-option : Specifies a pattern to match and provides small text content.
149 motd-title : This text will be added in brackets after the <html><title>
150 motd-page : This text will be added in a panel on the face of the page,
151 with the "motd-page-url" being the hyperlink "More".
152 Values for the "location" attribute are:
153 page : on the face of the page, e.g. in the spare space of the toc
154 alt : at the bottom of the left-hand navigation panel
159 <motd-option pattern="docs_0_80">
160 <motd-title>v0.8-dev</motd-title>
161 <motd-page location="both">
162 This is documentation for development version v0.8
164 <motd-page-url>/versions/index.html</motd-page-url>
166 <motd-option pattern="docs_0_70">
167 <motd-title>v0.7</motd-title>
168 <motd-page location="both">
169 This is documentation for current version v0.7
171 <motd-page-url>/versions/index.html</motd-page-url>
177 extra-css - here you can define custom css-elements that are
178 A) overriding the fallback elements or
179 B) adding the css definition from new elements that you may have
180 used in your documentation.
183 <!--Example of reason B:
184 To define the css definition of a new element that you may have used
185 in the class attribute of a <p> node.
186 e.g. <p class="quote"/>
191 background-color: #f0f0f0;
192 font-family: monospace;
200 To override the colours of links only in the footer.
202 #footer a { color: #0F3660; }
203 #footer a:visited { color: #009999; }
209 background-color: #f0f0f0;
216 <!-- These values are used for the generated CSS files.
217 They essentially "override" the default colors defined in the chosen skin.
218 There are four duplicate "groups" of colors below, denoted by comments:
219 Color group: Forrest, Krysalis, Collabnet, and Lenya using Pelt.
220 They are provided for example only. To customize the colors of any skin,
221 uncomment one of these groups of color elements and change the values
222 of the particular color elements that you wish to change.
223 Note that by default, all color groups are commented-out which means that
224 the default colors provided by the skin are being used.
227 <!-- Color group: Forrest: example colors similar to forrest.apache.org
228 Some of the element names are obscure, so comments are added to show how
229 the "pelt" skin uses them, other skins might use these elements in a different way.
230 Tip: temporarily change the value of an element to red (#ff0000) and see the effect.
231 pelt: breadtrail: the strip at the top of the page and the second strip under the tabs
232 pelt: header: top strip containing project and group logos
233 pelt: heading|subheading: section headings within the content
234 pelt: navstrip: the strip under the tabs which contains the published date
235 pelt: menu: the left-hand navigation panel
236 pelt: toolbox: the selected menu item
237 pelt: searchbox: the background of the searchbox
238 pelt: border: line border around selected menu item
239 pelt: body: any remaining parts, e.g. the bottom of the page
240 pelt: footer: the second from bottom strip containing credit logos and published date
241 pelt: feedback: the optional bottom strip containing feedback link
244 <color name="breadtrail" value="#cedfef" font="#0F3660" link="#0F3660" vlink="#0F3660" hlink="#000066"/>
245 <color name="header" value="#294563"/>
246 <color name="tab-selected" value="#4a6d8c" link="#0F3660" vlink="#0F3660" hlink="#000066"/>
247 <color name="tab-unselected" value="#b5c7e7" link="#0F3660" vlink="#0F3660" hlink="#000066"/>
248 <color name="subtab-selected" value="#4a6d8c" link="#0F3660" vlink="#0F3660" hlink="#000066"/>
249 <color name="subtab-unselected" value="#4a6d8c" link="#0F3660" vlink="#0F3660" hlink="#000066"/>
250 <color name="heading" value="#294563"/>
251 <color name="subheading" value="#4a6d8c"/>
252 <color name="published" value="#4C6C8F" font="#FFFFFF"/>
253 <color name="feedback" value="#4C6C8F" font="#FFFFFF" align="center"/>
254 <color name="navstrip" value="#4a6d8c" font="#ffffff" link="#0F3660" vlink="#0F3660" hlink="#000066"/>
255 <color name="menu" value="#4a6d8c" font="#cedfef" link="#ffffff" vlink="#ffffff" hlink="#ffcf00"/>
256 <color name="toolbox" value="#4a6d8c"/>
257 <color name="border" value="#294563"/>
258 <color name="dialog" value="#4a6d8c"/>
259 <color name="searchbox" value="#4a6d8c" font="#000000"/>
260 <color name="body" value="#ffffff" link="#0F3660" vlink="#009999" hlink="#000066"/>
261 <color name="table" value="#7099C5"/>
262 <color name="table-cell" value="#f0f0ff"/>
263 <color name="highlight" value="#ffff00"/>
264 <color name="fixme" value="#cc6600"/>
265 <color name="note" value="#006699"/>
266 <color name="warning" value="#990000"/>
267 <color name="code" value="#CFDCED"/>
268 <color name="footer" value="#cedfef"/>
271 <!-- Color group: Krysalis -->
273 <color name="header" value="#FFFFFF"/>
275 <color name="tab-selected" value="#a5b6c6" link="#000000" vlink="#000000" hlink="#000000"/>
276 <color name="tab-unselected" value="#F7F7F7" link="#000000" vlink="#000000" hlink="#000000"/>
277 <color name="subtab-selected" value="#a5b6c6" link="#000000" vlink="#000000" hlink="#000000"/>
278 <color name="subtab-unselected" value="#a5b6c6" link="#000000" vlink="#000000" hlink="#000000"/>
280 <color name="heading" value="#a5b6c6"/>
281 <color name="subheading" value="#CFDCED"/>
283 <color name="navstrip" value="#CFDCED" font="#000000" link="#000000" vlink="#000000" hlink="#000000"/>
284 <color name="toolbox" value="#a5b6c6"/>
285 <color name="border" value="#a5b6c6"/>
287 <color name="menu" value="#F7F7F7" link="#000000" vlink="#000000" hlink="#000000"/>
288 <color name="dialog" value="#F7F7F7"/>
290 <color name="body" value="#ffffff" link="#0F3660" vlink="#009999" hlink="#000066"/>
292 <color name="table" value="#a5b6c6"/>
293 <color name="table-cell" value="#ffffff"/>
294 <color name="highlight" value="#ffff00"/>
295 <color name="fixme" value="#cc6600"/>
296 <color name="note" value="#006699"/>
297 <color name="warning" value="#990000"/>
298 <color name="code" value="#a5b6c6"/>
300 <color name="footer" value="#a5b6c6"/>
303 <!-- Color group: Collabnet -->
305 <color name="header" value="#003366"/>
307 <color name="tab-selected" value="#dddddd" link="#555555" vlink="#555555" hlink="#555555"/>
308 <color name="tab-unselected" value="#999999" link="#ffffff" vlink="#ffffff" hlink="#ffffff"/>
309 <color name="subtab-selected" value="#cccccc" link="#000000" vlink="#000000" hlink="#000000"/>
310 <color name="subtab-unselected" value="#cccccc" link="#555555" vlink="#555555" hlink="#555555"/>
312 <color name="heading" value="#003366"/>
313 <color name="subheading" value="#888888"/>
315 <color name="navstrip" value="#dddddd" font="#555555"/>
316 <color name="toolbox" value="#dddddd" font="#555555"/>
317 <color name="border" value="#999999"/>
319 <color name="menu" value="#ffffff"/>
320 <color name="dialog" value="#eeeeee"/>
322 <color name="body" value="#ffffff"/>
324 <color name="table" value="#ccc"/>
325 <color name="table-cell" value="#ffffff"/>
326 <color name="highlight" value="#ffff00"/>
327 <color name="fixme" value="#cc6600"/>
328 <color name="note" value="#006699"/>
329 <color name="warning" value="#990000"/>
330 <color name="code" value="#003366"/>
332 <color name="footer" value="#ffffff"/>
334 <!-- Color group: Lenya using pelt-->
337 <color name="header" value="#ffffff"/>
339 <color name="tab-selected" value="#E5E4D9" link="#000000" vlink="#000000" hlink="#000000"/>
340 <color name="tab-unselected" value="#F5F4E9" link="#000000" vlink="#000000" hlink="#000000"/>
341 <color name="subtab-selected" value="#000000" link="#000000" vlink="#000000" hlink="#000000"/>
342 <color name="subtab-unselected" value="#E5E4D9" link="#000000" vlink="#000000" hlink="#000000"/>
344 <color name="heading" value="#E5E4D9"/>
345 <color name="subheading" value="#000000"/>
346 <color name="published" value="#000000"/>
347 <color name="navstrip" value="#E5E4D9" font="#000000"/>
348 <color name="toolbox" value="#CFDCED" font="#000000"/>
349 <color name="border" value="#999999"/>
351 <color name="menu" value="#E5E4D9" font="#000000" link="#000000" vlink="#000000" hlink="#000000"/>
352 <color name="dialog" value="#CFDCED"/>
353 <color name="body" value="#ffffff" />
355 <color name="table" value="#ccc"/>
356 <color name="table-cell" value="#ffffff"/>
357 <color name="highlight" value="#ffff00"/>
358 <color name="fixme" value="#cc6600"/>
359 <color name="note" value="#006699"/>
360 <color name="warning" value="#990000"/>
361 <color name="code" value="#003366"/>
363 <color name="footer" value="#E5E4D9"/>
368 Credits are typically rendered as a set of small clickable
369 images in the page footer.
371 Use box-location="alt" to move the credits to an alternate location
372 (if the skin supports it).
374 For example, pelt skin:
375 - box-location="alt" will place the logo at the end of the
376 left-hand coloured menu panel.
377 - box-location="alt2" will place them underneath that panel
378 in the left-hand whitespace.
379 - Otherwise they are placed next to the compatibility icons
380 at the bottom of the screen.
382 Comment out the whole <credit>-element if you want no credits in the
386 <credit box-location="alt">
387 <name>Built with Apache Forrest</name>
388 <url>http://forrest.apache.org/</url>
389 <image>images/built-with-forrest-button.png</image>
393 <!-- A credit with @role="pdf" will be used to compose a footer
394 for each page in the PDF, using either "name" or "url" or both.
398 <name>Built with Apache Forrest</name>
399 <url>http://forrest.apache.org/</url>