You are viewing a plain text version of this content. The canonical link for it is here.
Posted to server-dev@james.apache.org by da...@apache.org on 2002/07/29 18:04:45 UTC
cvs commit: jakarta-james/src/xdocs/stylesheets project.xml
danny 2002/07/29 09:04:45
Modified: src/xdocs FAQ.xml license.xml
src/xdocs/stylesheets project.xml
Added: src/xdocs contribute.xml
Log:
added "translation" link to japanese version hosted by Tetsuya Kitahata,
And a "how to" page for would be contributors.
Revision Changes Path
1.14 +216 -206 jakarta-james/src/xdocs/FAQ.xml
Index: FAQ.xml
===================================================================
RCS file: /home/cvs/jakarta-james/src/xdocs/FAQ.xml,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -r1.13 -r1.14
--- FAQ.xml 30 May 2002 11:21:03 -0000 1.13
+++ FAQ.xml 29 Jul 2002 16:04:45 -0000 1.14
@@ -1,206 +1,216 @@
-<?xml version="1.0"?>
-<document>
- <properties>
- <title>Frequently Asked Questions</title>
- <author email="danny@thought.co.uk">Danny Angus</author>
- </properties>
- <body>
- <section name="This FAQ">
- <P>This is a living document that provides answers to common questions about James, installation, configuration, admin and running not already answered in the documentation. Last Updated May 2002.</P>
- </section>
- <section name="Questions">
- <p>
- <ul>
- <li>
- <a href="#1">Would you please teach me how to set up a mailing list</a>
- </li>
- <li>
- <a href="#2">Is James an Open Relay for Spam?</a>
- </li>
- <li>
- <a href="#3">I can send messages to James, but nobody is receiving them. What do I do?</a>
- </li>
- <li>
- <a href="#4">I can send people messages via James, but nobody can send me messages. What do I do?</a>
- </li>
- <li>
- <a href="#5">I'm trying to debug messages that James is trying to deliver. Where should I look?</a>
- </li>
- <li>
- <a href="#6">What about IMAP support?</a>
- </li>
- <li>
- <a href="#7">What about support virtual hosting?</a>
- </li>
- <li>
- <a href="#8">Where do I stick classes and jars?</a>
- </li>
- <li>
- <a href="#9">How do I upgrade to a newer version of James?</a>
- </li>
- <li>
- <a href="#10">How do I run James as an NT/2k/XP service?</a>
- </li>
- <li>
- <a href="#11">Why isn't my mailet making changes to a MimeMessage?</a>
- </li>
- </ul>
- </p>
- </section>
- <section name="Answers">
- <a name="1"/>
- <subsection name="Would you please teach me how to set up a mailing list">
- <p>James currently (v2.0a2) includes only the most basic list functionality, users can subscribe and unsubscribe, but there is no moderation of messages or subscriptions</p>
- <p>To enable a list you need the following in config.xml in the root processor block and above the final mailet block -</p>
- <source>
-<mailet match="CommandForListserv=james@localhost"
- class="AvalonListservManager">
- <repositoryName>list-james</repositoryName>
-</mailet>
-</source>
- <p>that will intercept the command emails sent to
-<ul>
- <li>james-on@localhost to subscribe the sender</li>
- <li>james-off@localhost to unsubscribe the sender</li>
- </ul>
- </p>
- <p>and-</p>
- <source>
-<mailet match="RecipientIs=james@localhost" class="AvalonListserv">
- <membersonly> false </membersonly>
- <attachmentsallowed> true </attachmentsallowed>
- <replytolist> true </replytolist>
- <repositoryName>list-james</repositoryName>
- <subjectprefix>JamesList</subjectprefix>
-</mailet>
-</source>
- <p>Which will distribute the mail to the current subscribers</p>
- <p>in addition to the above you need to have a repository configured in the users-store block(usually near the bottom of config.xml) like so (database)-</p>
- <source>
-<repository name="list-james"
- class="org.apache.james.userrepository.ListUsersJdbcRepository"
- destinationURL="db://maildb/lists/list-james">
- <sqlFile>file://conf/sqlResources.xml</sqlFile>
-</repository>
-</source>
- <p>Database users will also need to ensure that they have configured a data-source named to match the destination URL</p>
- <p>Using the filesystem:-</p>
- <source>
-<repository name="list-james"
- class="org.apache.james.userrepository.UsersFileRepository">
- <destination URL="file://var/lists/list-james/"/>
-</repository>
-</source>
- <p>Restart James, send a mail to james-on@localhost and you should be subscribed.</p>
- <p>The repository, be it a database table or directory in the filesystem will be created automatically.</p>
- <p>Database users can manipulate the users repository using SQL, and hence any application capable of running SQL queries against it.<br/>Danny Angus</p>
- </subsection>
- <a name="2"/>
- <subsection name="James seems to be an open relay for Spam, is it?">
- <p>In some simple tests of mail relays James appears to be an open relay, properly configured it is not. </p>
- <p>Because James is an email application platform it currently accepts all mail delivered to it via SMTP for processing. Only after the mail has been recieved does this processing begin.</p>
- <p>This means that James accepts Spam. However the default configuration, and any sensible re-configuration has a number of anti-spam measures which will prevent the re-transmisson of spam from James. This makes it a blackhole for spam.</p>
- <p>This also means that James will not verify addresses, but of course this means that valid addresses can't be harvested from James by spammers either.<br/>Danny Angus</p>
- </subsection>
- <a name="3"/>
- <subsection name="I can send messages to James, but nobody is receiving them. What do I do?">
- <p>Check that you've added valid DNS servers to your James installation. Email delivery requires the use of special mail related DNS information (MX records), so James needs to explicitly be given DNS servers. Look at your config.xml file for a <dnsserver> section and add one or more DNS servers.<br/>Serge Knystautas</p>
- </subsection>
- <a name="4"/>
- <subsection name="I can send people messages via James, but nobody can send me messages. What do I do?">
- <p>You need to do one of two things:
- <ol>
- <li>Update your domain's DNS entries so there are MX records that point to the machine that is running James. Note that it is illegal for MX records to point to IP addresses. You need to point MX records to a valid CNAME or A name entry, and then map that eventually to an IP address.</li>
- <li>You could alternatively give people an email address with IP addresses. Most people will think it's a very strange email address, but hello@[192.168.0.1] is a valid email address. Note that you need to wrap the IP address in brackets.</li>
- </ol>
- Serge Knystautas</p>
- </subsection>
- <a name="5"/>
- <subsection name="I'm trying to debug messages that James is trying to deliver. Where should I look?">
- <p>First step is to look in the log directory at the James.Mailet.log file. Look for entries that include the text "RemoteDelivery". This should provide some high-level debug information of James's attempt to delivery mail remotely.</p>
- <p>If you want to delve into the code, look at the RemoteDelivery mailet. You may also want to review the mail repository source code for the repository type you are using (file, db, etc...).<br/>Serge Knystautas</p>
- </subsection>
- <a name="6"/>
- <subsection name="What about IMAP support?">
- <p>Unfortunately IMAP support is currently stalled. There is a proposal in CVS, but IMAP is a significantly more complex than other mail protocols, both from a protocol command support and in terms of complexity you need on the server. If you are interested in taking the proverbial ball and running with it, we would all very much appreciated. (I personally am incredibly frustrated with an old Netscape Mail server, but I've sworn myself to upgrade only to James's IMAP once ready as incentive.)
- <br/>Serge Knystautas</p>
- </subsection>
- <a name="7"/>
- <subsection name="What about support virtual hosting?">
- <p>Virtual hosting is something the developers are still wrestling with. The challenge is that POP3 does not support virtual hosting in that it does not have a command to indicate what domain the user is in. What this means is the mail server needs to develop a 'mapping' or 'translation', e.g., 'user1@domaina.com' gets a username 'domaina.user1'. This allows the mail server to have a single username namespace. We have seen a few good proposals put forward, but nothing that seemed the clear solution as ideally we could have this part solve the next issue.</p>
- <p>Beyond that, James needs to refine virtual hosting for mailet processing. The mailet API has a Mail.getUser() method that no longer would be useable as a reliable indicator of whether they were in the local username namespace. To date we are unclear of the best way to bring this translation into the mailet processing. Similarly, it would be nice to support different mailet processing based on the domain, although this is somewhat feasible using the limited processing flow offered with a HostIs/ForwardTo combination.</p>
- <p>This is one of the most requested feature, so hopefully this will be resolved soon.
- <br/>Serge Knystautas</p>
- </subsection>
- <a name="8"/>
- <subsection name="Where do I stick classes and jars?">
- <p>We are largely reliant on what Avalon is doing in terms of classloading, but here are a few tips and suggestions:
- <ul>
- <li>Stick jars in the james/lib directory and add them to the classpath in run.bat or run.sh.</li>
- <li>Custom mailets and matchers must be included in the james.bar (which is just a zip like a jar or war file).</li>
- </ul>
- Eventually we hope to support mailet reloading and a special lib and classes directory within the james directory that custom mailets can load from, but for now these are hopefully some useful tips.
- <br/>Serge Knystautas</p>
- </subsection>
- <a name="9"/>
- <subsection name="How do I upgrade to a newer version of James?">
- <p>
- <ol>
- <li>Rename the previous james directory into a james.old</li>
- <li>Run phoenix to let the new james.sar be deployed.</li>
- <li>Copy config.xml from james.old to the new deployed james/conf directory</li>
- <li>Replace the var directory by the previous var directory. This will copy over user accounts, inboxes, spools, and whatever else.</li>
- <li>Restart James.</li>
- </ol>
- Daniel Herlemont
- </p>
- </subsection>
- <a name="10"/>
- <subsection name="How do I run James as an NT/2k/XP service?">
- <p>You can use Alexandria will setup/run JAMES on NT/2k/XP</p>
- <p>I created a .bat file called InstallJamesNTService.bat containing the
-following (I used the Alexandria tomcat.bat file as my template, as you can
-see):</p>
- <source>
-
- @echo off
- echo --------
- echo Usage: %0 jdk_home james_home (classic/hotspot/server)
- echo NOTE: You MAY NOT use spaces in the path names.
- echo JDK 1.3 does not come with hotpot server by default, you must
- echo install this seperately if you wish to use it.
- echo Example: %0 c:\progra~1\jdk c:\progra~1\james classic
- echo --------
-
- if "%1" == "" goto eof
- if "%2" == "" goto eof
- if "%3" == "" goto eof
-
- copy JavaService.exe %2\bin\James.exe > nul
- %2\bin\James.exe -install JamesMailServer
- %1\jre\bin\%3\jvm.dll -Djava.ext.dirs=%2\lib -Djava.class.path=%CLASSPATH%;%2\bin\phoenix-loader.jar;%2\bin\phoenix-engine.jar -start org.apache.avalon.phoenix.launcher.Main -out %2\logs\stdout.log -err %2\logs\stderr.log
-
- goto eof
-
- :eof
- </source>
- <p>
- I created another .bat file called UnistallJamesNTService containing the following 1 line:
- </p>
- <source>
- James -uninstall JamesMailServer
- </source>
- <p>By copying the 2 above .bat files and the JavaService.exe (follow the download link at http://www.alexandriasc.com/software/JavaService/index.html) to the [james]\bin folder, I am able to install and uninstall the JamesMailServer NT service!
- <br/>Taken from http://www.mail-archive.com/james-user@jakarta.apache.org/msg01389.html by Steve Belt
- </p>
- </subsection>
- <a name="11"/>
- <subsection name="Why isn't my mailet making changes to a MimeMessage?">
- <p>Check the JavaMail docs... I don't think I would have designed it this way, but per the API, when you call MimeMessage.setContent(blah), you have to call saveChanges() to apply your changes. James tries to automatically call this method so you don't have to, but in certain cases you'll still have to call saveChanges().
- <br/>
- Serge Knystautas
- </p>
- </subsection>
- </section>
- </body>
-</document>
+<?xml version="1.0"?>
+<document>
+ <properties>
+ <title>Frequently Asked Questions</title>
+ <author email="danny@thought.co.uk">Danny Angus</author>
+ </properties>
+ <body>
+ <section name="This FAQ">
+ <P>This is a living document that provides answers to common questions about James, installation, configuration, admin and running not already answered in the documentation. Last Updated May 2002.</P>
+ </section>
+ <section name="Questions">
+ <p>
+ <ul>
+ <li>
+ <a href="#1">Would you please teach me how to set up a mailing list</a>
+ </li>
+ <li>
+ <a href="#2">Is James an Open Relay for Spam?</a>
+ </li>
+ <li>
+ <a href="#3">I can send messages to James, but nobody is receiving them. What do I do?</a>
+ </li>
+ <li>
+ <a href="#4">I can send people messages via James, but nobody can send me messages. What do I do?</a>
+ </li>
+ <li>
+ <a href="#5">I'm trying to debug messages that James is trying to deliver. Where should I look?</a>
+ </li>
+ <li>
+ <a href="#6">What about IMAP support?</a>
+ </li>
+ <li>
+ <a href="#7">What about support virtual hosting?</a>
+ </li>
+ <li>
+ <a href="#8">Where do I stick classes and jars?</a>
+ </li>
+ <li>
+ <a href="#9">How do I upgrade to a newer version of James?</a>
+ </li>
+ <li>
+ <a href="#10">How do I run James as an NT/2k/XP service?</a>
+ </li>
+ <li>
+ <a href="#11">Why isn't my mailet making changes to a MimeMessage?</a>
+ </li>
+ <li>
+ <a href="#12">How can I contribute to James?</a>
+ </li>
+ </ul>
+ </p>
+ </section>
+ <section name="Answers">
+ <a name="1"/>
+ <subsection name="Would you please teach me how to set up a mailing list">
+ <p>James currently (v2.0a2) includes only the most basic list functionality, users can subscribe and unsubscribe, but there is no moderation of messages or subscriptions</p>
+ <p>To enable a list you need the following in config.xml in the root processor block and above the final mailet block -</p>
+ <source>
+<mailet match="CommandForListserv=james@localhost"
+ class="AvalonListservManager">
+ <repositoryName>list-james</repositoryName>
+</mailet>
+</source>
+ <p>that will intercept the command emails sent to
+<ul>
+ <li>james-on@localhost to subscribe the sender</li>
+ <li>james-off@localhost to unsubscribe the sender</li>
+ </ul>
+ </p>
+ <p>and-</p>
+ <source>
+<mailet match="RecipientIs=james@localhost" class="AvalonListserv">
+ <membersonly> false </membersonly>
+ <attachmentsallowed> true </attachmentsallowed>
+ <replytolist> true </replytolist>
+ <repositoryName>list-james</repositoryName>
+ <subjectprefix>JamesList</subjectprefix>
+</mailet>
+</source>
+ <p>Which will distribute the mail to the current subscribers</p>
+ <p>in addition to the above you need to have a repository configured in the users-store block(usually near the bottom of config.xml) like so (database)-</p>
+ <source>
+<repository name="list-james"
+ class="org.apache.james.userrepository.ListUsersJdbcRepository"
+ destinationURL="db://maildb/lists/list-james">
+ <sqlFile>file://conf/sqlResources.xml</sqlFile>
+</repository>
+</source>
+ <p>Database users will also need to ensure that they have configured a data-source named to match the destination URL</p>
+ <p>Using the filesystem:-</p>
+ <source>
+<repository name="list-james"
+ class="org.apache.james.userrepository.UsersFileRepository">
+ <destination URL="file://var/lists/list-james/"/>
+</repository>
+</source>
+ <p>Restart James, send a mail to james-on@localhost and you should be subscribed.</p>
+ <p>The repository, be it a database table or directory in the filesystem will be created automatically.</p>
+ <p>Database users can manipulate the users repository using SQL, and hence any application capable of running SQL queries against it.<br/>Danny Angus</p>
+ </subsection>
+ <a name="2"/>
+ <subsection name="James seems to be an open relay for Spam, is it?">
+ <p>In some simple tests of mail relays James appears to be an open relay, properly configured it is not. </p>
+ <p>Because James is an email application platform it currently accepts all mail delivered to it via SMTP for processing. Only after the mail has been recieved does this processing begin.</p>
+ <p>This means that James accepts Spam. However the default configuration, and any sensible re-configuration has a number of anti-spam measures which will prevent the re-transmisson of spam from James. This makes it a blackhole for spam.</p>
+ <p>This also means that James will not verify addresses, but of course this means that valid addresses can't be harvested from James by spammers either.<br/>Danny Angus</p>
+ </subsection>
+ <a name="3"/>
+ <subsection name="I can send messages to James, but nobody is receiving them. What do I do?">
+ <p>Check that you've added valid DNS servers to your James installation. Email delivery requires the use of special mail related DNS information (MX records), so James needs to explicitly be given DNS servers. Look at your config.xml file for a <dnsserver> section and add one or more DNS servers.<br/>Serge Knystautas</p>
+ </subsection>
+ <a name="4"/>
+ <subsection name="I can send people messages via James, but nobody can send me messages. What do I do?">
+ <p>You need to do one of two things:
+ <ol>
+ <li>Update your domain's DNS entries so there are MX records that point to the machine that is running James. Note that it is illegal for MX records to point to IP addresses. You need to point MX records to a valid CNAME or A name entry, and then map that eventually to an IP address.</li>
+ <li>You could alternatively give people an email address with IP addresses. Most people will think it's a very strange email address, but hello@[192.168.0.1] is a valid email address. Note that you need to wrap the IP address in brackets.</li>
+ </ol>
+ Serge Knystautas</p>
+ </subsection>
+ <a name="5"/>
+ <subsection name="I'm trying to debug messages that James is trying to deliver. Where should I look?">
+ <p>First step is to look in the log directory at the James.Mailet.log file. Look for entries that include the text "RemoteDelivery". This should provide some high-level debug information of James's attempt to delivery mail remotely.</p>
+ <p>If you want to delve into the code, look at the RemoteDelivery mailet. You may also want to review the mail repository source code for the repository type you are using (file, db, etc...).<br/>Serge Knystautas</p>
+ </subsection>
+ <a name="6"/>
+ <subsection name="What about IMAP support?">
+ <p>Unfortunately IMAP support is currently stalled. There is a proposal in CVS, but IMAP is a significantly more complex than other mail protocols, both from a protocol command support and in terms of complexity you need on the server. If you are interested in taking the proverbial ball and running with it, we would all very much appreciated. (I personally am incredibly frustrated with an old Netscape Mail server, but I've sworn myself to upgrade only to James's IMAP once ready as incentive.)
+ <br/>Serge Knystautas</p>
+ </subsection>
+ <a name="7"/>
+ <subsection name="What about support virtual hosting?">
+ <p>Virtual hosting is something the developers are still wrestling with. The challenge is that POP3 does not support virtual hosting in that it does not have a command to indicate what domain the user is in. What this means is the mail server needs to develop a 'mapping' or 'translation', e.g., 'user1@domaina.com' gets a username 'domaina.user1'. This allows the mail server to have a single username namespace. We have seen a few good proposals put forward, but nothing that seemed the clear solution as ideally we could have this part solve the next issue.</p>
+ <p>Beyond that, James needs to refine virtual hosting for mailet processing. The mailet API has a Mail.getUser() method that no longer would be useable as a reliable indicator of whether they were in the local username namespace. To date we are unclear of the best way to bring this translation into the mailet processing. Similarly, it would be nice to support different mailet processing based on the domain, although this is somewhat feasible using the limited processing flow offered with a HostIs/ForwardTo combination.</p>
+ <p>This is one of the most requested feature, so hopefully this will be resolved soon.
+ <br/>Serge Knystautas</p>
+ </subsection>
+ <a name="8"/>
+ <subsection name="Where do I stick classes and jars?">
+ <p>We are largely reliant on what Avalon is doing in terms of classloading, but here are a few tips and suggestions:
+ <ul>
+ <li>Stick jars in the james/lib directory and add them to the classpath in run.bat or run.sh.</li>
+ <li>Custom mailets and matchers must be included in the james.bar (which is just a zip like a jar or war file).</li>
+ </ul>
+ Eventually we hope to support mailet reloading and a special lib and classes directory within the james directory that custom mailets can load from, but for now these are hopefully some useful tips.
+ <br/>Serge Knystautas</p>
+ </subsection>
+ <a name="9"/>
+ <subsection name="How do I upgrade to a newer version of James?">
+ <p>
+ <ol>
+ <li>Rename the previous james directory into a james.old</li>
+ <li>Run phoenix to let the new james.sar be deployed.</li>
+ <li>Copy config.xml from james.old to the new deployed james/conf directory</li>
+ <li>Replace the var directory by the previous var directory. This will copy over user accounts, inboxes, spools, and whatever else.</li>
+ <li>Restart James.</li>
+ </ol>
+ Daniel Herlemont
+ </p>
+ </subsection>
+ <a name="10"/>
+ <subsection name="How do I run James as an NT/2k/XP service?">
+ <p>You can use Alexandria will setup/run JAMES on NT/2k/XP</p>
+ <p>I created a .bat file called InstallJamesNTService.bat containing the
+following (I used the Alexandria tomcat.bat file as my template, as you can
+see):</p>
+ <source>
+
+ @echo off
+ echo --------
+ echo Usage: %0 jdk_home james_home (classic/hotspot/server)
+ echo NOTE: You MAY NOT use spaces in the path names.
+ echo JDK 1.3 does not come with hotpot server by default, you must
+ echo install this seperately if you wish to use it.
+ echo Example: %0 c:\progra~1\jdk c:\progra~1\james classic
+ echo --------
+
+ if "%1" == "" goto eof
+ if "%2" == "" goto eof
+ if "%3" == "" goto eof
+
+ copy JavaService.exe %2\bin\James.exe > nul
+ %2\bin\James.exe -install JamesMailServer
+ %1\jre\bin\%3\jvm.dll -Djava.ext.dirs=%2\lib -Djava.class.path=%CLASSPATH%;%2\bin\phoenix-loader.jar;%2\bin\phoenix-engine.jar -start org.apache.avalon.phoenix.launcher.Main -out %2\logs\stdout.log -err %2\logs\stderr.log
+
+ goto eof
+
+ :eof
+ </source>
+ <p>
+ I created another .bat file called UnistallJamesNTService containing the following 1 line:
+ </p>
+ <source>
+ James -uninstall JamesMailServer
+ </source>
+ <p>By copying the 2 above .bat files and the JavaService.exe (follow the download link at http://www.alexandriasc.com/software/JavaService/index.html) to the [james]\bin folder, I am able to install and uninstall the JamesMailServer NT service!
+ <br/>Taken from http://www.mail-archive.com/james-user@jakarta.apache.org/msg01389.html by Steve Belt
+ </p>
+ </subsection>
+ <a name="11"/>
+ <subsection name="Why isn't my mailet making changes to a MimeMessage?">
+ <p>Check the JavaMail docs... I don't think I would have designed it this way, but per the API, when you call MimeMessage.setContent(blah), you have to call saveChanges() to apply your changes. James tries to automatically call this method so you don't have to, but in certain cases you'll still have to call saveChanges().
+ <br/>
+ Serge Knystautas
+ </p>
+ </subsection>
+ <a name="12"/>
+ <subsection name="How can I contribute to James">
+ <p>Read the "Contributors How To" <a href="contribute.html">here</a>
+ <br/>
+ Danny Angus
+ </p>
+ </subsection>
+ </section>
+ </body>
+</document>
1.2 +6 -0 jakarta-james/src/xdocs/license.xml
Index: license.xml
===================================================================
RCS file: /home/cvs/jakarta-james/src/xdocs/license.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- license.xml 15 May 2001 16:47:22 -0000 1.1
+++ license.xml 29 Jul 2002 16:04:45 -0000 1.2
@@ -71,6 +71,12 @@
</section>
+<section name="mm.mysql drivers">
+<p>
+ mm.mysql JDBC drivers are distributed with James, a copy of the licence is contained in the distribution
+</p>
+</section>
+
</body>
</document>
1.1 jakarta-james/src/xdocs/contribute.xml
Index: contribute.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<title>Contributors How To</title>
<author email="danny@thought.co.uk">Danny Angus</author>
</properties>
<body>
<section name="Introduction">
<p>
<b>anyone can contribute></b><br/>
Thats right, we always want to hear from people with contributions to the code,
the documentation, the website and bug reports.<br/>
The rest of this document outlines the way to go about these to maximum effect.<br/>
</p>
<p>
If you are new to this you may be interested in some of these resources.<br/>
<a href="http://jakarta.apache.org/site/guides.html">A good, full, summary of links to guidelines</a><br/>
Subscribe to the relevant mailing lists (link on the left).<br/>
<a href="http://jakarta.apache.org/site/contributing.html">Craig R. McClanahan's advice how to get involved</a><br/>
<a href="http://jakarta.apache.org/site/guidelines.html">How Jakarta projects run</a><br/>
</p>
</section>
<section name="Code Patches">
<p>
Patches should be submitted to the developers mailing list.<br/>
<b>Always</b> use diff -u to generate patches, and make sure it conforms
to the code standards, otherwise it may be ignored.<br/>
Prefix the mail subject with [PATCH]<br/>
Briefly outline the reason for your patch,
the solution your patch implements, why a patch is
needed and why your code will solve the problem. Note any bug numbers your patch addresses.
</p>
<p>
The reason for these is so that the commiters can easily see what you are trying to achieve,
it is their resonsibility to manage the code and review submissions,
if you make it easy for them to see what you are doing your patch is more likely to
be commited quickly (or at all).<br/>
</p>
</section>
<section name="New code">
<p>
Like the principles for patch submission, mark your mail [PATCH] and ensure
your submission conforms to the code standards. Provide a Brief outline of
your intentions, as above, so that your code can be reviewed easily, and a
note of any relevant bug numbers.<br/>
New files must contain a refrence to the Apache licence, copy the header from an existing file.<br/>
</p>
</section>
<section name="Bug reporting and fixing">
<p>
Many improvements come as a direct result of bug
reports, and contributed fixes, often by the same person. It is sometimes said that Apache
projects evolve because users become so fed-up waiting for bugs to be addressed that they
fix them themselves. :)<br/>
If you report a bug, we'd often appreciate you sending a mail to the users or developers
mailing lists, so that we can discuss it with you, bugzilla isn't a great way for mediating
communication.<br/>
If you want to fix a bug, please contribute your changes according to the guidelines above,
in the Code Patches section. It is much simpler to deal with submissions if they all come
through the same channel.
</p>
</section>
<section name="Documentation">
<p>
While we are glad to accept contributions to documentation
from anyone, in almost any format, because its much better than none, please consider these
guidelines to help us to assimilate your contribution.<br/>
To edit an existing document try to edit the xml version in src/xdocs (check it out from cvs)
and if you can, submit a patch as for Code Patches.<br/>
If you want to contribute new files please try to use the simple xml format we use.<br/>
If this means nothing to you please try to contribute HTML or plain text documents without
any styling, so that we can get at the words and easily convert them into our xml format.<br/>
If all this seems like unnecessary nonsense, send us whatever you like, we'd still be
happy to recieve good documentation.
</p>
</section>
</body>
</document>
1.10 +67 -61 jakarta-james/src/xdocs/stylesheets/project.xml
Index: project.xml
===================================================================
RCS file: /home/cvs/jakarta-james/src/xdocs/stylesheets/project.xml,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- project.xml 27 Feb 2002 15:46:39 -0000 1.9
+++ project.xml 29 Jul 2002 16:04:45 -0000 1.10
@@ -1,61 +1,67 @@
-<?xml version="1.0" encoding="ISO-8859-1"?>
-<project name="JAMES"
- href="http://jakarta.apache.org/james/">
-
- <title>Jakarta James</title>
- <logo href="/images/james-logo.jpg">JAMES - Java Apache Mail Enterprise Server</logo>
-
- <body>
- <menu name="James">
- <item name="Overview" href="/index.html"/>
- <item name="Install" href="/install.html"/>
- <item name="Configuration" href="/configuration_v2_0.html"/>
- <item name="Architecture" href="/architecture_v2_0.html"/>
- <item name="James FAQ" href="/FAQ.html"/>
- </menu>
-
- <menu name="Download">
- <item name="Binaries" href="/site/binindex.html"/>
- <item name="Source Code" href="/site/sourceindex.html"/>
- </menu>
-
- <menu name="Guides">
- <item name="James API" href="/javadocs/index.html"/>
- <item name="Mailet API" href="/mailet/index.html"/>
- <item name="Using JDBC" href="/usingJDBC_v2.0.html"/>
- <item name="Using LDAP" href="/usingLDAP_v1_2.html"/>
- <item name="Using TLS" href="/usingTLS_v1_2.html"/>
- <item name="Useful RFCs {web}" href="http://jakarta.apache.org/james/rfclist"/>
- </menu>
-
- <menu name="Project">
- <item name="Coding Standards" href="/code-standards.html"/>
- <item name="License" href="/license.html"/>
- <item name="TODO" href="/todo.html"/>
- <item name="Changelog" href="/changelog.html"/>
- <item name="Who We Are" href="/weare.html"/>
- </menu>
-
- <menu name="Jakarta Information {web}">
- <item name="Get Involved" href="/site/getinvolved.html"/>
- <item name="CVS Repositories" href="/site/cvsindex.html"/>
- <item name="Mailing Lists" href="/site/mail.html"/>
- <item name="Reference Library" href="/site/library.html"/>
- <item name="Bug Database" href="/site/bugs.html"/>
- </menu>
-
- <menu name="Jakarta Essentials {web}">
- <item name="Front Page" href="http://jakarta.apache.org/index.html"/>
- <item name="News & Status" href="/site/news.html"/>
- <item name="Mission" href="/site/mission.html"/>
- <item name="Guidelines Notes" href="/site/guidelines.html"/>
- <item name="FAQs" href="/site/faqs.html"/>
- </menu>
-
- <menu name="Related Projects {web}">
- <item name="Ant" href="http://jakarta.apache.org/ant/index.html"/>
- <item name="Avalon" href="http://jakarta.apache.org/avalon/index.html"/>
- </menu>
-
- </body>
-</project>
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<project name="JAMES"
+ href="http://jakarta.apache.org/james/">
+
+ <title>Jakarta James</title>
+ <logo href="/images/james-logo.jpg">JAMES - Java Apache Mail Enterprise Server</logo>
+
+ <body>
+ <menu name="James">
+ <item name="Overview" href="/index.html"/>
+ <item name="Install" href="/install.html"/>
+ <item name="Configuration" href="/configuration_v2_0.html"/>
+ <item name="Architecture" href="/architecture_v2_0.html"/>
+ <item name="James FAQ" href="/FAQ.html"/>
+ </menu>
+
+ <menu name="Download">
+ <item name="Binaries" href="/site/binindex.html"/>
+ <item name="Source Code" href="/site/sourceindex.html"/>
+ </menu>
+
+ <menu name="Guides">
+ <item name="James API" href="/javadocs/index.html"/>
+ <item name="Mailet API" href="/mailet/index.html"/>
+ <item name="Using JDBC" href="/usingJDBC_v2.0.html"/>
+ <item name="Using LDAP" href="/usingLDAP_v1_2.html"/>
+ <item name="Using TLS" href="/usingTLS_v1_2.html"/>
+ <item name="Useful RFCs {web}" href="http://jakarta.apache.org/james/rfclist"/>
+ </menu>
+
+ <menu name="Translations {web}">
+ <item name="Japanese" href="http://www.terra-intl.com/jakarta/james/"/>
+ </menu>
+
+ <menu name="Project">
+ <item name="Coding Standards" href="/code-standards.html"/>
+ <item name="License" href="/license.html"/>
+ <item name="TODO" href="/todo.html"/>
+ <item name="Changelog" href="/changelog.html"/>
+ <item name="Bug Database {web}" href="/site/bugs.html"/>
+ <item name="Contributors How To" href="/contribute.html"/>
+
+ <item name="Who We Are" href="/weare.html"/>
+ </menu>
+
+ <menu name="Jakarta Information {web}">
+ <item name="Get Involved" href="/site/getinvolved.html"/>
+ <item name="CVS Repositories" href="/site/cvsindex.html"/>
+ <item name="Mailing Lists" href="/site/mail.html"/>
+ <item name="Reference Library" href="/site/library.html"/>
+ </menu>
+
+ <menu name="Jakarta Essentials {web}">
+ <item name="Front Page" href="http://jakarta.apache.org/index.html"/>
+ <item name="News & Status" href="/site/news.html"/>
+ <item name="Mission" href="/site/mission.html"/>
+ <item name="Guidelines Notes" href="/site/guidelines.html"/>
+ <item name="FAQs" href="/site/faqs.html"/>
+ </menu>
+
+ <menu name="Related Projects {web}">
+ <item name="Ant" href="http://jakarta.apache.org/ant/index.html"/>
+ <item name="Avalon" href="http://jakarta.apache.org/avalon/index.html"/>
+ </menu>
+
+ </body>
+</project>
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>