From: William Victor Mote Date: Mon, 7 Apr 2003 04:09:46 +0000 (+0000) Subject: Move contents of "involved" to the developers' introduction page. X-Git-Tag: Root_Temp_KnuthStylePageBreaking~1655 X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=373cda732db51d963463632a3774420ba07ab1ac;p=xmlgraphics-fop.git Move contents of "involved" to the developers' introduction page. git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@196221 13f79535-47bb-0310-9956-ffa450edef68 --- diff --git a/src/documentation/content/xdocs/book.xml b/src/documentation/content/xdocs/book.xml index a72ced6e8..f86e16ad0 100644 --- a/src/documentation/content/xdocs/book.xml +++ b/src/documentation/content/xdocs/book.xml @@ -43,7 +43,6 @@ - diff --git a/src/documentation/content/xdocs/dev/index.xml b/src/documentation/content/xdocs/dev/index.xml index 12c49252e..9ccf56420 100644 --- a/src/documentation/content/xdocs/dev/index.xml +++ b/src/documentation/content/xdocs/dev/index.xml @@ -14,10 +14,72 @@ -

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.

-

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.

+

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.

+

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.

+ +
+ Getting Involved +

There are many different ways that you can help with FOP development. +The development of FOP and the related plans and tasks are discussed on the dev mailing list. +Users can help or get issues resolved by contributing information and examples to the developers. +

+
+ Get familiar with the Fop related standards +

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 under Resources.

+
+
+ Fop's Design +

The design for FOP is specified under the Design section. This is where the information on how FOP is developed and designed +internally will be kept. +

+
+
+ Subscribe to the fop developers list +

You can subscribe to fop-dev@xml.apache.org by sending an email + to fop-dev-subscribe@xml.apache.org +

+

Sending bug reports and feature requests to the list is a welcome and important contribution to + developing Fop.

+

Read also the archive + of the discussion list fop-dev to get an idea of the issues being discussed.

+
+
+ Look at the developer's code using cvs +

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 http://xml.apache.org/cvs.html. + An introduction into cvs and the cvs manual can be found in the + reference library.

+

All changes to the code repository are sent to a special mailing list. After a cvs commit the diffs are automatically sent to this list. You can subscribe + to fop-cvs@xml.apache.org by sending an email to + fop-cvs-subscribe@xml.apache.org. If you want to contribute to the development of Fop you should subscribe, + because it is important that you follow changes being made.

+
+
+ Contributing code, tests and documentation +

If you want to contribute code (p.e. a bugfix), a test or documentation (p.e. an additional example), please do the following:

+

1) Make sure your code doesn't break the existing one and that Fop still compiles.

+

2) Create a file which shows the differences to the existing code.

+

3) Send this file as an Attachment to fop-dev@xml.apache.org. +

+

One of the committers will test your code and commit it to the code repository.

+

If you have a test or useful bug test you should read this page.

+

BTW: The Apache project knows different roles for contributors, namely 'users', 'developers', 'committers' and the 'Project + Management Committee' (An explanation of these roles can be found here).

+
+
+ Coding Conventions +

As mentioned in Apache XML Project Guidelines, + all Java Language source code in the repository must be written in conformance to the + Code Conventions + for the Java Programming Language as published by Sun. Additionally we agreed on 4 + spaces (no tabs) for indenting.

+

If you don't like those conventions, just use your own standards while developing and reformat the source before + committing with a tool like astyle (Artistic Style). +

+
diff --git a/src/documentation/content/xdocs/faq.xml b/src/documentation/content/xdocs/faq.xml index 08963d65f..59fa2f97a 100644 --- a/src/documentation/content/xdocs/faq.xml +++ b/src/documentation/content/xdocs/faq.xml @@ -114,8 +114,7 @@ How can I contribute?

- There is always plenty of things to do. See - getting involved. + There are numerous ways that you can help. They are outlined in the Developer's Introduction.

diff --git a/src/documentation/content/xdocs/involved.xml b/src/documentation/content/xdocs/involved.xml deleted file mode 100644 index af3d8fb90..000000000 --- a/src/documentation/content/xdocs/involved.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - -
- Getting Involved - How to Get Involved in FOP -
- - -
- Getting involved -

-There are many different levels where people can get involved. The -development of FOP and the related plans and tasks are discussed on -the dev mailing list. Users can help or get issues resolved by -contributing information and examples to the developers. -

- -
- Get familiar with the Fop related standards -

-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 under -Resources. -

-
-
- Fop's Design -

-The design for FOP is specified under the -Design section. -

-

-This is where the information on how FOP is developed and designed -internally will be kept. -

-
- -
- Subscribe to the fop developers list -

You can subscribe to fop-dev@xml.apache.org by sending an email - to fop-dev-subscribe@xml.apache.org

-

Sending bug reports and feature requests to the list is a welcome and important contribution to - developing Fop.

-

Read also the archive - of the discussion list fop-dev to get an idea of the issues being discussed.

-
-
- Look at the developer's code using cvs -

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 http://xml.apache.org/cvs.html. - An introduction into cvs and the cvs manual can be found in the - reference library.

-

All changes to the code repository are sent to a special mailing list. After a cvs commit the diffs are automatically sent to this list. You can subscribe - to fop-cvs@xml.apache.org by sending an email to - fop-cvs-subscribe@xml.apache.org. If you want to contribute to the development of Fop you should subscribe, - because it is important that you follow changes being made.

-
-
- Contributing code, tests and documentation -

If you want to contribute code (p.e. a bugfix), a test or documentation (p.e. an additional example), please do the following:

-

1) Make sure your code doesn't break the existing one and that Fop still compiles.

-

2) Create a file which shows the differences to the existing code.

-

3) Send this file as an Attachment to fop-dev@xml.apache.org.

-

One of the committers will test your code and commit it to the code repository.

-

If you have a test or useful bug test you should read this page.

-

BTW: The Apache project knows different roles for contributors, namely 'users', 'developers', 'committers' and the 'Project - Management Committee' (An explanation of these roles can be found here).

-
- -
- Coding Conventions -

As mentioned in Apache XML Project Guidelines, - all Java Language source code in the repository must be written in conformance to the - Code Conventions - for the Java Programming Language as published by Sun. Additionally we agreed on 4 - spaces (no tabs) for indenting.

-

If you don't like those conventions, just use your own standards while developing and reformat the source before - committing with a tool like astyle (Artistic Style). -

-
- -
- -
-