src/documentation/skinconf.xml

   1 <?xml version="1.0"?>
   2 <!--
   3    ====================================================================
   4    Licensed to the Apache Software Foundation (ASF) under one or more
   5    contributor license agreements.  See the NOTICE file distributed with
   6    this work for additional information regarding copyright ownership.
   7    The ASF licenses this file to You under the Apache License, Version 2.0
   8    (the "License"); you may not use this file except in compliance with
   9    the License.  You may obtain a copy of the License at
  10
  11        http://www.apache.org/licenses/LICENSE-2.0
  12
  13    Unless required by applicable law or agreed to in writing, software
  14    distributed under the License is distributed on an "AS IS" BASIS,
  15    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16    See the License for the specific language governing permissions and
  17    limitations under the License.
  18    ====================================================================
  19 -->
  20
  21 <!--
  22 Skin configuration file. This file contains details of your project, which will
  23 be used to configure the chosen Forrest skin.
  24 -->
  25
  26 <!DOCTYPE skinconfig [
  27
  28   <!ENTITY % links.att 'name CDATA #REQUIRED'>
  29   <!ENTITY % link.att 'name CDATA #REQUIRED href CDATA #REQUIRED'>
  30   <!ELEMENT skinconfig (disable-lucene?, disable-search?, disable-print-link?, disable-pdf-link?,
  31   disable-xml-link?, disable-compliance-links?, obfuscate-mail-links?, searchsite-domain?, searchsite-name?,
  32   project-name, project-description?, project-url, project-logo, group-name?, group-description?, group-url?, group-logo?,
  33   host-url?, host-logo?, year?, vendor?, trail?, toc?, credits?)*>
  34   <!ELEMENT credits (credit*)>
  35   <!ELEMENT credit (name, url, image?, width?, height?)>
  36   <!-- id uniquely identifies the tool, and role indicates its function -->
  37   <!ATTLIST credit id   CDATA #IMPLIED
  38                    role CDATA #IMPLIED>
  39   <!ELEMENT disable-lucene (#PCDATA)>
  40   <!ELEMENT disable-search (#PCDATA)>
  41   <!ELEMENT disable-print-link (#PCDATA)>
  42   <!ELEMENT disable-pdf-link (#PCDATA)>
  43   <!ELEMENT disable-xml-link (#PCDATA)>
  44   <!ELEMENT disable-compliance-links (#PCDATA)>
  45   <!ELEMENT obfuscate-mail-links (#PCDATA)>
  46   <!ELEMENT searchsite-domain (#PCDATA)>
  47   <!ELEMENT searchsite-name (#PCDATA)>
  48   <!ELEMENT project-name (#PCDATA)>
  49   <!ELEMENT project-description (#PCDATA)>
  50   <!ELEMENT project-url (#PCDATA)>
  51   <!ELEMENT project-logo (#PCDATA)>
  52   <!ELEMENT group-name (#PCDATA)>
  53   <!ELEMENT group-description (#PCDATA)>
  54   <!ELEMENT group-url (#PCDATA)>
  55   <!ELEMENT group-logo (#PCDATA)>
  56   <!ELEMENT host-url (#PCDATA)>
  57   <!ELEMENT host-logo (#PCDATA)>
  58   <!ELEMENT year (#PCDATA)>
  59   <!ELEMENT vendor (#PCDATA)>
  60   <!ELEMENT trail (link1, link2, link3)>
  61   <!ELEMENT link1 EMPTY>
  62   <!-- Seems we can't use param entity refs until this is DTDified -->
  63   <!ATTLIST link1 name CDATA #REQUIRED href CDATA #IMPLIED>
  64   <!ELEMENT link2 EMPTY>
  65   <!ATTLIST link2 name CDATA #REQUIRED href CDATA #IMPLIED>
  66   <!ELEMENT link3 EMPTY>
  67   <!ATTLIST link3 name CDATA #REQUIRED href CDATA #IMPLIED>
  68   <!ELEMENT name (#PCDATA)>
  69   <!ELEMENT url (#PCDATA)>
  70   <!ELEMENT image (#PCDATA)>
  71   <!ELEMENT width (#PCDATA)>
  72   <!ELEMENT height (#PCDATA)>
  73   <!ELEMENT toc EMPTY>
  74   <!ATTLIST toc level CDATA #IMPLIED>
  75   ]>
  76
  77 <skinconfig>
  78   <!-- Do we want to disable the Lucene search box? -->
  79   <disable-lucene>true</disable-lucene>
  80   <!-- Do we want to disable the Google search box? -->
  81   <disable-search>false</disable-search>
  82   <!-- Do we want to disable the print link? If enabled, invalid HTML 4.0.1 -->
  83   <disable-print-link>false</disable-print-link>
  84   <!-- Do we want to disable the PDF link? -->
  85   <disable-pdf-link>false</disable-pdf-link>
  86   <!-- Do we want to disable the xml source link? -->
  87   <disable-xml-link>true</disable-xml-link>
  88   <!-- Do we want to disable w3c compliance links? -->
  89   <disable-compliance-links>false</disable-compliance-links>
  90   <!-- Whether to render mailto: links unrecognisable by spam harvesters -->
  91   <obfuscate-mail-links>true</obfuscate-mail-links>
  92
  93   <!-- Do we want to disable the Google search box? -->
  94   <disable-search>false</disable-search>
  95   <!-- Do we want to disable w3c compliance links? -->
  96   <disable-compliance-links>false</disable-compliance-links>
  97
  98   <searchsite-domain>poi.apache.org</searchsite-domain>
  99   <searchsite-name>poi</searchsite-name>
 100
 101   <!-- mandatory project logo
 102        skin: forrest-site renders it at the top -->
 103   <project-name>POI</project-name>
 104   <project-url>http://poi.apache.org/</project-url>
 105   <project-logo>resources/images/project-logo.jpg</project-logo>
 106
 107   <!-- optional group logo
 108        skin: forrest-site renders it at the top-left corner -->
 109   <group-name>Apache POI</group-name>
 110   <group-url>http://poi.apache.org</group-url>
 111   <group-logo>resources/images/group-logo.jpg</group-logo>
 112
 113   <!-- optional host logo (e.g. sourceforge logo)
 114        skin: forrest-site renders it at the bottom-left corner -->
 115   <host-url></host-url>
 116   <host-logo></host-logo>
 117
 118   <!-- The following are used to construct a copyright statement -->
 119   <year>2002-2007</year>
 120   <vendor>The Apache Software Foundation</vendor>
 121
 122   <!-- Some skins use this to form a 'breadcrumb trail' of links. If you don't
 123   want these, set the attributes to blank. The DTD purposefully requires them.
 124   -->
 125   <trail>
 126     <link1 name="Apache" href="http://www.apache.org/"/>
 127     <link2 name="POI" href="http://poi.apache.org/"/>
 128   </trail>
 129
 130   <!-- Credits are typically rendered as a set of small clickable images in the
 131   page footer -->
 132   <credits>
 133     <credit>
 134       <name>Built with Apache Forrest</name>
 135       <url>http://xml.apache.org/forrest/</url>
 136       <image>images/built-with-forrest-button.png</image>
 137       <width>88</width>
 138       <height>31</height>
 139     </credit>
 140     <!-- A credit with @role='pdf' will have its name and url displayed in the
 141     PDF page's footer. -->
 142   </credits>
 143
 144 </skinconfig>