xml-general-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From cross...@apache.org
Subject cvs commit: xml-site/src/documentation/content/xdocs guidelines.xml
Date Thu, 21 Oct 2004 05:06:19 GMT
crossley    2004/10/20 22:06:19

  Modified:    .        forrest.properties
               src/documentation skinconf.xml
               src/documentation/content/xdocs guidelines.xml
  Added:       src/documentation/classes CatalogManager.properties
  Log:
  Update configuration files for top-level xml-site to use Forrest-0.6 release.
  
  Revision  Changes    Path
  1.2       +94 -9     xml-site/forrest.properties
  
  Index: forrest.properties
  ===================================================================
  RCS file: /home/cvs/xml-site/forrest.properties,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- forrest.properties	25 Oct 2002 15:19:26 -0000	1.1
  +++ forrest.properties	21 Oct 2004 05:06:18 -0000	1.2
  @@ -1,23 +1,108 @@
  +# Copyright 2002-2004 The Apache Software Foundation
  +#
  +# Licensed under the Apache License, Version 2.0 (the "License");
  +# you may not use this file except in compliance with the License.
  +# You may obtain a copy of the License at
  +#
  +#     http://www.apache.org/licenses/LICENSE-2.0
  +#
  +# Unless required by applicable law or agreed to in writing, software
  +# distributed under the License is distributed on an "AS IS" BASIS,
  +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  +# See the License for the specific language governing permissions and
  +# limitations under the License.
  +
   ##############
   # Properties used by forrest.build.xml for building the website
  +# These are the defaults, un-comment them if you need to change them.
   ##############
   
  +# Prints out a summary of Forrest settings for this project
  +#forrest.echo=true 
  +
  +# Project name (used to name .war file)
  +project.name=xml-site
  +
   # Specifies name of Forrest skin to use
  +#project.skin=tigris
  +#project.skin=pelt
   project.skin=forrest-site
   
  -# Echo Forrest settings when Forrest is run?
  -forrest.echo=true
  +# comma separated list, file:// is supported
  +#forrest.skins.descriptors=http://forrest.apache.org/skins/skins.xml,file:///c:/myskins/skins.xml
  +
  +##############
  +# behavioural properties
  +#project.menu-scheme=tab_attributes
  +#project.menu-scheme=directories
  +
  +##############
  +# layout properties
  +
  +# Properties that can be set to override the default locations
  +#
  +# Parent properties must be set. This usually means uncommenting
  +# project.content-dir if any other property using it is uncommented
   
  -# Properties that must be set to override the default locations
   #project.status=status.xml
  -#project.content-dir=src/documentation
  -#project.conf-dir=${project.content-dir}/conf
  -#project.sitemap=${project.content-dir}/sitemap.xmap
  +project.content-dir=src/documentation
  +#project.raw-content-dir=${project.content-dir}/content
  +project.conf-dir=${project.content-dir}/conf
  +#project.sitemap-dir=${project.content-dir}
   #project.xdocs-dir=${project.content-dir}/content/xdocs
  -#project.stylesheets-dir=${project.content-dir}/resources/stylesheets
  -#project.images-dir=${project.content-dir}/resources/images
  -#project.schema-dir=${project.content-dir}/resources/schema
  +#project.resources-dir=${project.content-dir}/resources
  +#project.stylesheets-dir=${project.resources-dir}/stylesheets
  +#project.images-dir=${project.resources-dir}/images
  +#project.schema-dir=${project.resources-dir}/schema
   #project.skins-dir=${project.content-dir}/skins
   #project.skinconf=${project.content-dir}/skinconf.xml
   #project.lib-dir=${project.content-dir}/lib
   #project.classes-dir=${project.content-dir}/classes
  +#project.translations-dir=${project.content-dir}/translations
  +
  +project.configfile=${project.home}/src/documentation/conf/cli.xconf
  +
  +##############
  +# validation properties
  +
  +# This set of properties determine if validation is performed
  +# Values are inherited unless overridden.
  +# e.g. if forrest.validate=false then all others are false unless set to true.
  +#forrest.validate=true
  +#forrest.validate.xdocs=${forrest.validate}
  +#forrest.validate.skinconf=${forrest.validate}
  +#forrest.validate.sitemap=${forrest.validate}
  +#forrest.validate.stylesheets=${forrest.validate}
  +#forrest.validate.skins=${forrest.validate}
  +#forrest.validate.skins.stylesheets=${forrest.validate.skins}
  +
  +# *.failonerror=(true|false) - stop when an XML file is invalid
  +#forrest.validate.failonerror=true
  +
  +# *.excludes=(pattern) - comma-separated list of path patterns to not validate
  +# e.g.
  +#forrest.validate.xdocs.excludes=samples/subdir/**, samples/faq.xml
  +#forrest.validate.xdocs.excludes=
  +
  +
  +##############
  +# General Forrest properties
  +
  +# The URL to start crawling from
  +#project.start-uri=linkmap.html # need to change from using book.xml to site.xml
  +project.start-uri=index.html
  +# Set logging level for messages printed to the console
  +# (DEBUG, INFO, WARN, ERROR, FATAL_ERROR)
  +#project.debuglevel=ERROR
  +# Max memory to allocate to Java
  +#forrest.maxmemory=64m
  +# Any other arguments to pass to the JVM. For example, to run on an X-less
  +# server, set to -Djava.awt.headless=true
  +#forrest.jvmargs=
  +# The bugtracking URL - the issue number will be appended
  +#project.bugtracking-url=http://issues.apache.org/bugzilla/show_bug.cgi?id=
  +#project.bugtracking-url=http://issues.apache.org/jira/browse/
  +# The issues list as rss
  +#project.issues-rss-url=
  +#I18n Property only works for the "forrest run" target.
  +#project.i18n=true
  
  
  
  1.8       +307 -59   xml-site/src/documentation/skinconf.xml
  
  Index: skinconf.xml
  ===================================================================
  RCS file: /home/cvs/xml-site/src/documentation/skinconf.xml,v
  retrieving revision 1.7
  retrieving revision 1.8
  diff -u -r1.7 -r1.8
  --- skinconf.xml	13 Jun 2004 07:55:49 -0000	1.7
  +++ skinconf.xml	21 Oct 2004 05:06:18 -0000	1.8
  @@ -1,81 +1,108 @@
   <?xml version="1.0"?>
  +<!--
  +  Copyright 2002-2004 The Apache Software Foundation
  +
  +  Licensed under the Apache License, Version 2.0 (the "License");
  +  you may not use this file except in compliance with the License.
  +  You may obtain a copy of the License at
  +
  +      http://www.apache.org/licenses/LICENSE-2.0
  +
  +  Unless required by applicable law or agreed to in writing, software
  +  distributed under the License is distributed on an "AS IS" BASIS,
  +  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  +  See the License for the specific language governing permissions and
  +  limitations under the License.
  +-->
   
   <!--
  -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 [
  +<!DOCTYPE skinconfig PUBLIC "-//APACHE//DTD Skin Configuration V0.6-3//EN" "http://forrest.apache.org/dtd/skinconfig-v06-3.dtd">
  +<skinconfig>
  +  <!-- To enable lucene search add provider="lucene" (default is google).
  +    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. @domain will enable sitesearch for the specific domain with google.
  +    In other words google will search the @domain for the query string.
  +  -->
  +  <search name="Apache XML" domain="xml.apache.org" provider="google"/>
   
  -  <!ENTITY % links.att 'name CDATA #REQUIRED'>
  -  <!ENTITY % link.att 'name CDATA #REQUIRED href CDATA #REQUIRED'>
  -  <!ELEMENT skinconfig (disable-search?, disable-compliance-links?, searchsite-domain?,
searchsite-name?,
  -  project-name, project-url, project-logo, group-name?, group-url?, group-logo?,
  -  host-url?, host-logo?, year?, vendor?, trail?, credits?)*>
  -  <!ELEMENT credits (credit*)>
  -  <!ELEMENT credit (name, url, image?, width?, height?)>
  -  <!-- id uniquely identifies the tool, and role indicates its function -->
  -  <!ATTLIST credit id   CDATA #IMPLIED
  -                   role CDATA #IMPLIED>
  -  <!ELEMENT disable-search (#PCDATA)>
  -  <!ELEMENT disable-compliance-links (#PCDATA)>
  -  <!ELEMENT searchsite-domain (#PCDATA)>
  -  <!ELEMENT searchsite-name (#PCDATA)>  
  -  <!ELEMENT project-name (#PCDATA)>
  -  <!ELEMENT project-url (#PCDATA)>
  -  <!ELEMENT project-logo (#PCDATA)>
  -  <!ELEMENT group-name (#PCDATA)>
  -  <!ELEMENT group-url (#PCDATA)>
  -  <!ELEMENT group-logo (#PCDATA)>
  -  <!ELEMENT host-url (#PCDATA)>
  -  <!ELEMENT host-logo (#PCDATA)>
  -  <!ELEMENT year (#PCDATA)>
  -  <!ELEMENT vendor (#PCDATA)>
  -  <!ELEMENT trail (link1, link2, link3)>
  -  <!ELEMENT link1 EMPTY>
  -  <!-- Seems we can't use param entity refs until this is DTDified -->
  -  <!ATTLIST link1 name CDATA #REQUIRED href CDATA #IMPLIED>
  -  <!ELEMENT link2 EMPTY>
  -  <!ATTLIST link2 name CDATA #REQUIRED href CDATA #IMPLIED>
  -  <!ELEMENT link3 EMPTY>
  -  <!ATTLIST link3 name CDATA #REQUIRED href CDATA #IMPLIED>
  -  <!ELEMENT name (#PCDATA)>
  -  <!ELEMENT url (#PCDATA)>
  -  <!ELEMENT image (#PCDATA)>
  -  <!ELEMENT width (#PCDATA)>
  -  <!ELEMENT height (#PCDATA)>
  -  ]>
  +  <!-- Disable the print link? If enabled, invalid HTML 4.0.1 -->
  +  <disable-print-link>true</disable-print-link>  
  +  <!-- Disable the PDF link? -->
  +  <disable-pdf-link>false</disable-pdf-link>
  +  <!-- Disable the POD link? -->
  +  <disable-pod-link>true</disable-pod-link>
  +  <!-- Disable the Text link? FIXME: NOT YET IMPLEMENETED. -->
  +  <disable-txt-link>true</disable-txt-link>
  +  <!-- 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>
   
  -<skinconfig>
  -  <!-- Do we want to disable the Google search box? -->
  -  <disable-search>false</disable-search>
  +  <!-- Disable navigation icons on all external links? -->
  +  <disable-external-link-image>true</disable-external-link-image>
  +
  +  <!-- Disable w3c compliance links? 
  +    Use e.g. align="center" to move the compliance links logos to 
  +    an alternate location default is left.
  +    (if the skin supports it) -->
     <disable-compliance-links>false</disable-compliance-links>
  -  <searchsite-domain>xml.apache.org</searchsite-domain>
  -  <searchsite-name>Apache XML</searchsite-name>  
  +
  +  <!-- Render mailto: links unrecognisable by spam harvesters? -->
  +  <obfuscate-mail-links>true</obfuscate-mail-links>
  +  <obfuscate-mail-value>.at.</obfuscate-mail-value>
  +
  +  <!-- Disable the javascript facility to change the font size -->
  +  <disable-font-script>true</disable-font-script>
   
     <!-- mandatory project logo
  -       skin: forrest-site renders it at the top -->
  +       default skin: renders it at the top -->
     <project-name>Apache XML</project-name>
  +  <project-description>Apache XML</project-description>
     <project-url>http://xml.apache.org/</project-url>
     <project-logo>images/project-logo.gif</project-logo>
  +  <!-- Alternative static image:
  +  <project-logo>images/project-logo.gif</project-logo> -->
   
     <!-- optional group logo
  -       skin: forrest-site renders it at the top-left corner -->
  +       default skin: renders it at the top-left corner -->
     <group-name>Apache XML</group-name>
  +  <group-description>Apache XML</group-description>
     <group-url>http://xml.apache.org/</group-url>
     <group-logo>images/group-logo.gif</group-logo>
  +  <!-- Alternative static image:
  +  <group-logo>images/group-logo.gif</group-logo> -->
   
     <!-- optional host logo (e.g. sourceforge logo)
  -       skin: forrest-site renders it at the bottom-left corner -->
  +       default skin: 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>2002-2004</year>
     <vendor>The Apache Software Foundation.</vendor>
  +  <!-- The optional copyright-link URL will be 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.
  +  <!-- Some skins use this to form a 'breadcrumb trail' of links.
  +    Use location="alt" to move the trail to an alternate location
  +    (if the skin supports it).
  +	  Omit the location attribute to display the trail in the default location.
  +	  Use location="none" to not display the trail (if the skin supports it).
  +    For some skins just set the attributes to blank.
     -->
     <trail>
       <link1 name="apache" href="http://www.apache.org/"/>
  @@ -83,23 +110,244 @@
       <link3 name="" href=""/>
     </trail>
   
  -  <!-- Credits are typically rendered as a set of small clickable images in the
  -  page footer -->
  +  <!-- 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). 
  +  @min-sections
  +   Minimum required to create a TOC.
  +  @location ("page","menu","page,menu", "none")
  +   Where to show the TOC.
  +  -->
  +  <toc max-depth="2" min-sections="1" location="page"/>
  +
  +  <!-- Heading types can be clean|underlined|boxed  -->
  +  <headings type="boxed"/>
  +  
  +  <!-- The optional feedback element will be used to construct a
  +    feedback link in the footer with the page pathname appended:
  +    <a href="@href">{@to}</a>
  +    -->
  +  <!--
  +  <feedback to="webmaster@foo.com"
  +    href="mailto:webmaster@foo.com?subject=Feedback&#160;" >
  +    Send feedback about the website to:
  +  </feedback>
  +  -->
  +
  +  <!--
  +    extra-css - here you can define custom css-elements that are 
  +    a. overriding the fallback elements or 
  +    b. adding the css definition from new elements that you may have 
  +       used in your documentation.
  +    -->
  +  <extra-css>
  +    <!--Example of b. 
  +        To define the css definition of a new element that you may have used
  +        in the class attribute of a <p> node. 
  +        e.g. <p class="quote"/>
  +    -->
  +    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"/>
  +
  +    <color name="tab-selected" value="#a5b6c6" link="#000000" vlink="#000000" hlink="#000000"/>
  +    <color name="tab-unselected" value="#F7F7F7"  link="#000000" vlink="#000000" hlink="#000000"/>
  +    <color name="subtab-selected" value="#a5b6c6"  link="#000000" vlink="#000000" hlink="#000000"/>
  +    <color name="subtab-unselected" value="#a5b6c6"  link="#000000" vlink="#000000"
hlink="#000000"/>
  +
  +    <color name="heading" value="#a5b6c6"/>
  +    <color name="subheading" value="#CFDCED"/>
  +        
  +    <color name="navstrip" value="#CFDCED" font="#000000" link="#000000" vlink="#000000"
hlink="#000000"/>
  +    <color name="toolbox" value="#a5b6c6"/>
  +    <color name="border" value="#a5b6c6"/>
  +        
  +    <color name="menu" value="#F7F7F7" link="#000000" vlink="#000000" hlink="#000000"/>
   
  +    <color name="dialog" value="#F7F7F7"/>
  +            
  +    <color name="body"    value="#ffffff" link="#0F3660" vlink="#009999" hlink="#000066"/>
  +    
  +    <color name="table" value="#a5b6c6"/>    
  +    <color name="table-cell" value="#ffffff"/>    
  +    <color name="highlight" value="#ffff00"/>
  +    <color name="fixme" value="#cc6600"/>
  +    <color name="note" value="#006699"/>
  +    <color name="warning" value="#990000"/>
  +    <color name="code" value="#a5b6c6"/>
  +        
  +    <color name="footer" value="#a5b6c6"/>
  +-->
  +  
  +  <!-- Forrest -->
  +    <color name="header"    value="#294563"/>
  +
  +    <color name="tab-selected" value="#4a6d8c" link="#0F3660" vlink="#0F3660" hlink="#000066"/>
  +    <color name="tab-unselected" value="#b5c7e7" link="#0F3660" vlink="#0F3660" hlink="#000066"/>
  +    <color name="subtab-selected" value="#4a6d8c" link="#0F3660" vlink="#0F3660" hlink="#000066"/>
  +    <color name="subtab-unselected" value="#4a6d8c" link="#0F3660" vlink="#0F3660" hlink="#000066"/>
  +
  +    <color name="heading" value="#294563"/>
  +    <color name="subheading" value="#4a6d8c"/>
  +        
  +    <color name="navstrip" value="#cedfef" font="#0F3660" link="#0F3660" vlink="#0F3660"
hlink="#000066"/>
  +    <color name="toolbox" value="#4a6d8c"/>
  +    <color name="border" value="#294563"/>
  +    
  +    <color name="menu" value="#4a6d8c" font="#cedfef" link="#ffffff" vlink="#ffffff"
hlink="#ffcf00"/>    
  +    <color name="dialog" value="#4a6d8c"/>
  +            
  +    <color name="body" value="#ffffff"  link="#0F3660" vlink="#009999" hlink="#000066"/>
  +    
  +    <color name="table" value="#7099C5"/>    
  +    <color name="table-cell" value="#f0f0ff"/>    
  +    <color name="highlight" value="#ffff00"/>
  +    <color name="fixme" value="#cc6600"/>
  +    <color name="note" value="#006699"/>
  +    <color name="warning" value="#990000"/>
  +    <color name="code" value="#CFDCED"/>
  +        
  +    <color name="footer" value="#cedfef"/>
  +
  +  <!-- Collabnet --> 
  +<!--
  +    <color name="header"    value="#003366"/>
  +
  +    <color name="tab-selected" value="#dddddd" link="#555555" vlink="#555555" hlink="#555555"/>
  +    <color name="tab-unselected" value="#999999" link="#ffffff" vlink="#ffffff" hlink="#ffffff"/>
  +    <color name="subtab-selected" value="#cccccc" link="#000000" vlink="#000000" hlink="#000000"/>
  +    <color name="subtab-unselected" value="#cccccc" link="#555555" vlink="#555555" hlink="#555555"/>
  +
  +    <color name="heading" value="#003366"/>
  +    <color name="subheading" value="#888888"/>
  +    
  +    <color name="navstrip" value="#dddddd" font="#555555"/>
  +    <color name="toolbox" value="#dddddd" font="#555555"/>
  +    <color name="border" value="#999999"/>
  +    
  +    <color name="menu" value="#ffffff"/>    
  +    <color name="dialog" value="#eeeeee"/>
  +            
  +    <color name="body"      value="#ffffff"/>
  +    
  +    <color name="table" value="#ccc"/>    
  +    <color name="table-cell" value="#ffffff"/>   
  +    <color name="highlight" value="#ffff00"/>
  +    <color name="fixme" value="#cc6600"/>
  +    <color name="note" value="#006699"/>
  +    <color name="warning" value="#990000"/>
  +    <color name="code" value="#003366"/>
  +        
  +    <color name="footer" value="#ffffff"/>
  +-->
  + <!-- Lenya using pelt-->
  +<!--
  +    <color name="header" value="#ffffff"/>
  +
  +    <color name="tab-selected" value="#4C6C8F" link="#ffffff" vlink="#ffffff" hlink="#ffffff"/>
  +    <color name="tab-unselected" value="#E5E4D9" link="#000000" vlink="#000000" hlink="#000000"/>
  +    <color name="subtab-selected" value="#000000" link="#000000" vlink="#000000" hlink="#000000"/>
  +    <color name="subtab-unselected" value="#E5E4D9" link="#000000" vlink="#000000" hlink="#000000"/>
  +
  +    <color name="heading" value="#E5E4D9"/>
  +    <color name="subheading" value="#000000"/>
  +    <color name="published" value="#4C6C8F" font="#FFFFFF"/>
  +    <color name="feedback" value="#4C6C8F" font="#FFFFFF" align="center"/>
  +    <color name="navstrip" value="#E5E4D9" font="#000000"/>
  +
  +    <color name="toolbox" value="#CFDCED" font="#000000"/>
  +
  +    <color name="border" value="#999999"/>
  +    <color name="menu" value="#4C6C8F" font="#ffffff" link="#ffffff" vlink="#ffffff"
hlink="#ffffff" current="#FFCC33" />    
  +    <color name="menuheading" value="#cfdced" font="#000000" />
  +    <color name="searchbox" value="#E5E4D9" font="#000000"/>
  +    
  +    <color name="dialog" value="#CFDCED"/>
  +    <color name="body" value="#ffffff" />            
  +    
  +    <color name="table" value="#ccc"/>    
  +    <color name="table-cell" value="#ffffff"/>   
  +    <color name="highlight" value="#ffff00"/>
  +    <color name="fixme" value="#cc6600"/>
  +    <color name="note" value="#006699"/>
  +    <color name="warning" value="#990000"/>
  +    <color name="code" value="#003366"/>
  +        
  +    <color name="footer" value="#E5E4D9"/>
  +-->
  +  </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).
  +       Supported text alignments are left, right, justify (default left).
  +    -->
  +    <page size="a4" orientation="portrait" text-align="left"/>
  +
  +    <!--
  +       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>
  +
  +    <!--
  +      Print the URL text next to all links going outside the file
  +    -->
  +    <show-external-urls>false</show-external-urls>
  +
  +    <!--
  +      Disable the copyright footer on each page of the PDF.
  +      A footer is composed for each page. By default, a "credit" with role=pdf
  +      will be used, as explained below. Otherwise a copyright statement
  +      will be generated. This latter can be disabled.
  +    -->
  +    <disable-copyright-footer>false</disable-copyright-footer>
  +  </pdf>
  +
  +  <!-- Credits are typically rendered as a set of small clickable
  +    images in the page footer.
  +    Use box-location="alt" to move the credit to an alternate location
  +    (if the skin supports it). 
  +  -->
     <credits>
       <credit>
         <name>Built with Apache Forrest</name>
  -      <url>http://xml.apache.org/forrest/</url>
  +      <url>http://forrest.apache.org/</url>
         <image>images/built-with-forrest-button.png</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 be used to compose a footer
  +     for each page in the PDF, using either "name" or "url" or both.
  +    -->
       <credit role="pdf">
  -      <name>PDF created with Apache FOP</name>
  -      <url>http://xml.apache.org/fop/dev</url>
  +      <name>Built with Apache FOP</name>
  +      <url>http://xml.apache.org/fop/</url>
       </credit>
  - 
     </credits>
   
   </skinconfig>
  
  
  
  1.1                  xml-site/src/documentation/classes/CatalogManager.properties
  
  Index: CatalogManager.properties
  ===================================================================
  # Copyright 2002-2004 The Apache Software Foundation
  #
  # Licensed under the Apache License, Version 2.0 (the "License");
  # you may not use this file except in compliance with the License.
  # You may obtain a copy of the License at
  #
  #     http://www.apache.org/licenses/LICENSE-2.0
  #
  # Unless required by applicable law or agreed to in writing, software
  # distributed under the License is distributed on an "AS IS" BASIS,
  # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  # See the License for the specific language governing permissions and
  # limitations under the License.
  
  #=======================================================================
  # CatalogManager.properties
  #
  # This is the default properties file for Apache Forrest.
  # This facilitates local configuration of application-specific catalogs.
  #
  # See the Apache Forrest documentation:
  # http://forrest.apache.org/docs/your-project.html
  # http://forrest.apache.org/docs/validation.html
  
  # verbosity ... level of messages for status/debug
  # See forrest/src/core/context/WEB-INF/cocoon.xconf
  
  # catalogs ... list of additional catalogs to load
  #  (Note that Apache Forrest will automatically load its own default catalog
  #  from src/core/context/resources/schema/catalog.xcat)
  # use full pathnames
  # pathname separator is always semi-colon (;) regardless of operating system
  # directory separator is always slash (/) regardless of operating system
  #
  #catalogs=/home/me/forrest/my-site/src/documentation/resources/schema/catalog.xcat
  catalogs=
  
  
  
  
  1.12      +70 -29    xml-site/src/documentation/content/xdocs/guidelines.xml
  
  Index: guidelines.xml
  ===================================================================
  RCS file: /home/cvs/xml-site/src/documentation/content/xdocs/guidelines.xml,v
  retrieving revision 1.11
  retrieving revision 1.12
  diff -u -r1.11 -r1.12
  --- guidelines.xml	13 Jun 2004 08:31:23 -0000	1.11
  +++ guidelines.xml	21 Oct 2004 05:06:19 -0000	1.12
  @@ -1,7 +1,7 @@
   <?xml version="1.0"?>
   <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN" "document-v11.dtd">
   <document><header><title>Project Guidelines</title></header><body>
  -    <section>
  +    <section id="project">
         <title>The xml.apache.org Project Guidelines</title>
         <p>
         This document defines the guidelines of the <em>xml.apache.org</em> 
  @@ -30,7 +30,8 @@
           Committee (PMC).</li><li><link href="mission.html">Our Mission
/ Charter</link>
           A copy of the Charter document for the xml.apache.org Project.</li></ul></section>
           
  -	<section><title>Website update guidelines</title>
  +	<section id="website">
  +    <title>Website update guidelines</title>
   	  <p>
   		As XML-oriented projects, so our website is also generated from 
   		XML files.  While many similar websites may use servlets or a 
  @@ -53,41 +54,80 @@
   	  </p>
   	  <note>
   		The website is gradually being converted to use
  -		<jump href="http://forrest.apache.org/">Forrest</jump>.  Whilst 
  +		<link href="http://forrest.apache.org/">Forrest</link>.  Whilst 
   		this conversion is occuring, there are two methods for updating 
   		content, dependent on what part of the site is being updated.
   	  </note>
   
  -	  <section>
  -		<title>Updating the top level site</title>
  +	  <section id="website-top">
  +		<title>Updating the top-level site</title>
   		
   		<p>
   		  The top level of the site is created using Forrest.  To update,
   		  committers with access to xml-site should checkout this module,
  -		  and make the content changes to the files found in
  -		  <em>xml-site/src/documentation/content/xdocs</em>
  +		  and make the content changes to the source files found in
  +		  "<em>xml-site/src/documentation/content/xdocs</em>".
  +      The generated website is stored in the same CVS at
  +		  "<em>xml-site/targets</em>".
   		</p>
  -		<p>
  -		  There are two methods for updating the content on xml.apache.org.
  -		</p>
  -		<p>
  -		  The first method is to manually update the contents of the
  -		  cvs xml-site module.  (After checking in the content changes made.)
  -		</p>
  -		<source>
  - (Currently using xml-forrest-0.5.1)
  -cvs checkout xml-forrest
  -cd xml-forrest
  -./build.sh
  -export PATH=`pwd`/build/dist/shbat/bin
  -cd ..
  -cvs checkout xml-site
  +    <p>
  +      Install the current release of Apache Forrest (v0.6) 
  +      by following the instructions at the index.html in the
  +      distribution, to set the environment variables
  +      $FORREST_HOME and $PATH.
  +    </p>
  +
  +    <p>See the examples of the
  +      <link href="http://forrest.apache.org/docs/document-v13.html">Forrest xdocs
format</link>.
  +      If you add a new page or change a page's name, update 
  +      <code>xdocs/book.xml</code> from which the menu is generated.
  +    </p>
  +
  +    <p>Here is a quick tour:</p>
  +    <ul>
  +    <li>cd into the local "xml-site" SVN directory.</li>
  +     <li>Do 'forrest run'.</li>
  +     <li>Browser http://localhost:8888/ to review the site.</li>
  +     <li>Edit the docs <strong>in place</strong> at <code>xdocs/*.xml</code>
  +     and see changes in the browser by re-loading the page.</li>
  +     </ul>
  +
  +     <p>When you are satisifed, you will rebuild the whole site and
  +     add the changed documents to the "targets" directory ...
  +     </p>
  +
  +    <p>In the top-level "<code>xml-site</code>" CVS directory,
  +      do 'forrest' to
  +      render the HTML and PDF files into "<code>build/site</code>".
  +      Forrest validates the XML, so will catch any syntax errors.
  +      You can also simply validate the source xdocs without rendering
  +      by doing 'forrest validate'.
  +    </p>
  +
  +    <p>If the site built without errors, you now need to synchronise the
  +     <code>xml-site/build/site</code> directory into the
  +     <code>xml-site/targets</code> directory.</p>
  +     <source>
   cd xml-site
  -forrest
  -cp -r build/site/* targets/
  -cvs add &lt;new files&gt;
  -cvs commit targets
  -		</source>
  +cvs -q update -dP
  +... careful, there is lots of stuff that you might want to avoid
  +    with better use of 'cvs update', e.g. targets/xindice/api/*
  +diff -rq build/site targets | grep -v "CVS"
  +... Ensure that the differences are what you expect.
  +cp -Rf build/site/* targets
  +... Now do the usual CVS stuff: 'cvsu' 'cvs add' 'cvs diff' 'cvs commit'
  +     </source>
  +
  +     <p>To update the website, the "xml-site/targets"
  +       CVS directory is checked-out on the server.
  +     </p>
  +     <source>
  +ssh www.apache.org
  +cd /www/incubator.apache.org
  +cvs -q update -dP
  +     </source>
  +
  +<!--FIXME: Hide the forrestbot option unitl it is updated.
   		<p>
   		  The second method is to use the <em>forrestbot</em>.
   		</p>
  @@ -102,8 +142,9 @@
   		  password-protected.  Committers wishing to use this facility should contact
   		  the <jump href="http://forrest.apache.org/mail-lists.html">forrest-dev</jump>
mailing list.
   		</note>
  +-->
   	  </section>
  -	  <section>
  +	  <section id="website-sub-forrest">
   		<title>Updating Forrest based sub-project websites</title>
   
           <p>The sub-projects generate their website from their own sources and
  @@ -120,7 +161,7 @@
             xml-site/src/documentation/ directory.
   		</p>
   	  </section>
  -	  <section>
  +	  <section id="website-sub-other">
   		<title>Updating non-Forrest sub-project websites</title>
   		<p>
   		  To update a part of the website (that does *not* use Forrest) do this:
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: general-cvs-unsubscribe@xml.apache.org
For additional commands, e-mail: general-cvs-help@xml.apache.org


Mime
View raw message