mirrors
/
fop
mirror of https://github.com/apache/fop.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165
							<?xml version="1.0" encoding="UTF-8"?>
<!--
  Licensed to the Apache Software Foundation (ASF) under one or more
  contributor license agreements.  See the NOTICE file distributed with
  this work for additional information regarding copyright ownership.
  The ASF licenses this file to You under the Apache License, Version 2.0
  (the "License"); you may not use this file except in compliance with
  the License.  You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.
-->
<!-- $Id$ -->
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.3//EN" "http://forrest.apache.org/dtd/document-v13.dtd">
<document>
  <header>
    <title>Apache™ FOP Development: General Information</title>
    <version>$Revision$</version>
  </header>
  <body>
    <section id="intro">
      <title>Introduction</title>
      <p>These pages contain information that should be helpful for those developing Apache™ FOP.
This certainly includes programmers, but may also include those contributing to the project in other ways.</p>
      <p>For basic and user information on FOP, please visit the <link href="http://xml.apache.org/fop">Apache™ FOP homepage</link>.</p>
    </section>
    <section id="lines">
      <title>Development</title>
      <p>
        The main development happens on "FOP Trunk".
      </p>
      <note>
        The SVN repository URL for the trunk is:<br/>
        <code>http://svn.apache.org/repos/asf/xmlgraphics/fop/trunk/</code>
      </note>
    </section>
    <section id="involved">
      <title>Getting Involved</title>
      <section id="apache-roles">
        <title>Understand Apache Roles</title>
        <p>Review the <link href="http://xml.apache.org/roles.html">Apache Project Roles and Responsibilities</link> document for an understanding of the various roles of contributors within the community.</p>
      </section>
      <section id="fop-tasks">
        <title>How you can help</title>
        <p>There are many different ways that you can help with FOP development. The following is a non-exhaustive list of ways that <em>non-programmers</em> can help. Remember that an hour spent on the tasks below is an hour that a programmer can devote to fixing bugs or adding features instead:</p>
        <ul>
          <li>Answer questions on the fop-user mailing list.</li>
          <li>Contribute examples that are useful to other users.</li>
          <li>Contribute test cases.</li>
          <li>Submit well-written feature requests.</li>
          <li>Submit well-written bug reports.</li>
          <li>Review open issues to see if you have any insight into them that might help a programmer solve the problem faster. Add comments and test cases as appropriate.</li>
          <li>Test newly-closed issues to make sure they are truly closed.</li>
          <li>Submit patches to the documentation.</li>
        </ul>
        <p>Of course, we're glad to have programmers help as well. Here are some additional tasks that would require programming ability:</p>
        <ul>
          <li>Fixing bugs.</li>
          <li>Implementing new features.</li>
        </ul>
      </section>
      <section id="fop-standards">
        <title>Understand FOP-related standards</title>
        <p>At the moment FOP is mainly a tool to render XSL-FO files to pdf. Therefore if you want to contribute to FOP you should become familiar with these standards. You can find links at <link href="../resources.html#specs">Specifications</link>.</p>
      </section>
      <section id="doc">
        <title>Review the Developer Documentation</title>
      </section>
      <section id="design">
        <title>Understand FOP's Design</title>
        <p>The design for FOP is specified under the <link href="design/index.html">Design</link> section. This is where the information on how FOP is developed and designed
internally will be kept.
        </p>
        <p>
          Another place where we write design documentation is the <link href="http://wiki.apache.org/xmlgraphics-fop/DeveloperPages">FOP Wiki</link>.
        </p>
        <note>
          Our design documentation may not always be up to date!
        </note>
      </section>
      <section id="mail-fop-dev">
        <title>Subscribe to the fop-dev Mailing List</title>
        <p>Use this forum to discuss topics related to FOP development, including patch submissions, bug reports, and design issues. Please <em>do not</em> use it for XML support, XSLT support, XSL-FO support, or even FOP support.
Appropriate mailing lists for these topics can be found on the <link href="../maillist.html">FOP Mailing List</link> page.
        </p>
        <ul>
          <li>
To review the archives, you have several options:
            <ul>
              <li>The <link href="http://mail-archives.apache.org/mod_mbox/xmlgraphics-fop-dev/">Apache Mailing List archive (mod_mbox)</link>.</li>
              <li>The <link href="http://xmlgraphics.apache.org/mail/fop-dev/">Apache Mailing List archive (gzipped mbox files)</link>.</li>
              <li>The <link href="http://marc.theaimsgroup.com/?l=fop-dev&amp;r=1&amp;w=2">Mailing list ARChives</link> (MARC) at the AIMS group (search).</li>
              <li><link href="http://www.mail-archive.com/fop-dev%40xmlgraphics.apache.org/">The Mail Archive</link>.</li>
              <li>The <link href="http://dir.gmane.org/gmane.text.xml.fop.devel">GMANE</link> archive.</li>
              <li>The <link href="http://apache-fop.1065347.n5.nabble.com/">Nabble</link> archive.</li>
              <li>The <link href="http://fop-dev.markmail.org">MarkMail</link> archive.</li>
            </ul>
          </li>
          <li>Before posting questions to any list, see "<link href="../maillist.html#general">General Information</link>".</li>
          <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-dev-digest-subscribe@xmlgraphics.apache.org">fop-dev-digest-subscribe@xmlgraphics.apache.org</link>.
          </li>
          <li>
To subscribe fully: Send email to <link href="mailto:fop-dev-subscribe@xmlgraphics.apache.org">fop-dev-subscribe@xmlgraphics.apache.org</link>.
          </li>
          <li>
For standard help: Send email to <link href="mailto:fop-dev-help@xmlgraphics.apache.org">fop-dev-help@xmlgraphics.apache.org</link>.
          </li>
          <li>
To unsubscribe: Send email to <link href="mailto:fop-dev-unsubscribe@xmlgraphics.apache.org">fop-dev-unsubscribe@xmlgraphics.apache.org</link>.
          </li>
        </ul>
      </section>
      <section id="mail-fop-cvs">
        <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>
            To review the archives, you have several options:
            <ul>
              <li>The <link href="http://mail-archives.apache.org/mod_mbox/xmlgraphics-fop-commits/">Apache Mailing List archive (mod_mbox)</link>.</li>
              <li>The <link href="http://xmlgraphics.apache.org/mail/fop-commits/">Apache Mailing List archive (gzipped mbox files)</link>.</li>
              <li>The <link href="http://marc.theaimsgroup.com/?l=fop-cvs&amp;r=1&amp;w=2">Mailing list ARChives</link> (MARC) at the AIMS group (search).</li>
              <li><link href="http://www.mail-archive.com/fop-commits%40xmlgraphics.apache.org/">The Mail Archive</link>.</li>
              <li>The <link href="http://dir.gmane.org/gmane.text.xml.fop.cvs">GMANE</link> archive.</li>
              <li>The <link href="http://fop-commits.markmail.org">MarkMail</link> archive.</li>
            </ul>
          </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 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>
        <p>If you have useful changes to source code (bugfixes or enhancements), test files, or documentation that you would like to contribute to the project, please do the following:</p>
        <ul>
          <li>If your changes include source code, make sure that it does not break FOP (i.e. make sure that FOP still compiles with your changes).</li>
          <li>If your changes include test files, review the <link href="testing.html">Testing page</link>.</li>
          <li><link href="tools.html#patches">Create a patch file</link> for the differences to be applied to the existing code.</li>
          <li><link href="../bugs.html#issues_new">Create a new bugzilla issue</link> for the patch. Include the text "[PATCH]" at the beginning of the description. Attach the patch file to the issue.</li>
        </ul>
        <p>One of the committers will test your patch and consider its implications for the project. They will then either commit it to the repository or explain on the issue why they did not. Depending on the work load and skill-sets of the various committers, it may take some time before a a submitted patch is addressed.</p>
      </section>
    </section>
  </body>
</document>