forrest-svn mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject svn commit: rev 76188 - in forrest/trunk/docs-author/content/xdocs/TR: . 2004
Date Wed, 17 Nov 2004 23:34:28 GMT
Author: nicolaken
Date: Wed Nov 17 15:34:23 2004
New Revision: 76188

   forrest/trunk/docs-author/content/xdocs/TR/2004/WD-forrest10.html   (contents, props changed)
Add initial file for the working document for Forrest 1.0 spec.

Not using a date in the end of the page, as since development is open, working documents are
always considered published and current. 

Added: forrest/trunk/docs-author/content/xdocs/TR/2004/WD-forrest10.html
--- (empty file)
+++ forrest/trunk/docs-author/content/xdocs/TR/2004/WD-forrest10.html	Wed Nov 17 15:34:23
@@ -0,0 +1,335 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+	<META HTTP-EQUIV="CONTENT-TYPE" CONTENT="text/html; charset=windows-1252">
+	<TITLE>Forrest 1.0</TITLE>
+	<META NAME="GENERATOR" CONTENT=" 1.1.2  (Win32)">
+	<META NAME="CREATED" CONTENT="20041116;13330320">
+	<META NAME="CHANGEDBY" CONTENT="Nicola Ken Barozzi">
+	<META NAME="CHANGED" CONTENT="20041116;18423737">
+	<!--
+		@page { size: 8.5in 11in }
+		TD P { color: #000000; font-family: sans-serif }
+		H1 { color: #005a9c; font-family: sans-serif; font-style: normal; font-weight: medium;
text-align: left }
+		P { color: #000000; font-family: sans-serif }
+		H2 { color: #005a9c; font-family: sans-serif; font-style: normal; font-weight: medium;
text-align: left }
+		H3 { color: #005a9c; font-family: sans-serif; font-style: normal; font-weight: medium;
text-align: left }
+		H4 { color: #000000; font-family: sans-serif; font-style: normal; text-align: left }
+		PRE { color: #000000; font-family: monospace }
+		DT { color: #000000; font-family: sans-serif; font-weight: bold }
+		DD { color: #000000; font-family: sans-serif }
+		BLOCKQUOTE { color: #000000; font-family: sans-serif }
+	-->
+	</STYLE>
+<BODY LANG="en-US" TEXT="#000000" BGCOLOR="#ffffff" DIR="LTR" STYLE="border: none; padding:
+<H1>Forrest 1.0</H1>
+<H2>Apache Forrest Project Working Draft <I>insert pubdate</I></H2>
+	<DT>This version: 
+	</DT><DD>
+	<A HREF=""></A></DD><DT>
+	Latest version: 
+	</DT><DD>
+	<A HREF=""></A></DD><DT>
+	Previous version: 
+	</DT><DD>
+	<A HREF="">none</A></DD><DT>
+	Authors: 
+	</DT><DD>
+	See <A HREF="#acknowledgements">acknowledgments</A></DD><DD STYLE="margin-bottom:
+	<BR><BR>
+	</DD></DL>
+Copyright &copy;2004 <A HREF="">The Apache
+Software Foundation</A>, All Rights Reserved.</P>
+<H2><A NAME="abstract"></A>Abstract</H2>
+<P>Forrest 1.0 is the first specification of Forrest (the product),
+intended to be the reference point for developers and users in the
+road to making a first stable Forrest release.</P>
+<H2><A NAME="status"></A>Status of this Document</H2>
+<P><EM>This section describes the status of this document at the time
+of its publication. Other documents may supersede this document.</EM></P>
+<P>This is the <A HREF="">First
+Public Working Draft</A> of the Forrest 1.0 specification. This
+document has been produced by the Apache Forrest Project developer
+community as part of the Apache Forrest Project. The authors of this
+document are the Apache Forrest Project participants.</P>
+<P>Publication as a Working Draft does not imply endorsement by the
+Apache Forrest Project Membership. This is a draft document and may
+be updated, replaced or obsoleted by other documents at any time. It
+is inappropriate to cite this document as other than work in
+<P>Comments on this document are welcome. Please send issues to the
+public mailing list (link to archive). It is
+appropriate to send discussion email to this address. Please note
+that comments that you make will be <STRONG>publicly</STRONG>
+archived and available, do not send information you would not want to
+see distributed, such as private data.</P>
+<H2><A NAME="intro"></A>1 Introduction</H2>
+<H3><A NAME="intro-reading"></A>1.1 Reading the Specification</H3>
+<P>The specification has been written with various modes of
+presentation in mind. In case of a discrepancy, the online electronic
+version is considered the authoritative version of the document.</P>
+<P>This document uses the terms <B>must</B>, <B>must not</B>,
+<B>required</B>, <B>shall</B>, <B>shall not</B>, <B>recommended</B>,
+<B>should</B>, <B>should not</B>, <B>may</B>, and <B>optional</B>
+accord with <A HREF="">[RFC
+<H3><A NAME="intro-org"></A>1.2 How the Specification is Organized</H3>
+<P>Chapters are arranged by topic.</P>
+<H3><A NAME="intro-conventions"></A>1.3 Documentation Conventions</H3>
+<P>Throughout this document, the following namespace prefixes and
+corresponding namespace identifiers are used:</P>
+<BLOCKQUOTE><B>xhtml2:</B> The XHTML 2.0 namespace<BR><B>my:</B>
+user defined namespace</BLOCKQUOTE>
+<P>This is only a convention; any namespace prefix may be used in
+<P>The following typographical conventions are used to present
+technical material in this document.</P>
+<P>Examples are set off typographically:</P>
+<P>Example: Example item</P>
+<PRE STYLE="margin-bottom: 0.2in">Example Item</PRE><P>
+References to external documents appear as follows: <A HREF="">[Sample
+Reference]</A> with links to the references section of this document.</P>
+	<DT><A NAME="ref-example"></A>Sample Reference 
+	</DT><DD STYLE="margin-bottom: 0.2in">
+	<CITE>Reference</CITE> - linked to from above. 
+	</DD></DL>
+The following typesetting convention is used for non-normative
+<P>A gentle explanation to readers.</P>
+		<TD WIDTH=50%>
+			<P ALIGN=LEFT><B>Editorial note: Editorial Note Name</B></P>
+		</TD>
+		<TD WIDTH=50%>
+			<P ALIGN=RIGHT>&nbsp;</P>
+		</TD>
+	</TR>
+	<TR>
+			<P ALIGN=LEFT>Editorial commentary, not intended for final
+			publication.</P>
+		</TD>
+	</TR>
+<P><A NAME="sample-implementation-issue"></A><B>Issue
+<P>A specific issue for which input from implementors is requested,
+for example as part of the Candidate Recommendation phase.</P>
+<P>None recorded.</P>
+<H2>Forrest Core</H2>
+	<COL WIDTH=366>
+	<COL WIDTH=363>
+		<TD WIDTH=366>
+			<P ALIGN=LEFT><B>Editorial note: TODOs</B></P>
+		</TD>
+		<TD WIDTH=363>
+			<P ALIGN=RIGHT>&nbsp;</P>
+		</TD>
+	</TR>
+	<TR>
+			<DL>
+				<DD>raw files 
+				</DD><DD>
+				project directory layout 
+				</DD><DD>
+				config file formats 
+				</DD><DD>
+				internationalization</DD></DL>
+		</TD>
+	</TR>
+<H3>Processing pipeline</H3>
+<P>This is the conceptual processing pipeline offered by Forrest.</P>
+<P>All references to actual source dirs and internal or external
+formats is generic and are specified elsewhere in this spec. 
+<H4>Step 1: Resolution (content)</H4>
+<P>Forrest has a single conceptual source space, that can initially
+be thought of as a single directory, the current xdocs dir. Every
+file that is outside of this directory has to be resolved by a
+locationmap, so that Forrest sees it all as a single directory in any
+<P>This source space contains files that a filename and an extension.
+There should be only one file with a certain name in a certain
+directory, which will be the main source of our transformation. 
+<P>For each URL that is requested, there shall be only one source
+file resolved, which will be our main source. 
+<H4>Step 2: Format Transformation (content) 
+<P>In the second step, Forrest transforms the main source to the
+intermediate format, which is XHTML2 (also automatic transforms from
+XHTML1 and HTML will be supported). Transformations from HTML and
+XHTML will be done in the core, while all others will be done by
+plugins (input plugins). 
+<P>Multiple formats can be asked for the same source: the filename
+asked will be in the following manner. 
+<PRE STYLE="margin-bottom: 0.2in">name.type.format</PRE><P>
+myfile.html </PRE><H4>
+Step 3: Filtering (content)</H4>
+<P>This is a new step, that adds navigation, metadata, extra content
+and transformations to the content stream.</P>
+<P>Navigation is the addition of the 'tab' and 'linkmap' information
+to the stream. 
+<P>Metadata about a page can be added, like the date, page size, etc.
+<P>Nuggets of information can be added based on the URL and on the
+contents of the main source. For example, newsfeeds about the page
+being processed.</P>
+<P>Filtering on the main content can be done, like the automatic
+creation of links based on the site.xml linkmap or footnote
+<P>These filtering steps are to be done by plugins (filtering
+<H4>Step 4: Skinning (presentation)</H4>
+<P>Based on the skin specified, the content is transformed in a
+format that contains presentation information. Example formats are
+html, fo (formatting objects) and svg.</P>
+<P>Note that this part adds functionality to the content. For
+example, a search item can be displayed, or widgets can be used.
+These are fbits, or functionality bits, and are different from
+nuggets, which are extra content. 
+<P>Note that fbits are skin dependant, so that a skin can decide to
+implement them or not. The configuration of these bits are to be done
+with the new generic skinconf format.</P>
+<P>Example of current fbits are the search pane, the project and
+group logos, the page format selector, etc.</P>
+<H4>Step 5: Theming (presentation)</H4>
+<P>Here the result of the skinning is given to theming, that adds
+colors and general appearance info. In html it's css files for
+example, or the skinconf color information.</P>
+<H4>Step 6: Serializing (presentation)</H4>
+<P>The presentation is transformed to the actual final format with
+output plugins. For example a fo presentation can be outputted as
+pdf, rtf, doc, ps, etc. 
+<H2><A NAME="dt"></A>A Schemas for Forrest 1.0 config files</H2>
+<P><EM>To be added.</EM></P>
+<H2><A NAME="references"></A>B References</H2>
+<H3><A NAME="references-norm"></A>B.1 Normative References</H3>
+	<DT><A NAME="ref-html4"></A><STRONG>[HTML]</STRONG> 
+	</DT><DD>
+	&quot;<CITE><A HREF="">HTML
+	4.01 Specification</A></CITE>&quot;, D. Raggett, A. Le&nbsp;Hors, I.
+	Jacobs, 24 December 1999.<BR><A HREF="">Latest
+	version</A> available at: 
+	</DD><DT>
+	<A NAME="ref-rfc2119"></A><STRONG>[RFC2119]</STRONG> 
+	</DT><DD>
+	&quot;<CITE><A HREF="">RFC2119:
+	Key words for use in RFCs to Indicate Requirement Levels</A></CITE>&quot;,
+	S. Bradner, March 1997.<BR>Available at:
+	</DD><DT>
+	<A NAME="ref-rfc2396"></A><STRONG>[RFC2396]</STRONG> 
+	</DT><DD>
+	&quot;<CITE><A HREF="">RFC2396:
+	Uniform Resource Identifiers (URI): Generic Syntax</A></CITE>&quot;,
+	T. Berners-Lee, R. Fielding, L. Masinter, August 1998.<BR>This
+	document updates RFC1738 and RFC1808.<BR>Available at:
+	</DD><DT>
+	<A NAME="ref-rfc2854"></A><STRONG>[RFC2854]</STRONG> 
+	</DT><DD>
+	&quot;<CITE><A HREF="">RFC2854:
+	The text/html Media Type</A></CITE>&quot;, D. Conolly, L. Masinter,
+	June 2000.<BR>Available at: 
+	</DD><DT>
+	<A NAME="ref-rfc3023"></A><STRONG>[RFC3023]</STRONG> 
+	</DT><DD>
+	&quot;<CITE><A HREF="">RFC3023:
+	XML Media Types</A></CITE>&quot;, M. Murata, S. St.Laurent, D. Kohn,
+	January 2001.<BR>This document obsoletes [<A HREF="">RFC2376</A>].<BR>Available
+	at: 
+	</DD><DT>
+	<A NAME="ref-rfc3066"></A><STRONG>[RFC3066]</STRONG> 
+	</DT><DD>
+	&quot;<A HREF="">Tags for the
+	Identification of Languages</A>&quot;, H. Alvestrand, January
+	2001.<BR>Available at: 
+	</DD><DT>
+	<A NAME="ref-rfc3236"></A><STRONG>[RFC3236]</STRONG> 
+	</DT><DD>
+	&quot;<A HREF="">The
+	'application/xhtml+xml' Media Type</A>&quot;, M. Baker, P. Stark,
+	January 2002.<BR>Available at: 
+	</DD><DT>
+	<A NAME="ref-xml"></A><STRONG>[XML]</STRONG> 
+	</DT><DD>
+	&quot;<A HREF="">Extensible
+	Markup Language (XML) 1.0 Specification (Second Edition)</A>&quot;,
+	T. Bray, J. Paoli, C. M. Sperberg-McQueen, E. Maler, 6 October
+	2000.<BR><A HREF="">Latest version</A>
+	available at: 
+	</DD><DT>
+	<A NAME="ref-xmlns"></A><STRONG>[XMLNS]</STRONG> 
+	</DT><DD>
+	&quot;<A HREF="">Namespaces
+	in XML</A>&quot;, T. Bray, D. Hollander, A. Layman, 14 January
+	1999.<BR>XML namespaces provide a simple method for qualifying names
+	used in XML documents by associating them with namespaces identified
+	by URI.<BR><A HREF="">Latest
+	version</A> available at: 
+	</DD><DT>
+	<A NAME="ref-xmlc14n"></A><STRONG>[XMLC14N]</STRONG> 
+	</DT><DD STYLE="margin-bottom: 0.2in">
+	&quot;<A HREF="">Canonical
+	XML Version 1.0</A>&quot;, J. Boyer, 15 March 2001.<BR>This document
+	describes a method for generating a physical representation, the
+	canonical form, of an XML document.<BR><A HREF="">Latest
+	version</A> available at: 
+	</DD></DL>
+<A NAME="references-inform"></A>B.2 Informative References</H3>
+	<DT><A NAME="ref-xhtml-mod"></A>XHTML Modularization 
+	</DT><DD>
+	<CITE><A HREF="">Modularization
+	of XHTML</A></CITE>, M. Altheim, et. al., 2001. W3C Recommendation
+	available at 
+	</DD><DT>
+	<A NAME="ref-xml-events"></A>XML Events 
+	</DT><DD STYLE="margin-bottom: 0.2in">
+	<CITE><A HREF="">XML Events - An
+	events syntax for XML</A></CITE>, Steven Pemberton, T. V. Raman,
+	Shane P. McCarron, 2003. W3C Recommendation available at:
+	</DD></DL>
+<A NAME="changes"></A>C Changes (Non-Normative)</H2>
+<P><EM>To be added.</EM></P>
+<H2><A NAME="acknowledgements"></A>D Acknowledgements (Non-Normative)</H2>
+<P>This document was produced with the participation of current
+Apache Forrest Project members and of all participants to the public
+<H2><A NAME="prodnotes"></A>E Production Notes (Non-Normative)</H2>
+<P><EM>To be added.</EM></P>
\ No newline at end of file

View raw message