wamblee.org Git - utils/blob - crawler/kiss/docs/skinconf.xml

   1 <?xml version="1.0"?>
   2 <!--
   3   Copyright 2002-2005 The Apache Software Foundation or its licensors,
   4   as applicable.
   5
   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
   9
  10       http://www.apache.org/licenses/LICENSE-2.0
  11
  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.
  17 -->
  18
  19 <!--
  20 Skin configuration file. This file contains details of your project,
  21 which will be used to configure the chosen Forrest skin.
  22 -->
  23
  24 <!DOCTYPE skinconfig PUBLIC "-//APACHE//DTD Skin Configuration V0.7-1//EN" "http://forrest.apache.org/dtd/skinconfig-v07-1.dtd">
  25 <skinconfig>
  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.
  32   -->
  33   <search name="MyProject" domain="mydomain" provider="google"/>
  34
  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>
  50
  51   <!-- Disable navigation icons on all external links? -->
  52   <disable-external-link-image>true</disable-external-link-image>
  53
  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>
  59
  60   <!-- Render mailto: links unrecognisable by spam harvesters? -->
  61   <obfuscate-mail-links>true</obfuscate-mail-links>
  62   <obfuscate-mail-value>.at.</obfuscate-mail-value>
  63
  64   <!-- Disable the javascript facility to change the font size -->
  65   <disable-font-script>true</disable-font-script>
  66
  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> -->
  75
  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> -->
  84
  85   <!-- optional host logo (e.g. sourceforge logo)
  86        default skin: renders it at the bottom-left corner -->
  87   <host-url></host-url>
  88   <host-logo></host-logo>
  89
  90   <!-- relative url of a favicon file, normally favicon.ico -->
  91   <favicon-url></favicon-url>
  92
  93   <!-- The following are used to construct a copyright statement -->
  94   <year>2006</year>
  95   <vendor>wamblee.org</vendor>
  96   <!-- The optional copyright-link URL will be used as a link in the
  97     copyright statement
  98   <copyright-link>http://www.apache.org/licenses/</copyright-link>
  99   -->
 100
 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.
 107
 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
 110     directory.
 111   -->
 112   <trail>
 113     <link1 name="wamblee.org" href="http://wamblee.org/"/>
 114     <link2 name="utils" href="http://wamblee.org/utils"/>
 115     <link3 name="KiSS crawler" href="http://kiss.wamblee.org"/>
 116   </trail>
 117
 118   <!-- Configure the TOC, i.e. the Table of Contents.
 119   @max-depth
 120    how many "section" levels need to be included in the
 121    generated Table of Contents (TOC).
 122   @min-sections
 123    Minimum required to create a TOC.
 124   @location ("page","menu","page,menu", "none")
 125    Where to show the TOC.
 126   -->
 127   <toc max-depth="2" min-sections="1" location="page"/>
 128
 129   <!-- Heading types can be clean|underlined|boxed  -->
 130   <headings type="boxed"/>
 131
 132   <!-- The optional feedback element will be used to construct a
 133     feedback link in the footer with the page pathname appended:
 134     <a href="@href">{@to}</a>
 135     -->
 136   <feedback to="erik@wamblee.org"
 137     href="mailto:erik@wamblee.org?subject=Feedback&#160;" >
 138     Send feedback about the website to:
 139   </feedback>
 140
 141   <!-- Optional message of the day (MOTD).
 142     Note: This is only implemented in the pelt skin.
 143     If the optional <motd> element is used, then messages will be appended
 144     depending on the URI string pattern.
 145     motd-option : Specifies a pattern to match and provides small text content.
 146     motd-title : This text will be added in brackets after the <html><title>
 147     motd-page : This text will be added in a panel on the face of the page,
 148     with the "motd-page-url" being the hyperlink "More".
 149     Values for the "location" attribute are:
 150       page : on the face of the page, e.g. in the spare space of the toc
 151       alt : at the bottom of the left-hand navigation panel
 152       both : both
 153     -->
 154 <!--
 155   <motd>
 156     <motd-option pattern="docs_0_80">
 157       <motd-title>v0.8-dev</motd-title>
 158       <motd-page location="both">
 159         This is documentation for development version v0.8
 160       </motd-page>
 161       <motd-page-url>/versions/index.html</motd-page-url>
 162     </motd-option>
 163     <motd-option pattern="docs_0_70">
 164       <motd-title>v0.7</motd-title>
 165       <motd-page location="both">
 166         This is documentation for current version v0.7
 167       </motd-page>
 168       <motd-page-url>/versions/index.html</motd-page-url>
 169     </motd-option>
 170   </motd>
 171 -->
 172
 173   <!--
 174     extra-css - here you can define custom css-elements that are
 175     A) overriding the fallback elements or
 176     B) adding the css definition from new elements that you may have
 177        used in your documentation.
 178     -->
 179   <extra-css>
 180     <!--Example of reason B:
 181         To define the css definition of a new element that you may have used
 182         in the class attribute of a <p> node.
 183         e.g. <p class="quote"/>
 184     -->
 185     p.quote {
 186       margin-left: 2em;
 187       padding: .5em;
 188       background-color: #f0f0f0;
 189       font-family: monospace;
 190     }
 191     <!--Example:
 192         To override the colours of links only in the footer.
 193     -->
 194     #footer a { color: #0F3660; }
 195     #footer a:visited { color: #009999; }
 196   </extra-css>
 197
 198   <colors>
 199   <!-- These values are used for the generated CSS files.
 200     They essentially "override" the default colors defined in the chosen skin.
 201     There are four duplicate "groups" of colors below, denoted by comments:
 202       Color group: Forrest, Krysalis, Collabnet, and Lenya using Pelt.
 203     They are provided for example only. To customize the colors of any skin,
 204     uncomment one of these groups of color elements and change the values
 205     of the particular color elements that you wish to change.
 206     Note that by default, all color groups are commented-out which means that
 207     the default colors provided by the skin are being used.
 208   -->
 209
 210   <!-- Color group: Forrest: example colors similar to forrest.apache.org
 211     Some of the element names are obscure, so comments are added to show how
 212     the "pelt" skin uses them, other skins might use these elements in a different way.
 213     Tip: temporarily change the value of an element to red (#ff0000) and see the effect.
 214      pelt: breadtrail: the strip at the top of the page and the second strip under the tabs
 215      pelt: header: top strip containing project and group logos
 216      pelt: heading|subheading: section headings within the content
 217      pelt: navstrip: the strip under the tabs which contains the published date
 218      pelt: menu: the left-hand navigation panel
 219      pelt: toolbox: the selected menu item
 220      pelt: searchbox: the background of the searchbox
 221      pelt: border: line border around selected menu item
 222      pelt: body: any remaining parts, e.g. the bottom of the page
 223      pelt: footer: the second from bottom strip containing credit logos and published date
 224      pelt: feedback: the optional bottom strip containing feedback link
 225   -->
 226 <!--
 227     <color name="breadtrail" value="#cedfef" font="#0F3660" link="#0F3660" vlink="#0F3660" hlink="#000066"/>
 228     <color name="header" value="#294563"/>
 229     <color name="tab-selected" value="#4a6d8c" link="#0F3660" vlink="#0F3660" hlink="#000066"/>
 230     <color name="tab-unselected" value="#b5c7e7" link="#0F3660" vlink="#0F3660" hlink="#000066"/>
 231     <color name="subtab-selected" value="#4a6d8c" link="#0F3660" vlink="#0F3660" hlink="#000066"/>
 232     <color name="subtab-unselected" value="#4a6d8c" link="#0F3660" vlink="#0F3660" hlink="#000066"/>
 233     <color name="heading" value="#294563"/>
 234     <color name="subheading" value="#4a6d8c"/>
 235     <color name="published" value="#4C6C8F" font="#FFFFFF"/>
 236     <color name="feedback" value="#4C6C8F" font="#FFFFFF" align="center"/>
 237     <color name="navstrip" value="#4a6d8c" font="#ffffff" link="#0F3660" vlink="#0F3660" hlink="#000066"/>
 238     <color name="menu" value="#4a6d8c" font="#cedfef" link="#ffffff" vlink="#ffffff" hlink="#ffcf00"/>
 239     <color name="toolbox" value="#4a6d8c"/>
 240     <color name="border" value="#294563"/>
 241     <color name="dialog" value="#4a6d8c"/>
 242     <color name="searchbox" value="#4a6d8c" font="#000000"/>
 243     <color name="body" value="#ffffff" link="#0F3660" vlink="#009999" hlink="#000066"/>
 244     <color name="table" value="#7099C5"/>
 245     <color name="table-cell" value="#f0f0ff"/>
 246     <color name="highlight" value="#ffff00"/>
 247     <color name="fixme" value="#cc6600"/>
 248     <color name="note" value="#006699"/>
 249     <color name="warning" value="#990000"/>
 250     <color name="code" value="#CFDCED"/>
 251     <color name="footer" value="#cedfef"/>
 252 -->
 253
 254   <!-- Color group: Krysalis -->
 255 <!--
 256     <color name="header"    value="#FFFFFF"/>
 257
 258     <color name="tab-selected" value="#a5b6c6" link="#000000" vlink="#000000" hlink="#000000"/>
 259     <color name="tab-unselected" value="#F7F7F7"  link="#000000" vlink="#000000" hlink="#000000"/>
 260     <color name="subtab-selected" value="#a5b6c6"  link="#000000" vlink="#000000" hlink="#000000"/>
 261     <color name="subtab-unselected" value="#a5b6c6"  link="#000000" vlink="#000000" hlink="#000000"/>
 262
 263     <color name="heading" value="#a5b6c6"/>
 264     <color name="subheading" value="#CFDCED"/>
 265
 266     <color name="navstrip" value="#CFDCED" font="#000000" link="#000000" vlink="#000000" hlink="#000000"/>
 267     <color name="toolbox" value="#a5b6c6"/>
 268     <color name="border" value="#a5b6c6"/>
 269
 270     <color name="menu" value="#F7F7F7" link="#000000" vlink="#000000" hlink="#000000"/>
 271     <color name="dialog" value="#F7F7F7"/>
 272
 273     <color name="body"    value="#ffffff" link="#0F3660" vlink="#009999" hlink="#000066"/>
 274
 275     <color name="table" value="#a5b6c6"/>
 276     <color name="table-cell" value="#ffffff"/>
 277     <color name="highlight" value="#ffff00"/>
 278     <color name="fixme" value="#cc6600"/>
 279     <color name="note" value="#006699"/>
 280     <color name="warning" value="#990000"/>
 281     <color name="code" value="#a5b6c6"/>
 282
 283     <color name="footer" value="#a5b6c6"/>
 284 -->
 285
 286   <!-- Color group: Collabnet -->
 287 <!--
 288     <color name="header"    value="#003366"/>
 289
 290     <color name="tab-selected" value="#dddddd" link="#555555" vlink="#555555" hlink="#555555"/>
 291     <color name="tab-unselected" value="#999999" link="#ffffff" vlink="#ffffff" hlink="#ffffff"/>
 292     <color name="subtab-selected" value="#cccccc" link="#000000" vlink="#000000" hlink="#000000"/>
 293     <color name="subtab-unselected" value="#cccccc" link="#555555" vlink="#555555" hlink="#555555"/>
 294
 295     <color name="heading" value="#003366"/>
 296     <color name="subheading" value="#888888"/>
 297
 298     <color name="navstrip" value="#dddddd" font="#555555"/>
 299     <color name="toolbox" value="#dddddd" font="#555555"/>
 300     <color name="border" value="#999999"/>
 301
 302     <color name="menu" value="#ffffff"/>
 303     <color name="dialog" value="#eeeeee"/>
 304
 305     <color name="body"      value="#ffffff"/>
 306
 307     <color name="table" value="#ccc"/>
 308     <color name="table-cell" value="#ffffff"/>
 309     <color name="highlight" value="#ffff00"/>
 310     <color name="fixme" value="#cc6600"/>
 311     <color name="note" value="#006699"/>
 312     <color name="warning" value="#990000"/>
 313     <color name="code" value="#003366"/>
 314
 315     <color name="footer" value="#ffffff"/>
 316 -->
 317  <!-- Color group: Lenya using pelt-->
 318 <!--
 319
 320     <color name="header" value="#ffffff"/>
 321
 322     <color name="tab-selected" value="#E5E4D9" link="#000000" vlink="#000000" hlink="#000000"/>
 323     <color name="tab-unselected" value="#F5F4E9" link="#000000" vlink="#000000" hlink="#000000"/>
 324     <color name="subtab-selected" value="#000000" link="#000000" vlink="#000000" hlink="#000000"/>
 325     <color name="subtab-unselected" value="#E5E4D9" link="#000000" vlink="#000000" hlink="#000000"/>
 326
 327     <color name="heading" value="#E5E4D9"/>
 328     <color name="subheading" value="#000000"/>
 329     <color name="published" value="#000000"/>
 330     <color name="navstrip" value="#E5E4D9" font="#000000"/>
 331     <color name="toolbox" value="#CFDCED" font="#000000"/>
 332     <color name="border" value="#999999"/>
 333
 334     <color name="menu" value="#E5E4D9" font="#000000" link="#000000" vlink="#000000" hlink="#000000"/>
 335     <color name="dialog" value="#CFDCED"/>
 336     <color name="body" value="#ffffff" />
 337
 338     <color name="table" value="#ccc"/>
 339     <color name="table-cell" value="#ffffff"/>
 340     <color name="highlight" value="#ffff00"/>
 341     <color name="fixme" value="#cc6600"/>
 342     <color name="note" value="#006699"/>
 343     <color name="warning" value="#990000"/>
 344     <color name="code" value="#003366"/>
 345
 346     <color name="footer" value="#E5E4D9"/>
 347 -->
 348   </colors>
 349
 350   <!-- Settings specific to PDF output. -->
 351   <pdf>
 352     <!--
 353        Supported page sizes are a0, a1, a2, a3, a4, a5, executive,
 354        folio, legal, ledger, letter, quarto, tabloid (default letter).
 355        Supported page orientations are portrait, landscape (default
 356        portrait).
 357        Supported text alignments are left, right, justify (default left).
 358     -->
 359     <page size="letter" orientation="portrait" text-align="left"/>
 360
 361     <!--
 362        Pattern of the page numbering in the footer - Default is "Page x".
 363        first occurrence of '1' digit represents the current page number,
 364        second occurrence of '1' digit represents the total page number,
 365        anything else is considered as the static part of the numbering pattern.
 366        Examples : x is the current page number, y the total page number.
 367        <page-numbering-format>none</page-numbering-format> Do not displays the page numbering
 368        <page-numbering-format>1</page-numbering-format> Displays "x"
 369        <page-numbering-format>p1.</page-numbering-format> Displays "px."
 370        <page-numbering-format>Page 1/1</page-numbering-format> Displays "Page x/y"
 371        <page-numbering-format>(1-1)</page-numbering-format> Displays "(x-y)"
 372     -->
 373     <page-numbering-format>Page 1</page-numbering-format>
 374
 375     <!--
 376        Margins can be specified for top, bottom, inner, and outer
 377        edges. If double-sided="false", the inner edge is always left
 378        and the outer is always right. If double-sided="true", the
 379        inner edge will be left on odd pages, right on even pages,
 380        the outer edge vice versa.
 381        Specified below are the default settings.
 382     -->
 383     <margins double-sided="false">
 384       <top>1in</top>
 385       <bottom>1in</bottom>
 386       <inner>1.25in</inner>
 387       <outer>1in</outer>
 388     </margins>
 389
 390     <!--
 391       Print the URL text next to all links going outside the file
 392     -->
 393     <show-external-urls>false</show-external-urls>
 394
 395     <!--
 396       Disable the copyright footer on each page of the PDF.
 397       A footer is composed for each page. By default, a "credit" with role=pdf
 398       will be used, as explained below. Otherwise a copyright statement
 399       will be generated. This latter can be disabled.
 400     -->
 401     <disable-copyright-footer>false</disable-copyright-footer>
 402   </pdf>
 403
 404   <!--
 405     Credits are typically rendered as a set of small clickable
 406     images in the page footer.
 407
 408     Use box-location="alt" to move the credits to an alternate location
 409     (if the skin supports it).
 410
 411     For example, pelt skin:
 412     - box-location="alt" will place the logo at the end of the
 413       left-hand coloured menu panel.
 414     - box-location="alt2" will place them underneath that panel
 415       in the left-hand whitespace.
 416     - Otherwise they are placed next to the compatibility icons
 417       at the bottom of the screen.
 418
 419     Comment out the whole <credit>-element if you want no credits in the
 420     web pages
 421    -->
 422   <credits>
 423     <credit box-location="alt">
 424       <name>Built with Apache Forrest</name>
 425       <url>http://forrest.apache.org/</url>
 426       <image>images/built-with-forrest-button.png</image>
 427       <width>88</width>
 428       <height>31</height>
 429     </credit>
 430     <!-- A credit with @role="pdf" will be used to compose a footer
 431      for each page in the PDF, using either "name" or "url" or both.
 432     -->
 433     <!--
 434     <credit role="pdf">
 435       <name>Built with Apache Forrest</name>
 436       <url>http://forrest.apache.org/</url>
 437     </credit>
 438     -->
 439   </credits>
 440
 441 </skinconfig>