forrest-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From brond...@apache.org
Subject svn commit: rev 21074 - forrest/trunk/src/documentation/content/xdocs/docs
Date Fri, 11 Jun 2004 05:53:29 GMT
Author: brondsem
Date: Thu Jun 10 22:53:29 2004
New Revision: 21074

Modified:
   forrest/trunk/src/documentation/content/xdocs/docs/your-project.xml
Log:
update skinconf example block

Modified: forrest/trunk/src/documentation/content/xdocs/docs/your-project.xml
==============================================================================
--- forrest/trunk/src/documentation/content/xdocs/docs/your-project.xml	(original)
+++ forrest/trunk/src/documentation/content/xdocs/docs/your-project.xml	Thu Jun 10 22:53:29
2004
@@ -233,24 +233,36 @@
 
         <p>
           Most Forrest skins can be customized through a single XML file,
-          <code>src/documentation/skinconf.xml</code>, which (minus its DTD)
looks
-          like this:
+          <code>src/documentation/skinconf.xml</code>, which looks like this:
         </p>
 <source><![CDATA[
+ <!DOCTYPE skinconfig PUBLIC
+        "-//APACHE//DTD Skin Configuration V0.6-1//EN"
+        "skinconfig-v06-1.dtd">
+
 <skinconfig>
-  <!-- Do we want to disable the Google search box? -->
-  <disable-search>false</disable-search>
-  <!-- Do we want to disable the print link? If enabled, valid HTML 4.0.1 -->
+  <!-- To enable lucene search add provider="lucene" -->
+  <search name="MyProject" domain="mydomain"/>
+  
+  <!-- Do we want to disable the print link? If enabled, invalid HTML 4.0.1 -->
   <disable-print-link>true</disable-print-link>  
   <!-- Do we want to disable the PDF link? -->
   <disable-pdf-link>false</disable-pdf-link>
   <!-- Do we want to disable the xml source link? -->
+  <!-- The xml source link makes it possible to access the xml rendition of
+        the source frim the html page, and to have it generated statically.
+        This can be used to enable other sites and services to reuse the
+        xml format for their uses. Keep this disabled if you don't want other
+        sites to easily reuse your pages.-->
   <disable-xml-link>true</disable-xml-link>
+  
+  <!-- If true, an the images on all external links will not be added -->  
+  <disable-external-link-image>false</disable-external-link-image>
+  
   <!-- Do we want to disable w3c compliance links? -->
   <disable-compliance-links>false</disable-compliance-links>
-
-  <searchsite-domain>mydomain</searchsite-domain>  
-  <searchsite-name>MyProject</searchsite-name>  
+  <!-- Whether to render mailto: links unrecognisable by spam harvesters -->
+  <obfuscate-mail-links>true</obfuscate-mail-links>
 
   <!-- mandatory project logo
        skin: forrest-site renders it at the top -->
@@ -274,25 +286,72 @@
        skin: forrest-site renders it at the bottom-left corner -->
   <host-url></host-url>
   <host-logo></host-logo>
+  
+  <!-- relative url of a favicon file, normally favicon.ico -->
+  <favicon-url></favicon-url>
 
   <!-- The following are used to construct a copyright statement -->
-  <year>2003</year>
+  <year>2004</year>
   <vendor>The Acme Software Foundation.</vendor>
+  <!-- if present, the copyright-link URL will used as a link in the copyright statement
+  <copyright-link>http://www.apache.org/licenses/LICENSE-2.0</copyright-link>
+  -->
 
   <!-- Some skins use this to form a 'breadcrumb trail' of links. If you don't
   want these, set the attributes to blank. The DTD purposefully requires them.
   -->
   <trail>
     <link1 name="myGroup" href="http://www.apache.org/"/>
-    <link2 name="myProject" href="http://xml.apache.org/"/>
+    <link2 name="myProject" href="http://forrest.apache.org/"/>
     <link3 name="" href=""/>
   </trail>
 
-  <!-- Configure how many "section" levels need to be included in the
-  generated Table of Contents (TOC). By default, if no toc element is provided
-  below, then 2 levels are included. Level 0 does not generate any TOC at all.
+  <!-- Configure the TOC, ie the Table of Contents.
+  @max-depth
+  how many "section" levels need to be included in the
+  generated Table of Contents (TOC). 
+  @min-sections
+  Minimum required to create a TOC.
+  @location ("page","menu","page,menu")
+  Where to show the TOC.
   -->
-  <toc level="2"/>
+  <toc max-depth="2" min-sections="1" location="page"/>
+
+  <!-- Heading types can be clean|underlined|boxed  -->
+  <headings type="boxed"/>
+  
+  <extra-css>
+  </extra-css>
+  
+  <colors>
+  <!-- CSS coloring examples omitted for brevity -->
+  </colors>
+ 
+  <!-- Settings specific to PDF output.  -->
+  <pdf>
+    <!-- 
+       Supported page sizes are a0, a1, a2, a3, a4, a5, executive,
+       folio, legal, ledger, letter, quarto, tabloid (default letter).
+       Supported page orientations are portrait, landscape (default
+       portrait).
+    -->
+    <page size="letter" orientation="portrait"/>
+
+    <!--
+       Margins can be specified for top, bottom, inner, and outer
+       edges. If double-sided="false", the inner edge is always left
+       and the outer is always right. If double-sided="true", the
+       inner edge will be left on odd pages, right on even pages,
+       the outer edge vice versa.
+       Specified below are the default settings.
+    -->
+    <margins double-sided="false">
+      <top>1in</top>
+      <bottom>1in</bottom>
+      <inner>1.25in</inner>
+      <outer>1in</outer>
+    </margins>
+  </pdf>
 
   <!-- Credits are typically rendered as a set of small clickable images in the
   page footer -->

Mime
View raw message