Might be nice if I included the file :-P
On 10/19/06, Laura Stewart <[EMAIL PROTECTED]> wrote:
Huge help Jean ! The CDATA tag is long but worked beautifully !!! Now a few minor irritants :-) I've attached the html page. Please note that the first section title is left justified in the tan bar, but the remaining section titles are not... anyway to fix? Also the table bleeds off to the right... anyway to fix that? Really appreciate you help on this ! -- Laura Stewart
-- Laura StewartTitle: Apache Derby: Writing guidelines
Apache Derby: Writing guidelines
The Derby documentation manual is sourced DITA. This page ...
New topics: Choosing the correct topic type
There are three types of topics used in the Derby documentation: concepts, reference, and tasks.
Concept topics are overview information that answer the question "What is...?". They explain "why" something is important or behaves the way it does. Concepts provide the background information users must understand before they can complete the tasks successfully.
Reference topics provide detailed information about product capabilities for quick reference and for completeness. Reference information provides quick access to facts, but no explanation of concepts or procedures. Examples of reference topics are the syntax for commands, and SQL statements, class descriptions, detailed examples, and troubleshooting information.
Task topics answer the question "How do I?". Tasks typically include step-by-step instructions. Task topics often list (or link to) prerequisites that need to be completed before the user can perform the task. Tasks also list (or link to) any restrictions on performing the task.
Using a template to create a new file
Tagging guidelines
The following table lists the proper tags to use for the most common features within the Derby topics. If you are not certain which tags to use, ask on the derby-dev list.
| Feature | Tag to use | Comments |
|---|---|---|
| Index entries | <indexterm> | See the section below on Indexing guidelines. |
Indexing
In Derby, the index entries are inserted just after the <title> and <shortdesc> tags. The index entries use the <indexterm> tag, but that tag must be nested inside serveral other tags. For example, if the index term is CREATE TABLE, the tags that you would need are: <prolog> <metadata> <keywords> <indexterm>CREATE TABLE</indexterm> </keywords> </metadata> </prolog>
Please post feedback to the derby-dev mail list.
Last Updated: October 19, 2006
