Index: manuals/dita.xml =================================================================== --- manuals/dita.xml (revision 169882) +++ manuals/dita.xml (working copy) @@ -42,8 +42,9 @@
  1. From a command line, navigate to %DOC_ROOT%/trunk/.
  2. Enter the desired ant command on the command line using the following syntax: -ant <output_type>.<manual_id>The <output_type> is the format of the output you wish to create, either HTML or PDF. The <manual_id> is the id of the manual you wish to output. The id can be found as the name of the directory containing that manual's DITA source files in %DOC_ROOT%/trunk/src/. For example, to create PDF output for the Getting Started with Derby guide, enter the following command:ant pdf.getstart To create PDF or HTML output for ALL SIX manuals at once, simply enter the output type with no manual:ant pdforant html
    3. +ant <output_type>.<manual_id>The <output_type> is the format of the output you wish to create, either HTML or PDF. The <manual_id> is the id of the manual you wish to output. The id can be found as the name of the directory containing that manual's DITA source files in %DOC_ROOT%/trunk/src/. For example, to create PDF output for the Getting Started with Derby guide, enter the following command:ant pdf.getstart To create PDF or HTML output for ALL SIX manuals at once, simply enter the output type with no manual:ant pdforant htmlorant monohtml
+

Note that monohtml creates a single HTML file for each manual, while html creates multiple HTML files with a navigation tree.

The output files will be built by the ant file and placed in the %DOC_ROOT%/out/ directory. If any of the software is not set up and configured correctly, the build will fail.

The following table lists the manual id's for each Derby manual:

@@ -129,7 +130,7 @@

    - +
  1. Open a Jira issue under the documentation component for Derby, if one has not already been created for this issue. You will be posting your patch to the entry. You can also create a documentation subtask to an existing JIRA entry for code changes if your change is to reflect a bug fix, new feature, etc.

  2. @@ -160,28 +161,28 @@

  3. -Test your changes by running ant to create output in both HTML and PDF. Make sure no new errors or build failures result from your changes, and check that the output looks correct. +Test your changes by running ant to create output in both HTML and PDF. Make sure no new errors or build failures result from your changes, and check that the output looks correct. This is the documentation that users will read, so please check your writing for spelling, grammar, and punctuation mistakes.

  4. -Make the patch. +Make the patch. Be sure to create the patch from the trunk/ directory.

    svn diff > xyz.diff
    5. - +
  5. It will be necessary for the community to review your changes, and the best way to do that is to see the HTML output that reflects your changes. Since you have already created HTML output when testing your changes, simply add the relevant HTML files along with the patch file to a zip file. +

  6. -Post the patch to the derby-dev mail list -or attach it to the Jira issue. +Attach the zip file to the appropriate JIRA entry.

    -Include the following information with your post: +Include the following information with your attachment: