forrest-svn mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From cross...@apache.org
Subject svn commit: r529504 - in /forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.output.Anakia: ./ resources/themes/common/html/ src/documentation/content/xdocs/
Date Tue, 17 Apr 2007 06:55:27 GMT
Author: crossley
Date: Mon Apr 16 23:55:24 2007
New Revision: 529504

URL: http://svn.apache.org/viewvc?view=rev&rev=529504
Log:
Update "content-anakia-link.ft" and instructions to use recent development
of Dispatcher. Add a sample link.

Added:
    forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.output.Anakia/src/documentation/content/xdocs/sample-1.xml
  (with props)
Modified:
    forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.output.Anakia/resources/themes/common/html/content-anakia-link.ft
    forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.output.Anakia/src/documentation/content/xdocs/index.xml
    forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.output.Anakia/src/documentation/content/xdocs/site.xml
    forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.output.Anakia/status.xml

Modified: forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.output.Anakia/resources/themes/common/html/content-anakia-link.ft
URL: http://svn.apache.org/viewvc/forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.output.Anakia/resources/themes/common/html/content-anakia-link.ft?view=diff&rev=529504&r1=529503&r2=529504
==============================================================================
--- forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.output.Anakia/resources/themes/common/html/content-anakia-link.ft
(original)
+++ forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.output.Anakia/resources/themes/common/html/content-anakia-link.ft
Mon Apr 16 23:55:24 2007
@@ -15,24 +15,33 @@
   See the License for the specific language governing permissions and
   limitations under the License.
 -->
-<forrest:contract name="content-anakia-link" type="nugget"
-  xmlns:forrest="http://apache.org/forrest/templates/1.0">
+<forrest:contract name="content-anakia-link"
+    xmlns:forrest="http://apache.org/forrest/templates/1.0">
   <description>
-    content-anakia-link will output the XDOC link with image to the content in
+    content-anakia-link will output the XDOC image iwth a link to the content in
     Anakia xdoc format.
   </description>
   <usage>
 <![CDATA[<forrest:contract name="content-anakia-link"/>]]>
   </usage>
-  <forrest:template xmlns:forrest="http://apache.org/forrest/templates/1.0" 
-    format="html" name="content-anakia-link" inputFormat="xsl" body="true" head="false">
+  <forrest:template
+  xmlns:forrest="http://apache.org/forrest/templates/1.0"
+  name="content-anakia-link" inputFormat="xsl">
     <xsl:stylesheet version="1.1" 
-      xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
-      <xsl:template name="content-anakia-link-body"><a href="{$filename-noext}.xdoc"
class="format">
-        <img class="skin" 
-          src="{$skin-img-dir}/xmldoc.gif" alt="XML - icon" />
-        <span
-          class="caption">XDOC</span></a>
+        xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
+      <xsl:param name="defaultVariables" select="'test.html'"/>
+      <xsl:variable name="skin-img-dir" 
+          select="$defaultVariables/*/*[@name='skin-img-dir']/@value"/>
+      <xsl:variable name="filename-noext" 
+          select="$defaultVariables/*/*[@name='filename-noext']/@value"/>
+      <xsl:template match="/">
+        <forrest:content>
+          <forrest:part><a href="{$filename-noext}.xdoc" class="format">
+            <img class="skin" src="{$skin-img-dir}/xmldoc.gif" 
+                  alt="xml - icon"/>
+            <span class="caption">XDOC</span></a>
+          </forrest:part>
+        </forrest:content>
       </xsl:template>
     </xsl:stylesheet>
   </forrest:template>

Modified: forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.output.Anakia/src/documentation/content/xdocs/index.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.output.Anakia/src/documentation/content/xdocs/index.xml?view=diff&rev=529504&r1=529503&r2=529504
==============================================================================
--- forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.output.Anakia/src/documentation/content/xdocs/index.xml
(original)
+++ forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.output.Anakia/src/documentation/content/xdocs/index.xml
Mon Apr 16 23:55:24 2007
@@ -22,28 +22,36 @@
   </header>
   <body>
     <section id="overview">
-      <title>Apache Forrest - org.apache.forrest.plugin.output.Anakia Plugin</title>
+      <title>Overview</title>
       <p>
         Produce output in
-        <a href="http://jakarta.apache.org/velocity/docs/anakia.html">Anakia</a>
-        "xdoc" format, i.e. localhost:8888//index.xdoc
+        <a href="http://velocity.apache.org/engine/devel/anakia.html">Apache Velocity
Anakia</a>
+        "xdoc" format, for example
+        <a href="site:sample-1">localhost:8888/index.xdoc</a>
       </p>
       <p>
         One use of this plugin is to export a Forrest-based site to Anakia
-        "xdoc". Forrest can then draw together source content in various formats
-        and export a set of consistent documents.
+        "xdoc".
       </p>
       <p>
-        To do that you need a link from each page to its .xdoc version. The
-        easiest way to do that is with the new Dispatcher functionality. A
-        contract is provided at
-        resources/themes/common/html/content-anakia-link.ft
+        Forrest can then be used as normal, to draw together source content
+        in various formats, and export a set of consistent documents.
       </p>
+    </section>
+    <section id="howto">
+      <title>Howto</title>
       <p>
-        The current "xdoc" output structure is specifically to be that currently
-        used at http://svn.apache.org/repos/asf/infrastructure/site (produces
-        the top-level website at apache.org) which it seems does not have a DTD
-        or other grammar.
+        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.
+      </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.
       </p>
     </section>
   </body>

Added: forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.output.Anakia/src/documentation/content/xdocs/sample-1.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.output.Anakia/src/documentation/content/xdocs/sample-1.xml?view=auto&rev=529504
==============================================================================
--- forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.output.Anakia/src/documentation/content/xdocs/sample-1.xml
(added)
+++ forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.output.Anakia/src/documentation/content/xdocs/sample-1.xml
Mon Apr 16 23:55:24 2007
@@ -0,0 +1,41 @@
+<?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
+
+      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.
+-->
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
+<document>
+  <header>
+    <title>Example document</title>
+  </header>
+  <body>
+    <section id="s1">
+      <title>Sample section One</title>
+      <p>
+        Paragraph One.
+      </p>
+      <p>
+        Paragraph Two,
+        and a link which will transform to <a href="site:sample-1-xdoc">xdoc</a>.
+      </p>
+    </section>
+    <section id="s2">
+      <title>Sample section Two</title>
+      <p>
+        Paragraph One.
+      </p>
+    </section>
+  </body>
+</document>

Propchange: forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.output.Anakia/src/documentation/content/xdocs/sample-1.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Modified: forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.output.Anakia/src/documentation/content/xdocs/site.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.output.Anakia/src/documentation/content/xdocs/site.xml?view=diff&rev=529504&r1=529503&r2=529504
==============================================================================
--- forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.output.Anakia/src/documentation/content/xdocs/site.xml
(original)
+++ forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.output.Anakia/src/documentation/content/xdocs/site.xml
Mon Apr 16 23:55:24 2007
@@ -34,14 +34,9 @@
     <forrestPlugins label="Plugins Index" href="site:forrest/plugins" description="Index
of Forrest Plugins"/>
     <changes label="Changes" href="changes.html" description="History of Changes" />
     <todo label="Todo" href="todo.html" description="Todo List" />
+    <sample-1 label="Sample-1" href="sample-1.html" description="Sample simple generated
html" />
+    <sample-1-xdoc href="sample-1.xdoc"/>
   </about>
-<!--
-  The href must be wholesite.html/pdf  You can change the labels and node names
-  <all label="All">
-    <whole_site_html label="Whole Site HTML" href="wholesite.html"/>
-    <whole_site_pdf label="Whole Site PDF" href="wholesite.pdf"/>
-  </all>
-  -->
   <external-refs>
     <forrest href="http://forrest.apache.org/">
       <linking href="docs/linking.html"/>

Modified: forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.output.Anakia/status.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.output.Anakia/status.xml?view=diff&rev=529504&r1=529503&r2=529504
==============================================================================
--- forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.output.Anakia/status.xml (original)
+++ forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.output.Anakia/status.xml Mon
Apr 16 23:55:24 2007
@@ -18,12 +18,9 @@
 <status>
   <developers>
 <!-- Add new developers here -->
+    <person name="David Crossley" email="crossley@apache.org" id="DC"/>
     <person name="Volunteer needed" email="dev@forrest.apache.org" id="open"/>
   </developers>
-<!-- Define here the Title of the Context you want to display in the Changes pages.
-       id = the context value of actions
-       title = Title of the Context
-  -->
   <contexts>
 <!-- Add new contexts here -->
     <context id="code" title="Changes to the Code Base"/>
@@ -34,6 +31,10 @@
   </contexts>
   <changes>
     <release version="0.1" date="not-released">
+      <action dev="DC" type="update" context="code">
+        Update "content-anakia-link.ft" and instructions to use recent development
+        of Dispatcher. Add a sample link.
+      </action>
       <action dev="DC" type="update" context="code">
         Fine-tune the output xdoc format. Use section/title
         and section/section.



Mime
View raw message