You are viewing a plain text version of this content. The canonical link for it is here.
Posted to fop-commits@xmlgraphics.apache.org by je...@apache.org on 2005/06/24 11:32:22 UTC
svn commit: r201586 - in
/xmlgraphics/fop/trunk/src/documentation/content/xdocs: ./
design/alt.design/ design/alt.design/properties/ dev/
Author: jeremias
Date: Fri Jun 24 02:32:20 2005
New Revision: 201586
URL: http://svn.apache.org/viewcvs?rev=201586&view=rev
Log:
CVS -> SVN.
Recreated Clay's changes (hopefully all of them).
Removed alt.design stuff.
Removed:
xmlgraphics/fop/trunk/src/documentation/content/xdocs/design/alt.design/PropNames-png.xml
xmlgraphics/fop/trunk/src/documentation/content/xdocs/design/alt.design/alt-properties.xml
xmlgraphics/fop/trunk/src/documentation/content/xdocs/design/alt.design/compound-properties.xml
xmlgraphics/fop/trunk/src/documentation/content/xdocs/design/alt.design/coroutines.xml
xmlgraphics/fop/trunk/src/documentation/content/xdocs/design/alt.design/footnotes.xml
xmlgraphics/fop/trunk/src/documentation/content/xdocs/design/alt.design/galleys.xml
xmlgraphics/fop/trunk/src/documentation/content/xdocs/design/alt.design/index.xml
xmlgraphics/fop/trunk/src/documentation/content/xdocs/design/alt.design/keeps.xml
xmlgraphics/fop/trunk/src/documentation/content/xdocs/design/alt.design/properties/
xmlgraphics/fop/trunk/src/documentation/content/xdocs/design/alt.design/properties-classes.xml
xmlgraphics/fop/trunk/src/documentation/content/xdocs/design/alt.design/spaces.xml
xmlgraphics/fop/trunk/src/documentation/content/xdocs/design/alt.design/traits.xml
xmlgraphics/fop/trunk/src/documentation/content/xdocs/design/alt.design/user-agent-refs.xml
xmlgraphics/fop/trunk/src/documentation/content/xdocs/design/alt.design/xml-parsing.ehtml
Modified:
xmlgraphics/fop/trunk/src/documentation/content/xdocs/dev/api-doc.xml
xmlgraphics/fop/trunk/src/documentation/content/xdocs/dev/conventions.xml
xmlgraphics/fop/trunk/src/documentation/content/xdocs/dev/doc.xml
xmlgraphics/fop/trunk/src/documentation/content/xdocs/dev/index.xml
xmlgraphics/fop/trunk/src/documentation/content/xdocs/dev/testing.xml
xmlgraphics/fop/trunk/src/documentation/content/xdocs/dev/tools.xml
xmlgraphics/fop/trunk/src/documentation/content/xdocs/download.xml
xmlgraphics/fop/trunk/src/documentation/content/xdocs/gethelp.xml
xmlgraphics/fop/trunk/src/documentation/content/xdocs/maillist.xml
xmlgraphics/fop/trunk/src/documentation/content/xdocs/site.xml
xmlgraphics/fop/trunk/src/documentation/content/xdocs/team.xml
Modified: xmlgraphics/fop/trunk/src/documentation/content/xdocs/dev/api-doc.xml
URL: http://svn.apache.org/viewcvs/xmlgraphics/fop/trunk/src/documentation/content/xdocs/dev/api-doc.xml?rev=201586&r1=201585&r2=201586&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/documentation/content/xdocs/dev/api-doc.xml (original)
+++ xmlgraphics/fop/trunk/src/documentation/content/xdocs/dev/api-doc.xml Fri Jun 24 02:32:20 2005
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
- Copyright 1999-2004 The Apache Software Foundation
+ Copyright 1999-2005 The Apache Software Foundation
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@@ -15,8 +15,7 @@
limitations under the License.
-->
<!-- $Id$ -->
-<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN"
- "http://cvs.apache.org/viewcvs.cgi/*checkout*/xml-forrest/src/core/context/resources/schema/dtd/document-v12.dtd">
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.3//EN" "http://forrest.apache.org/dtd/document-v13.dtd">
<document>
<header>
<title>FOP Development: API Documentation (javadocs)</title>
@@ -27,12 +26,12 @@
<title>On-line Access (through Gump)</title>
<p>FOP (and many other Apache projects) use <link href="http://gump.apache.org/">Apache Gump</link> to do a test build several times each day. One of the useful byproducts of this process is that javadocs can be created and made available.</p>
<p>First, determine which line of development code you wish to see. If you don't know, you probably want the "Maintenance Branch", which is the line that currently produces FOP releases. See <link href="index.html#lines">Development Lines</link> for more details.</p>
- <warning>Javadocs for both development lines are made from current CVS code, and are not tied to any particular release. Both the documentation and the API may be different, even if you are working with the correct branch. Currently, the only way to obtain API documentation for a specific release is to <link href="#self-built">build it yourself</link>.</warning>
+ <warning>Javadocs for both development lines are made from current SVN code, and are not tied to any particular release. Both the documentation and the API may be different, even if you are working with the correct branch. Currently, the only way to obtain API documentation for a specific release is to <link href="#self-built">build it yourself</link>.</warning>
<ul>
<li><link href="http://gump.apache.org/javadoc/xml-fop-maintenance/build/javadocs/index.html">Javadocs for Maintenance Branch</link></li>
<li><link href="http://gump.apache.org/javadoc/xml-fop/build/javadocs/index.html">Javadocs for Trunk (Redesign)</link></li>
</ul>
- <note>If the links return an "Object not found!" message or otherwise do not work properly, it is probably because of a build error. Please raise a question on the <link href="../maillist.html#fop-user">fop-user mailing list</link> so that any problems can be fixed before the next build.</note>
+ <note>If the links return an "Object not found!" message or otherwise do not work properly, it is probably because of a build error. Please raise a question on the <link href="../maillist.html#fop-user">FOP User Mailing List</link> so that any problems can be fixed before the next build.</note>
</section>
<section id="self-built">
<title>Building them Yourself</title>
Modified: xmlgraphics/fop/trunk/src/documentation/content/xdocs/dev/conventions.xml
URL: http://svn.apache.org/viewcvs/xmlgraphics/fop/trunk/src/documentation/content/xdocs/dev/conventions.xml?rev=201586&r1=201585&r2=201586&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/documentation/content/xdocs/dev/conventions.xml (original)
+++ xmlgraphics/fop/trunk/src/documentation/content/xdocs/dev/conventions.xml Fri Jun 24 02:32:20 2005
@@ -15,8 +15,7 @@
limitations under the License.
-->
<!-- $Id$ -->
-<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN"
- "http://cvs.apache.org/viewcvs.cgi/*checkout*/xml-forrest/src/core/context/resources/schema/dtd/document-v12.dtd">
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.3//EN" "http://forrest.apache.org/dtd/document-v13.dtd">
<document>
<header>
<title>FOP Development: Coding Conventions</title>
@@ -24,12 +23,12 @@
</header>
<body>
<p>Acknowledgement: Some content in this guide was adapted from other Apache projects such as Avalon, Cactus, Turbine and Velocity.</p>
- <section id="cvs">
- <title>CVS Repository</title>
+ <section id="svn">
+ <title>Subversion Repository</title>
<p>Conventions in this section apply to Repository content, regardless of type:</p>
<ul>
<li>Files checked in must conform to the code conventions for that type of file (java files must conform to java requirements, xml to xml requirements, etc.). If a submitted patch does not conform, it is the responsibility of the committer to bring it into conformance before checking it in. Developers submitting patches are encouraged to follow the code conventions to reduce the work load on the the committers.</li>
- <li>To reduce the amount of spurious deltas, all text (non-binary) files checked into CVS must have Unix-style line endings (LF only). Many IDEs and editors (even on non-Unix platforms) have settings that can facilitate this convention.</li>
+ <li>To reduce the amount of spurious deltas, all text (non-binary) files checked into SVN must have Unix-style line endings (LF only). Many IDEs and editors (even on non-Unix platforms) have settings that can facilitate this convention.</li>
</ul>
</section>
<section id="java">
Modified: xmlgraphics/fop/trunk/src/documentation/content/xdocs/dev/doc.xml
URL: http://svn.apache.org/viewcvs/xmlgraphics/fop/trunk/src/documentation/content/xdocs/dev/doc.xml?rev=201586&r1=201585&r2=201586&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/documentation/content/xdocs/dev/doc.xml (original)
+++ xmlgraphics/fop/trunk/src/documentation/content/xdocs/dev/doc.xml Fri Jun 24 02:32:20 2005
@@ -1,6 +1,6 @@
<?xml version="1.0" standalone="no"?>
<!--
- Copyright 1999-2004 The Apache Software Foundation
+ Copyright 1999-2005 The Apache Software Foundation
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@@ -15,8 +15,7 @@
limitations under the License.
-->
<!-- $Id$ -->
-<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN"
- "http://cvs.apache.org/viewcvs.cgi/*checkout*/xml-forrest/src/core/context/resources/schema/dtd/document-v12.dtd">
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.3//EN" "http://forrest.apache.org/dtd/document-v13.dtd">
<document>
<header>
<title>FOP Development: Managing Documentation</title>
@@ -25,9 +24,9 @@
<body>
<section id="general">
<title>General Information</title>
- <p>All raw documentation content is managed in the FOP CVS repository.
+ <p>All raw documentation content is managed in the FOP SVN repository.
Updates should be committed to the repository, then the repository files are used to generate usable output.
-The remaining discussions on this page assume that the CVS repository is the starting place for processing.
+The remaining discussions on this page assume that the SVN repository is the starting place for processing.
The path to the documentation is xml-fop/src/documentation/content/xdocs.</p>
<note>All documentation is maintained on the trunk.
Although we are currently maintaining two sets of code (trunk and maintenance), there is only one set of documentation.
@@ -67,9 +66,9 @@
</tr>
<tr>
<td>Developer commits code to FOP repository.</td>
- <td>FOP repository (cvs) at cvs.apache.org/home/cvs/xml-fop</td>
+ <td>FOP repository (SVN)</td>
<td>Raw XML and other content</td>
- <td><link href="http://cvs.apache.org/viewcvs.cgi/xml-fop/src/documentation/content/xdocs/">ViewCVS</link></td>
+ <td><link href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/src/documentation/content/xdocs/">ViewCVS</link></td>
</tr>
<tr>
<td>Developer builds documentation and commits it to xml-site.</td>
Modified: xmlgraphics/fop/trunk/src/documentation/content/xdocs/dev/index.xml
URL: http://svn.apache.org/viewcvs/xmlgraphics/fop/trunk/src/documentation/content/xdocs/dev/index.xml?rev=201586&r1=201585&r2=201586&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/documentation/content/xdocs/dev/index.xml (original)
+++ xmlgraphics/fop/trunk/src/documentation/content/xdocs/dev/index.xml Fri Jun 24 02:32:20 2005
@@ -15,8 +15,7 @@
limitations under the License.
-->
<!-- $Id$ -->
-<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN"
- "http://cvs.apache.org/viewcvs.cgi/*checkout*/xml-forrest/src/core/context/resources/schema/dtd/document-v12.dtd">
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.3//EN" "http://forrest.apache.org/dtd/document-v13.dtd">
<document>
<header>
<title>FOP Development: General Information</title>
@@ -33,8 +32,27 @@
<title>Development</title>
<p>There are currently two branches of FOP :</p>
<ul>
- <li>The "maintenance branch" is the one that releases are currently generated from, and is also called the "maintenance branch". Because of limitations in its design, the FOP committers decided to freeze new development on this branch, and are providing only bug fixes. This branch is tagged as "fop-0_20_2-maintain" in the CVS repository. Please note that patches for enhancements to the maintenance branch will generally not be considered. Bug fixes are welcome there, but new developers are strongly encouraged to apply their efforts to the trunk development line.</li>
- <li>The main development line is the future of FOP. It is currently not as mature as the "maintenance" branch, but has far greater long-term prospects. It is also known as the "root" or "trunk" or "redesign".</li>
+ <li>
+ The "maintenance branch" is the one that the last release was generated
+ from. Because of limitations in its design, the FOP committers decided
+ to freeze new development on this branch, and are providing only bug fixes.
+ Please note that patches for enhancements to the maintenance branch will
+ generally not be considered. Bug fixes are welcome there, but new developers
+ are strongly encouraged to apply their efforts to the trunk development line.
+ <note>
+ The SVN repository URL for the maintenance branch is:<br/>
+ <code>http://svn.apache.org/repos/asf/xmlgraphics/fop/branches/fop-0_20_2-maintain/</code>
+ </note>
+ </li>
+ <li>
+ The main development line is the future of FOP. It is currently not as
+ mature as the "maintenance branch", but has far greater long-term prospects.
+ It is also known as the "root" or "trunk" or "redesign".
+ <note>
+ The SVN repository URL for the trunk is:<br/>
+ <code>http://svn.apache.org/repos/asf/xmlgraphics/fop/trunk/</code>
+ </note>
+ </li>
</ul>
<p>Because there is a fair amount of common information between the maintenance and trunk development lines, we attempt to document them together, highlighting differences only where needed.</p>
</section>
@@ -120,22 +138,24 @@
<note>The Eyebrowse archives are currently broken!</note>
</section>
<section id="mail-fop-cvs">
- <title>Subscribe to the fop-cvs Mailing List</title>
+ <title>Subscribe to the fop-commits Mailing List</title>
<p>When changes are committed to the code repository, a record of the diffs is emailed to the fop-cvs mailing list. FOP developers are encouraged to subscribe to this list because it helps in following the progress of the project.
</p>
<ul>
- <li>Review the archives at <link href="http://mail-archives.eu.apache.org/mod_mbox/xmlgraphics-fop-commits/">http://mail-archives.eu.apache.org/mod_mbox/xmlgraphics-fop-commits/</link> (mod_mbox).</li>
+ <li>Review the archives at <link href="http://mail-archives.apache.org/mod_mbox/xmlgraphics-fop-commits/">http://mail-archives.apache.org/mod_mbox/xmlgraphics-fop-commits/</link> (mod_mbox).</li>
<li>Review the archives at <link href="http://marc.theaimsgroup.com/?l=fop-cvs&r=1&w=2">Mailing list ARChives</link> (MARC) at the AIMS group (search).</li>
<li>Subscribe by sending an email to <link href="mailto:fop-commits-subscribe@xmlgraphics.apache.org">fop-commits-subscribe@xmlgraphics.apache.org</link>.</li>
</ul>
</section>
<section id="dev-code">
- <title>Download and Use the Developers' Code Using CVS</title>
- <p>Between releases the newest code can be accessed via cvs. To do this you need to install a cvs
- client on your computer, if it is not already there. An explanation how to connect to the
- FOP source repository can be found at <link href="http://xmlgraphics.apache.org/repo.html">http://xmlgraphics.apache.org/repo.html</link>.
- An introduction into cvs and the cvs manual can be found in the
- <link href="http://xml.apache.org/library.html">reference library</link>.</p>
+ <title>Download and Use the Developers' Code Using Subversion</title>
+ <p>
+ Between releases the newest code can be accessed via SVN. To do this
+ you need to install a SVN client on your computer, if it is not already
+ there. An explanation how to connect to the FOP source repository can
+ be found at <link href="http://xmlgraphics.apache.org/repo.html">http://xmlgraphics.apache.org/repo.html</link>.
+ More information can be found on the <link href="tools.html">Tools page</link>.
+ </p>
</section>
<section id="patches">
<title>Submitting Patches</title>
Modified: xmlgraphics/fop/trunk/src/documentation/content/xdocs/dev/testing.xml
URL: http://svn.apache.org/viewcvs/xmlgraphics/fop/trunk/src/documentation/content/xdocs/dev/testing.xml?rev=201586&r1=201585&r2=201586&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/documentation/content/xdocs/dev/testing.xml (original)
+++ xmlgraphics/fop/trunk/src/documentation/content/xdocs/dev/testing.xml Fri Jun 24 02:32:20 2005
@@ -1,6 +1,6 @@
<?xml version="1.0" standalone="no"?>
<!--
- Copyright 1999-2004 The Apache Software Foundation
+ Copyright 1999-2005 The Apache Software Foundation
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@@ -15,9 +15,7 @@
limitations under the License.
-->
<!-- $Id$ -->
-<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN"
- "http://cvs.apache.org/viewcvs.cgi/*checkout*/xml-forrest/src/core/context/resources/schema/dtd/document-v12.dtd">
-
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.3//EN" "http://forrest.apache.org/dtd/document-v13.dtd">
<document>
<header>
<title>FOP Development: Testing</title>
@@ -27,7 +25,7 @@
<body>
<section id="build">
<title>"Build" Testing</title>
- <p>Apache projects use an automated build tool called "gump" to create nightly builds from the CVS repository. Gump sends "nag" messages if the build fails. This can be considered a sort of basic test of the build process. To view the most recent logs of the gump builds:</p>
+ <p>Apache projects use an automated build tool called "gump" to create nightly builds from the SVN repository. Gump sends "nag" messages if the build fails. This can be considered a sort of basic test of the build process. To view the most recent logs of the gump builds:</p>
<ul>
<li><link href="http://gump.cocoondev.org/xml-fop.html">Gump build for the Trunk</link></li>
<li><link href="http://gump.cocoondev.org/xml-fop-maintenance.html">Gump build for the Maintenance Branch</link></li>
@@ -40,6 +38,15 @@
The build will then report error(s) if the high-level APIs for Driver and the Transcoders fail.
The tests do not check the output, but only ensure that something is generated and without exceptions.</p>
</section>
+ <section id="layoutengine">
+ <title>Layout Engine Testing</title>
+ <p>
+ The <link href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/test/layoutengine/"><code>test/layoutengine</code></link>
+ directory in the repository contains a test suite for checking the functionality of FOP's
+ layout engine. For information on how to create test cases for the layout engine, please
+ visit the <link href="http://wiki.apache.org/xmlgraphics-fop/HowToCreateLayoutEngineTests">Wiki page</link>.
+ </p>
+ </section>
<section id="functional">
<title>Functional Testing</title>
<warning>The "functional" testing section on this page is currently inoperative.</warning>
@@ -106,11 +113,12 @@
<section>
<title>How Testing Works</title>
<p>
-The tests are stored in the "<cvs_repository>/test" directory.
+The tests are stored in the "<svn_repository>/test" directory.
</p>
<p>
You can run the tests by specifying the build target "test" ie: <br/>
-<code>build.sh test</code>
+<code>ant.sh test</code> (Unix)<br/>
+<code>ant test</code> (Windows)<br/>
</p>
<p>
This will then compare the current code in the local src directory to a specified
@@ -134,7 +142,8 @@
<title>SVG Testing</title>
<p>
The testing of SVG is not part of this testing system. SVG is tested for its rendering
-accuracy by using the transcoding mechanism via Batik. So that the only part that needs
+accuracy by using the transcoding mechanism via
+<link href="ext:batik">Apache Batik</link>. So that the only part that needs
testing is how the SVG image is embedded inside the flow of the fo document.
</p>
</section>
Modified: xmlgraphics/fop/trunk/src/documentation/content/xdocs/dev/tools.xml
URL: http://svn.apache.org/viewcvs/xmlgraphics/fop/trunk/src/documentation/content/xdocs/dev/tools.xml?rev=201586&r1=201585&r2=201586&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/documentation/content/xdocs/dev/tools.xml (original)
+++ xmlgraphics/fop/trunk/src/documentation/content/xdocs/dev/tools.xml Fri Jun 24 02:32:20 2005
@@ -15,20 +15,29 @@
limitations under the License.
-->
<!-- $Id$ -->
-<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN"
- "http://cvs.apache.org/viewcvs.cgi/*checkout*/xml-forrest/src/core/context/resources/schema/dtd/document-v12.dtd">
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.3//EN" "http://forrest.apache.org/dtd/document-v13.dtd">
<document>
<header>
<title>FOP Development: Developer Tools</title>
<version>$Revision$</version>
</header>
<body>
- <p>This page documents items that may be helpful to other developers, especially to those who are new to FOP. Exhaustive treatment of these topics is better suited to other fora, but the information presented here is intended to deal with FOP-specific issues related to these tools, especially "gotchas", and to help developers get jump-started.</p>
+ <p>
+ This page documents items that may be helpful to other developers,
+ especially to those who are new to FOP. Exhaustive treatment of these
+ topics is better suited to other fora, but the information presented
+ here is intended to deal with FOP-specific issues related to these
+ tools, especially "gotchas", and to help developers get jump-started.
+ </p>
<section id="checklist">
<title>Developer Checklist</title>
- <p>Here is a (probably not comprehensive) list of tools you will need to be a successful FOP developer:</p>
+ <p>
+ Here is a (probably not comprehensive) list of tools you will need
+ to be a successful FOP developer:
+ </p>
<ul>
<li>A java IDE (see <link href="#ide">IDE</link>).</li>
+ <li>A Subversion client (see <link href="#svn">Subversion</link>).</li>
<li>Ant (see <link href="../compiling.html">Building FOP</link>).</li>
<li>checkstyle (see <link href="conventions.html#java-checkstyle">Checkstyle</link> on the conventions page).</li>
<li>JUnit (see <link href="testing.html#basic">Basic Testing</link>).</li>
@@ -36,74 +45,78 @@
</section>
<section id="general">
<title>General Developer Information</title>
- <p>See <link href="http://www.apache.org/dev/contributors.html">the Apache Contributors Tech Guide</link> for useful information and links for Apache developers, including help with tools and procedures.</p>
+ <p>
+ See <link href="http://www.apache.org/dev/contributors.html">the Apache Contributors Tech Guide</link>
+ for useful information and links for Apache developers, including help
+ with tools and procedures.
+ </p>
</section>
- <section id="cvs">
- <title>Concurrent Versions System (CVS)</title>
- <section id="cvs_general">
+ <section id="svn">
+ <title>Subversion (SVN)</title>
+ <section id="svn_general">
<title>General</title>
- <p>Visit <link href="http://xmlgraphics.apache.org/repo.html">Apache XML Graphics Code Repositories</link> for useful information.</p>
- <p>You will need a CVS client to be able to gain access to the FOP repository. For general CVS information, visit <link href="http://www.cvshome.org">CVS Home</link>. Nice GUI clients for Windows can be found at <link href="http://www.wincvs.org">WinCVS</link> and for Mac (68k, PPC) and Mac OS X from <link href="http://www.heilancoo.net/MacCVSClient/">MacCVSClient</link>.</p>
- <p>Regardless of what platform you develop on, please be sure to submit patches that use Unix line endings. If you are using WinCVS or MacCVSClient, check code out this way by going to the Admin / Preferences menu item, clicking on the "Globals" tab, then select the "Checkout text files with the Unix LF (0xa)" option. You will also need to use an editor that supports opening and saving files using Unix line endings.</p>
+ <p>
+ Visit <link href="http://xmlgraphics.apache.org/repo.html">Apache XML Graphics Code Repositories</link>
+ for useful information.
+ </p>
+ <p>
+ You will need a SVN client to be able to gain access to the FOP repository.
+ For general SVN information, visit
+ <link href="http://subversion.tigris.org">Subversion Home</link>.
+ A comprehensive list of clients for all operating systems and many IDEs
+ can be found at
+ <link href="http://subversion.tigris.org/project_links.html">the Subversion Links page</link>.
+ For Microsoft Windows we recommend <link href="http://tortoisesvn.tigris.org">TortoiseSVN</link>.
+ The command-line client that comes with Subversion is also very easy to use.
+ </p>
</section>
- <section id="wincvs_download">
- <title>Step-by-step instructions for downloading FOP using WinCVS</title>
+ <section id="svn_download">
+ <title>Step-by-step instruction for downloading FOP using the SVN command-line client</title>
+ <p>
+ On the command-line (Windows or Unix), simply run:
+ </p>
+ <source>
+svn co http://svn.apache.org/repos/asf/xmlgraphics/fop/trunk/ fop-trunk
+ </source>
+ <p>
+ This will download the FOP trunk into the directory "fop-trunk".
+ </p>
+ </section>
+ <section id="tortoisesvn_download">
+ <title>Step-by-step instructions for downloading FOP using TortoiseSVN (on Windows)</title>
<ul>
- <li>Select "Create / Checkout Module" menu item.</li>
- <li>âCheckout Settingsâ Tab:
- <ul>
- <li>âEnter the module name and path on the server:â<br/>
- <code>xml-fop</code>
- </li>
- <li>âLocal folder to checkout to:â<br/>Enter your local directory</li>
- </ul>
- </li>
- <li>âCheckout Optionsâ Tab:
- <ul>
- <li>If you are checking out the trunk, unset all options.</li>
- <li>If you are checking out the maintenance branch (currently distributed code), check âBy revision/tag/branch:â and enter <code>fop-0_20_2-maintain</code>.</li>
- </ul>
- </li>
- <li>âGeneralâ Tab:
- <ul>
- <li>âEnter the CVSROOT:â<br/>
- <code>:pserver:anoncvs@cvs.apache.org:/home/cvspublic</code>
- </li>
- <li>âAuthentication:â<br/>
- <code>âpasswdâ file on the cvs server</code>
- </li>
- </ul>
- </li>
- <li>âGlobalsâ Tab:
- <ul>
- <li>check âCheckout text files with the Unix LF (Oxa)â</li>
- </ul>
- </li>
+ <li>Create a new, empty directory in a place of your choice.</li>
+ <li>Right-click the new directory and select "SVN Checkout..." from the context menu.</li>
+ <li>Enter <code>http://svn.apache.org/repos/asf/xmlgraphics/fop/trunk/</code> as the URL of the repository.</li>
<li>Click "OK" and the download should begin.</li>
</ul>
</section>
- <section id="cvs_patch">
+ <section id="patches">
<title>Creating Patches</title>
<ul>
<li>
- <code>cd</code> to a directory that contains all of the changes that you wish to include in the patch. To comprehend the entire distribution, <code>cd</code> to the directory above the "xml-fop" directory that was created when you checked out the code.</li>
- <li>Run: <code>cvs -q diff -wu <list of items to diff></code>
- <br/>The <list of items to diff> is a space-separated list of files and directories relative to the current directory that you wish to include in the diff. For example, to include the entire distribution, assuming that you are in the directory, above xml-fop, simply enter "xml-fop". This will recursively go through the directories beneath xml-fop to diff each file.</li>
- <li>If you are running WinCVS, select "Admin/Command Line" for a console in which to key the above command.</li>
- <li>On a Linux/Unix machine, you will want to redirect the output from the above command into a file. If you are using GNU WinCVS, you can cut the output from the console window and paste it into a file. The "-w" ignores whitespace differences. The "-u" puts the diff in "universal" format. You may wish to use the "-N" option as well, which is supposed to treat new files as if there were an old 0 byte file -- in other words, it is supposed to include the new file in the patch. However, it only operates on files that have been "add"ed to the CVS repository, which cannot be done without commit access.</li>
+ <code>cd</code> to a directory that contains all of the changes
+ that you wish to include in the patch. To comprehend the entire
+ distribution, <code>cd</code> to the top directory where you
+ checked out the sources.
+ </li>
+ <li>
+ Run: <code>svn up</code> to make sure the diff is created against the latest sources.
+ </li>
+ <li>
+ Run: <code>svn diff >mypatch.diff</code>
+ <br/>This will write the patch to the file "mypatch.diff".
+ </li>
+ <li>If you are running TortoiseSVN, you can select "Create Patch..." in the TortoiseSVN context menu.</li>
</ul>
</section>
- <section id="cvs-doc">
+ <section id="svn-doc">
<title>Documentation</title>
<ul>
- <li>[online resource] <jump href="http://www.cvshome.org">The CVS Home Page</jump>.</li>
- <li>[electronic manual] <jump href="http://www.cvshome.org/docs/manual">"The Cederqvist"</jump> (official CVS manual).
-Note that this manual applies to the command-line version of CVS.</li>
- <li>[book] <jump href="http://www.oreilly.com/catalog/cvs">Essential CVS</jump>, by Jennifer Vesperman (O'Reilly & Associates).</li>
- <li>[book] <jump href="http://www.oreilly.com/catalog/cvspr2">The CVS Pocket Reference</jump>, by Gregor N. Purdy (O'Reilly & Associates).</li>
- <li>[book] Open Source Development with CVS, by Moshe Bar and Karl Franz Fogel (Paraglyph Press, ISBN 1-932111-81-6).</li>
- <li>[book] <jump href="http://www.oreilly.com/catalog/rcs">Applying RCS and SCCS</jump>, by Dan Bolinger and Tan Bronson (O'Reilly & Associates).
-RCS is used by CVS for its file operations (CVS is kind of a wrapper around RCS).</li>
+ <li>[online resource] <jump href="http://subversion.tigris.org">The Subversion Home Page</jump>.</li>
+ <li>[electronic manual] <jump href="http://svnbook.red-bean.com">Version Control with Subversion</jump> (official Subversion manual).
+Note that this manual applies to the command-line version of SVN.</li>
+ <li>[online resource] <jump href="http://subversion.tigris.org/project_links.html">Comprehensive list of links to documentation and Subversion clients and plugins.</jump></li>
</ul>
</section>
</section>
Modified: xmlgraphics/fop/trunk/src/documentation/content/xdocs/download.xml
URL: http://svn.apache.org/viewcvs/xmlgraphics/fop/trunk/src/documentation/content/xdocs/download.xml?rev=201586&r1=201585&r2=201586&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/documentation/content/xdocs/download.xml (original)
+++ xmlgraphics/fop/trunk/src/documentation/content/xdocs/download.xml Fri Jun 24 02:32:20 2005
@@ -1,6 +1,6 @@
<?xml version="1.0" standalone="no"?>
<!--
- Copyright 1999-2004 The Apache Software Foundation
+ Copyright 1999-2005 The Apache Software Foundation
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@@ -15,45 +15,135 @@
limitations under the License.
-->
<!-- $Id$ -->
-<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN"
- "http://cvs.apache.org/viewcvs.cgi/*checkout*/xml-forrest/src/core/context/resources/schema/dtd/document-v12.dtd">
-
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.3//EN" "http://forrest.apache.org/dtd/document-v13.dtd">
<document>
<header>
- <title>FOP: Downloading A Distribution</title>
+ <title>Apache FOP: Downloading A Distribution</title>
<version>$Revision$</version>
</header>
<body>
- <section id="dist-type">
- <title>Binary or Source?</title>
- <p>Most FOP users will want to download the latest binary distribution, which is ready to run "out of the box."
-However, a source distribution will be preferable if you fall into one of the following categories:</p>
- <ul>
- <li>You wish to modify FOP.</li>
- <li>You wish to use a version more recent than the latest release. For example, if you have read on the user mailing list that a bug has been fixed or a feature added that you are eager to try, you might download a source distribution from the CVS repository so that you don't have to wait for the next release.</li>
- <li>You wish to build a local copy of the API documentation (javadocs).</li>
- </ul>
- </section>
- <section id="binary">
- <title>Binary Download</title>
- <p>Binary distributions include "-bin" in their names, and can be downloaded from a
- <link href="http://www.apache.org/dyn/closer.cgi/xml/fop">FOP Distribution mirror</link>.
- </p>
- </section>
- <section id="source">
- <title>Source Download</title>
- <p>You must first determine which of the two main development branches you wish to download, "maintenance" or "redesign".
-See <link href="dev/index.html">Development Introduction</link> for more details on the choices, and for the CVS tags to use when downloading the "maintenance" branch.</p>
- <p>There are three ways to obtain a source distribution. Please note that they are listed from least current to most current:</p>
- <ul>
- <li>Download a released version from a <link href="http://www.apache.org/dyn/closer.cgi/xml/fop">FOP Distribution mirror</link>. Source distributions include "-src" in their names. Please note that official releases currently are <em>only</em> made from the "maintenance" branch.</li>
- <li>Download a CVS snapshot from the cvs files <link href="http://xml.apache.org/from-cvs/xml-fop/">here</link>. These snapshots are built approximately every six hours, and have the GMT of their creation time embedded in their names. Please note that CVS snapshots are made only for the "redesign" branch.</li>
- <li>Download directly from the CVS repository.
-Anyone can do this using the <link href="http://xml.apache.org/cvs.html#AnonCVS">Anonymous CVS Server</link>. By default, the CVS code is up-to-the-minute, the same code that the developers are modifying. See the <link href="dev/tools.html#cvs">CVS section of Developer Tools</link> for more information on using CVS.</li>
- </ul>
- <p>With any source distribution, you will need to <link href="compiling.html">Build FOP</link> from the source files.</p>
-</section>
- </body>
+ <section id="dist-type">
+ <title>Binary or Source?</title>
+ <p>
+ Most FOP users will want to download the latest binary distribution,
+ which is ready to run "out of the box." However, a source distribution
+ will be preferable if you fall into one of the following categories:
+ </p>
+ <ul>
+ <li>
+ You wish to modify FOP.
+ </li>
+ <li>
+ You wish to use a version more recent than the latest release. For
+ example, if you have read on the user mailing list that a bug has
+ been fixed or a feature added that you are eager to try, you might
+ download a source distribution from the CVS repository so that you
+ don't have to wait for the next release.
+ </li>
+ <li>
+ You wish to build a local copy of the API documentation (javadocs).
+ </li>
+ </ul>
+ </section>
+ <section id="binary">
+ <title>Binary Download</title>
+ <p>
+ Binary distributions include "-bin" in their names, and can be downloaded from a
+ <link href="http://www.apache.org/dyn/closer.cgi/xml/fop">FOP Distribution mirror</link>.
+ </p>
+ </section>
+ <section id="source">
+ <title>Source Download</title>
+ <p>
+ You must first determine which of the two main development branches you wish
+ to download, "maintenance" or "redesign". See
+ <link href="dev/index.html">Development Introduction</link> for more details
+ on the choices, and for the CVS tags to use when downloading the "maintenance"
+ branch.
+ </p>
+ <p>
+ There are several ways to obtain a source distribution. Please note that they
+ are listed from least current to most current:
+ </p>
+ <ul>
+ <li>
+ Download a released version from a
+ <link href="http://www.apache.org/dyn/closer.cgi/xml/fop">FOP Distribution mirror</link>.
+ Source distributions include "-src" in their names. Please note that official
+ releases currently are <em>only</em> made from the "maintenance" branch.
+ </li>
+ <!--li>
+ Download a CVS snapshot from the cvs files
+ <link href="http://xml.apache.org/from-cvs/xml-fop/">here</link>.
+ These snapshots are built approximately every six hours, and have the GMT of
+ their creation time embedded in their names. Please note that CVS snapshots
+ are made only for the "redesign" branch.
+ </li-->
+ <li>
+ Download directly from the SVN repository.
+ Anyone can do this using the
+ <link href="http://xmlgraphics.apache.org/repo.html">Anonymous SVN Server</link>.
+ By default, the code in SVN is up-to-the-minute, the same code that the developers
+ are modifying. See the <link href="dev/tools.html#svn">SVN section of Developer Tools</link>
+ for more information on using SVN.
+ </li>
+ </ul>
+ <p/>
+ <table>
+ <tr>
+ <th colspan="2">Maintenance Branch</th>
+ </tr>
+ <tr>
+ <td>Repository URL</td>
+ <td>
+ <link href="http://svn.apache.org/repos/asf/xmlgraphics/fop/branches/fop-0_20_2-maintain/">
+ <code>http://svn.apache.org/repos/asf/xmlgraphics/fop/branches/fop-0_20_2-maintain/</code>
+ </link>
+ </td>
+ </tr>
+ <tr>
+ <td>Web view</td>
+ <td>
+ <link href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/branches/fop-0_20_2-maintain/">
+ <code>http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/branches/fop-0_20_2-maintain/</code>
+ </link>
+ </td>
+ </tr>
+ <tr>
+ <th colspan="2">Trunk</th>
+ </tr>
+ <tr>
+ <td>Repository URL</td>
+ <td>
+ <link href="http://svn.apache.org/repos/asf/xmlgraphics/fop/trunk/">
+ <code>http://svn.apache.org/repos/asf/xmlgraphics/fop/trunk/</code>
+ </link>
+ </td>
+ </tr>
+ <tr>
+ <td>Web view</td>
+ <td>
+ <link href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/">
+ <code>http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/</code>
+ </link>
+ </td>
+ </tr>
+ </table>
+ <p>
+ With any source distribution, you will need to
+ <link href="compiling.html">Build FOP</link> from the source files.
+ </p>
+ <fixme author="jeremias">Reenable the link to the SVN snapshots once they are available.</fixme>
+ </section>
+ <section id="archives">
+ <title>Archive Download</title>
+ <p>
+ FOP Archive distributions are linked from the upper portion of the Apache FOP
+ Download Mirror Page and can be downloaded from the FOP Archives
+ <link href="http://archive.apache.org/dist/xml/fop/binaries/">binaries</link> &
+ <link href="http://archive.apache.org/dist/xml/fop/source/">source</link> links.
+ </p>
+ </section>
+ </body>
</document>
-
<!-- Last Line of $RCSfile$ -->
Modified: xmlgraphics/fop/trunk/src/documentation/content/xdocs/gethelp.xml
URL: http://svn.apache.org/viewcvs/xmlgraphics/fop/trunk/src/documentation/content/xdocs/gethelp.xml?rev=201586&r1=201585&r2=201586&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/documentation/content/xdocs/gethelp.xml (original)
+++ xmlgraphics/fop/trunk/src/documentation/content/xdocs/gethelp.xml Fri Jun 24 02:32:20 2005
@@ -1,6 +1,6 @@
<?xml version="1.0" standalone="no"?>
<!--
- Copyright 1999-2004 The Apache Software Foundation
+ Copyright 1999-2005 The Apache Software Foundation
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@@ -15,8 +15,7 @@
limitations under the License.
-->
<!-- $Id$ -->
-<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN"
- "http://cvs.apache.org/viewcvs.cgi/*checkout*/xml-forrest/src/core/context/resources/schema/dtd/document-v12.dtd">
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.3//EN" "http://forrest.apache.org/dtd/document-v13.dtd">
<document>
<header>
<title>FOP: Getting Help</title>
@@ -72,6 +71,7 @@
<section id="user-mailing-list">
<title>Submit Question to FOP User Mailing List</title>
<p>See <link href="maillist.html#fop-user">FOP User Mailing List</link> for details.</p>
+ <note label="Important">Please don't write to any developer directly. Only if you submit questions to the <link href="maillist.html#fop-user">FOP User Mailing List</link> will other FOP users be able to profit from answers given to your question. Another point is that a developer may have gone inactive or is on holidays in which case you may not get an answer in time.</note>
</section>
<section id="enter-issue">
<title>Enter an Issue Report</title>
Modified: xmlgraphics/fop/trunk/src/documentation/content/xdocs/maillist.xml
URL: http://svn.apache.org/viewcvs/xmlgraphics/fop/trunk/src/documentation/content/xdocs/maillist.xml?rev=201586&r1=201585&r2=201586&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/documentation/content/xdocs/maillist.xml (original)
+++ xmlgraphics/fop/trunk/src/documentation/content/xdocs/maillist.xml Fri Jun 24 02:32:20 2005
@@ -15,8 +15,7 @@
limitations under the License.
-->
<!-- $Id$ -->
-<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN"
- "http://cvs.apache.org/viewcvs.cgi/*checkout*/xml-forrest/src/core/context/resources/schema/dtd/document-v12.dtd">
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.3//EN" "http://forrest.apache.org/dtd/document-v13.dtd">
<document>
<header>
<title>FOP: Mailing List Resources</title>
@@ -44,7 +43,7 @@
<p>To review the archives, you have several options:</p>
<ul>
- <li>The <link href="http://mail-archives.eu.apache.org/mod_mbox/xmlgraphics-fop-users/">Apache Mailing List archive</link> (mod_mbox archive).</li>
+ <li>The <link href="http://mail-archives.apache.org/mod_mbox/xmlgraphics-fop-users/">Apache Mailing List archive</link> (mod_mbox archive).</li>
<li>The <link href="http://xmlgraphics.apache.org/mail/fop-users/">Apache Mailing List archive</link> (gzip files).</li>
<li>The <jump href="http://marc.theaimsgroup.com/?l=fop-user&r=1&w=2">Mailing list ARChives </jump> (MARC) at the AIMS group (search).</li>
<li>The <jump href="http://mail-archives.apache.org/eyebrowse/SummarizeList?listName=fop-user@xml.apache.org">Apache Eyebrowse</jump> archive (search, list by date, author, subject, or thread).</li>
@@ -55,7 +54,7 @@
<title>Subscription Information</title>
<ul>
<li>See <link href="http://xmlgraphics.apache.org/mail.html">Apache XML Graphics Mailing Lists</link> for detailed subscription information.</li>
- <li>To subscribe (digest only): Send email to <link href="mailto:fop-user-digest-subscribe@xmlgraphics.apache.org">fop-users-digest-subscribe@xmlgraphics.apache.org</link>.</li>
+ <li>To subscribe (digest only): Send email to <link href="mailto:fop-users-digest-subscribe@xmlgraphics.apache.org">fop-users-digest-subscribe@xmlgraphics.apache.org</link>.</li>
<li>To subscribe fully: Send email to <link href="mailto:fop-users-subscribe@xmlgraphics.apache.org">fop-users-subscribe@xmlgraphics.apache.org</link>.</li>
<li>For standard help: Send email to <link href="mailto:fop-users-help@xmlgraphics.apache.org">fop-users-help@xmlgraphics.apache.org</link>.</li>
<li>To unsubscribe: Send email to <link href="mailto:fop-users-unsubscribe@xmlgraphics.apache.org">fop-users-unsubscribe@xmlgraphics.apache.org</link>.</li>
Modified: xmlgraphics/fop/trunk/src/documentation/content/xdocs/site.xml
URL: http://svn.apache.org/viewcvs/xmlgraphics/fop/trunk/src/documentation/content/xdocs/site.xml?rev=201586&r1=201585&r2=201586&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/documentation/content/xdocs/site.xml (original)
+++ xmlgraphics/fop/trunk/src/documentation/content/xdocs/site.xml Fri Jun 24 02:32:20 2005
@@ -1,6 +1,6 @@
<?xml version="1.0"?>
<!--
- Copyright 2002-2004 The Apache Software Foundation
+ Copyright 2002-2005 The Apache Software Foundation
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@@ -19,7 +19,7 @@
<about label="About">
<index label="Introduction" href="index.html"/>
<license label="Release Notes" href="relnotes.html"/>
- <download label="Download" href="http://www.apache.org/dyn/closer.cgi/xml/fop/"/>
+ <download label="Download" href="download.html"/>
<help label="Getting Help" href="gethelp.html"/>
<faqs label="FAQs" href="faq.html"/>
<maillist label="Mailing Lists" href="maillist.html"/>
@@ -53,7 +53,7 @@
<xsl-fo label="XSL-FO" href="fo.html"/>
<examples label="Examples" href="examples.html"/>
<bugs label="Bugs" href="bugs.html"/>
- <wiki label="Wiki" href="http://wiki.apache.org/xmlgraphics-fop/FOPProjectPages"/>
+ <wiki label="Wiki" href="http://wiki.apache.org/xmlgraphics-fop/FrontPage"/>
<other label="Other" href="resources.html"/>
</resources>
@@ -97,7 +97,7 @@
<resources label="Resources">
<faq label="FAQs" href="faq.html"/>
<tools label="Tools" href="tools.html"/>
- <view-cvs label="ViewCVS" href="http://cvs.apache.org/viewcvs.cgi/xml-fop"/>
+ <viewcvs label="ViewCVS" href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop"/>
</resources>
<subpackages label="SubPackages">
@@ -150,6 +150,8 @@
<input-modules href="userdocs/concepts/modules.html"/>
<views href="userdocs/concepts/views.html"/>
</cocoon-->
+ <xmlgraphics.apache.org href="http://xmlgraphics.apache.org">
+ </xmlgraphics.apache.org>
<xml.apache.org href="http://xml.apache.org/">
<forrest href="forrest/"/>
<xindice href="xindice/"/>
Modified: xmlgraphics/fop/trunk/src/documentation/content/xdocs/team.xml
URL: http://svn.apache.org/viewcvs/xmlgraphics/fop/trunk/src/documentation/content/xdocs/team.xml?rev=201586&r1=201585&r2=201586&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/documentation/content/xdocs/team.xml (original)
+++ xmlgraphics/fop/trunk/src/documentation/content/xdocs/team.xml Fri Jun 24 02:32:20 2005
@@ -15,9 +15,7 @@
limitations under the License.
-->
<!-- $Id$ -->
-<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN"
- "http://cvs.apache.org/viewcvs.cgi/*checkout*/xml-forrest/src/core/context/resources/schema/dtd/document-v12.dtd">
-
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.3//EN" "http://forrest.apache.org/dtd/document-v13.dtd">
<document>
<header>
<title>FOP: Development Team</title>
@@ -30,6 +28,7 @@
<link href="mailto:fop-dev@xmlgraphics.apache.org">fop-dev</link> mailing list.</p>
<section id="commit-active">
<title>Active Committers</title>
+ <note label="Important">Please don't write to any developer directly if you need help on using FOP. Only if you submit questions to the <link href="maillist.html#fop-user">FOP User Mailing List</link> will other FOP users be able to profit from answers given to your question. Another point is that a developer may have gone inactive or is on holidays in which case you may not get an answer in time.</note>
<ul>
<li id="fb"><link href="mailto:bckfnn@worldonline.dk">Finn Bock</link> (FB)</li>
<li id="cb"><link href="mailto:bowditch_chris@hotmail.com">Chris Bowditch</link> (CB)
---------------------------------------------------------------------
To unsubscribe, e-mail: fop-commits-unsubscribe@xmlgraphics.apache.org
For additional commands, e-mail: fop-commits-help@xmlgraphics.apache.org