You are viewing a plain text version of this content. The canonical link for it is here.
Posted to svn@forrest.apache.org by cr...@apache.org on 2004/07/23 07:27:16 UTC
svn commit: rev 23180 - in forrest/trunk/src: core/fresh-site/src/documentation documentation
Author: crossley
Date: Thu Jul 22 22:27:15 2004
New Revision: 23180
Modified:
forrest/trunk/src/core/fresh-site/src/documentation/skinconf.xml
forrest/trunk/src/documentation/skinconf.xml
Log:
Tidy the comments and synchronise between fesh-site and Forrest docs.
Modified: forrest/trunk/src/core/fresh-site/src/documentation/skinconf.xml
==============================================================================
--- forrest/trunk/src/core/fresh-site/src/documentation/skinconf.xml (original)
+++ forrest/trunk/src/core/fresh-site/src/documentation/skinconf.xml Thu Jul 22 22:27:15 2004
@@ -16,8 +16,8 @@
-->
<!--
-Skin configuration file. This file contains details of your project, which will
-be used to configure the chosen Forrest skin.
+Skin configuration file. This file contains details of your project,
+which will be used to configure the chosen Forrest skin.
-->
<!DOCTYPE skinconfig PUBLIC
@@ -28,31 +28,31 @@
<skinconfig>
<!-- To enable lucene search add provider="lucene"
- Add box-location="alt" to move the search box to an alternate location
- (if the skin supports it) and box-location="all" to show it in all
- available locations on the page. Remove the <search> element to show
- no search box.
- -->
+ Add box-location="alt" to move the search box to an alternate location
+ (if the skin supports it) and box-location="all" to show it in all
+ available locations on the page. Remove the <search> element to show
+ no search box.
+ -->
<search name="MyProject" domain="mydomain"/>
-
- <!-- Do we want to disable the print link? If enabled, invalid HTML 4.0.1 -->
+
+ <!-- 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 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 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 navigation icons on all external links? -->
<disable-external-link-image>false</disable-external-link-image>
- <!-- Do we want to disable w3c compliance links? -->
+ <!-- Disable w3c compliance links? -->
<disable-compliance-links>false</disable-compliance-links>
- <!-- Whether to render mailto: links unrecognisable by spam harvesters -->
+ <!-- Render mailto: links unrecognisable by spam harvesters? -->
<obfuscate-mail-links>true</obfuscate-mail-links>
<!-- mandatory project logo
@@ -84,13 +84,16 @@
<!-- The following are used to construct a copyright statement -->
<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>
+ <!-- The optional copyright-link URL will used as a link in the
+ copyright statement
+ <copyright-link>http://www.apache.org/licenses/</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.
- Use location="alt" to move the trail to an alternate location (if the skin supports it).
+ <!-- Some skins use this to form a 'breadcrumb trail' of links.
+ If you don't want these, then set the attributes to blank.
+ The DTD purposefully requires them.
+ Use location="alt" to move the trail to an alternate location
+ (if the skin supports it).
-->
<trail>
<link1 name="myGroup" href="http://www.apache.org/"/>
@@ -98,34 +101,33 @@
<link3 name="" href=""/>
</trail>
- <!-- Configure the TOC, ie the Table of Contents.
+ <!-- Configure the TOC, i.e. the Table of Contents.
@max-depth
- how many "section" levels need to be included in the
- generated Table of Contents (TOC).
+ how many "section" levels need to be included in the
+ generated Table of Contents (TOC).
@min-sections
- Minimum required to create a TOC.
+ Minimum required to create a TOC.
@location ("page","menu","page,menu")
- Where to show the TOC.
+ Where to show the TOC.
-->
<toc max-depth="2" min-sections="1" location="page"/>
<!-- Heading types can be clean|underlined|boxed -->
<headings type="boxed"/>
-
- <extra-css>
- <!-- A little sample to show how the class attribute can be used -->
+ <extra-css>
+ <!-- A sample to show how the class attribute can be used -->
p.quote {
margin-left: 2em;
padding: .5em;
background-color: #f0f0f0;
font-family: monospace;
}
-
</extra-css>
-
+
<colors>
-
+ <!-- These values are used for the generated CSS files. -->
+
<!-- Krysalis -->
<!--
<color name="header" value="#FFFFFF"/>
@@ -267,7 +269,7 @@
portrait).
Supported text alignments are left, right, justify (default left).
-->
- <page size="letter" orientation="portrait"/>
+ <page size="letter" orientation="portrait" text-align="left"/>
<!--
Margins can be specified for top, bottom, inner, and outer
@@ -290,8 +292,8 @@
<show-external-urls>false</show-external-urls>
</pdf>
- <!-- Credits are typically rendered as a set of small clickable images in the
- page footer -->
+ <!-- Credits are typically rendered as a set of small clickable
+ images in the page footer -->
<credits>
<credit>
<name>Built with Apache Forrest</name>
@@ -300,8 +302,8 @@
<width>88</width>
<height>31</height>
</credit>
- <!-- A credit with @role='pdf' will have its name and url displayed in the
- PDF page's footer. -->
+ <!-- A credit with @role='pdf' will have its name and url
+ displayed in the PDF page's footer. -->
</credits>
</skinconfig>
Modified: forrest/trunk/src/documentation/skinconf.xml
==============================================================================
--- forrest/trunk/src/documentation/skinconf.xml (original)
+++ forrest/trunk/src/documentation/skinconf.xml Thu Jul 22 22:27:15 2004
@@ -16,8 +16,8 @@
-->
<!--
-Skin configuration file. This file contains details of your project, which will
-be used to configure the chosen Forrest skin.
+Skin configuration file. This file contains details of your project,
+which will be used to configure the chosen Forrest skin.
-->
<!DOCTYPE skinconfig PUBLIC
@@ -28,30 +28,31 @@
<skinconfig>
<!-- To enable lucene search add provider="lucene"
- Add box-location="alt" to move the search box to an alternate location
- (if the skin supports it) and box-location="all" to show it in all
- available locations on the page. Remove the <search> element to show
- no search box.
- -->
+ Add box-location="alt" to move the search box to an alternate location
+ (if the skin supports it) and box-location="all" to show it in all
+ available locations on the page. Remove the <search> element to show
+ no search box.
+ -->
<search name="Apache Forrest" domain="forrest.apache.org"/>
- <!-- Do we want to disable the print link? If enabled, invalid HTML 4.0.1 -->
+
+ <!-- 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 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 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 navigation icons on all external links? -->
<disable-external-link-image>false</disable-external-link-image>
- <!-- Do we want to disable w3c compliance links? -->
+ <!-- Disable w3c compliance links? -->
<disable-compliance-links>false</disable-compliance-links>
- <!-- Whether to render mailto: links unrecognisable by spam harvesters -->
+ <!-- Render mailto: links unrecognisable by spam harvesters? -->
<obfuscate-mail-links>true</obfuscate-mail-links>
<!-- mandatory project logo
@@ -80,36 +81,41 @@
<!-- The following are used to construct a copyright statement -->
<year>2002-2004</year>
<vendor>The Apache Software Foundation.</vendor>
- <copyright-link>http://www.apache.org/licenses/LICENSE-2.0</copyright-link>
+ <copyright-link>http://www.apache.org/licenses/</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.
+ <!-- Some skins use this to form a 'breadcrumb trail' of links.
+ If you don't want these, then set the attributes to blank.
+ The DTD purposefully requires them.
+ Use location="alt" to move the trail to an alternate location
+ (if the skin supports it).
-->
+
<trail>
<link1 name="apache" href="http://www.apache.org/"/>
<link2 name="forrest" href="http://forrest.apache.org/"/>
<link3 name="" href=""/>
</trail>
- <!-- Configure the TOC, ie the Table of Contents.
+ <!-- Configure the TOC, i.e. the Table of Contents.
@max-depth
- how many "section" levels need to be included in the
- generated Table of Contents (TOC).
+ how many "section" levels need to be included in the
+ generated Table of Contents (TOC).
@min-sections
- Minimum required to create a TOC.
+ Minimum required to create a TOC.
@location ("page","menu","page,menu")
- Where to show the TOC.
+ Where to show the TOC.
-->
<toc max-depth="2" min-sections="1" location="page"/>
<!-- Heading types can be clean|underlined|boxed -->
<headings type="clean"/>
-
+
<extra-css>
</extra-css>
-
+
<colors>
-
+ <!-- These values are used for the generated CSS files. -->
+
<!-- Krysalis -->
<!--
<color name="header" value="#FFFFFF"/>
@@ -231,31 +237,32 @@
<inner>1.25in</inner>
<outer>1in</outer>
</margins>
-
+
<!--
Print the URL text next to all links going outside the file
-->
<show-external-urls>false</show-external-urls>
</pdf>
- <!-- Credits are typically rendered as a set of small clickable images in the
- page footer -->
+ <!-- Credits are typically rendered as a set of small clickable
+ images in the page footer -->
<credits>
<credit>
- <name>Built with Forrest</name>
+ <name>Built with Apache Forrest</name>
<url>http://forrest.apache.org/</url>
<image>skin/images/built-with-forrest-button.png</image>
<width>88</width>
<height>31</height>
</credit>
<credit>
- <name>Built with Cocoon</name>
+ <name>Built with Apache Cocoon</name>
<url>http://cocoon.apache.org/</url>
<image>images/built-with-cocoon.gif</image>
<width>88</width>
<height>31</height>
</credit>
- <!-- A credit with @role='pdf' will have its name and url displayed in the
- PDF page's footer. -->
+ <!-- A credit with @role='pdf' will have its name and url
+ displayed in the PDF page's footer. -->
</credits>
+
</skinconfig>