Return-Path: X-Original-To: apmail-tomcat-dev-archive@www.apache.org Delivered-To: apmail-tomcat-dev-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 51A646FBA for ; Sun, 31 Jul 2011 23:28:44 +0000 (UTC) Received: (qmail 38151 invoked by uid 500); 31 Jul 2011 23:28:43 -0000 Delivered-To: apmail-tomcat-dev-archive@tomcat.apache.org Received: (qmail 38056 invoked by uid 500); 31 Jul 2011 23:28:42 -0000 Mailing-List: contact dev-help@tomcat.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: "Tomcat Developers List" Delivered-To: mailing list dev@tomcat.apache.org Received: (qmail 38047 invoked by uid 99); 31 Jul 2011 23:28:42 -0000 Received: from nike.apache.org (HELO nike.apache.org) (192.87.106.230) by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 31 Jul 2011 23:28:42 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=5.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.131] (HELO eos.apache.org) (140.211.11.131) by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 31 Jul 2011 23:28:39 +0000 Received: from eos.apache.org (localhost [127.0.0.1]) by eos.apache.org (Postfix) with ESMTP id 54296EEE; Sun, 31 Jul 2011 23:28:18 +0000 (UTC) MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable From: Apache Wiki To: Apache Wiki Date: Sun, 31 Jul 2011 23:28:18 -0000 Message-ID: <20110731232818.91116.23766@eos.apache.org> Subject: =?utf-8?q?=5BTomcat_Wiki=5D_Update_of_=22HowTo=22_by_KonstantinKolinko?= Auto-Submitted: auto-generated X-Virus-Checked: Checked by ClamAV on apache.org Dear Wiki user, You have subscribed to a wiki page or wiki category on "Tomcat Wiki" for ch= ange notification. The "HowTo" page has been changed by KonstantinKolinko: http://wiki.apache.org/tomcat/HowTo?action=3Ddiff&rev1=3D109&rev2=3D110 Comment: Tweaks to "How do I contribute to Tomcat's documentation" answer However, ''do not'' add questions without answers to this page. If you ha= ve a question about how to do something in Tomcat which has not been addres= sed yet, ask the [[http://tomcat.apache.org/lists.html#tomcat-users|tomcat-= user list]]. Once you've figured out how to fix your problem, come back and= update the Wiki to allow the rest of us to benefit from what you've learne= d! = =3D=3D How do I contribute to Tomcat's documentation? =3D=3D - - Download the source bundle or grab the source XML file from [[http://to= mcat.apache.org/svn.html|Subversion repository]]. The docs are in the weba= pps/docs subdirectory. They are in XML format and get processed into the H= TML documentation as part of the Tomcat release. = + Download the source bundle or grab the source XML file from [[http://tomc= at.apache.org/svn.html|Subversion repository]]. If you are not familiar wit= h Subversion, see http://www.apache.org/dev/contributors.html. + = + The docs are in the webapps/docs subdirectory. They are in XML format an= d get processed into the HTML documentation as part of the Tomcat release. + = - - Edit the documentation XML file(s) as you wish. The xdocs format is se= lf-explanatory: use normal HTML markup, and add
or t= ags as you see fit. Look at the existing docs as examples. Make sure you = use valid XML markup. + Edit the documentation XML file(s) as you wish. The xdocs format is self= -explanatory: use normal HTML markup, and add {{{
}}} or {{{}}} tags as you see fit. Look at the existing docs as examples. Make= sure you use valid XML markup. = - - Open a Bugzilla enhancement item with the explanation of your enhanceme= nts, and attach a {{{svn diff}}} or {{{diff -u}}} format of your patch. We= will evaluate and commit your patch as needed. Note that the Tomcat web s= ite is updated with every release, so that documentation changes will not b= e visible until next Tomcat release. - = - - If you're interested in previewing your changes, you will need to follo= w the directions for building Tomcat yourself. The docs will be generated = in the webapps/docs directory just like with any normal Tomcat distribution= s. + If you're interested in previewing your changes, you will need to follow = the directions for building Tomcat yourself. The docs will be generated in= the webapps/docs directory just like with any normal Tomcat distributions. = - - Documentation for current (unreleased) versions of Tomcat 6 and Tomcat = 7 is published by ASF Buildbot. See links on the [[http://tomcat.apache.org= /ci.html|buildbot]] page on Apache Tomcat web site. + Open a Bugzilla enhancement item with the explanation of your enhancement= s, and attach a {{{svn diff}}} or {{{diff -u}}} format of your patch. We w= ill evaluate and commit your patch as needed. = - - If you're not familiar with how to grab files from Subversion, see http= ://www.apache.org/dev/contributors.html. + Note, that the Tomcat web site is updated with every release, so that doc= umentation changes will not be visible until next Tomcat release. It is pos= sible to view documentation for unreleased versions of Tomcat 7 and Tomcat = 6, that is published by ASF Buildbot. See links on the [[http://tomcat.apac= he.org/ci.html|buildbot]] page on Apache Tomcat web site. = = =3D Installation =3D --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org For additional commands, e-mail: dev-help@tomcat.apache.org