forrest-svn mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject svn commit: r701296 - in /forrest/trunk/examples/contentIntegration: ./ src/documentation/content/xdocs/ src/documentation/content/xdocs/howto/ src/documentation/content/xdocs/samples/
Date Fri, 03 Oct 2008 04:42:33 GMT
Author: gmcdonald
Date: Thu Oct  2 21:42:30 2008
New Revision: 701296

A start at improving documentation

  (with props)

Modified: forrest/trunk/examples/contentIntegration/
--- forrest/trunk/examples/contentIntegration/ (original)
+++ forrest/trunk/examples/contentIntegration/ Thu Oct  2 21:42:30 2008
@@ -24,6 +24,6 @@
   <property name="dispatcher.theme" value="maven"/>
   <property name="dispatcher.theme-ext" value=".fv"/>
 <!--SVG example for project/group logo-->
-  <property name="group-name" value="tei to odt"/>
-  <property name="project-name" value="tei to odt"/>
+  <property name="group-name" value="aggregation"/>
+  <property name="project-name" value="aggregation"/>

Added: forrest/trunk/examples/contentIntegration/src/documentation/content/xdocs/howto/index.xml
--- forrest/trunk/examples/contentIntegration/src/documentation/content/xdocs/howto/index.xml
+++ forrest/trunk/examples/contentIntegration/src/documentation/content/xdocs/howto/index.xml
Thu Oct  2 21:42:30 2008
@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="UTF-8"?>
+  Licensed to the Apache Software Foundation (ASF) under one or more
+  contributor license agreements.  See the NOTICE file distributed with
+  this work for additional information regarding copyright ownership.
+  The ASF licenses this file to You 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
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  See the License for the specific language governing permissions and
+  limitations under the License.
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "">
+  <header>
+    <title>How To - a look inside configuring your site.</title>
+  </header>
+  <body>
+    <section id="intro">
+      <title>Introduction</title>
+      <p>Intended Audience: For those that Administer their Apache Forrest instances,
and for developers. Other areas of this example
+              site are intended to give examples to users of sites such as this.</p>
+      <p>The aims of this How To section is to show you how you can alter your site
configuration files to enable, disable and enhance
+              the site to suit your needs. We'll also show how you can alter 'themes' and
'plugins'. </p>
+    </section>
+  </body>

Propchange: forrest/trunk/examples/contentIntegration/src/documentation/content/xdocs/howto/index.xml
    svn:eol-style = native

Modified: forrest/trunk/examples/contentIntegration/src/documentation/content/xdocs/index.xml
--- forrest/trunk/examples/contentIntegration/src/documentation/content/xdocs/index.xml (original)
+++ forrest/trunk/examples/contentIntegration/src/documentation/content/xdocs/index.xml Thu
Oct  2 21:42:30 2008
@@ -18,17 +18,24 @@
 <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "">
-    <title>Sample Site With TEI and ODT plugins as well as disptacher enabled</title>
+    <title>Content Integration - Aggregating multiple content</title>
     <section id="status">
-      <title>Early Days</title>
-      <p>This example site can take TEI xml or xdoc as an input format, and output
it as ODT format. (Actually any page on this site can be output as ODT format)
-      </p>
-      <p>This site is also an example of a dispatcher themed enabled site in action.
Currently it is using the 'maven' type theme. The 'maven' theme is also a work in progress,
it look similar to a maven generated site but there are still a few tweaks that can be done.
-      </p>
-      <p>If you have 2.3+ then you can <a href="index.odt">view
this xdoc page in OpenOffice</a>. The samples section has a TEI and document-v20 xml
file that can be viewed as HTML or downloaded as ODT, <a href="samples/index.html">take
a look.</a>
+      <title>Site Objectives</title>
+      <p>The initial main aims of this example site is to be a proving ground and showcase
of sorts for just a few of what Apache Forrest can do to make things easier.
+      <p>Some of the things this site can (or will) do are :</p>
+      <ul>
+              <li>Convert local and remote TEI based documents for display in this
site as <acronym title="Hypertext Markup Language">HTML</acronym></li>
+              <li>Make the same content available for downloading in
2.3+ Writer program in the OpenDocument based ODT format.</li>
+              <li>Pull in other sources and formats of information such as Wikipedia,
Google Wiki, Media Wiki and using Simal and OSSWatch for some example remote content also.</li>
+              <li>A new References Section has been added to this site which summarises
all links on a page (and only appears if there are links to process, unlike this page).</li>
+      </ul>
+      <p>The current ODT output template is based on a donated template by OSSWatch.
At some stage in the future there should be alternative templates offered.</p>
+      <p>The rest of this site is dedicated to providing working examples and documenting
how these are made to work.</p>
+      <warning>This example site is in need of improvment, it also suffers from a few
Issues - currently the site will
+              work fine under 'forrest run' but will not build as a static site due to our
use of remote documents.</warning>

Modified: forrest/trunk/examples/contentIntegration/src/documentation/content/xdocs/samples/index.xml
--- forrest/trunk/examples/contentIntegration/src/documentation/content/xdocs/samples/index.xml
+++ forrest/trunk/examples/contentIntegration/src/documentation/content/xdocs/samples/index.xml
Thu Oct  2 21:42:30 2008
@@ -21,20 +21,45 @@
+    <section id="intro">
+            <title>Introduction</title>
+            <p>This area contains some example documents, some are local, some are
remote to try and be varied. The last section contains instructions on how
+                    to request random remote addresses via the address bar of your browser.
We welcome more examples and also feedback on how they are working
+                    for you.</p>
+            <p>Check out the How To sections (links on the left navigation) for more
detailed instructions on how to construct your own remote document requests.</p>
+    </section>
     <section id="samples">
-      <title>Below are some sample files, either TEI or XDOC.</title>
-      <ul><li><a href="xdoc.html">Sample 1</a> A basic TEI xml document
rendered as HTML</li>
-              <li><a href="document-v20.html">Sample 2</a> Our document-v20
in HTML</li>
-      </ul>
-      <note label="Hint">Go to the above documents and click on the ODT icon to download
as .odt in OpenOffice 2.3+</note>
+            <title>Samples</title>
+            <p>Some local content examples :-</p>
+            <ul>
+              <li><a href="xdoc.html">Sample 1</a> A basic TEI xml document
rendered as HTML</li>
+              <li><a href="document-v20.html">Sample 2</a> Our document-v20
xdoc in HTML</li>
+              <li>Local wiki example coming soon...</li>
+            </ul>
+             <note label="Hint">Go to the above documents and click on the ODT icon
to download as .odt in OpenOffice 2.3+</note>
+             <p>Some remote content examples :-</p>
+             <ul>
+               <li><a href="/osswatch/resources/beginners.html">OSSWatch 'Open
Source for absolute beginners'</a></li>
+               <li><a href="osswatch/resources/precurement-infopack.html">OSSWatch
'Decision Factors...'</a></li>
+               <li>Simal Docs example to go here</li>
+               <li>Google Wiki example to go here</li>
+               <li>Another wiki example to go here</li>
+               <li>Something else...</li>
+       </ul>
+       <note>Remote documents need to be processed 'on the fly' for displaying, so
you will notice a delay - this is normal.</note>
-    <section id="please-contribute">
-      <title>Have some more samples to share ...</title>
-      <p>
-        Patches are welcome:
-        <a href="">Forrest FAQ</a>
-<p>The idea here is to produce lots more TEI or XDOC or other inputs for transforming
in the OOo odt output format. The .odt output needs improvement and more features to come,
this example site will help flesh them out and cure them.</p>
+    <section id="remote">
+      <title>Requesting remote documents.</title>
+      <p>Currently, requesting remote documents are limited to the 'resources' area
of the <a href="">OSSWatch site</a>. This limitation
+      is mainly by choice; combined with some instructions in the How To section, we aim
to expand our choices and help you to be able to do the same.</p>
+      <section id="remote_osswatch_resources">
+              <title>Remote resources from OSSWatch</title>
+              <p>In our sites locationamp.xml file we have chosen a match so that requests
made to /osswatch/resources/ will go and retrieve those requests from
and bring them back to Forrest for further processing. That further processing could be 'display
in my current site as a regular HTML file' or if an .odt extension is specified it means 'convert
to ODT format and allow download for displaying in OpenOffice' (or a number of other things).</p>
+              <p>So, go ahead and request a document from the OSSWatch resources area.
If you are running this site in localhost then your address bar would end up looking something
like <code>http://localhost:8888/osswatch/resources/beginners.html</code>.</p>
+      </section>
+<note label="Hint">By requesting any of the above documents with the <code>.odt</code>
extension, we can bypass HTML viewing and download direct for opening into

Modified: forrest/trunk/examples/contentIntegration/src/documentation/content/xdocs/site.xml
--- forrest/trunk/examples/contentIntegration/src/documentation/content/xdocs/site.xml (original)
+++ forrest/trunk/examples/contentIntegration/src/documentation/content/xdocs/site.xml Thu
Oct  2 21:42:30 2008
@@ -47,6 +47,9 @@
           <tei-sample label="TEI Sample" href="samples/xdoc.html" description="A simple
TEI document"/>
           <doc-v20 label="Document-v20" href="samples/document-v20.html" description="Oor
+  <howtos label="How To">
+          <index label="Index" href="howto/index.html" description="Documentation on how
to aggregate content"/>
+  </howtos>
     <forrest href="">
       <linking href="docs/linking.html"/>

View raw message