You are viewing a plain text version of this content. The canonical link for it is here.
Posted to site-svn@forrest.apache.org by cr...@apache.org on 2010/06/08 05:37:56 UTC
svn commit: r952524 - in
/forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.output.Anakia:
changes.html changes.rss index.html sample-1.xdoc todo.html
Author: crossley
Date: Tue Jun 8 03:37:56 2010
New Revision: 952524
URL: http://svn.apache.org/viewvc?rev=952524&view=rev
Log:
Deployment of docs for org.apache.forrest.plugin.output.Anakia plugin (deployed by 'deploy-docs' target of plugin build script)
Modified:
forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.output.Anakia/changes.html
forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.output.Anakia/changes.rss
forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.output.Anakia/index.html
forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.output.Anakia/sample-1.xdoc
forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.output.Anakia/todo.html
Modified: forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.output.Anakia/changes.html
URL: http://svn.apache.org/viewvc/forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.output.Anakia/changes.html?rev=952524&r1=952523&r2=952524&view=diff
==============================================================================
--- forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.output.Anakia/changes.html (original)
+++ forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.output.Anakia/changes.html Tue Jun 8 03:37:56 2010
@@ -133,16 +133,27 @@ document.write("Last Published: " + docu
<a href="#introduction">Introduction and explanation of symbols</a>
</li>
<li>
+<a href="#version_0.2">Version 0.2 (not-released)</a>
+<ul class="minitoc">
+<li>
+<a href="#Changes+to+the+Code+Base">Changes to the Code Base</a>
+</li>
+<li>
+<a href="#Contributors+to+this+release">Contributors to this release</a>
+</li>
+</ul>
+</li>
+<li>
<a href="#version_0.1">Version 0.1 (not-released)</a>
<ul class="minitoc">
<li>
<a href="#Changes+to+Project+Administration">Changes to Project Administration</a>
</li>
<li>
-<a href="#Changes+to+the+Code+Base">Changes to the Code Base</a>
+<a href="#Changes+to+the+Code+Base-N10048">Changes to the Code Base</a>
</li>
<li>
-<a href="#Contributors+to+this+release">Contributors to this release</a>
+<a href="#Contributors+to+this+release-N10057">Contributors to this release</a>
</li>
</ul>
</li>
@@ -161,10 +172,30 @@ document.write("Last Published: " + docu
<p>Changes are sorted by "type" and then chronologically with the most recent at the top. These symbols denote the various action types:<img class="icon" alt="add" src="images/add.jpg">=add, <img class="icon" alt="update" src="images/update.jpg">=update</p>
</div>
-<a name="N1001D"></a><a name="version_0.1"></a>
+<a name="N1001D"></a><a name="version_0.2"></a>
+<h2 class="underlined_10">Version 0.2 (not-released)</h2>
+<div class="section">
+<a name="N10021"></a><a name="Changes+to+the+Code+Base"></a>
+<h3 class="underlined_5">Changes to the Code Base</h3>
+<ul>
+<li>
+<img class="icon" alt="update" src="images/update.jpg">
+ Developed a much better way to configure this plugin.
+ See the <a href="index.html">overview</a> page Howto section.
+ Removed the need for Dispatcher. So this plugin has no dependencies
+ and can be easily applied to any site using 0.8 release or newer.
+ Committed by DC.</li>
+</ul>
+<a name="N1002F"></a><a name="Contributors+to+this+release"></a>
+<h3 class="underlined_5">Contributors to this release</h3>
+<p>We thank the following people for their contributions to this release.</p>
+<p>This is a list of all people who participated as committers:<br>David Crossley (DC).</p>
+</div>
+
+<a name="N1003A"></a><a name="version_0.1"></a>
<h2 class="underlined_10">Version 0.1 (not-released)</h2>
<div class="section">
-<a name="N10021"></a><a name="Changes+to+Project+Administration"></a>
+<a name="N1003E"></a><a name="Changes+to+Project+Administration"></a>
<h3 class="underlined_5">Changes to Project Administration</h3>
<ul>
<li>
@@ -172,7 +203,7 @@ document.write("Last Published: " + docu
Initial plugin code.
Committed by DC.</li>
</ul>
-<a name="N1002B"></a><a name="Changes+to+the+Code+Base"></a>
+<a name="N10048"></a><a name="Changes+to+the+Code+Base-N10048"></a>
<h3 class="underlined_5">Changes to the Code Base</h3>
<ul>
<li>
@@ -186,13 +217,13 @@ document.write("Last Published: " + docu
and section/section.
Committed by DC.</li>
</ul>
-<a name="N1003A"></a><a name="Contributors+to+this+release"></a>
+<a name="N10057"></a><a name="Contributors+to+this+release-N10057"></a>
<h3 class="underlined_5">Contributors to this release</h3>
<p>We thank the following people for their contributions to this release.</p>
<p>This is a list of all people who participated as committers:<br>David Crossley (DC).</p>
</div>
-<a name="N10045"></a><a name="all-committers"></a>
+<a name="N10062"></a><a name="all-committers"></a>
<h2 class="underlined_10">All Committers</h2>
<div class="section">
<p>This is a list of all people who have ever participated
Modified: forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.output.Anakia/changes.rss
URL: http://svn.apache.org/viewvc/forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.output.Anakia/changes.rss?rev=952524&r1=952523&r2=952524&view=diff
==============================================================================
--- forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.output.Anakia/changes.rss (original)
+++ forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.output.Anakia/changes.rss Tue Jun 8 03:37:56 2010
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="ISO-8859-1"?><!DOCTYPE rss PUBLIC "-//Netscape Communications//DTD RSS 0.91//EN" "http://my.netscape.com/publish/formats/rss-0.91.dtd">
-<rss version="0.91"><channel><title>MyProject (0.1) Changes</title><link>http://example.org/myproj//changes.html</link><description>MyProject
+<rss version="0.91"><channel><title>MyProject (0.2) Changes</title><link>http://example.org/myproj//changes.html</link><description>MyProject
(
- 0.1
+ 0.2
) Changes
</description><language>en-us</language>
@@ -24,6 +24,18 @@
DC
:
+ Developed a much better way to configure this plugin.
+ See the overview page Howto section.
+ Removed the need for Dispatcher. So this plugin has no dependencies
+ and can be easily applied to any site using 0.8 release or newer.
+ </description></item>
+
+
+ <item><title>MyProject code update</title><link>http://example.org/myproj//changes.html</link><description>code update
+ by
+ DC
+ :
+
Update "content-anakia-link.ft" and instructions to use recent development
of Dispatcher. Add a sample link.
</description></item>
@@ -50,19 +62,8 @@
DC
:
- Update "content-anakia-link.ft" and instructions to use recent development
- of Dispatcher. Add a sample link.
- </description></item><item><title>MyProject code update</title><link>http://example.org/myproj//changes.html</link><description>code update
- by
- DC
- :
-
- Fine-tune the output xdoc format. Use section/title
- and section/section.
- </description></item><item><title>MyProject admin add</title><link>http://example.org/myproj//changes.html</link><description>admin add
- by
- DC
- :
-
- Initial plugin code.
+ Developed a much better way to configure this plugin.
+ See the overview page Howto section.
+ Removed the need for Dispatcher. So this plugin has no dependencies
+ and can be easily applied to any site using 0.8 release or newer.
</description></item></channel></rss>
\ No newline at end of file
Modified: forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.output.Anakia/index.html
URL: http://svn.apache.org/viewvc/forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.output.Anakia/index.html?rev=952524&r1=952523&r2=952524&view=diff
==============================================================================
--- forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.output.Anakia/index.html (original)
+++ forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.output.Anakia/index.html Tue Jun 8 03:37:56 2010
@@ -135,6 +135,9 @@ document.write("Last Published: " + docu
<li>
<a href="#howto">Howto</a>
</li>
+<li>
+<a href="#explanation">How it works</a>
+</li>
</ul>
</div>
</div>
@@ -143,38 +146,85 @@ document.write("Last Published: " + docu
<h2 class="underlined_10">Overview</h2>
<div class="section">
<p>
- Produce output in
+ Produce output in Anakia-like "xdoc" format. Enables use of Forrest as
+ a tool for gathering input from various sources, and output a
+ consistent set of xml output documents.
+ The output is similar to
<a href="http://velocity.apache.org/engine/devel/anakia.html">Apache Velocity Anakia</a>
- "xdoc" format, for example
- <a href="sample-1.html">localhost:8888/index.xdoc</a>
+ "xdoc" format.
+ See <a href="sample-1.html">example</a>.
+ </p>
+</div>
+
+<a name="N10020"></a><a name="howto"></a>
+<h2 class="underlined_10">Howto</h2>
+<div class="section">
+<p>
+ In your project's <span class="codefrag">forrest.properties</span> file make the
+ following changes ...
+ </p>
+<ul>
+
+<li>
+ Declare the <span class="codefrag">org.apache.forrest.plugin.output.Anakia</span>
+ plugin at the <span class="codefrag">project.required.plugins</span> property
+ (comma-separated list).
+ </li>
+
+<li>
+ Uncomment the <span class="codefrag">project.start-uri</span> property and set it to be
+ <span class="codefrag">anakia-start.xml</span>
+
+</li>
-</p>
+</ul>
<p>
- One use of this plugin is to export a Forrest-based site to Anakia
- "xdoc".
+ Now do '<span class="codefrag">forrest</span>' to build your site as normal.
</p>
<p>
- Forrest can then be used as normal, to draw together source content
- in various formats, and export a set of consistent documents.
+ Alongside each <span class="codefrag">*.html</span> file there will now be a matching
+ <span class="codefrag">*.xdoc</span> file.
</p>
</div>
-<a name="N10026"></a><a name="howto"></a>
-<h2 class="underlined_10">Howto</h2>
+<a name="N10051"></a><a name="explanation"></a>
+<h2 class="underlined_10">How it works</h2>
<div class="section">
<p>
- You need a link from each page to its .xdoc version. The
- easiest way to do that is with the new whiteboard
- <a href="http://forrest.apache.org/pluginDocs/dev/org.apache.forrest.plugin.internal.dispatcher/">Dispatcher</a>
- functionality. Follow the "Quickstart" document. Edit your new structurer panels to add
- a new contract "content-anakia-link" following the existing "content-pdf-link".
- A contract is provided in the o.a.f.plugin.output.Anakia plugin at
- resources/themes/common/html/content-anakia-link.ft to copy to the same place in your project.
+ Explanation of how this plugin works
+ and how its output can be enhanced with additional processing.
+ </p>
+<p>
+ Without touching any of the site source content or navigation system,
+ we need to additionally inject another set of links to be processed.
+ Each html output document will then also have a matching URI with
+ <span class="codefrag">*.xdoc</span> extension.
+ </p>
+<p>
+ This is achieved with the <span class="codefrag">input.xmap</span> sitemap. For the
+ requested pipeline <span class="codefrag">anakia-start.xml</span> Forrest will generate
+ the "linkmap" of the site navigation, then apply a transformation
+ to amend each link.
+ </p>
+<p>
+ This automatically enables the crawler to gather this set of links.
</p>
<p>
- Don't forget to declare the o.a.f.plugin.output.Anakia plugin (and the usual Dispatcher
- plugins) in your project's forrest.properties file.
+ The <span class="codefrag">output.xmap</span> sitemap then handles each xdoc URI to
+ transform the internal content structure. This plugin provides one
+ stylesheet <span class="codefrag">document-to-xdoc.xsl</span> then applies a core
+ transformation to make the xml output a bit more pretty.
</p>
+<p>
+ To enhance the output, either amend the <span class="codefrag">document-to-xdoc.xsl</span>
+ stylesheet (and please send changes) or insert another transformation
+ of your own. In the <span class="codefrag">output.xmap</span> after the abovementioned
+ transformation, add the line
+ <span class="codefrag"><map:transform src="{lm:anakia.transform.xdoc.mine}"/></span>
+ and add your stylesheet (following the locationmap naming convention) at
+ <span class="codefrag">resources/stylesheets/xdoc-to-mine.xsl</span>
+
+</p>
</div>
</div>
Modified: forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.output.Anakia/sample-1.xdoc
URL: http://svn.apache.org/viewvc/forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.output.Anakia/sample-1.xdoc?rev=952524&r1=952523&r2=952524&view=diff
==============================================================================
--- forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.output.Anakia/sample-1.xdoc (original)
+++ forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.output.Anakia/sample-1.xdoc Tue Jun 8 03:37:56 2010
@@ -1,9 +1,9 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<document>
<properties>
- <title xmlns:xi="http://www.w3.org/2001/XInclude">Example document</title>
+ <title>Example document</title>
</properties>
- <body xmlns:xi="http://www.w3.org/2001/XInclude">
+ <body>
<section id="s1">
<title>Sample section One</title>
<p>
Modified: forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.output.Anakia/todo.html
URL: http://svn.apache.org/viewvc/forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.output.Anakia/todo.html?rev=952524&r1=952523&r2=952524&view=diff
==============================================================================
--- forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.output.Anakia/todo.html (original)
+++ forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.output.Anakia/todo.html Tue Jun 8 03:37:56 2010
@@ -142,6 +142,11 @@ document.write("Last Published: " + docu
<ul>
<li>
<strong>[code]</strong>
+ See issues at <a href="http://forrest.apache.org/issues.html">issue tracker</a> in the
+ "Plugin: output.Anakia" Component.
+ → open</li>
+<li>
+<strong>[code]</strong>
Enable use of the .xml filename extension, rather than the current .xdoc
extension. This requires some work on Forrest internals.
→ open</li>