jakarta-taglibs-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From gl...@apache.org
Subject cvs commit: jakarta-taglibs/src/doc addtaglib.xml
Date Sun, 01 Jul 2001 15:54:27 GMT
glenn       01/07/01 08:54:27

  Modified:    src/doc  addtaglib.xml
  Log:
  Updated documentation
  
  Revision  Changes    Path
  1.2       +40 -53    jakarta-taglibs/src/doc/addtaglib.xml
  
  Index: addtaglib.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-taglibs/src/doc/addtaglib.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- addtaglib.xml	2001/06/30 13:39:08	1.1
  +++ addtaglib.xml	2001/07/01 15:54:27	1.2
  @@ -18,47 +18,31 @@
   source repository.</p>
   </section>
   
  -<section name="Create the standard taglib directory and file layout" href="Create">
  -<p>For a tag library, create the directory <code>jakarta-taglibs/{taglib-name}</code>.
  -For a CTLX, create the <code>{taglib-name}</code> directory in the
  -appropriate subdirectory of the <code>jakarta-taglibs/tools/</code> directory.</p>
  -
  -<p>Copy the files from <code>src/taglib-template</code> into the new
directory.
  -This creates a standard set of directories and files you can
  -use as a starting point for developing the new taglib.  Here is the
  -listing of directories and files created:
  -<ul>
  -<li><b>build.xml</b> - Ant build configuration file</li>
  -<li><b>doc/</b> - Source files for creating the {taglib-name}-doc.war</li>
  -<li><b>doc/conf/web.xml</b> - {taglib-name}-doc web application configuration</li>
  -<li><b>doc/web/</b> - taglib static HTML documentation pages</li>
  -<li><b>doc/web/changes.html</b> - taglib documentation revision change
history</li>
  -<li><b>examples/</b> - Source files for creating the {taglib-name}-examples.war</li>
  -<li><b>examples/conf/web.xml</b> - {taglib-name}-examples web application
configuration</li>
  -<li><b>examples/web/</b> - taglib example static HTML and JSP pages</li>
  -<li><b>src/org/apache/taglibs/</b> - taglibs java source package directory</li>
  -<li><b>xml/intro.xml</b> - XML file transformed by src/doc/stylesheets/taglibs.xsl
  -    to create http://jakarta.apache.org/taglibs/doc/{taglib-name}-doc/intro.html</li>
  -<li><b>xml/taglib-template.xml</b> - XML file transformed by src/taglib/taglib-doc.xsl
  -    to create your taglib documentation and transformed by src/taglib/tld11.xsl
  -    to create your {taglib-name}.tld Tag Lib Descriptor file.</li>
  +<section name="Create the new taglib or CTLX directory and file layout" href="Create">
  +<p>The directory and file structure for a new tag library or CTLX can be created
  +by using the ant build target <code>new.taglib</code> or <code>new.ctlx</code>.
  +<ul>
  +  <p>
  +  <code>ant new.taglib -Dtaglib.name=cooljsp</code><br/><br/>
  +  Creates a new taglib in the directory <code>jakarta-taglibs/cooljsp</code>.
  +  </p>
  +  <p>
  +  <code>ant new.ctlx -Dctlx.name=coolctlx1 -Dctlx.path=tools</code><br/><br/>
  +  Creates a new CTLX in the directory <code>jakarta-taglibs/tools/coolctlx1</code>.
  +  </p>
   </ul>
   </p>
   
  -<p>Make a new directory for your taglib java source code files of:
  -
  -<pre>
  -src/org/apache/taglibs/{taglib-name}
  -</pre>
  +<p>You will need to edit any xml files created above to customize them for
  +your new taglib.  Text you should customize in the xml files is listed inside
  +curly braces <code>{ .. }</code>.
  +<ul>
  +  <li><code>{taglib-name}</code> - replace with the taglib or ctlx nickname.</li>
  +  <li><code>{display-name}</code> - replace with the name used for taglib
in documentation.</li>
  +  <li><code>{your-name}</code> - replace with your name as author of
taglib.</li>
  +</ul>
   </p>
   
  -<p>Change the name of <code>xml/taglib-template.xml</code> to
  -<code>xml/{taglib-name}.xml</code>.</p>
  -
  -<p>You will need to edit the above files to customize them for
  -your new taglib.  Anyplace you see &lt;taglib-name&gt; should be
  -replaced with either the taglib nickname or taglib display name.</p>
  -
   <p>If your tag library will be using any API's or versions of API's
   other than servlet.jar check the <code>jakarta-taglibs/build.properties.sample</code>
   to see if a property is already configured for it.  If not,
  @@ -169,7 +153,7 @@
   <code>&lt;tagindex&gt;</code> section.
   <pre>
   &lt;!-- Example taginfo, initial state should be "develop"
  -     &lt;taginfo name="DBTags" state="develop" branch=""&gt;
  +     &lt;taginfo name="DBTags" state="develop"&gt;
          The DBTags (formerly called JDBC) custom tag library contains
          tags which can be used to read from and write to an SQL database.
        &lt;/taginfo&gt;
  @@ -180,7 +164,7 @@
   <pre>
   &lt;!-- Example ctlxinfo
       &lt;ctlxindex&gt;
  -      &lt;ctlxinfo name="UltraDev" state="develop" branch=""&gt;
  +      &lt;ctlxinfo name="UltraDev" state="develop"&gt;
           The UltraDev CTLX adds the ability to use JSP custom tag
           libraries when publishing JSP pages using UltraDev 4.0.
         &lt;/ctlxinfo&gt; 
  @@ -286,8 +270,6 @@
   <p>Update the jakarta web site by editing <code>src/doc/index.xml</code>:
   <ul>
   <li>Add a <code>&lt;newsitem&gt;</code> announcing the milestone
release.</li>
  -<li>Set the <code>&lt;taginfo&gt;</code> or <code>&lt;ctlxinfo&gt;</code>
branch
  -attribute for your taglib or ctlx to <code>{release-name}</code>.</li>
   </ul>
   </p>
   
  @@ -302,6 +284,9 @@
   </ul>
   </p>
   
  +<p>Update the &lt;revision&gt; section of your xml/{taglib-name}.xml
  +file so that the changes.html file for your taglib is up to date.</p>
  +
   <p>Make sure you have committed all your {taglib-name} and
   jakarta-taglibs changes to CVS.</p>
   
  @@ -314,9 +299,9 @@
   </ul>
   </p>
   
  -<p>Your {taglib-name} release will be made available on the
  -jakarta.apache.org site once the nightly builds have been
  -completed.</p>
  +<p>Send an email to the taglibs-dev list requesting that the
  +Jakarta-Taglibs Project release manager perform the
  +tag library or CTLX milestone release.</p>
   
   <p>The documentation for the taglib release will be at:
   http://jakarta.apache.org/taglibs/doc/{taglib-name}-doc/{release-name}/</p>
  @@ -346,8 +331,6 @@
   <p>Update the jakarta web site by editing <code>src/doc/index.xml</code>:
   <ul>
   <li>Add a <code>&lt;newsitem&gt;</code> announcing the beta release.</li>
  -<li>Set the <code>&lt;taginfo&gt;</code> or <code>&lt;ctlxinfo&gt;</code>
branch
  -attribute for your taglib or ctlx to <code>{release-name}</code>.</li>
   <li>Set the <code>&lt;taginfo&gt;</code> or <code>&lt;ctlxinfo&gt;</code>
state
   attribute for your taglib or ctlx to <code>beta</code>.</li>
   </ul>
  @@ -364,6 +347,9 @@
   </ul>
   </p>
   
  +<p>Update the &lt;revision&gt; section of your xml/{taglib-name}.xml
  +file so that the changes.html file for your taglib is up to date.</p>
  +
   <p>Make sure you have committed all your {taglib-name} and
   jakarta-taglibs changes to CVS.</p> 
   
  @@ -376,9 +362,9 @@
   </ul>
   </p>
   
  -<p>Your {taglib-name} release will be made available on the
  -jakarta.apache.org site once the nightly builds have been
  -completed.</p>
  +<p>Send an email to the taglibs-dev list requesting that the
  +Jakarta-Taglibs Project release manager perform the
  +tag library or CTLX beta release.</p>
   
   <p>The documentation for the taglib release will be at:
   http://jakarta.apache.org/taglibs/doc/{taglib-name}-doc/{release-name}/</p>
  @@ -408,8 +394,6 @@
   <p>Update the jakarta web site by editing <code>src/doc/index.xml</code>:
   <ul>
   <li>Add a <code>&lt;newsitem&gt;</code> announcing the release.</li>
  -<li>Set the <code>&lt;taginfo&gt;</code> or <code>&lt;ctlxinfo&gt;</code>
branch
  -attribute for your taglib or ctlx to <code>{release-name}</code>.</li>
   <li>Set the <code>&lt;taginfo&gt;</code> or <code>&lt;ctlxinfo&gt;</code>
state
   attribute for your taglib or ctlx to <code>released</code>.</li>
   </ul>
  @@ -426,6 +410,9 @@
   </ul>
   </p>
   
  +<p>Update the &lt;revision&gt; section of your xml/{taglib-name}.xml
  +file so that the changes.html file for your taglib is up to date.</p>
  +
   <p>Make sure you have committed all your {taglib-name} and
   jakarta-taglibs changes to CVS.</p>
   
  @@ -438,9 +425,9 @@
   </ul>
   </p>
   
  -<p>Your {taglib-name} release will be made available on the
  -jakarta.apache.org site once the nightly builds have been
  -completed.</p>
  +<p>Send an email to the taglibs-dev list requesting that the
  +Jakarta-Taglibs Project release manager perform the
  +tag library or CTLX release.</p>
   
   <p>The documentation for the taglib release will be at:
   http://jakarta.apache.org/taglibs/doc/{taglib-name}-doc/{release-name}/</p>
  
  
  

Mime
View raw message