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 2007/04/10 05:48:57 UTC
svn commit: r527010 [6/26] - in /forrest/trunk/site-author/content: ./
skins/ xdocs/ xdocs/docs_0_70/ xdocs/docs_0_70/howto/
xdocs/docs_0_70/howto/bugzilla-patch/ xdocs/docs_0_70/howto/cvs-ssh/
xdocs/docs_0_70/howto/multi/ xdocs/docs_0_80/ xdocs/docs_0...
Modified: forrest/trunk/site-author/content/xdocs/docs_0_70/libre-intro.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/docs_0_70/libre-intro.xml?view=diff&rev=527010&r1=527009&r2=527010
==============================================================================
--- forrest/trunk/site-author/content/xdocs/docs_0_70/libre-intro.xml (original)
+++ forrest/trunk/site-author/content/xdocs/docs_0_70/libre-intro.xml Mon Apr 9 20:48:52 2007
@@ -16,51 +16,65 @@
limitations under the License.
-->
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.2//EN" "http://forrest.apache.org/dtd/document-v12.dtd">
-<document>
- <header>
- <title>Libre QuickStart</title>
- <abstract>This document is the current full documentation on the "libre"
- generator that was implanted into xml-forrest.</abstract>
- </header>
- <body>
- <section>
- <title>Intro</title>
- <warning>This document is still relevant for ideas and potential
- solutions. However, the experimental code for Libre was removed from
- the scratchpad on 2003-04-18 during spring cleaning. If you want to
- resurrect it, then use the cvs tag "before_libre_departure".
+<document>
+ <header>
+ <title>Libre QuickStart</title>
+ <abstract>
+ This document is the current full documentation on the "libre" generator
+ that was implanted into xml-forrest.
+ </abstract>
+ </header>
+ <body>
+ <section>
+ <title>Intro</title>
+ <warning>
+ This document is still relevant for ideas and potential solutions.
+ However, the experimental code for Libre was removed from the scratchpad
+ on 2003-04-18 during spring cleaning. If you want to resurrect it, then
+ use the cvs tag "before_libre_departure".
</warning>
- <p>The libre idea was born out of the cocoon book.xml itch. The actual
- need to start scratching was introduced by the higher volume of
+ <p>
+ The libre idea was born out of the cocoon book.xml itch. The actual need
+ to start scratching was introduced by the higher volume of
book.xml-editing-work that came along with the cocoon documentation and
- xml-forrest efforts.</p>
- <p>The single idea behind it in fact is trying to automatically generate
- part of the navigation tree which is held now in the different book.xml 's.
- This automation effort however is held back by the lack of meta-data you can
- extract from the filesystem itself. This is why the libre approach still
- requires you to add this extra metadata using some libre.xml file. This
- libre.xml however has the following main advantages over the book.xml:</p>
- <ul>
+ xml-forrest efforts.
+ </p>
+ <p>
+ The single idea behind it in fact is trying to automatically generate
+ part of the navigation tree which is held now in the different book.xml
+ 's. This automation effort however is held back by the lack of meta-data
+ you can extract from the filesystem itself. This is why the libre
+ approach still requires you to add this extra metadata using some
+ libre.xml file. This libre.xml however has the following main advantages
+ over the book.xml:
+ </p>
+ <ul>
<li>The settings are 'inherited' down the directory tree, so you do not
need a libre.xml on each directory level. You only need it to change
- the subdir traversing strategy from its parent dir.</li>
+ the subdir traversing strategy from its parent dir.</li>
<li>It combines some 'filesystem-introspection'-like declarations
that are used in run-time filtering, sorting and attributing decisions.
Introspection strategies are currently based on either (1) reading properties
of the java.io.File object at hand, or (2) executing xpath expressions on the
- pointed at XML file. </li>
- </ul>
- </section>
- <section>
- <title>Using Libre now (0.0 alfa)</title>
- <warning>Disclaimer: most of what you read below is 'how it was intended'
- . To what extent that matches the actual execution process is largely dependent
- on my programming skills and thoroughness of testing. <br/>In other words:
- don't expect a thing unless you've seen it work. (at this time)</warning>
- <section>
- <title>Generated Output</title>
- <p>The XML output that comes out of the generator largely follows this
- example:</p>
+ pointed at XML file. </li>
+ </ul>
+ </section>
+ <section>
+ <title>Using Libre now (0.0 alfa)</title>
+ <warning>
+ Disclaimer: most of what you read below is 'how it was intended' . To
+ what extent that matches the actual execution process is largely
+ dependent on my programming skills and thoroughness of testing.
+ <br/>
+ In other words: don't expect a thing unless you've seen it work. (at
+ this time)
+ </warning>
+ <section>
+ <title>Generated Output</title>
+ <p>
+ The XML output that comes out of the generator largely follows this
+ example:
+ </p>
<source><?xml version="1.0" encoding="UTF-8"?>
<collection xmlns="http://outerx.org/yer/hierarchy/0.1">
<collection label="content">
@@ -92,25 +106,34 @@
title="Who we are"/>
</collection>
</collection>
-</collection></source>
- <p>And it's not getting any harder in fact: only 2 elements,
- <code><collection></code> and <code><item></code> and that should
- do. The first maps to a menu-group in the navigation, guess what the second
- maps to?</p>
- <p>The number and value (and its meaning) of the attributes on these
- elements are specified in the libre.xml file.</p>
- </section>
- <section>
- <title><code>libre.xml</code> Contents</title>
- <p>That libre.xml file follows the
- src/resources/schema/dtd/libre-v10.dtd. In fact the current release allows for
- some extra elements (I'll explain where) and some unrestricted attribute CDATA
- types that cause some extensible xml output resp. some java-introspection to be
- triggered. So basically the DTD will be limiting you more than the runtime
- interpretation. (future versions will try to narrow this down seriously, main
- reason is that a more elaborate DTD allows for more XML-editor assistance in
- editing the files.)</p>
- <p>The dtd:</p>
+</collection></source>
+ <p>
+ And it's not getting any harder in fact: only 2 elements,
+ <code><collection></code> and <code><item></code> and that
+ should do. The first maps to a menu-group in the navigation, guess
+ what the second maps to?
+ </p>
+ <p>
+ The number and value (and its meaning) of the attributes on these
+ elements are specified in the libre.xml file.
+ </p>
+ </section>
+ <section>
+ <title><code>libre.xml</code> Contents</title>
+ <p>
+ That libre.xml file follows the
+ src/resources/schema/dtd/libre-v10.dtd. In fact the current release
+ allows for some extra elements (I'll explain where) and some
+ unrestricted attribute CDATA types that cause some extensible xml
+ output resp. some java-introspection to be triggered. So basically the
+ DTD will be limiting you more than the runtime interpretation. (future
+ versions will try to narrow this down seriously, main reason is that a
+ more elaborate DTD allows for more XML-editor assistance in editing
+ the files.)
+ </p>
+ <p>
+ The dtd:
+ </p>
<source><!ELEMENT libre (entry | auto)*>
<!ELEMENT entry (label?, href?)>
<!ATTLIST entry
@@ -139,121 +162,124 @@
mask CDATA #IMPLIED
regex CDATA #IMPLIED
substitute CDATA #IMPLIED
-></source>
- <section>
- <title>Building Blocks</title>
- <p>The following elements get the following meaning when interpreted
- by the LibreConfigBuilder</p>
- <source><libre xmlns="http://outerx.org/libre/config/0.1"></source>
- <ul>
+></source>
+ <section>
+ <title>Building Blocks</title>
+ <p>
+ The following elements get the following meaning when interpreted by
+ the LibreConfigBuilder
+ </p>
+ <source><libre xmlns="http://outerx.org/libre/config/0.1"></source>
+ <ul>
<li>This is one of those libre.xml files, that will configure how
- items are filteres, sorted and attributed</li>
- </ul>
- <source><entry location="[relative location path]" /></source>
- <ul>
+ items are filteres, sorted and attributed</li>
+ </ul>
+ <source><entry location="[relative location path]" /></source>
+ <ul>
<li>Allows to manually sort out specific files or directories.</li>
-
<li>Comparable to standard book.xml behaviour, except for the fact
- that </li>
- <ul>
- <li>libre doesn't yet support external hrefs (should be easy
- though)</li>
- <li>there is no difference between <code><menu></code> and
+ that </li>
+ <ul>
+ <li>libre doesn't yet support external hrefs (should be easy
+ though)</li>
+ <li>there is no difference between <code><menu></code> and
<code><menu-item></code>, there just is <code><entry></code>. It
will become a <code><collection></code> or <code><item></code> in
the output based on the fact if the location points to a directory resp. a
- file.</li>
- <li>For locations that point to a filter it doesn't make sense, but
+ file.</li>
+ <li>For locations that point to a filter it doesn't make sense, but
when it points to a directory it is nested <code><filter></code> and
- <code><sort></code> elements get inherited down to the next level. </li>
- </ul>
- </ul>
- <fixme author="mpo">This last remarks actually means (1) I need to
- update the DTD to reflect this and (2) check the code for actually doing
- this.</fixme>
- <source><auto></source>
- <ul>
+ <code><sort></code> elements get inherited down to the next level. </li>
+ </ul>
+ </ul>
+ <fixme author="mpo">
+ This last remarks actually means (1) I need to update the DTD to
+ reflect this and (2) check the code for actually doing this.
+ </fixme>
+ <source><auto></source>
+ <ul>
<li>Automatically generates more <code><collection></code>
and <code><item></code> elements in the output, based on the
specifications of the nested elements: <code><filter></code> (which
- resources?) and <code><sort></code> (in which order?).</li>
- </ul>
- <source><filter logic="inverse" clear="no"></source>
- <ul>
+ resources?) and <code><sort></code> (in which order?).</li>
+ </ul>
+ <source><filter logic="inverse" clear="no"></source>
+ <ul>
<li>This element wraps a so-called AttributeReader (there are
currently two of them: <code><xpath></code> and
- <code><property></code>)</li>
+ <code><property></code>)</li>
<li>The AttributeReader is going to specify which
information-element is going to be retrieved from the file or directory it is
pointing at. Depending on which one is used this wrapping filter will test for
presence or regex match of the resource being read. Based on the outcome of
this test (true or false) the passed file will be accepted or not in the
- list.</li>
+ list.</li>
<li>This wrapping filter element allows to inverse the
acceptance-logic (accept what normally should be rejected and vice versa).</li>
-
<li>Using the <code>clear="yes"</code> attribute stops the
inheritance of the used filter strategy from the parent directory. Instead the
default filter strategy (which is to accept all files) is slided in at this
- level.</li>
- </ul>
- <source><sort order="descending" clear="no"></source>
- <ul>
+ level.</li>
+ </ul>
+ <source><sort order="descending" clear="no"></source>
+ <ul>
<li>This element wraps a so called AttributeReader (there are
currently two of them: <code><xpath></code> and
- <code><property></code>).</li>
+ <code><property></code>).</li>
<li>The AttributeReader is going to specify which
information-element is going to be retrieved from the file or directory it is
pointing at. This information element will be considered to be a simple
Key-String and <code><collection></code> and <code><item></code>
elements in the output will appear in the order defined by the alphabetic
- sorting of these keys.</li>
+ sorting of these keys.</li>
<li>This wrapping sort element allows to reverse the order.
- (z->a instead of a->z)</li>
+ (z->a instead of a->z)</li>
<li>Using the <code>clear="yes"</code> attribute stops the
inheritance of the used sort strategy from the parent directory. Instead the
default sort strategy (which is to use default filesystem sorting, alphabetic
- on filename) is slided in at this level.</li>
- </ul>
- <source><label>, <href>, <YOURTAG>.... {AttributeDefinitions}</source>
- <ul>
+ on filename) is slided in at this level.</li>
+ </ul>
+ <source><label>, <href>, <YOURTAG>.... {AttributeDefinitions}</source>
+ <ul>
<li>The remainder of the elements inside the
<code><auto></code> tag specify the attributes that need to be applied to
the generated <code><collection></code> and <code><item></code>
elements in the output: <code><item label=".." href=".." YOURTAG=".."
- /></code></li>
+ /></code></li>
<li>There is currently only support for adding attributes, not
- nested elements.</li>
+ nested elements.</li>
<li>These elements all wrap a so called AttributeReader (there are
- currently two of them: <xpath> and <property>)</li>
+ currently two of them: <xpath> and <property>)</li>
<li>In these cases the wrapped AttributeReader is going to specify
which information-element is going to be retrieved from the file or directory
it is pointing at. This information element will be considered to be a simple
String-value that gets slided in as the corresponding output attribute
- value.</li>
- </ul>
- <source><xpath expression="/document/header/title/text()"></source>
- <ul>
+ value.</li>
+ </ul>
+ <source><xpath expression="/document/header/title/text()"></source>
+ <ul>
<li>This element specifies an xpath AttributeReader to use inside
<code><filter></code>, <code><sort></code> or
- {AttributeDefinitions}.</li>
+ {AttributeDefinitions}.</li>
<li>It allows to specify an xpath expression that should result in
one single text node to be returned when applied to the root node of the xml
file at the location of any given entry. The contents of this text-node is the
string value to sort (<code><sort></code> usage) or to fill in the
specified attribute (<code><label></code>, <code><href></code>...
use). When inside a <code><filter></code>: the presence of the node
- results in passing the test.</li>
- </ul>
- <warning>This currently breaks for non xml (<code>*.gif</code>)
- files, so get your filter right please, and in the mean time: sorry for not
- being able to use it in the filter yet <code>:-(</code>.</warning>
+ results in passing the test.</li>
+ </ul>
+ <warning>
+ This currently breaks for non xml (<code>*.gif</code>) files, so get
+ your filter right please, and in the mean time: sorry for not being
+ able to use it in the filter yet <code>:-(</code>.
+ </warning>
<source><property name="path" regex="(\.[\\/])*(.*)" substitute="$2"/>
-<property name="name" mask="CVS"/></source>
- <ul>
+<property name="name" mask="CVS"/></source>
+ <ul>
<li>This element specifies an xpath AttributeReader to use inside
<code><filter></code>, <code><sort></code> or
- {AttributeDefinitions}.</li>
+ {AttributeDefinitions}.</li>
<li>It allows to specify a JavaBean-like property to read (this
introspection behavior will probably not survive the future release) on the
file at the 'location' of any given entry. The (object-)value of this property
@@ -261,62 +287,75 @@
sort (<code><sort></code> usage) or to fill in the specified attribute
(<code><label></code>, <code><href></code>... use). When inside a
<code><filter></code>, the test passes if the read property is not null
- or "".</li>
+ or "".</li>
<li>Furthermore this element allows to express more elaborate
true-false tests (filter use) or regex substitution (other use)
- attributes:</li>
- <ul>
- <li>combination of @regex with @substitute accounts for a
- s/{regex}/{substitute}/ kind of operation on the string property.</li>
- <li>while @mask or @regex by their own (filter use) allow for a
- glob-mask or regex test to be applied on the read property.</li>
- </ul>
- </ul>
- </section>
- </section>
- <section>
- <title>Important Side Effects</title>
- <p>There are some things that libre is doing that you should be aware of.</p>
- <section>
- <title>No libre.xml</title>
- <p>When using an <code><auto> </code>section, the filter will
- NEVER accept the <code>libre.xml</code> file to be in the generated output. You
- can however include a manual <code><entry></code> to point to the
- <code>libre.xml</code> file if needed.</p>
- </section>
- <section>
- <title>No Duplicates</title>
- <p>You can combine multiple <code><entry></code> and
- <code><auto></code> elements after each other. The system will make sure
- that the resulting list of <code><collection></code> and
- <code><item></code> will not contain duplicates. So the filters in
- <code><auto></code> sections lower down the <code>libre.xml</code> file
- can include already accepted files or directories, they will only show up once
- in the output.</p>
- </section>
- </section>
- <section>
- <title>Example Constructs</title>
- <p>Adding sorting and filtering to the filesystem with libre becomes a
+ attributes:</li>
+ <ul>
+ <li>combination of @regex with @substitute accounts for a
+ s/{regex}/{substitute}/ kind of operation on the string property.</li>
+ <li>while @mask or @regex by their own (filter use) allow for a
+ glob-mask or regex test to be applied on the read property.</li>
+ </ul>
+ </ul>
+ </section>
+ </section>
+ <section>
+ <title>Important Side Effects</title>
+ <p>
+ There are some things that libre is doing that you should be aware of.
+ </p>
+ <section>
+ <title>No libre.xml</title>
+ <p>
+ When using an <code><auto> </code>section, the filter will
+ NEVER accept the <code>libre.xml</code> file to be in the generated
+ output. You can however include a manual <code><entry></code>
+ to point to the <code>libre.xml</code> file if needed.
+ </p>
+ </section>
+ <section>
+ <title>No Duplicates</title>
+ <p>
+ You can combine multiple <code><entry></code> and
+ <code><auto></code> elements after each other. The system will
+ make sure that the resulting list of <code><collection></code>
+ and <code><item></code> will not contain duplicates. So the
+ filters in <code><auto></code> sections lower down the
+ <code>libre.xml</code> file can include already accepted files or
+ directories, they will only show up once in the output.
+ </p>
+ </section>
+ </section>
+ <section>
+ <title>Example Constructs</title>
+ <p>
+ Adding sorting and filtering to the filesystem with libre becomes a
subtle play with editable filesystem properties, smart XML content and
- <code>libre.xml</code> configs. This should be considered as the 'extended'
- contract between the following roles in the documentation system: the one
- choosing (or creating) the DTDs, the one applying those to create content and
- give the resulting files a name, the one that sets up the directories to store
- those files and writes the <code>libre.xml</code> files.</p>
- <section>
- <title>Sorting your files or your menu entries?</title>
- <p>In every case the very pragmatic approach can become something
- like this:</p>
+ <code>libre.xml</code> configs. This should be considered as the
+ 'extended' contract between the following roles in the documentation
+ system: the one choosing (or creating) the DTDs, the one applying
+ those to create content and give the resulting files a name, the one
+ that sets up the directories to store those files and writes the
+ <code>libre.xml</code> files.
+ </p>
+ <section>
+ <title>Sorting your files or your menu entries?</title>
+ <p>
+ In every case the very pragmatic approach can become something like
+ this:
+ </p>
<source>+ content
+ xdocs
+ 010Topic
+ 010Foo
+ 111Bar
+ 050Aspect
- + NotInList</source>
- <p>In combination with something that lives by the introduced
- alphabetic order, but yet hides the ugly number-prefixes:</p>
+ + NotInList</source>
+ <p>
+ In combination with something that lives by the introduced
+ alphabetic order, but yet hides the ugly number-prefixes:
+ </p>
<source><?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE libre PUBLIC "-//Outerthought//DTD Libre Configuration V0.1//EN" "libre-v01.dtd" >
<libre xmlns="http://outerx.org/libre/config/0.1">
@@ -328,29 +367,36 @@
<property name="name" regex="\d{3}(.*)" substitute="$1"/>
</label>
</auto>
-</libre></source>
- <p>Will produce an automatic list of entries (collections and items
- in the output) that </p>
- <ul>
+</libre></source>
+ <p>
+ Will produce an automatic list of entries (collections and items in
+ the output) that
+ </p>
+ <ul>
<li><code><filter></code>: only resources which name starts
- with a 3-digit pattern</li>
+ with a 3-digit pattern</li>
<li>No <code><sort></code>: in their natural filesystem order
- assured by the digit-prefix</li>
+ assured by the digit-prefix</li>
<li><code><label></code>: hold a label attribute that strips
- of the ugly number prefix</li>
- </ul>
- <p>Of course the advantage over book.xml only comes when more menu
- items should be easily slided in later on, and/or deeply nested directory
- structures can all benefit from this same filenaming/sorting strategy.</p>
- </section>
- <section>
- <title>Naming your files or asking them their name?</title>
- <p>Given the poor expressiveness of the filesystem, the labels that
- need to show up in the menu can hardly remain the filenames they are now
- (specially if we're adding these ugly number prefixes). Instead we can sign a
- contract with the content writer to also provide the navigation system with a
- sensible name for his entry using XML metadata that the system will pick up
- using an xpath expression.</p>
+ of the ugly number prefix</li>
+ </ul>
+ <p>
+ Of course the advantage over book.xml only comes when more menu
+ items should be easily slided in later on, and/or deeply nested
+ directory structures can all benefit from this same
+ filenaming/sorting strategy.
+ </p>
+ </section>
+ <section>
+ <title>Naming your files or asking them their name?</title>
+ <p>
+ Given the poor expressiveness of the filesystem, the labels that
+ need to show up in the menu can hardly remain the filenames they are
+ now (specially if we're adding these ugly number prefixes). Instead
+ we can sign a contract with the content writer to also provide the
+ navigation system with a sensible name for his entry using XML
+ metadata that the system will pick up using an xpath expression.
+ </p>
<source><?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE libre PUBLIC "-//Outerthought//DTD Libre Configuration V0.1//EN" "libre-v01.dtd" >
<libre xmlns="http://outerx.org/libre/config/0.1">
@@ -370,61 +416,70 @@
<xpath expression="/document/header/title/text()"/>
</label>
</auto>
-</libre></source>
- </section>
- </section>
- </section>
- <section>
- <title>Next Libre (0.1)</title>
- <note>Next libre is in fact largely in your hands... just drop
- the forrest-dev <link href="site:mail-lists">mail list</link>
- a line, and see what happens...</note>
- <section>
- <title>Itches</title>
- <p>There is quite a number of fast code patches that can/need to
- happen</p>
- <ul>
+</libre></source>
+ </section>
+ </section>
+ </section>
+ <section>
+ <title>Next Libre (0.1)</title>
+ <note>
+ Next libre is in fact largely in your hands... just drop the forrest-dev
+ <link href="site:mail-lists">mail list</link> a line, and see what
+ happens...
+ </note>
+ <section>
+ <title>Itches</title>
+ <p>
+ There is quite a number of fast code patches that can/need to happen
+ </p>
+ <ul>
<li>package renaming and restructuring (ideas welcome, but not top of
- mind)</li>
+ mind)</li>
<li>on same level: possible xmlns and/or elms/atts renaming on the
- generated output and the libre.xml file</li>
+ generated output and the libre.xml file</li>
<li>when compiling you currently get 4 stupid deprecation warnings
- that should be removed, in fact:</li>
+ that should be removed, in fact:</li>
<li>LibreConfigHelper has a silly test in it to switch to own parser
and resolver if there is no avalon component manager in the neighborhoud
(historical reason is the testing outside cocoon with the command line util,
which should become some kind of avalon based junit task: if you have a clue
- how to start this, throw it at us please.)</li>
+ how to start this, throw it at us please.)</li>
<li>xpath property reader needs to survive working on a non-xml
- document (by returning nothing rather then breaking on the exception)</li>
+ document (by returning nothing rather then breaking on the exception)</li>
<li>general robustness and resilience towards
- mis-configurations</li>
+ mis-configurations</li>
<li>filestreams need to get closed and avalon resources need to be
- released properly</li>
- <li>caching at the level of the generator needs to be set up</li>
+ released properly</li>
+ <li>caching at the level of the generator needs to be set up</li>
<li>in fact general performance has not been subject to loads of
- early optimizations :-P</li>
- </ul>
- </section>
- <section>
- <title>Upcoming Features</title>
- <p>More importantly however there is a major set of new features that
- is waiting to get in there. It all boils down in fact to having a more
- expressive libre.xml file... some of the thoughts:</p>
- <section>
- <title>Combinations of filter logic</title>
- <p>Some itching stuff:</p>
- <ul>
+ early optimizations :-P</li>
+ </ul>
+ </section>
+ <section>
+ <title>Upcoming Features</title>
+ <p>
+ More importantly however there is a major set of new features that is
+ waiting to get in there. It all boils down in fact to having a more
+ expressive libre.xml file... some of the thoughts:
+ </p>
+ <section>
+ <title>Combinations of filter logic</title>
+ <p>
+ Some itching stuff:
+ </p>
+ <ul>
<li>logic="inverse" on the <filter> element seems a bit
- awkward</li>
+ awkward</li>
<li><em>n</em>th degree of slickness in the regexes will only bring
- us so far, combinatory filter logic seems to be the way to go...:</li>
- </ul>
+ us so far, combinatory filter logic seems to be the way to go...:</li>
+ </ul>
<source><!ELEMENT filter (xpath | property | and | or | not)>
<!ELEMENT not (xpath | property | and | or | not)>
<!ELEMENT and (xpath | property | and | or | not)+>
-<!ELEMENT or (xpath | property | and | or | not)+></source>
- <p>So we can make up some richer:</p>
+<!ELEMENT or (xpath | property | and | or | not)+></source>
+ <p>
+ So we can make up some richer:
+ </p>
<source>
<filter>
<not>
@@ -437,150 +492,173 @@
</and>
</not>
</filter>
- </source>
- </section>
- <section>
+ </source>
+ </section>
+ <section>
<title>Separating property-retrieval from formatting and
- testing</title>
- <p>Playing around with the attributes in
- <code><property></code>:</p>
- <ul>
+ testing</title>
+ <p>
+ Playing around with the attributes in <code><property></code>:
+ </p>
+ <ul>
<li>poses hard to explain combinatory effects (@regex with
@substitute vs without, @regex can't be combined with @mask, different
- behaviour inside <filter>== test or <sort>==formatting)</li>
+ behaviour inside <filter>== test or <sort>==formatting)</li>
<li>which in fact are hard (if not impossible) to rule out by
- modifying the DTD</li>
+ modifying the DTD</li>
<li>makes you wonder why it's not available on the <xpath>
- ?</li>
- </ul>
- <p>So maybe an example more down the lines of the following would be
- easier to use:</p>
+ ?</li>
+ </ul>
+ <p>
+ So maybe an example more down the lines of the following would be
+ easier to use:
+ </p>
<source><label><!-- same applies for the sort context -->
<regexformatter exp="..." substitute="....">
<property name="absoluteLocation" />
</regexformatter>
-</label></source>
- <p>Allowing the formatter to be used around the xpath reader as well.
- And opening up the possibility to maybe format other stuff than Strings:
- <code><dateformat format="dd/mmm/yy"> </code></p>
- <p>It would also clearly distinguish the semantical difference of
- applying a test in the <code><filter></code> context:</p>
+</label></source>
+ <p>
+ Allowing the formatter to be used around the xpath reader as well.
+ And opening up the possibility to maybe format other stuff than
+ Strings: <code><dateformat format="dd/mmm/yy"> </code>
+ </p>
+ <p>
+ It would also clearly distinguish the semantical difference of
+ applying a test in the <code><filter></code> context:
+ </p>
<source><filter>
<regextest match="...">
<property ... />
</regextest>
-</filter></source>
- <p>And more logically introduce other tests like <code><globtest
- match="..."></code> or <code><availabletest></code> or...</p>
- </section>
- <section>
+</filter></source>
+ <p>
+ And more logically introduce other tests like <code><globtest
+ match="..."></code> or <code><availabletest></code> or...
+ </p>
+ </section>
+ <section>
<title>Replace the introspection with semantically richer named
- properties to read.</title>
- <p>Currently the <code><property
- name="someJavaBeanProp"></code> is applied in a java introspection for the
- <code>getSomeJavaBeanProp()</code> on the <code>java.io.File</code> object that
- is actually representing the node in the hierarchy at any given time. The DTD
- declares the attribute as of type CDATA. These decisions however:</p>
- <ul>
+ properties to read.</title>
+ <p>
+ Currently the <code><property name="someJavaBeanProp"></code>
+ is applied in a java introspection for the
+ <code>getSomeJavaBeanProp()</code> on the <code>java.io.File</code>
+ object that is actually representing the node in the hierarchy at
+ any given time. The DTD declares the attribute as of type CDATA.
+ These decisions however:
+ </p>
+ <ul>
<li>lead to a lesser user guidance for the libre.xml writer using
- an XML (and DTD) savvy editor </li>
+ an XML (and DTD) savvy editor </li>
<li>leads to assuming the <code>libre.xml</code> editor has access
- to and knows how to interpret jdk javadoc</li>
+ to and knows how to interpret jdk javadoc</li>
<li>leads to poor semantical support and thus more possible RUNTIME
errors for those just filling in some valid CDATA value that is not mapping any
- getter.</li>
+ getter.</li>
<li>leads to confusion for all, since who actually knows the subtle
- difference between all the get*Path methods on java.io.File?</li>
- </ul>
- <p>So the big idea here would be to go for an upfront declared list
- of sensible and clearly defined properties that we would like to
- read... Today's ideas about that list:</p>
- <ul>
- <li>name</li>
- <li>isDirectory (isCollection?)</li>
+ difference between all the get*Path methods on java.io.File?</li>
+ </ul>
+ <p>
+ So the big idea here would be to go for an upfront declared list of
+ sensible and clearly defined properties that we would like to
+ read... Today's ideas about that list:
+ </p>
+ <ul>
+ <li>name</li>
+ <li>isDirectory (isCollection?)</li>
<li>abs and relPath (or abs/rel Location? why would we need
- abs?)</li>
- <li>canRead</li>
- <li>canWrite</li>
- <li>lastModified</li>
- <li>length</li>
- </ul>
- <p>The DTD would then list the possible attributeValues.</p>
- </section>
- </section>
- <section>
- <title>Avalonising</title>
- <p>There are a number of perceived opportunities in taking up a
- stronger dependecy towards Avalon. Some of the possibilities become clear when
- looking into the current design...</p>
- <ul>
+ abs?)</li>
+ <li>canRead</li>
+ <li>canWrite</li>
+ <li>lastModified</li>
+ <li>length</li>
+ </ul>
+ <p>
+ The DTD would then list the possible attributeValues.
+ </p>
+ </section>
+ </section>
+ <section>
+ <title>Avalonising</title>
+ <p>
+ There are a number of perceived opportunities in taking up a stronger
+ dependecy towards Avalon. Some of the possibilities become clear when
+ looking into the current design...
+ </p>
+ <ul>
<li>Currently the EntryFactory is a abstract factory, the factory
part could be done by an Avalon Component manager. Which would also allow the
- EntryFactory to become a cleaner component interface then it is now.</li>
+ EntryFactory to become a cleaner component interface then it is now.</li>
<li>Some investigation/feedback on the current hacker-way of using
- the Composables could be nice</li>
+ the Composables could be nice</li>
<li>The current cli part in the package is only there for testing
(avoiding the cocoon webapp cycle when developing/testing) it should be
replaced by a more formal test class that actually would take up the role
(probably delegate to ECM or the like) of the componentmanager to give the
- HierarchyReader the (avalon) environment he needs.</li>
- </ul>
- </section>
- <section>
- <title>Unresolved Discussions</title>
- <ul>
+ HierarchyReader the (avalon) environment he needs.</li>
+ </ul>
+ </section>
+ <section>
+ <title>Unresolved Discussions</title>
+ <ul>
<li>do we need support for nested elements inside
- <code><item></code> output (retrieved by e.g. xpath expressions)?</li>
+ <code><item></code> output (retrieved by e.g. xpath expressions)?</li>
<li>do we need an extra <code><constant></code> like
attributereader that would allow like book.xml to add fixed values for
- expressed attributes</li>
+ expressed attributes</li>
<li>clear set out inheritance rules, just doing 'something' now
- :-(</li>
+ :-(</li>
<li>votes on needed file properties to replace the current (limiting
- and semantically poor) Java-introspection</li>
- </ul>
- </section>
- </section>
- <section>
- <title>Libre Design</title>
- <p> So why is that silly 'yer' package name in there? Yer originally was
- some all-hierarchy-structures to SAX event thing, and since some of that is in
- here as well, we kind of picked that idea up out of the dustbin.</p>
- <p>So reflecting the current packagenames we kind of have these sets of
- responsibilities</p>
- <ul>
+ and semantically poor) Java-introspection</li>
+ </ul>
+ </section>
+ </section>
+ <section>
+ <title>Libre Design</title>
+ <p>
+ So why is that silly 'yer' package name in there? Yer originally was
+ some all-hierarchy-structures to SAX event thing, and since some of that
+ is in here as well, we kind of picked that idea up out of the dustbin.
+ </p>
+ <p>
+ So reflecting the current packagenames we kind of have these sets of
+ responsibilities
+ </p>
+ <ul>
<li><em>*.yer.hierarchy</em>: describe in a formal way how hierarchies
should be built up in order to have them dumped to XML using the
- HierarchyReader.</li>
+ HierarchyReader.</li>
<li><em>*.yer.use.cocoon</em>:house of the generator. It basically just
gets a reader and subscribes the next ContentHandler in the cocoon pipeline to
- the HierarchyReader that it is using.</li>
+ the HierarchyReader that it is using.</li>
<li><em>*.yer.impl</em>: hold the different implementations of the
- *.yer.hierarchy API </li>
+ *.yer.hierarchy API </li>
<li><em>*.yer.impl.fs</em>: (only current impl) Build the described
filesystem oriented implementation of the hierarchy. It is using the libre
- configuration strategy.</li>
+ configuration strategy.</li>
<li><em>*.yer.libre</em>: provide a generic strategy for adding
filtering, sorting and attributing information to a hierarchy through the use
- of XML config files (in an XML configuration/declarative manner)</li>
- </ul>
- <p>... hope this somewhat clarifies how things have been setup for
- now.</p>
- <section>
- <title>Dependencies</title>
- <ul>
+ of XML config files (in an XML configuration/declarative manner)</li>
+ </ul>
+ <p>
+ ... hope this somewhat clarifies how things have been setup for now.
+ </p>
+ <section>
+ <title>Dependencies</title>
+ <ul>
<li>The regex stuff inside libre adds the dependency upon the oro
package. Basically I failed to find substitution support inside the regex
package (which is already in cocoon) in a timeframe comparable to just get on
- with this using oro.</li>
+ with this using oro.</li>
<li>The HierarchyGenerator is the first one in the chain (and the
last in fact) that actually needs the cocoon package (at least it was intended
- this way, could be that there are some glitches on this statement)</li>
+ this way, could be that there are some glitches on this statement)</li>
<li>There is a sort of false dependency on Avalon right now (some
Composables in there, no real container stuff though). As expressed higher
- there are some plans to stronger benefit from this dependency. </li>
- </ul>
- </section>
- </section>
- </body>
+ there are some plans to stronger benefit from this dependency. </li>
+ </ul>
+ </section>
+ </section>
+ </body>
</document>
Modified: forrest/trunk/site-author/content/xdocs/docs_0_70/linking.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/docs_0_70/linking.xml?view=diff&rev=527010&r1=527009&r2=527010
==============================================================================
--- forrest/trunk/site-author/content/xdocs/docs_0_70/linking.xml (original)
+++ forrest/trunk/site-author/content/xdocs/docs_0_70/linking.xml Mon Apr 9 20:48:52 2007
@@ -21,32 +21,28 @@
<!ENTITY s '<code>site.xml</code>'>
<!ENTITY t '<code>tabs.xml</code>'>
]>
-
<document>
<header>
<title>Menus and Linking</title>
</header>
-
<body>
<section id="intro">
<title>Introduction</title>
<p>
This document describes Forrest's internal URI space; how it is managed
- with the "&s;" configuration file, how menus are generated,
- and how various link schemes (site: and ext:) operate.
- An overview of the implementation is also provided.
+ with the "&s;" configuration file, how menus are generated, and how
+ various link schemes (site: and ext:) operate. An overview of the
+ implementation is also provided.
</p>
</section>
-
<section id="site">
<title>site.xml</title>
<p>
- The "&s;" configuration file is what we would call a "site map"
- if Cocoon hadn't already claimed that term.
- The "&s;" is a loosely structured XML file, acting as a map of the
- site's contents. It provides a unique identifier (an XPath address)
- for "nodes" of information in the website. A "node" of site information
- can be:
+ The "&s;" configuration file is what we would call a "site map" if
+ Cocoon hadn't already claimed that term. The "&s;" is a loosely
+ structured XML file, acting as a map of the site's contents. It provides
+ a unique identifier (an XPath address) for "nodes" of information in the
+ website. A "node" of site information can be:
</p>
<ul>
<li>A category of information, like "the user guide". A category may
@@ -58,7 +54,7 @@
<p>
In addition to providing fine-grained addressing of site info, the &s;
allows <em>metadata</em> to be associated with each node, using
- attributes or child elements. Most commonly, a <code>label</code>
+ attributes or child elements. Most commonly, a <code>label</code>
attribute is used to provide a text description of the node.
</p>
<p>
@@ -76,7 +72,8 @@
<p>
Here is a sample &s; ...
</p>
- <source><![CDATA[
+ <source>
+<![CDATA[
<?xml version="1.0"?>
<site label="Forrest" href="" tab="home"
xmlns="http://apache.org/forrest/linkmap/1.0">
@@ -130,8 +127,11 @@
</external-refs>
</site>
- ]]></source>
- <p>As you can see, things are quite free-form. The rules are as follows:</p>
+ ]]>
+ </source>
+ <p>
+ As you can see, things are quite free-form. The rules are as follows:
+ </p>
<ul>
<li>The root element must be "site", and normal content should be in the
namespace <code>http://apache.org/forrest/linkmap/1.0</code> (Feel
@@ -150,71 +150,86 @@
"<code>http://xml.apache.org/commons/resolver/</code>"</li>
</ul>
<p>
- See another <link href="site:v0.70//faq/site-xml">explained example</link>.
+ See another <link href="site:v0.70//faq/site-xml">explained
+ example</link>.
</p>
</section>
-
<section id="menu_generation">
<title>Generating Menus</title>
<p>
Two files are used to define a site's tabs and menu (&s; and
- <code>tabs.xml</code>). Both files are located in
- <code>src/documentation/content/xdocs/</code></p>
- <p>Assume that our <code>tabs.xml</code> looks like this:</p>
- <source><![CDATA[
+ <code>tabs.xml</code>). Both files are located in
+ <code>src/documentation/content/xdocs/</code>
+ </p>
+ <p>
+ Assume that our <code>tabs.xml</code> looks like this:
+ </p>
+ <source>
+<![CDATA[
<tabs ...>
<tab id="home" label="Home" dir=""/>
<tab id="community" label="Community" dir="community" indexfile="mailLists.html"/>
<tab id="howto" label="How-Tos" dir="community/howto"/>
</tabs>
- ]]></source>
- <p>Using the "&s;" listed above, we would get these menus:</p>
+ ]]>
+ </source>
+ <p>
+ Using the "&s;" listed above, we would get these menus:
+ </p>
<p>
- <img src="images/menu.png" alt="Menu generated from site.xml"/>
- <img src="images/menu2.png" alt="Community menu generated from site.xml"/>
+ <img src="images/menu.png" alt="Menu generated from site.xml"/>
+
+ <img src="images/menu2.png" alt="Community menu generated from site.xml"/>
+
<img src="images/menu3.png" alt="Howto menu generated from site.xml"/>
</p>
-
- <p>When using the "<code>dir</code>" attribute as above the value of the
- "<code>indexfile</code>" parameter is appended to the value of the
- "<code>dir</code>" attribute (together with a preceding '/'). For example,
- the link for the community tab above is
- <code>community/mailLists.html</code>. Note that "<code>indexfile</code>"
- defaults to "<code>index.html</code>" if no value is supplied. Therefore the
- link for the howto tab is <code>community/howto/index.html</code></p>
-
+ <p>
+ When using the "<code>dir</code>" attribute as above the value of the
+ "<code>indexfile</code>" parameter is appended to the value of the
+ "<code>dir</code>" attribute (together with a preceding '/'). For
+ example, the link for the community tab above is
+ <code>community/mailLists.html</code>. Note that
+ "<code>indexfile</code>" defaults to "<code>index.html</code>" if no
+ value is supplied. Therefore the link for the howto tab is
+ <code>community/howto/index.html</code>
+ </p>
<section id="tabs-external">
<title>Tabs for External Resources</title>
- <p>A tab can refer to an external resource by using the
- "<code>href</code>" attribute instead of the "<code>dir</code>" attribute.
- The value of "<code>href</code>" should be the URI of the resource you wish
- to link to. For example:</p>
-
- <source><![CDATA[
+ <p>
+ A tab can refer to an external resource by using the
+ "<code>href</code>" attribute instead of the "<code>dir</code>"
+ attribute. The value of "<code>href</code>" should be the URI of the
+ resource you wish to link to. For example:
+ </p>
+ <source>
+<![CDATA[
<tab id="apache" label="XML Apache" href="http://xml.apache.org/"/>
- ]]></source>
-
- <p>Unlike the "<code>dir</code>" attribute, the value of "<code>href</code>"
- is left unmodified by Forrest unless it is root-relative and obviously
- specifies a directory (ends in '/'). In which case /index.html will be
- added.</p>
+ ]]>
+ </source>
+ <p>
+ Unlike the "<code>dir</code>" attribute, the value of
+ "<code>href</code>" is left unmodified by Forrest unless it is
+ root-relative and obviously specifies a directory (ends in '/'). In
+ which case /index.html will be added.
+ </p>
</section>
-
<section id="selecting-entries">
<title>Selecting menu entries</title>
- <p>Forrest decides which menu entries to display, by examining the
- "<code>tab</code>" attributes in the &s; file. The children of
- all &s; entries with a
- "<code>tab</code>" which is equal to that of the current page, are
- added to the menu, whilst the element itself forms the root of that
- part of the menu (see the "<code>community</code>" element in the
- example below). Child elements that have a different
+ <p>
+ Forrest decides which menu entries to display, by examining the
+ "<code>tab</code>" attributes in the &s; file. The children of all &s;
+ entries with a "<code>tab</code>" which is equal to that of the
+ current page, are added to the menu, whilst the element itself forms
+ the root of that part of the menu (see the "<code>community</code>"
+ element in the example below). Child elements that have a different
"<code>tab</code>" attribute value will appear in the menu for their
- parents, and will also form the root of a new menu for a tab with
- the appropriate name (see the "<code>howto-samples</code>" element
- below).</p>
- <p>Consider our &s; example:</p>
- <source>
+ parents, and will also form the root of a new menu for a tab with the
+ appropriate name (see the "<code>howto-samples</code>" element below).
+ </p>
+ <p>
+ Consider our &s; example:
+ </p>
+ <source>
<site label="Forrest" href="" <strong>tab="home"</strong>
xmlns="http://apache.org/forrest/linkmap/1.0">
@@ -238,34 +253,41 @@
<step1 label="Step 1" href="step1.html"/>
...</source>
<p>
- Every &s; node can potentially have a "<code>tab</code>" attribute. If
- unspecified, nodes inherit the "<code>tab</code>" of their parent. Thus
- everything in the <strong><about></strong> section has an implicit
- <code>tab="home" </code>attribute.</p>
- <note>You can see this by viewing your site's
- <link href="../abs-menulinks">abs-menulinks</link> pipeline in a
- browser.</note>
- <p>Say that the user is viewing the <code>linking.html</code>
- page. The <strong><linking></strong> node has an implicit tab
- value of "<code>home</code>". Forrest will select <em>all nodes with
- tab="home"</em> and put them in the menu.
+ Every &s; node can potentially have a "<code>tab</code>" attribute. If
+ unspecified, nodes inherit the "<code>tab</code>" of their parent.
+ Thus everything in the <strong><about></strong> section has an
+ implicit <code>tab="home" </code>attribute.
+ </p>
+ <note>
+ You can see this by viewing your site's
+ <link href="../abs-menulinks">abs-menulinks</link> pipeline in a
+ browser.
+ </note>
+ <p>
+ Say that the user is viewing the <code>linking.html</code> page. The
+ <strong><linking></strong> node has an implicit tab value of
+ "<code>home</code>". Forrest will select <em>all nodes with
+ tab="home"</em> and put them in the menu.
</p>
</section>
-
<section id="other-menu-selection">
<title>Alternative menu selection mechanisms.</title>
<p>
The "<code>tab</code>" attribute-based scheme for selecting a menu's
- entries is not the only one, although it is the most flexible. Here
- we describe a few alternatives.
+ entries is not the only one, although it is the most flexible. Here we
+ describe a few alternatives.
</p>
<section id="dir-menu-selection">
<title>Directory-based selection</title>
- <p>In this scheme, each tab corresponds to a directory within the
- site. All content below that directory is included in the menu.</p>
<p>
- <img src="images/dir-menu.png" alt="Directory-based site menu"/>
- <img src="images/dir-menu2.png" alt="community/ directory menu"/>
+ In this scheme, each tab corresponds to a directory within the site.
+ All content below that directory is included in the menu.
+ </p>
+ <p>
+ <img src="images/dir-menu.png" alt="Directory-based site menu"/>
+
+ <img src="images/dir-menu2.png" alt="community/ directory menu"/>
+
<img src="images/dir-menu3.png" alt="community/howto/ directory menu"/>
</p>
<p>
@@ -282,31 +304,30 @@
<title>Specifying menus with book.xml</title>
<p>
Historically, menus in Forrest have been generated from a
- <code>book.xml</code> file, one per directory. This mechanism is
+ <code>book.xml</code> file, one per directory. This mechanism is
still available, and if a <code>book.xml</code> is found, it will be
- used in preference to the menu generated by the &s; file. The <code>book.xml</code>
- files can use "<code>site:</code>" URIs to ease the maintenance burden
- that led to obsolescence of book.xml files. In general, however, we
- recommend that users avoid <code>book.xml</code> files.
+ used in preference to the menu generated by the &s; file. The
+ <code>book.xml</code> files can use "<code>site:</code>" URIs to
+ ease the maintenance burden that led to obsolescence of book.xml
+ files. In general, however, we recommend that users avoid
+ <code>book.xml</code> files.
</p>
</section>
</section>
-
<section id="tab-selection">
<title>Selecting the current tab</title>
<p>
The tab selection algorithm is quite simple: the tab with the
- "<code>id</code>" which matches that of the current &s;
- node is "selected". However the interaction of &t; and &s;
- while powerful, can be complex to establish.
+ "<code>id</code>" which matches that of the current &s; node is
+ "selected". However the interaction of &t; and &s; while powerful, can
+ be complex to establish.
</p>
</section>
-
<section id="tab-site">
<title>Configuring the interaction between tabs.xml and site.xml</title>
<p>
- This is a collection of tips to assist with getting your menus and tabs
- to properly display.
+ This is a collection of tips to assist with getting your menus and
+ tabs to properly display.
</p>
<ul>
<li>
@@ -356,22 +377,22 @@
</li>
</ul>
</section>
-
</section>
-
<section id="toc-generation">
<title>Table of Contents Generation</title>
- <p>Each page can have an automatically generated table of contents. This
- is created from the titles of each section in your xdoc. By default only
- sections up to two levels deep are included and the table of contents is
- displayed at the top of the page. However, you can configure this
- behaviour in <code>src/documentation/skinconf.xml</code> using the
- "<code>toc</code>" element.</p>
-
- <source><![CDATA[
+ <p>
+ Each page can have an automatically generated table of contents. This is
+ created from the titles of each section in your xdoc. By default only
+ sections up to two levels deep are included and the table of contents is
+ displayed at the top of the page. However, you can configure this
+ behaviour in <code>src/documentation/skinconf.xml</code> using the
+ "<code>toc</code>" element.
+ </p>
+ <source>
+<![CDATA[
<toc level="2" location="page"/>
- ]]></source>
-
+ ]]>
+ </source>
<ul>
<li><strong><code>level</code></strong> - is the depth to which you
want your table of contents to go. Setting it to "3" will therefore
@@ -387,19 +408,16 @@
in the menu to the left of the body of the page</li>
<li><code>menu, page</code> - table of contents will be rendered
in both the page and the menu positions</li>
- </ul>
- </li>
+ </ul></li>
</ul>
</section>
-
<section id="linking">
<title>Linking systems</title>
-
<section id="direct-linking">
<title>Direct linking</title>
<p>
In earlier versions of Forrest (and in similar systems), there has
- been only one URI space: that of the generated site. If &a; wants to
+ been only one URI space: that of the generated site. If &a; wants to
link to &b; then &a; would use
</p>
<source>
@@ -407,7 +425,7 @@
</source>
<p>
The theoretical problem with this is that the content producer should
- not know or care how Forrest is going to render the source. A URI
+ not know or care how Forrest is going to render the source. A URI
should only <em>identify</em> a resource, not specify it's type
[<link href="ext:semantic-linking">mail ref</link>] and
[<link href="ext:cool-uris">cool URIs</link>]. In fact, as Forrest
@@ -415,7 +433,6 @@
one of them (here, the PDF) are likely to break.
</p>
</section>
-
<section id="indirect-linking">
<title>Indirect linking</title>
<p>
@@ -435,58 +452,59 @@
<p>
We call this indirect, or <em>semantic</em> linking because instead of
linking to a physical representation (todo.html), we've linked to the
- "idea" of "the todo file". It doesn't matter where it physically lives;
- that will be sorted out by Forrest.
+ "idea" of "the todo file". It doesn't matter where it physically
+ lives; that will be sorted out by Forrest.
</p>
-
<section id="resolve-site-uris">
<title>Resolving site: URIs</title>
-
<p>
- So how does "<code>site:v0.70//todo</code>" get resolved? A full answer
- is provided in the <link href="#implementation">implementation</link>
- section. Essentially, the "<code>todo</code>" part has
- "<code>/site//</code>" prepended, and "<code>/@href</code>" appended, to
- form the string "<code>/site//todo/@href</code>". This is
- then used as an XPath expression in &s; to identify the string
- replacement, in this case "<code>todo.html</code>"
+ So how does "<code>site:v0.70//todo</code>" get resolved? A full
+ answer is provided in the
+ <link href="#implementation">implementation</link> section.
+ Essentially, the "<code>todo</code>" part has "<code>/site//</code>"
+ prepended, and "<code>/@href</code>" appended, to form the string
+ "<code>/site//todo/@href</code>". This is then used as an XPath
+ expression in &s; to identify the string replacement, in this case
+ "<code>todo.html</code>"
</p>
<p>
- Thus by modifying the XPath prefix and suffix, almost any XML
- format can be accommodated.
+ Thus by modifying the XPath prefix and suffix, almost any XML format
+ can be accommodated.
</p>
<note>
Actually, the XPath is applied to XML generated dynamically from
- &s;. The generated XML has each "@href" fully expanded ("absolutized")
- and dot-dots (..) added as needed ("relativized").
+ &s;. The generated XML has each "@href" fully expanded
+ ("absolutized") and dot-dots (..) added as needed ("relativized").
</note>
-
<p>
- Notice that the "//" allows us any degree of specificity when linking.
- In the sample &s; above, both "<code>site:v0.70//new_content_type</code>" and
+ Notice that the "//" allows us any degree of specificity when
+ linking. In the sample &s; above, both
+ "<code>site:v0.70//new_content_type</code>" and
"<code>site:about/your-project/new_content_type</code>" identify the
- same node. It is up to you to decide how specific to make links. One
+ same node. It is up to you to decide how specific to make links. One
nice benefit of link "ambiguity" is that &s; can be reorganized
- without breaking links. For example, "new_content_type" currently
- identifies a node in "your-project". By leaving that fact unspecified
- in "<code>site:new_content_type</code>" we are free to make
- "new_content_type" its own XML file, or a node in another file, in
- another category.
+ without breaking links. For example, "new_content_type" currently
+ identifies a node in "your-project". By leaving that fact
+ unspecified in "<code>site:new_content_type</code>" we are free to
+ make "new_content_type" its own XML file, or a node in another file,
+ in another category.
</p>
</section>
-
<section id="resolve-ext-uris">
<title>ext: URIs: linking to external URLs</title>
<p>
The "<code>ext:</code>" scheme was created partly to demonstrate the
ease with which new schemes can be defined, and partly for practical
use. The "<code>ext:</code>" URIs identify nodes in &s; below the
- <external-refs> node. By convention, nodes here link to URLs
+ <external-refs> node. By convention, nodes here link to URLs
outside the website, and are not listed in the menu generated from
the &s; file.
</p>
- <p>Here is a &s; snippet illustrating "<code>external-refs</code>":</p>
- <source><![CDATA[
+ <p>
+ Here is a &s; snippet illustrating "<code>external-refs</code>":
+ </p>
+ <source>
+<![CDATA[
<site>
...
<external-refs>
@@ -498,51 +516,57 @@
</xml.apache.org>
...
</external-refs>
-</site>]]></source>
+</site>]]>
+ </source>
<p>
- As an example, <a href="ext:commons/resolver">
- generates the link
+ As an example, <a href="ext:commons/resolver"> generates the
+ link
<link href="ext:commons/resolver">http://xml.apache.org/components/resolver/</link>
</p>
<p>
The general rules of &s; and "<code>site:</code>" linking apply.
- Specifically, the "@href" aggregation makes defining large numbers of
- related URLs easy.
+ Specifically, the "@href" aggregation makes defining large numbers
+ of related URLs easy.
</p>
</section>
-
<section id="source-uris">
<title>Theory: source URIs</title>
<p>
- The "<code>site:</code>" URIs like "<code>site:v0.70//todo</code>" are examples of
- "<em>source</em>" URIs, in contrast to the more usual
- <code>foo.html</code> style URIs, which we here call
- "<em>destination</em>" URIs. This introduces an important concept: that
- the "<em>source</em>" URI space exists and is independent of that of the
- generated site. Furthermore, URIs (i.e. links) are first-class objects,
- on par with XML documents, in that just as XML content is transformed,
- so are the links. Within the source URI space, we can have all sorts of
- interesting schemes (person: mail: google: java: etc). These will
- all be translated into plain old "<code>http:</code>" or relative URIs
- in the destination URI space, just like exotic XML source formats are
- translated into plain old HTML in the output.
+ The "<code>site:</code>" URIs like "<code>site:v0.70//todo</code>"
+ are examples of "<em>source</em>" URIs, in contrast to the more
+ usual <code>foo.html</code> style URIs, which we here call
+ "<em>destination</em>" URIs. This introduces an important concept:
+ that the "<em>source</em>" URI space exists and is independent of
+ that of the generated site. Furthermore, URIs (i.e. links) are
+ first-class objects, on par with XML documents, in that just as XML
+ content is transformed, so are the links. Within the source URI
+ space, we can have all sorts of interesting schemes (person: mail:
+ google: java: etc). These will all be translated into plain old
+ "<code>http:</code>" or relative URIs in the destination URI space,
+ just like exotic XML source formats are translated into plain old
+ HTML in the output.
</p>
</section>
-
-
<section id="future-schemes">
<title>Future schemes</title>
<p>
- So far, the "<code>site:</code>" and "<code>ext:</code>" schemes are defined.
- To give you some ideas on other things we'd like to implement (and
- wouldd welcome help to implement) here are a few possibilities.
+ So far, the "<code>site:</code>" and "<code>ext:</code>" schemes are
+ defined. To give you some ideas on other things we'd like to
+ implement (and wouldd welcome help to implement) here are a few
+ possibilities.
</p>
<table>
- <tr><th>Scheme</th><th>Example "From"</th><th>Example "To"</th><th>Description</th></tr>
+ <tr>
+ <th>Scheme</th>
+ <th>Example "From"</th>
+ <th>Example "To"</th>
+ <th>Description</th>
+ </tr>
<tr>
<td>java</td>
<td>java:org.apache.proj.SomeClass</td>
- <td><code>../../apidocs/org/apache/proj/SomeClass.html</code></td>
+ <td><code>../../apidocs/org/apache/proj/SomeClass.html</code>
+ </td>
<td>
Links to documentation for a Java class (typically generated by
<code>javadoc</code>).
@@ -551,7 +575,8 @@
<tr>
<td>mail</td>
<td>mail::<Message-Id></td>
- <td><code>http://marc.theaimsgroup.com?t=12345678</code></td>
+ <td><code>http://marc.theaimsgroup.com?t=12345678</code>
+ </td>
<td>
Links to an email, identified by its <code>Message-Id</code>
header. Any mail archive website could be used.
@@ -560,14 +585,16 @@
<tr>
<td>search</td>
<td>search:<searchterm></td>
- <td><code>http://www.google.com/search?q=searchterm</code></td>
+ <td><code>http://www.google.com/search?q=searchterm</code>
+ </td>
<td>Link to set of results from a search engine</td>
</tr>
<tr>
<td>person</td>
<td>person:JT, person:JT/blog etc</td>
<td><code>mailto:jefft<at>apache.org</code>,
- <code>http://www.webweavertech.com/jefft/weblog/</code></td>
+ <code>http://www.webweavertech.com/jefft/weblog/</code>
+ </td>
<td>
A "<code>person:</code>" scheme could be used, say, to insert an
automatically obfuscated email address, or link to a URI in some
@@ -576,11 +603,12 @@
</tr>
</table>
<p>
- There are even more possibilities in specific environments. In an
+ There are even more possibilities in specific environments. In an
intranet, a "<code>project:XYZ</code>" scheme could identify company
- project pages. In a project like <link href="ext:ant">Apache
- Ant</link>, each Task could be identified with
- <code>task:<taskname></code>, e.g. <code>task:pathconvert</code>.
+ project pages. In a project like <link href="ext:ant">Apache
+ Ant</link>, each Task could be identified with
+ <code>task:<taskname></code>, e.g.
+ <code>task:pathconvert</code>.
</p>
</section>
</section>
@@ -590,21 +618,23 @@
<p>
The "<code>site:</code>" scheme and associated ideas for &s; were
originally described in <link href="ext:linkmaps">the 'linkmap' RT
- email</link> to the forrest-dev list (RT means 'random thought'; a
- Cocoon invention). Only section 2 has been implemented, and there is
- still significant work required to implement the full system
- described. In particular, there is much scope for automating the
- creation of &s; (section 4). However, what is currently implemented
- gains most of the advantages of the system.
+ email</link> to the forrest-dev list (RT means 'random thought'; a
+ Cocoon invention). Only section 2 has been implemented, and there is
+ still significant work required to implement the full system described.
+ In particular, there is much scope for automating the creation of &s;
+ (section 4). However, what is currently implemented gains most of the
+ advantages of the system.
</p>
</section>
<section id="implementation">
<title>Implementation</title>
- <p>Full details on the implementation of
- <link href="site:v0.70//linkrewriting_impl">link rewriting</link> and
- <link href="site:v0.70//menu_generation_impl">menu generation</link> are available in
- the <link href="site:v0.70//sitemap-ref">Sitemap Reference</link></p>
+ <p>
+ Full details on the implementation of
+ <link href="site:v0.70//linkrewriting_impl">link rewriting</link> and
+ <link href="site:v0.70//menu_generation_impl">menu generation</link> are
+ available in the <link href="site:v0.70//sitemap-ref">Sitemap
+ Reference</link>
+ </p>
</section>
-
</body>
</document>
Modified: forrest/trunk/site-author/content/xdocs/docs_0_70/menu-index.fv
URL: http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/docs_0_70/menu-index.fv?view=diff&rev=527010&r1=527009&r2=527010
==============================================================================
--- forrest/trunk/site-author/content/xdocs/docs_0_70/menu-index.fv (original)
+++ forrest/trunk/site-author/content/xdocs/docs_0_70/menu-index.fv Mon Apr 9 20:48:52 2007
@@ -17,7 +17,7 @@
-->
<forrest:views xmlns:forrest="http://apache.org/forrest/templates/1.0"
xmlns:jx="http://apache.org/cocoon/templates/jx/1.0">
- <!-- The following variables are used to contact data models and/or contracts. -->
+<!-- The following variables are used to contact data models and/or contracts. -->
<jx:set var="getRequest" value="#{$cocoon/parameters/getRequest}"/>
<forrest:view type="html" hooksXpath="/">
<forrest:contract name="genericMarkup">
@@ -27,4 +27,4 @@
</forrest:property>
</forrest:contract>
</forrest:view>
-</forrest:views>
\ No newline at end of file
+</forrest:views>