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 2005/04/11 17:12:18 UTC
svn commit: r160902 [4/28] - in forrest/site/0.6: ./ docs/ docs/images/ dtd/
entity/ howto/ images/ skin/ skin/css/ skin/images/ skin/scripts/ skins/
Added: forrest/site/0.6/contrib.html
URL: http://svn.apache.org/viewcvs/forrest/site/0.6/contrib.html?view=auto&rev=160902
==============================================================================
--- forrest/site/0.6/contrib.html (added)
+++ forrest/site/0.6/contrib.html Mon Apr 11 08:11:56 2005
@@ -0,0 +1,459 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<meta content="Apache Forrest" name="Generator">
+<meta name="Forrest-version" content="0.7-dev">
+<meta name="Forrest-skin-name" content="pelt">
+<meta-data></meta-data>
+<title>Contributing to Apache Forrest (v0.6)</title>
+<link type="text/css" href="skin/basic.css" rel="stylesheet">
+<link media="screen" type="text/css" href="skin/screen.css" rel="stylesheet">
+<link media="print" type="text/css" href="skin/print.css" rel="stylesheet">
+<link type="text/css" href="skin/profile.css" rel="stylesheet">
+<script src="skin/getBlank.js" language="javascript" type="text/javascript"></script><script src="skin/getMenu.js" language="javascript" type="text/javascript"></script><script src="skin/fontsize.js" language="javascript" type="text/javascript"></script>
+<link rel="shortcut icon" href="favicon.ico">
+</head>
+<body onload="init()">
+<script type="text/javascript">ndeSetTextSize();</script>
+<div id="top">
+<!--+
+ |breadtrail
+ +-->
+<div class="breadtrail">
+<a href="http://www.apache.org/">apache</a> > <a href="http://forrest.apache.org/">forrest</a><script src="skin/breadcrumbs.js" language="JavaScript" type="text/javascript"></script>
+</div>
+<!--+
+ |header
+ +-->
+<div class="header">
+<!--+
+ |start group logo
+ +-->
+<div class="grouplogo">
+<a href="http://www.apache.org/"><img class="logoImage" alt="Apache" src="images/apache-forrest.png" title="The Apache Software Foundation"></a>
+</div>
+<!--+
+ |end group logo
+ +-->
+<!--+
+ |start Project Logo
+ +-->
+<div class="projectlogo">
+<a href="http://forrest.apache.org/"><img class="logoImage" alt="Forrest" src="images/project-logo.gif" title="Apache Forrest"></a>
+</div>
+<!--+
+ |end Project Logo
+ +-->
+<!--+
+ |start Search
+ +-->
+<div class="searchbox">
+<form action="http://www.google.com/search" method="get" class="roundtopsmall">
+<input value="forrest.apache.org" name="sitesearch" type="hidden"><input onFocus="getBlank (this, 'Search the site with google:');" value="Search the site with google:" size="25" name="q" id="query" type="text">
+ <input name="Search" value="Search" type="submit">
+</form>
+</div>
+<!--+
+ |end search
+ +-->
+<!--+
+ |start Tabs
+ +-->
+<ul id="tabs">
+<li>
+<a class="base-not-selected" href="index.html">Welcome</a>
+</li>
+<li class="current">
+<a class="base-selected" href="contrib.html">Project</a>
+</li>
+<li>
+<a class="base-not-selected" href="docs/index.html">O.6 Docs</a>
+</li>
+<li>
+<a class="base-not-selected" href="howto/index.html">0.6 How-To</a>
+</li>
+</ul>
+<!--+
+ |end Tabs
+ +-->
+</div>
+</div>
+<div id="main">
+<div id="publishedStrip">
+<!--+
+ |start Subtabs
+ +-->
+<div id="level2tabs"></div>
+<!--+
+ |end Endtabs
+ +-->
+<script type="text/javascript" language="JavaScript"><!--
+ document.write("Published: " + document.lastModified);
+ // --></script>
+</div>
+<!--+
+ |breadtrail
+ +-->
+<div class="breadtrail">
+
+
+ </div>
+<!--+
+ |start Menu, mainarea
+ +-->
+<!--+
+ |start Menu
+ +-->
+<div id="menu">
+<div onclick="SwitchMenu('menu_selected_1.1', 'skin/')" id="menu_selected_1.1Title" class="menutitle" style="background-image: url('skin/images/chapter_open.gif');">Getting Involved</div>
+<div id="menu_selected_1.1" class="selectedmenuitemgroup" style="display: block;">
+<div class="menupage">
+<div class="menupagetitle">Contributing</div>
+</div>
+<div class="menuitem">
+<a title="" href="build.html">Building Forrest</a>
+</div>
+<div class="menuitem">
+<a title="" href="http://svn.apache.org/viewcvs.cgi/forrest/trunk/?root=Apache-SVN">Browse SVN</a>
+</div>
+<div class="menuitem">
+<a title="" href="mail-lists.html">Mail lists</a>
+</div>
+<div class="menuitem">
+<a title="" href="http://issues.cocoondev.org/secure/BrowseProject.jspa?id=10000">Bugs and Issues</a>
+</div>
+<div class="menuitem">
+<a title="" href="forrest-issues.html">Open Issues</a>
+</div>
+</div>
+<div id="credit">
+<hr>
+ This is documentation for past release v0.6
+ (<a href="http://forrest.apache.org/docs.html">More</a> ...)</div>
+<div id="roundbottom">
+<img style="display: none" class="corner" height="15" width="15" alt="" src="skin/images/rc-b-l-15-1body-2menu-3menu.png"></div>
+<!--+
+ |alternative credits
+ +-->
+</div>
+<!--+
+ |end Menu
+ +-->
+<!--+
+ |start content
+ +-->
+<div id="content">
+<div title="Portable Document Format" class="pdflink">
+<a class="dida" href="contrib.pdf"><img alt="PDF -icon" src="skin/images/pdfdoc.gif" class="skin"><br>
+ PDF</a>
+</div>
+<div class="trail">
+ Font size:
+ <input value="Reset" class="resetfont" title="Reset text" onclick="ndeSetTextSize('reset'); return false;" type="button">
+ <input value="-a" class="smallerfont" title="Shrink text" onclick="ndeSetTextSize('decr'); return false;" type="button">
+ <input value="+a" class="biggerfont" title="Enlarge text" onclick="ndeSetTextSize('incr'); return false;" type="button">
+</div>
+<h1>Contributing to Apache Forrest</h1>
+<div id="motd-area">
+ This is documentation for past release v0.6
+ (<a href="http://forrest.apache.org/docs.html">More</a> ...)</div>
+<div id="minitoc-area">
+<ul class="minitoc">
+<li>
+<a href="#introduction">Introduction</a>
+</li>
+<li>
+<a href="#wanted">Help Wanted Here</a>
+</li>
+<li>
+<a href="#cvshowto">SVN Usage</a>
+</li>
+<li>
+<a href="#ssh">SVN Committer with Secure Shell access</a>
+</li>
+<li>
+<a href="#procedure">Procedure for Raising Development Issues</a>
+</li>
+<li>
+<a href="#patch">How to prepare and contribute patches</a>
+</li>
+<li>
+<a href="#tips">Contribution Notes and Tips</a>
+</li>
+</ul>
+</div>
+
+<a name="N1000D"></a><a name="introduction"></a>
+<h2 class="underlined_10">Introduction</h2>
+<div class="section">
+<p> The Forrest Project is an <a class="external" href="http://www.opensource.org/">Open Source</a> volunteer project released
+ under a very liberal license. This means there are many ways to contribute to the
+ project - either with direct participation (coding, documenting, answering
+ questions, proposing ideas, reporting bugs, suggesting bug-fixes, etc..) or by
+ resource donations (money, time, publicity, hardware, software, conference
+ presentations, speeches, etc...). </p>
+<p> To begin with, we suggest you to subscribe to the
+ <a href="mail-lists.html">Forrest mailing lists</a> (follow the link for
+ information on how to subscribe and to access the mail list archives).
+ Listen-in for a while, to hear how others make contributions. </p>
+<p>You can get your local working copy of the
+ <a class="external" href="http://svn.apache.org/viewcvs.cgi/forrest/trunk/?root=Apache-SVN">latest and
+ greatest code</a> (which you find in the Forrest module in the SVN code
+ repository. Review the todo list, choose a task (or perhaps you have noticed
+ something that needs patching). Make the changes, do the testing, generate a
+ patch, and post to the dev mailing list. (Do not worry - the process is easy
+ and explained below.) </p>
+<p> Document writers are usually the most wanted people so if you like to
+ help but you're not familiar with the innermost technical details, don't worry:
+ we have work for you! </p>
+</div>
+
+<a name="N1002C"></a><a name="wanted"></a>
+<h2 class="underlined_10">Help Wanted Here</h2>
+<div class="section">
+<p>We would be glad to have extra help in any of the following areas:
+ </p>
+<ul>
+
+<li>Assisting to improve documentation.</li>
+
+<li>Testing Forrest (especially its less-frequently-used features) on
+ various configurations and reporting back.</li>
+
+<li>Debugging - producing reproduceable test cases and/or finding
+ causes of bugs. Some known bugs are informally listed on To Do, and some are
+ recorded as issues (see <a href="#procedure">explanation
+ below</a>).</li>
+
+<li>Providing new use-cases and requirements. If you think that
+ Forrest does not quite meet your needs then tell us about it.</li>
+
+<li>Specifying/analysing/designing new features - and beyond. If you
+ wish to get further involved with this, please join the <span class="codefrag">forrest-dev</span> mailing
+ list, install and try out Forrest and read some of the
+ <a href="mail-lists.html">mail archives</a>. You should have a reasonable
+ fluency in XML technologies, some Java and Ant skills, and a basic understanding of the Forrest
+ architecture - don't just say "it should have XYZ" without reading anything
+ first - because chances are, somebody has already thought of that feature!)</li>
+
+<li>Packaging easy-to-install packages (such as RPMs) for the myriad of
+ possible configurations out there. (The project does not maintain anything but
+ the basic <span class="codefrag">.zip</span> and <span class="codefrag">.tar.gz</span> packages, but anyone is
+ welcome to build their own specific packages and announce them on the
+ <span class="codefrag">forrest-dev</span> list)</li>
+
+<li>... and there is just one other thing - don't forget to tell everyone
+ who asks, how great Forrest is! The more people that know about and start
+ to use Forrest, the larger the pool of potential contributors there will be.
+ </li>
+
+</ul>
+</div>
+
+
+<a name="N10062"></a><a name="cvshowto"></a>
+<h2 class="underlined_10">SVN Usage</h2>
+<div class="section">
+<p>An overview of how to use Subversion (SVN) to participate in Forrest development.
+ Do not be afraid - you cannot accidently destroy the actual code repository,
+ because you are working with a local copy as an anonymous user. Therefore, you
+ do not have the system permissions to change anything. You can only update your
+ local repository and compare your revisions with the real repository.
+ The <a href="build.html">Building Forrest</a> document explains.
+ </p>
+</div>
+
+
+<a name="N10070"></a><a name="ssh"></a>
+<h2 class="underlined_10">SVN Committer with Secure Shell access</h2>
+<div class="section">
+<p>After a developer has consistently provided contributions (code,
+ documentation and discussion) and demonstrated committment, then the rest of the dev community may vote to
+ grant this developer commit access to the Subversion repository. </p>
+<p>You will need secure access to the repository to be able to commit
+ patches. Commits to the SVN repository must use the https: protocol.
+ If you already have the codebase
+ checked out via the http: protocol, then the following command will
+ convert it.</p>
+<pre class="code">svn sw https://svn.apache.org/repos/asf/forrest/trunk</pre>
+<p>Line ending issues can be a problem when committing, since developers use
+ both Linux and Windows. SVN can understand that files are text (as opposed to binary like images), but
+ this must be specified for every new file added. The commandline SVN client
+ can be <a class="external" href="http://issues.cocoondev.org/browse/FOR-124">configured to automatically do this</a>
+ for certain file extensions. To do it manually, make sure all line endings
+ are in your current OS's native format (the dos2unix and unix2dos utilities
+ may be useful) and then do a <span class="codefrag">svn propset svn:eol-style native myfilename.txt</span>
+ and <span class="codefrag">svn commit -m "fix line endings" myfilename.txt</span>
+
+</p>
+</div>
+
+
+<a name="N1008E"></a><a name="procedure"></a>
+<h2 class="underlined_10">Procedure for Raising Development Issues</h2>
+<div class="section">
+<p> There are two methods for discussing development and submitting
+ patches. So that everyone can be productive, it is important to know which
+ method is appropriate for a certain situation and how to go about it without
+ confusion. This section explains when to use the developer
+ <a href="mail-lists.html">mailing list</a> and the
+ <a href="forrest-issues.html">issue tracker</a>. </p>
+<p> Research your topic thoroughly before beginning to discuss a new
+ development issue. Search and browse through the email archives - your issue
+ may have been discussed before. Prepare your post clearly and concisely. </p>
+<p> Most issues will be discovered, resolved, and then patched quickly
+ via the developer mailing list. Larger issues, and ones that are
+ not yet fully understood or are hard to solve, are destined for the issue tracker. </p>
+<p> Experienced developers use the issue tracker directly, as they are very sure
+ when they have found a bug and when not. However, less experienced users should
+ first discuss it on the user or developer mailing list (as appropriate).
+ Impatient people always enter everything into the issue tracker without caring if it is
+ a bug of Forrest or their own installation/configuration mistake - please do
+ not do this. </p>
+<p> As a rule-of-thumb, discuss an issue on the developers
+ mailing list first to work out any details. After it is confirmed to be
+ worthwhile, and you are clear about it, then submit the bug description or
+ patch via Bug Tracking. </p>
+<p> Perhaps you do not get any answer on your first reply, so just post
+ it again until you get one. (But please not every hour - allow a few days for
+ the list to deal with it.) Do not be impatient - remember that the whole world
+ is busy, not just you. Bear in mind that other countries will have holidays at
+ different times to your country and that they are in different time zones. You
+ might also consider rewriting your initial posting - perhaps it was not clear
+ enough and the readers eyes glazed over. </p>
+</div>
+
+
+<a name="N100AF"></a><a name="patch"></a>
+<h2 class="underlined_10">How to prepare and contribute patches</h2>
+<div class="section">
+<p>If you use the current development version of Forrest, then do
+ '<span class="codefrag">svn update; svn status</span>' to see what files that you
+ have changed.
+ Do '<span class="codefrag">svn diff > mypatch.txt</span>' to make a patch which
+ includes every change. To make a patch for a specific file, do
+ <span class="codefrag">svn diff src/documentation/content/xdocs/faq.xml > faq.xml.diff</span>'.
+ For more information about working with SVN, see
+ <a class="external" href="http://svnbook.red-bean.com/">Version Control with
+ Subversion</a> - the opensource SVN book.
+ </p>
+<p>If you use a downloaded released version of Forrest, then do
+ '<span class="codefrag">diff -u faq.xml.orig faq.xml > faq.xml.diff</span>'
+ </p>
+<div class="frame note">
+<div class="label">Note</div>
+<div class="content">Please send all contributions via our
+ <a class="external" href="http://issues.cocoondev.org/secure/BrowseProject.jspa?id=10000">issue tracker</a>.
+ </div>
+</div>
+<p>
+ It is always a good idea to check the Forrest
+ <a class="external" href="http://issues.cocoondev.org/secure/BrowseProject.jspa?id=10000">issue tracker</a>
+ and
+ <a href="todo.html">to do list</a>
+ before diving in.
+ </p>
+</div>
+
+
+<a name="N100DE"></a><a name="tips"></a>
+<h2 class="underlined_10">Contribution Notes and Tips</h2>
+<div class="section">
+<p> This is a collection of tips for contributing to the project in a
+ manner that is productive for all parties. </p>
+<ul>
+
+<li> Every contribution is worthwhile. Even if the ensuing discussion
+ proves it to be off-beam, then it may jog ideas for other people. </li>
+
+<li> Use sensible and concise email subject headings. Search engines,
+ and humans trying to browse a voluminous list, will respond favourably to a
+ descriptive title. </li>
+
+<li>Start new threads with new Subject for new topics, rather than
+ reusing the previous Subject line. </li>
+
+<li>Keep each topic focused. If some new topic arises then start a new
+ discussion. This leaves the original topic to continue uncluttered. </li>
+
+<li>Whenever you decide to start a new topic, then start with a fresh
+ new email message window. Do not use the "Reply to" button, because
+ threaded mail-readers get confused (they utilise the <span class="codefrag">In-reply-to</span>
+ header). If so, then your new topic will get lost in the previous thread and go
+ unanswered. </li>
+
+<li> Prepend your email subject line with a marker when that is
+ appropriate, e.g. <span class="codefrag">[Proposal]</span>,
+ <span class="codefrag">[RT]</span> (Random Thought which quickly blossom into research topics
+ :-), <span class="codefrag">[STATUS]</span> (development status of a certain facility). </li>
+
+<li> When making changes to XML documentation, or any XML document for
+ that matter, use a validating XML editor. Here is some assistance
+ with editor
+ <a href="docs/catalog.html">configuration</a>.
+ </li>
+
+<li> Remember that most people are participating in development on a
+ volunteer basis and in their "spare time". These enthusiasts will attempt to
+ respond to issues. It may take a little while to get your answers. </li>
+
+<li> Research your topic thoroughly before beginning to discuss a new
+ development issue. Search and browse through the email archives - your issue
+ may have been discussed before. Do not just perceive a problem and then rush
+ out with a question - instead, delve. </li>
+
+<li> Try to at least offer a partial solution and not just a problem
+ statement. </li>
+
+<li> Take the time to clearly explain your issue and write a concise
+ email message. Less confusion facilitates fast and complete resolution. </li>
+
+<li> Do not bother to send an email reply that simply says "thanks". When
+ the issue is resolved, that is the finish - end of thread. Reduce clutter.
+ </li>
+
+<li> You would usually do any development work against the trunk of
+ SVN. </li>
+
+<li> When sending a patch, you usually do not need to worry about which
+ SVN branch it should be applied to. The maintainers of the repository will
+ decide. </li>
+
+<li>Keep all project-related discussion on the mailing list. It is much
+ better to utilise the wider audience, rather than to break off into
+ private discussion groups. You never know who else will have the
+ answer to your issues, and anyway other people are interested in
+ the outcome.
+ </li>
+
+<li> Become familiar with the mailing lists. As you browse and search,
+ you will see the way other people do things. Follow the leading examples. </li>
+
+
+</ul>
+</div>
+
+</div>
+<!--+
+ |end content
+ +-->
+<div class="clearboth"> </div>
+</div>
+<div id="footer">
+<!--+
+ |start bottomstrip
+ +-->
+<div class="lastmodified">
+<script type="text/javascript"><!--
+document.write("Last Published: " + document.lastModified);
+// --></script>
+</div>
+<div class="copyright">
+ Copyright © 2002-2004 The Apache Software Foundation.</div>
+<!--+
+ |end bottomstrip
+ +-->
+</div>
+</body>
+</html>
Propchange: forrest/site/0.6/contrib.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: forrest/site/0.6/contrib.pdf
URL: http://svn.apache.org/viewcvs/forrest/site/0.6/contrib.pdf?view=auto&rev=160902
==============================================================================
Binary file - no diff available.
Propchange: forrest/site/0.6/contrib.pdf
------------------------------------------------------------------------------
svn:mime-type = application/pdf
Added: forrest/site/0.6/docs/cap.html
URL: http://svn.apache.org/viewcvs/forrest/site/0.6/docs/cap.html?view=auto&rev=160902
==============================================================================
--- forrest/site/0.6/docs/cap.html (added)
+++ forrest/site/0.6/docs/cap.html Mon Apr 11 08:11:56 2005
@@ -0,0 +1,371 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<meta content="Apache Forrest" name="Generator">
+<meta name="Forrest-version" content="0.7-dev">
+<meta name="Forrest-skin-name" content="pelt">
+<meta-data></meta-data>
+<title>SourceTypeAction (content aware pipelines) (v0.6)</title>
+<link type="text/css" href="../skin/basic.css" rel="stylesheet">
+<link media="screen" type="text/css" href="../skin/screen.css" rel="stylesheet">
+<link media="print" type="text/css" href="../skin/print.css" rel="stylesheet">
+<link type="text/css" href="../skin/profile.css" rel="stylesheet">
+<script src="../skin/getBlank.js" language="javascript" type="text/javascript"></script><script src="../skin/getMenu.js" language="javascript" type="text/javascript"></script><script src="../skin/fontsize.js" language="javascript" type="text/javascript"></script>
+<link rel="shortcut icon" href="../favicon.ico">
+</head>
+<body onload="init()">
+<script type="text/javascript">ndeSetTextSize();</script>
+<div id="top">
+<!--+
+ |breadtrail
+ +-->
+<div class="breadtrail">
+<a href="http://www.apache.org/">apache</a> > <a href="http://forrest.apache.org/">forrest</a><script src="../skin/breadcrumbs.js" language="JavaScript" type="text/javascript"></script>
+</div>
+<!--+
+ |header
+ +-->
+<div class="header">
+<!--+
+ |start group logo
+ +-->
+<div class="grouplogo">
+<a href="http://www.apache.org/"><img class="logoImage" alt="Apache" src="../images/apache-forrest.png" title="The Apache Software Foundation"></a>
+</div>
+<!--+
+ |end group logo
+ +-->
+<!--+
+ |start Project Logo
+ +-->
+<div class="projectlogo">
+<a href="http://forrest.apache.org/"><img class="logoImage" alt="Forrest" src="../images/project-logo.gif" title="Apache Forrest"></a>
+</div>
+<!--+
+ |end Project Logo
+ +-->
+<!--+
+ |start Search
+ +-->
+<div class="searchbox">
+<form action="http://www.google.com/search" method="get" class="roundtopsmall">
+<input value="forrest.apache.org" name="sitesearch" type="hidden"><input onFocus="getBlank (this, 'Search the site with google:');" value="Search the site with google:" size="25" name="q" id="query" type="text">
+ <input name="Search" value="Search" type="submit">
+</form>
+</div>
+<!--+
+ |end search
+ +-->
+<!--+
+ |start Tabs
+ +-->
+<ul id="tabs">
+<li>
+<a class="base-not-selected" href="../index.html">Welcome</a>
+</li>
+<li>
+<a class="base-not-selected" href="../contrib.html">Project</a>
+</li>
+<li class="current">
+<a class="base-selected" href="../docs/index.html">O.6 Docs</a>
+</li>
+<li>
+<a class="base-not-selected" href="../howto/index.html">0.6 How-To</a>
+</li>
+</ul>
+<!--+
+ |end Tabs
+ +-->
+</div>
+</div>
+<div id="main">
+<div id="publishedStrip">
+<!--+
+ |start Subtabs
+ +-->
+<div id="level2tabs">
+<a class="base-selected" href="../docs/your-project.html">Core</a> | <a class="base-selected" href="../docs/forrestbot.html">ForrestBot</a> | <a class="base-selected" href="../docs/forrestbar.html">ForrestBar</a>
+</div>
+<!--+
+ |end Endtabs
+ +-->
+<script type="text/javascript" language="JavaScript"><!--
+ document.write("Published: " + document.lastModified);
+ // --></script>
+</div>
+<!--+
+ |breadtrail
+ +-->
+<div class="breadtrail">
+
+
+ </div>
+<!--+
+ |start Menu, mainarea
+ +-->
+<!--+
+ |start Menu
+ +-->
+<div id="menu">
+<div onclick="SwitchMenu('menu_selected_1.1', '../skin/')" id="menu_selected_1.1Title" class="menutitle" style="background-image: url('../skin/images/chapter_open.gif');">Documentation</div>
+<div id="menu_selected_1.1" class="selectedmenuitemgroup" style="display: block;">
+<div class="menuitem">
+<a title="" href="../docs/index.html">Index</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/your-project.html">Using Forrest</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/validation.html">XML Validation</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/linking.html">Menus and Linking</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/searching.html">Searching</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/skins.html">Default Skins</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/skin-package.html">Skin Packages</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/forrest-contract.html">Our Contract</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/compliance.html">Standards Compliance</a>
+</div>
+<div onclick="SwitchMenu('menu_selected_1.1.10', '../skin/')" id="menu_selected_1.1.10Title" class="menutitle" style="background-image: url('../skin/images/chapter_open.gif');">Advanced Topics</div>
+<div id="menu_selected_1.1.10" class="selectedmenuitemgroup" style="display: block;">
+<div class="menuitem">
+<a title="" href="../docs/catalog.html">Using DTD Catalogs</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/sitemap-ref.html">Sitemap Reference</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/project-sitemap.html">Project sitemap</a>
+</div>
+<div class="menupage">
+<div class="menupagetitle">Sourcetype Action</div>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.1.11', '../skin/')" id="menu_1.1.11Title" class="menutitle">Upgrading</div>
+<div id="menu_1.1.11" class="menuitemgroup">
+<div class="menuitem">
+<a title="" href="../docs/upgrading_06.html">Upgrading to 0.6</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/upgrading_05.html">Upgrading to 0.5</a>
+</div>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.2', '../skin/')" id="menu_1.2Title" class="menutitle">SubProjects</div>
+<div id="menu_1.2" class="menuitemgroup">
+<div class="menuitem">
+<a title="" href="../docs/forrestbar.html">ForrestBar</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/forrestbot.html">Forrestbot</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/forrestbot-web-interface.html">Forrestbot Webapp</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.3', '../skin/')" id="menu_1.3Title" class="menutitle">Reference docs</div>
+<div id="menu_1.3" class="menuitemgroup">
+<div onclick="SwitchMenu('menu_1.3.1', '../skin/')" id="menu_1.3.1Title" class="menutitle">DTD documentation</div>
+<div id="menu_1.3.1" class="menuitemgroup">
+<div class="menuitem">
+<a title="" href="../docs/dtd-docs.html">Overview</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/document-v20.dtdx.html">document-v20</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/howto-v20.dtdx.html">howto-v20</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/faq-v20.dtdx.html">faq-v20</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/document-v13.dtdx.html">document-v13</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/howto-v13.dtdx.html">howto-v13</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/faq-v13.dtdx.html">faq-v13</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.3.2', '../skin/')" id="menu_1.3.2Title" class="menutitle">Doc samples</div>
+<div id="menu_1.3.2" class="menuitemgroup">
+<div class="menuitem">
+<a title="" href="../docs/document-v13.html">document-v13</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/document-v20.html">document-v20</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/wiki-sample.html">JSPWiki Reference</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/oowriter.html">OpenOffice.Org Writer</a>
+</div>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.4', '../skin/')" id="menu_1.4Title" class="menutitle">Older Docs</div>
+<div id="menu_1.4" class="menuitemgroup">
+<div class="menuitem">
+<a title="" href="../docs/primer.html">Forrest Primer</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/libre-intro.html">Libre</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/dreams.html">Dream list</a>
+</div>
+</div>
+<div id="credit">
+<hr>
+ This is documentation for past release v0.6
+ (<a href="http://forrest.apache.org/docs.html">More</a> ...)</div>
+<div id="roundbottom">
+<img style="display: none" class="corner" height="15" width="15" alt="" src="../skin/images/rc-b-l-15-1body-2menu-3menu.png"></div>
+<!--+
+ |alternative credits
+ +-->
+</div>
+<!--+
+ |end Menu
+ +-->
+<!--+
+ |start content
+ +-->
+<div id="content">
+<div title="Portable Document Format" class="pdflink">
+<a class="dida" href="cap.pdf"><img alt="PDF -icon" src="../skin/images/pdfdoc.gif" class="skin"><br>
+ PDF</a>
+</div>
+<div class="trail">
+ Font size:
+ <input value="Reset" class="resetfont" title="Reset text" onclick="ndeSetTextSize('reset'); return false;" type="button">
+ <input value="-a" class="smallerfont" title="Shrink text" onclick="ndeSetTextSize('decr'); return false;" type="button">
+ <input value="+a" class="biggerfont" title="Enlarge text" onclick="ndeSetTextSize('incr'); return false;" type="button">
+</div>
+<h1>SourceTypeAction (content aware pipelines)</h1>
+<div id="motd-area">
+ This is documentation for past release v0.6
+ (<a href="http://forrest.apache.org/docs.html">More</a> ...)</div>
+<div id="minitoc-area">
+<ul class="minitoc">
+<li>
+<a href="#Introduction">Introduction</a>
+</li>
+<li>
+<a href="#Configuration">Configuration</a>
+</li>
+<li>
+<a href="#Usage">Usage</a>
+</li>
+</ul>
+</div>
+
+<a name="N1000E"></a><a name="Introduction"></a>
+<h2 class="underlined_10">Introduction</h2>
+<div class="section">
+<p>SourceTypeAction assigns a "type" (a string) to an XML file. This is
+ done based on information occuring in the header of the XML file, up to the
+ document (root) element. This type is then returned to the sitemap as a
+ variable with the name 'sourcetype'. If no matching sourcetype could be be
+ found, null is returned and thus the contents of the action element will not be
+ executed.</p>
+<p>SourceTypeAction works by pull-parsing the document and collecting
+ information such as the Public Id, the processing instructions, the document
+ element local name and namespace, and the xsi:schemaLocation and
+ xsi:noNamespaceSchemaLocation attributes. This information is then compared
+ with the rules described in the configuration of the SourceTypeAction.</p>
+</div>
+
+<a name="N1001B"></a><a name="Configuration"></a>
+<h2 class="underlined_10">Configuration</h2>
+<div class="section">
+<p>The action should be declared and configured in the map:actions
+ section of the sitemap. Example:</p>
+<pre class="code"><map:action name="sourcetype" src="org.apache.cocoon.acting.sourcetype.SourceTypeAction">
+ <sourcetype name="documentv13">
+ <document-declaration public-id="-//APACHE//DTD Documentation V1.3//EN"/>
+ </sourcetype>
+ <sourcetype name="foo">
+ <document-element local-name="foo">
+ </sourcetype>
+</map:action></pre>
+<p>Each sourcetype-tag declares a source type. Inside the sourcetype-tag
+ a number of rules can be defined, described below. The sourcetypes will be
+ checked in the same order as they are defined in the configuration, the first
+ sourcetype of which all rules match will be used.</p>
+<p>These are the available rules:</p>
+<dl>
+
+<dt>document-declaration</dt>
+
+<dd>This rule checks the public ID. It takes one attribute
+ <span class="codefrag">public-id</span>.</dd>
+
+<dt>document-element</dt>
+
+<dd>This rule checks the local name and/or namespace of the document
+ element. These are specified with the attributes <span class="codefrag">local-name</span> and
+ <span class="codefrag">namespace</span>. At least one of these two is required.</dd>
+
+<dt>processing-instruction</dt>
+
+<dd>This rule checks a processing instruction. It can take two
+ attributes: <span class="codefrag">target</span> and <span class="codefrag">data</span>. The target attribute is
+ always required, the data attribute is optional.</dd>
+
+<dt>w3c-xml-schema</dt>
+
+<dd>This rule checks the value of the xsi:schemaLocation and
+ xsi:noNamespaceSchemaLocation attributes on the document element. These are
+ specified with the attributes <span class="codefrag">schema-location</span> and
+ <span class="codefrag">no-namespace-schema-location</span>.</dd>
+
+</dl>
+</div>
+
+<a name="N1005F"></a><a name="Usage"></a>
+<h2 class="underlined_10">Usage</h2>
+<div class="section">
+<p>The source of which the sourcetype must be defined must be specified
+ using the 'src' attribute on the map:act element.</p>
+<pre class="code"><map:act type="sourcetype" src="{1}">
+...
+</map:act></pre>
+</div>
+
+</div>
+<!--+
+ |end content
+ +-->
+<div class="clearboth"> </div>
+</div>
+<div id="footer">
+<!--+
+ |start bottomstrip
+ +-->
+<div class="lastmodified">
+<script type="text/javascript"><!--
+document.write("Last Published: " + document.lastModified);
+// --></script>
+</div>
+<div class="copyright">
+ Copyright © 2002-2004 The Apache Software Foundation.</div>
+<!--+
+ |end bottomstrip
+ +-->
+</div>
+</body>
+</html>
Propchange: forrest/site/0.6/docs/cap.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: forrest/site/0.6/docs/cap.pdf
URL: http://svn.apache.org/viewcvs/forrest/site/0.6/docs/cap.pdf?view=auto&rev=160902
==============================================================================
Binary file - no diff available.
Propchange: forrest/site/0.6/docs/cap.pdf
------------------------------------------------------------------------------
svn:mime-type = application/pdf
Added: forrest/site/0.6/docs/catalog.html
URL: http://svn.apache.org/viewcvs/forrest/site/0.6/docs/catalog.html?view=auto&rev=160902
==============================================================================
--- forrest/site/0.6/docs/catalog.html (added)
+++ forrest/site/0.6/docs/catalog.html Mon Apr 11 08:11:56 2005
@@ -0,0 +1,542 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<meta content="Apache Forrest" name="Generator">
+<meta name="Forrest-version" content="0.7-dev">
+<meta name="Forrest-skin-name" content="pelt">
+<meta-data></meta-data>
+<title>Using Catalog Entity Resolver for local DTDs (v0.6)</title>
+<link type="text/css" href="../skin/basic.css" rel="stylesheet">
+<link media="screen" type="text/css" href="../skin/screen.css" rel="stylesheet">
+<link media="print" type="text/css" href="../skin/print.css" rel="stylesheet">
+<link type="text/css" href="../skin/profile.css" rel="stylesheet">
+<script src="../skin/getBlank.js" language="javascript" type="text/javascript"></script><script src="../skin/getMenu.js" language="javascript" type="text/javascript"></script><script src="../skin/fontsize.js" language="javascript" type="text/javascript"></script>
+<link rel="shortcut icon" href="../favicon.ico">
+</head>
+<body onload="init()">
+<script type="text/javascript">ndeSetTextSize();</script>
+<div id="top">
+<!--+
+ |breadtrail
+ +-->
+<div class="breadtrail">
+<a href="http://www.apache.org/">apache</a> > <a href="http://forrest.apache.org/">forrest</a><script src="../skin/breadcrumbs.js" language="JavaScript" type="text/javascript"></script>
+</div>
+<!--+
+ |header
+ +-->
+<div class="header">
+<!--+
+ |start group logo
+ +-->
+<div class="grouplogo">
+<a href="http://www.apache.org/"><img class="logoImage" alt="Apache" src="../images/apache-forrest.png" title="The Apache Software Foundation"></a>
+</div>
+<!--+
+ |end group logo
+ +-->
+<!--+
+ |start Project Logo
+ +-->
+<div class="projectlogo">
+<a href="http://forrest.apache.org/"><img class="logoImage" alt="Forrest" src="../images/project-logo.gif" title="Apache Forrest"></a>
+</div>
+<!--+
+ |end Project Logo
+ +-->
+<!--+
+ |start Search
+ +-->
+<div class="searchbox">
+<form action="http://www.google.com/search" method="get" class="roundtopsmall">
+<input value="forrest.apache.org" name="sitesearch" type="hidden"><input onFocus="getBlank (this, 'Search the site with google:');" value="Search the site with google:" size="25" name="q" id="query" type="text">
+ <input name="Search" value="Search" type="submit">
+</form>
+</div>
+<!--+
+ |end search
+ +-->
+<!--+
+ |start Tabs
+ +-->
+<ul id="tabs">
+<li>
+<a class="base-not-selected" href="../index.html">Welcome</a>
+</li>
+<li>
+<a class="base-not-selected" href="../contrib.html">Project</a>
+</li>
+<li class="current">
+<a class="base-selected" href="../docs/index.html">O.6 Docs</a>
+</li>
+<li>
+<a class="base-not-selected" href="../howto/index.html">0.6 How-To</a>
+</li>
+</ul>
+<!--+
+ |end Tabs
+ +-->
+</div>
+</div>
+<div id="main">
+<div id="publishedStrip">
+<!--+
+ |start Subtabs
+ +-->
+<div id="level2tabs">
+<a class="base-selected" href="../docs/your-project.html">Core</a> | <a class="base-selected" href="../docs/forrestbot.html">ForrestBot</a> | <a class="base-selected" href="../docs/forrestbar.html">ForrestBar</a>
+</div>
+<!--+
+ |end Endtabs
+ +-->
+<script type="text/javascript" language="JavaScript"><!--
+ document.write("Published: " + document.lastModified);
+ // --></script>
+</div>
+<!--+
+ |breadtrail
+ +-->
+<div class="breadtrail">
+
+
+ </div>
+<!--+
+ |start Menu, mainarea
+ +-->
+<!--+
+ |start Menu
+ +-->
+<div id="menu">
+<div onclick="SwitchMenu('menu_selected_1.1', '../skin/')" id="menu_selected_1.1Title" class="menutitle" style="background-image: url('../skin/images/chapter_open.gif');">Documentation</div>
+<div id="menu_selected_1.1" class="selectedmenuitemgroup" style="display: block;">
+<div class="menuitem">
+<a title="" href="../docs/index.html">Index</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/your-project.html">Using Forrest</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/validation.html">XML Validation</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/linking.html">Menus and Linking</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/searching.html">Searching</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/skins.html">Default Skins</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/skin-package.html">Skin Packages</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/forrest-contract.html">Our Contract</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/compliance.html">Standards Compliance</a>
+</div>
+<div onclick="SwitchMenu('menu_selected_1.1.10', '../skin/')" id="menu_selected_1.1.10Title" class="menutitle" style="background-image: url('../skin/images/chapter_open.gif');">Advanced Topics</div>
+<div id="menu_selected_1.1.10" class="selectedmenuitemgroup" style="display: block;">
+<div class="menupage">
+<div class="menupagetitle">Using DTD Catalogs</div>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/sitemap-ref.html">Sitemap Reference</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/project-sitemap.html">Project sitemap</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/cap.html">Sourcetype Action</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.1.11', '../skin/')" id="menu_1.1.11Title" class="menutitle">Upgrading</div>
+<div id="menu_1.1.11" class="menuitemgroup">
+<div class="menuitem">
+<a title="" href="../docs/upgrading_06.html">Upgrading to 0.6</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/upgrading_05.html">Upgrading to 0.5</a>
+</div>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.2', '../skin/')" id="menu_1.2Title" class="menutitle">SubProjects</div>
+<div id="menu_1.2" class="menuitemgroup">
+<div class="menuitem">
+<a title="" href="../docs/forrestbar.html">ForrestBar</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/forrestbot.html">Forrestbot</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/forrestbot-web-interface.html">Forrestbot Webapp</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.3', '../skin/')" id="menu_1.3Title" class="menutitle">Reference docs</div>
+<div id="menu_1.3" class="menuitemgroup">
+<div onclick="SwitchMenu('menu_1.3.1', '../skin/')" id="menu_1.3.1Title" class="menutitle">DTD documentation</div>
+<div id="menu_1.3.1" class="menuitemgroup">
+<div class="menuitem">
+<a title="" href="../docs/dtd-docs.html">Overview</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/document-v20.dtdx.html">document-v20</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/howto-v20.dtdx.html">howto-v20</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/faq-v20.dtdx.html">faq-v20</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/document-v13.dtdx.html">document-v13</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/howto-v13.dtdx.html">howto-v13</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/faq-v13.dtdx.html">faq-v13</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.3.2', '../skin/')" id="menu_1.3.2Title" class="menutitle">Doc samples</div>
+<div id="menu_1.3.2" class="menuitemgroup">
+<div class="menuitem">
+<a title="" href="../docs/document-v13.html">document-v13</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/document-v20.html">document-v20</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/wiki-sample.html">JSPWiki Reference</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/oowriter.html">OpenOffice.Org Writer</a>
+</div>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.4', '../skin/')" id="menu_1.4Title" class="menutitle">Older Docs</div>
+<div id="menu_1.4" class="menuitemgroup">
+<div class="menuitem">
+<a title="" href="../docs/primer.html">Forrest Primer</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/libre-intro.html">Libre</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/dreams.html">Dream list</a>
+</div>
+</div>
+<div id="credit">
+<hr>
+ This is documentation for past release v0.6
+ (<a href="http://forrest.apache.org/docs.html">More</a> ...)</div>
+<div id="roundbottom">
+<img style="display: none" class="corner" height="15" width="15" alt="" src="../skin/images/rc-b-l-15-1body-2menu-3menu.png"></div>
+<!--+
+ |alternative credits
+ +-->
+</div>
+<!--+
+ |end Menu
+ +-->
+<!--+
+ |start content
+ +-->
+<div id="content">
+<div title="Portable Document Format" class="pdflink">
+<a class="dida" href="catalog.pdf"><img alt="PDF -icon" src="../skin/images/pdfdoc.gif" class="skin"><br>
+ PDF</a>
+</div>
+<div class="trail">
+ Font size:
+ <input value="Reset" class="resetfont" title="Reset text" onclick="ndeSetTextSize('reset'); return false;" type="button">
+ <input value="-a" class="smallerfont" title="Shrink text" onclick="ndeSetTextSize('decr'); return false;" type="button">
+ <input value="+a" class="biggerfont" title="Enlarge text" onclick="ndeSetTextSize('incr'); return false;" type="button">
+</div>
+<h1>Using Catalog Entity Resolver for local DTDs</h1>
+<div id="motd-area">
+ This is documentation for past release v0.6
+ (<a href="http://forrest.apache.org/docs.html">More</a> ...)</div>
+<div id="minitoc-area">
+<ul class="minitoc">
+<li>
+<a href="#overview">Overview</a>
+</li>
+<li>
+<a href="#config">General configuration notes</a>
+</li>
+<li>
+<a href="#tools">Configuring specific tools</a>
+<ul class="minitoc">
+<li>
+<a href="#system">Operating system catalog</a>
+</li>
+<li>
+<a href="#xmllint">xmllint validating parser</a>
+</li>
+<li>
+<a href="#vim">Vim</a>
+</li>
+<li>
+<a href="#emacs">Emacs</a>
+</li>
+<li>
+<a href="#onsgmls">onsgmls validating parser</a>
+</li>
+<li>
+<a href="#jedit">jEdit - Open Source programmer's text editor</a>
+</li>
+<li>
+<a href="#oxygenxml">oXygen XML Editor</a>
+</li>
+<li>
+<a href="#xmlspy">xmlspy</a>
+</li>
+<li>
+<a href="#xxe">XMLmind XML Editor (XXE)</a>
+<ul class="minitoc">
+<li>
+<a href="#XXE+v2.5p2+or+older">XXE v2.5p2 or older</a>
+</li>
+<li>
+<a href="#XXE+v2.5p3%2B">XXE v2.5p3+</a>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+<li>
+<a href="#info">Further information and resources</a>
+</li>
+</ul>
+</div>
+
+<a name="N1000D"></a><a name="overview"></a>
+<h2 class="underlined_10">Overview</h2>
+<div class="section">
+<p>
+ This is a collection of notes for configuring the Catalog Entity
+ Resolver with your favourite XML tools (validating parsers and
+ editors).
+ </p>
+<p>
+ All XML documents declare their ruleset - the Document Type Definition
+ (DTD). When Forrest processes the documents, it uses the Resolver to
+ find Forrest's local copies of the DTDs, rather than trundling out
+ onto the network.
+ </p>
+<p>
+ Many Java-based XML tools already have an entity resolver, probably
+ the same one that Forrest uses. Many non-Java tools also have an
+ entity resolver. To use these tools with documents based on the
+ Forrest DTDs, you need to configure the tools.
+ </p>
+<div class="frame note">
+<div class="label">Note</div>
+<div class="content">
+ The information provided here is not intended to endorse any
+ particular tool.
+ </div>
+</div>
+<p>
+ If you have any other configuration tips for a particular tool, then
+ please send them to the forrest-dev mailing list.
+ </p>
+</div>
+
+
+<a name="N10023"></a><a name="config"></a>
+<h2 class="underlined_10">General configuration notes</h2>
+<div class="section">
+<p>
+ The Forrest DTDs and supporting resources are in the Forrest
+ distribution at <span class="codefrag">src/core/context/resources/schema/</span>
+
+</p>
+<p>
+ Usually all that is required is to direct your tool to the "catalog"
+ supplied by Forrest at either:
+ <span class="codefrag">$FORREST/src/core/context/resources/schema/catalog.xcat</span>
+ (for XML Catalog) or
+ <span class="codefrag">$FORREST/src/core/context/resources/schema/catalog</span>
+ (for TR 9401 Catalog).
+ </p>
+</div>
+
+
+<a name="N10039"></a><a name="tools"></a>
+<h2 class="underlined_10">Configuring specific tools</h2>
+<div class="section">
+<a name="N1003F"></a><a name="system"></a>
+<h3 class="underlined_5">Operating system catalog</h3>
+<p>
+ Some operating systems already provide a system-wide catalog that
+ is used by many tools. This is usually located at
+ <span class="codefrag">/etc/xml/catalog</span> or at
+ <span class="codefrag">/usr/share/sgml/catalog</span> files.
+ </p>
+<p>
+ For an XML Catalog, add this line:
+ </p>
+<pre class="code">
+<nextCatalog
+catalog="/usr/local/svn/forrest/src/core/context/resources/schema/catalog.xcat"/>
+ </pre>
+<p>
+ For a TR 9401 Catalog, add this line:
+ </p>
+<pre class="code">
+CATALOG \
+"/usr/local/svn/forrest/src/core/context/resources/schema/catalog"
+ </pre>
+<p>
+ Actually you probably do not want to touch that system catalog,
+ so rather create your own catalog file in your home directory
+ which refers to both the Forrest catalog and your system catalog.
+ </p>
+<a name="N10060"></a><a name="xmllint"></a>
+<h3 class="underlined_5">xmllint validating parser</h3>
+<p>
+ "xmllint" is part of the "libxml2" package.
+ It is very fast and powerful, with are many facilities. It can
+ validate whole directories of files at once.
+ Set the SGML_CATALOG_FILES environment variable.
+ </p>
+<pre class="code">
+export SGML_CATALOG_FILES=$SGML_CATALOG_FILES:\
+$FORREST/src/core/context/resources/schema/catalog
+xmllint --valid --catalogs --noout mydoc.xml
+ </pre>
+<a name="N1006E"></a><a name="vim"></a>
+<h3 class="underlined_5">Vim</h3>
+<p>
+ The following .vimrc entries are useful:
+ </p>
+<pre class="code">
+au FileType xml set efm=%A%f:%l:\ %.%#error:\ %m,%-Z%p^,%-C%.%#
+au FileType xml set makeprg=xmllint\ --noout\ --valid\ --catalogs\ %
+ </pre>
+<a name="N1007C"></a><a name="emacs"></a>
+<h3 class="underlined_5">Emacs</h3>
+<p>See
+ <a class="external" href="http://www.thaiopensource.com/nxml-mode/">nXML mode</a>
+ and
+ <a class="external" href="http://www.dpawson.co.uk/relaxng/nxml/">FAQ</a>.
+ </p>
+<a name="N1008E"></a><a name="onsgmls"></a>
+<h3 class="underlined_5">onsgmls validating parser</h3>
+<p>
+ "onsgmls" is part of the "Open SP" package.
+ You need to also tell it where to find an "SGML declaration".
+ The easiest way is to create your own little "my-catalog" file,
+ containing this:
+ </p>
+<pre class="code">
+SGMLDECL "/usr/share/sgml/xml.dcl"
+CATALOG \
+"/usr/local/svn/forrest/src/core/context/resources/schema/catalog"
+ </pre>
+<p>
+ Then point the parser at it:
+ </p>
+<pre class="code">
+onsgmls -c path/to/my-catalog -wall -wxml -s mydoc.xml
+ </pre>
+<a name="N100A3"></a><a name="jedit"></a>
+<h3 class="underlined_5">jEdit - Open Source programmer's text editor</h3>
+<pre class="code">
+Select the menu:
+Utilities > Global Options > Plugins:XML > Catalogs
+Select the "+" button, and use the "File System Browser"
+to specify the TR9401 Catalog file:
+"forrest/src/core/context/resources/schema/catalog"
+ </pre>
+<a name="N100AE"></a><a name="oxygenxml"></a>
+<h3 class="underlined_5">oXygen XML Editor</h3>
+<pre class="code">
+Select the menu:
+External Tools > Preferences > XML Catalog
+Specify the XML Catalog file:
+"forrest/src/core/context/resources/schema/catalog.xcat"
+ </pre>
+<a name="N100B9"></a><a name="xmlspy"></a>
+<h3 class="underlined_5">xmlspy</h3>
+<pre class="code">
+Add the following entry to the file CustomCatalog.xml
+(located in XMLSpy install directory):
+
+<nextCatalog
+catalog="file://localhost/C:/apache/forrest/src/core/
+context/resources/schema/catalog.xcat"/>
+ </pre>
+<a name="N100C4"></a><a name="xxe"></a>
+<h3 class="underlined_5">XMLmind XML Editor (XXE)</h3>
+<a name="N100CA"></a><a name="XXE+v2.5p2+or+older"></a>
+<h4>XXE v2.5p2 or older</h4>
+<pre class="code">
+Select the menu:
+Options > Options > Schema > Add File
+Specify the XML Catalog file:
+"forrest/src/core/context/resources/schema/catalog.xcat"
+ </pre>
+<a name="N100D5"></a><a name="XXE+v2.5p3%2B"></a>
+<h4>XXE v2.5p3+</h4>
+<p>XXE supports catalogs by automatic detection via configuration files.
+ Download the <a class="external" href="http://www.splike.com/howtos/xxe_forrest.html">XXE
+ Forrest Config</a> files from splike.com; this also add support for WYSIWYG
+ editing of forrest documents.
+ Note: This configuration suite has recently been added to the
+ Forrest scratchpad.
+ </p>
+</div>
+
+
+<a name="N100E5"></a><a name="info"></a>
+<h2 class="underlined_10">Further information and resources</h2>
+<div class="section">
+<p>
+ Forrest and Cocoon use the
+ <a class="external" href="http://xml.apache.org/commons/components/resolver/">Catalog
+ Entity Resolver</a>
+ that is provided by the
+ <a class="external" href="http://xml.apache.org/commons/">Apache XML Commons</a>
+ project. The resolver is packaged with the Forrest distribution at
+ <span class="codefrag">lib/core/xml-commons-resolver-x.y.jar</span>
+
+</p>
+<p>
+ Other Forrest documentation has some notes about configuring the
+ entity resolver for your own DTDs. See
+ <a href="../docs/validation.html">XML Validation</a>.
+ </p>
+<p>
+ Cocoon has extensive documentation about the entity resolver. See
+ <a class="external" href="http://cocoon.apache.org/2.1/userdocs/concepts/catalog.html">Entity resolution with catalogs</a>.
+ </p>
+</div>
+
+</div>
+<!--+
+ |end content
+ +-->
+<div class="clearboth"> </div>
+</div>
+<div id="footer">
+<!--+
+ |start bottomstrip
+ +-->
+<div class="lastmodified">
+<script type="text/javascript"><!--
+document.write("Last Published: " + document.lastModified);
+// --></script>
+</div>
+<div class="copyright">
+ Copyright © 2002-2004 The Apache Software Foundation.</div>
+<!--+
+ |end bottomstrip
+ +-->
+</div>
+</body>
+</html>
Propchange: forrest/site/0.6/docs/catalog.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: forrest/site/0.6/docs/catalog.pdf
URL: http://svn.apache.org/viewcvs/forrest/site/0.6/docs/catalog.pdf?view=auto&rev=160902
==============================================================================
Binary file - no diff available.
Propchange: forrest/site/0.6/docs/catalog.pdf
------------------------------------------------------------------------------
svn:mime-type = application/pdf
Added: forrest/site/0.6/docs/compliance.html
URL: http://svn.apache.org/viewcvs/forrest/site/0.6/docs/compliance.html?view=auto&rev=160902
==============================================================================
--- forrest/site/0.6/docs/compliance.html (added)
+++ forrest/site/0.6/docs/compliance.html Mon Apr 11 08:11:56 2005
@@ -0,0 +1,403 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<meta content="Apache Forrest" name="Generator">
+<meta name="Forrest-version" content="0.7-dev">
+<meta name="Forrest-skin-name" content="pelt">
+<meta-data></meta-data>
+<title>Standards Compliance (v0.6)</title>
+<link type="text/css" href="../skin/basic.css" rel="stylesheet">
+<link media="screen" type="text/css" href="../skin/screen.css" rel="stylesheet">
+<link media="print" type="text/css" href="../skin/print.css" rel="stylesheet">
+<link type="text/css" href="../skin/profile.css" rel="stylesheet">
+<script src="../skin/getBlank.js" language="javascript" type="text/javascript"></script><script src="../skin/getMenu.js" language="javascript" type="text/javascript"></script><script src="../skin/fontsize.js" language="javascript" type="text/javascript"></script>
+<link rel="shortcut icon" href="../favicon.ico">
+</head>
+<body onload="init()">
+<script type="text/javascript">ndeSetTextSize();</script>
+<div id="top">
+<!--+
+ |breadtrail
+ +-->
+<div class="breadtrail">
+<a href="http://www.apache.org/">apache</a> > <a href="http://forrest.apache.org/">forrest</a><script src="../skin/breadcrumbs.js" language="JavaScript" type="text/javascript"></script>
+</div>
+<!--+
+ |header
+ +-->
+<div class="header">
+<!--+
+ |start group logo
+ +-->
+<div class="grouplogo">
+<a href="http://www.apache.org/"><img class="logoImage" alt="Apache" src="../images/apache-forrest.png" title="The Apache Software Foundation"></a>
+</div>
+<!--+
+ |end group logo
+ +-->
+<!--+
+ |start Project Logo
+ +-->
+<div class="projectlogo">
+<a href="http://forrest.apache.org/"><img class="logoImage" alt="Forrest" src="../images/project-logo.gif" title="Apache Forrest"></a>
+</div>
+<!--+
+ |end Project Logo
+ +-->
+<!--+
+ |start Search
+ +-->
+<div class="searchbox">
+<form action="http://www.google.com/search" method="get" class="roundtopsmall">
+<input value="forrest.apache.org" name="sitesearch" type="hidden"><input onFocus="getBlank (this, 'Search the site with google:');" value="Search the site with google:" size="25" name="q" id="query" type="text">
+ <input name="Search" value="Search" type="submit">
+</form>
+</div>
+<!--+
+ |end search
+ +-->
+<!--+
+ |start Tabs
+ +-->
+<ul id="tabs">
+<li>
+<a class="base-not-selected" href="../index.html">Welcome</a>
+</li>
+<li>
+<a class="base-not-selected" href="../contrib.html">Project</a>
+</li>
+<li class="current">
+<a class="base-selected" href="../docs/index.html">O.6 Docs</a>
+</li>
+<li>
+<a class="base-not-selected" href="../howto/index.html">0.6 How-To</a>
+</li>
+</ul>
+<!--+
+ |end Tabs
+ +-->
+</div>
+</div>
+<div id="main">
+<div id="publishedStrip">
+<!--+
+ |start Subtabs
+ +-->
+<div id="level2tabs">
+<a class="base-selected" href="../docs/your-project.html">Core</a> | <a class="base-selected" href="../docs/forrestbot.html">ForrestBot</a> | <a class="base-selected" href="../docs/forrestbar.html">ForrestBar</a>
+</div>
+<!--+
+ |end Endtabs
+ +-->
+<script type="text/javascript" language="JavaScript"><!--
+ document.write("Published: " + document.lastModified);
+ // --></script>
+</div>
+<!--+
+ |breadtrail
+ +-->
+<div class="breadtrail">
+
+
+ </div>
+<!--+
+ |start Menu, mainarea
+ +-->
+<!--+
+ |start Menu
+ +-->
+<div id="menu">
+<div onclick="SwitchMenu('menu_selected_1.1', '../skin/')" id="menu_selected_1.1Title" class="menutitle" style="background-image: url('../skin/images/chapter_open.gif');">Documentation</div>
+<div id="menu_selected_1.1" class="selectedmenuitemgroup" style="display: block;">
+<div class="menuitem">
+<a title="" href="../docs/index.html">Index</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/your-project.html">Using Forrest</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/validation.html">XML Validation</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/linking.html">Menus and Linking</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/searching.html">Searching</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/skins.html">Default Skins</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/skin-package.html">Skin Packages</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/forrest-contract.html">Our Contract</a>
+</div>
+<div class="menupage">
+<div class="menupagetitle">Standards Compliance</div>
+</div>
+<div onclick="SwitchMenu('menu_1.1.10', '../skin/')" id="menu_1.1.10Title" class="menutitle">Advanced Topics</div>
+<div id="menu_1.1.10" class="menuitemgroup">
+<div class="menuitem">
+<a title="" href="../docs/catalog.html">Using DTD Catalogs</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/sitemap-ref.html">Sitemap Reference</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/project-sitemap.html">Project sitemap</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/cap.html">Sourcetype Action</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.1.11', '../skin/')" id="menu_1.1.11Title" class="menutitle">Upgrading</div>
+<div id="menu_1.1.11" class="menuitemgroup">
+<div class="menuitem">
+<a title="" href="../docs/upgrading_06.html">Upgrading to 0.6</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/upgrading_05.html">Upgrading to 0.5</a>
+</div>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.2', '../skin/')" id="menu_1.2Title" class="menutitle">SubProjects</div>
+<div id="menu_1.2" class="menuitemgroup">
+<div class="menuitem">
+<a title="" href="../docs/forrestbar.html">ForrestBar</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/forrestbot.html">Forrestbot</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/forrestbot-web-interface.html">Forrestbot Webapp</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.3', '../skin/')" id="menu_1.3Title" class="menutitle">Reference docs</div>
+<div id="menu_1.3" class="menuitemgroup">
+<div onclick="SwitchMenu('menu_1.3.1', '../skin/')" id="menu_1.3.1Title" class="menutitle">DTD documentation</div>
+<div id="menu_1.3.1" class="menuitemgroup">
+<div class="menuitem">
+<a title="" href="../docs/dtd-docs.html">Overview</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/document-v20.dtdx.html">document-v20</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/howto-v20.dtdx.html">howto-v20</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/faq-v20.dtdx.html">faq-v20</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/document-v13.dtdx.html">document-v13</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/howto-v13.dtdx.html">howto-v13</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/faq-v13.dtdx.html">faq-v13</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.3.2', '../skin/')" id="menu_1.3.2Title" class="menutitle">Doc samples</div>
+<div id="menu_1.3.2" class="menuitemgroup">
+<div class="menuitem">
+<a title="" href="../docs/document-v13.html">document-v13</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/document-v20.html">document-v20</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/wiki-sample.html">JSPWiki Reference</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/oowriter.html">OpenOffice.Org Writer</a>
+</div>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.4', '../skin/')" id="menu_1.4Title" class="menutitle">Older Docs</div>
+<div id="menu_1.4" class="menuitemgroup">
+<div class="menuitem">
+<a title="" href="../docs/primer.html">Forrest Primer</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/libre-intro.html">Libre</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/dreams.html">Dream list</a>
+</div>
+</div>
+<div id="credit">
+<hr>
+ This is documentation for past release v0.6
+ (<a href="http://forrest.apache.org/docs.html">More</a> ...)</div>
+<div id="roundbottom">
+<img style="display: none" class="corner" height="15" width="15" alt="" src="../skin/images/rc-b-l-15-1body-2menu-3menu.png"></div>
+<!--+
+ |alternative credits
+ +-->
+</div>
+<!--+
+ |end Menu
+ +-->
+<!--+
+ |start content
+ +-->
+<div id="content">
+<div title="Portable Document Format" class="pdflink">
+<a class="dida" href="compliance.pdf"><img alt="PDF -icon" src="../skin/images/pdfdoc.gif" class="skin"><br>
+ PDF</a>
+</div>
+<div class="trail">
+ Font size:
+ <input value="Reset" class="resetfont" title="Reset text" onclick="ndeSetTextSize('reset'); return false;" type="button">
+ <input value="-a" class="smallerfont" title="Shrink text" onclick="ndeSetTextSize('decr'); return false;" type="button">
+ <input value="+a" class="biggerfont" title="Enlarge text" onclick="ndeSetTextSize('incr'); return false;" type="button">
+</div>
+<h1>Standards Compliance</h1>
+<div id="motd-area">
+ This is documentation for past release v0.6
+ (<a href="http://forrest.apache.org/docs.html">More</a> ...)</div>
+<div id="minitoc-area">
+<ul class="minitoc">
+<li>
+<a href="#Introduction">Introduction</a>
+</li>
+<li>
+<a href="#HTML">HTML</a>
+</li>
+<li>
+<a href="#WAI">WAI</a>
+</li>
+<li>
+<a href="#CSS">CSS</a>
+</li>
+</ul>
+</div>
+
+<a name="N1000D"></a><a name="Introduction"></a>
+<h2 class="underlined_10">Introduction</h2>
+<div class="section">
+<p>
+ Forrest is still quite young, so there are known issues.
+ Standards compliance is a definite major goal. Please send patches
+ for the Forrest skin stylesheets to ensure such compliance.
+ </p>
+</div>
+
+
+<a name="N10019"></a><a name="HTML"></a>
+<h2 class="underlined_10">HTML</h2>
+<div class="section">
+<p>
+ Tested using the W3C HTML Validation Service
+ (<a class="external" href="http://validator.w3.org/">validator.w3.org</a>). The
+ index.html page of Forrest sites will have a link to this validator,
+ unless the user has turned this off.
+ </p>
+<p>
+ The "<span class="codefrag">crust</span>" skin (current forrest-0.6-dev)
+ validates as HTML 4.0.1
+ </p>
+<p>
+ The "<span class="codefrag">tigris</span>" skin (current forrest-0.6-dev)
+ validates as HTML 4.0.1
+ </p>
+</div>
+
+
+<a name="N10033"></a><a name="WAI"></a>
+<h2 class="underlined_10">WAI</h2>
+<div class="section">
+<p>See
+<a class="external" href="http://www.w3.org/WAI/">Web Accessibility Initiative (WAI)</a>
+
+</p>
+<p>
+ There are actually many accessibility issues with the heavy use of
+ tables and images. These skins are gradually being improved.
+</p>
+<p>
+Bobby with WAI:
+<a class="external" href="http://bobby.watchfire.com/">bobby.watchfire.com</a>
+
+</p>
+<p>Issues ...</p>
+<ol>
+
+<li>
+ Priority 1: alt text for images.
+ </li>
+
+<li>Priority 2:
+ <a class="external" href="http://bobby.watchfire.com/bobby/html/en/gls/g41.html">Explicitly
+ associate form controls and their labels with the LABEL element</a>.
+ Perhaps we could have a label hidden with CSS?</li>
+
+<li>FIXME: need to list other issues here, or attend to them.</li>
+
+</ol>
+<div class="frame note">
+<div class="label">Note</div>
+<div class="content">The forrest-site skin does not have any missing alts. Perhaps Bobby
+ does not like the trick with empty alt attributes. However, it only
+ complains about the two in the footer, and not about the other 40.</div>
+</div>
+<p>
+Bobby with U.S. Section 508 Guidelines:
+<a class="external" href="http://bobby.watchfire.com/">bobby.watchfire.com</a>
+
+</p>
+<p>Issues ...</p>
+<ol>
+
+<li>The same issues as above</li>
+
+</ol>
+</div>
+
+
+<a name="N10071"></a><a name="CSS"></a>
+<h2 class="underlined_10">CSS</h2>
+<div class="section">
+<p>
+Jigsaw:
+<a class="external" href="http://jigsaw.w3.org/css-validator/">jigsaw.w3.org</a>
+
+</p>
+<p>Issues ...</p>
+<ol>
+
+<li>CSS 2: No errors. Some warnings.</li>
+
+<li>CSS 1: Errors: hover class, @media-print. Some warnings.</li>
+
+<li>FIXME: need to list other issues here, or attend to them.</li>
+
+</ol>
+</div>
+
+</div>
+<!--+
+ |end content
+ +-->
+<div class="clearboth"> </div>
+</div>
+<div id="footer">
+<!--+
+ |start bottomstrip
+ +-->
+<div class="lastmodified">
+<script type="text/javascript"><!--
+document.write("Last Published: " + document.lastModified);
+// --></script>
+</div>
+<div class="copyright">
+ Copyright © 2002-2004 The Apache Software Foundation.</div>
+<!--+
+ |end bottomstrip
+ +-->
+</div>
+</body>
+</html>
Propchange: forrest/site/0.6/docs/compliance.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: forrest/site/0.6/docs/compliance.pdf
URL: http://svn.apache.org/viewcvs/forrest/site/0.6/docs/compliance.pdf?view=auto&rev=160902
==============================================================================
Binary file - no diff available.
Propchange: forrest/site/0.6/docs/compliance.pdf
------------------------------------------------------------------------------
svn:mime-type = application/pdf