db-derby-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From fuzzylo...@apache.org
Subject svn commit: r474863 - in /db/derby/docs/trunk/templates: ./ concept_template.dita reference_template.dita task_template.dita
Date Tue, 14 Nov 2006 16:42:25 GMT
Author: fuzzylogic
Date: Tue Nov 14 08:42:25 2006
New Revision: 474863

URL: http://svn.apache.org/viewvc?view=rev&rev=474863
Log:
DERBY-2001: Add templates for the 3 DITA topic types.

Committed for Laura Stewart <scotsmatrix@gmail.com>

Added:
    db/derby/docs/trunk/templates/
    db/derby/docs/trunk/templates/concept_template.dita   (with props)
    db/derby/docs/trunk/templates/reference_template.dita   (with props)
    db/derby/docs/trunk/templates/task_template.dita   (with props)

Added: db/derby/docs/trunk/templates/concept_template.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/templates/concept_template.dita?view=auto&rev=474863
==============================================================================
--- db/derby/docs/trunk/templates/concept_template.dita (added)
+++ db/derby/docs/trunk/templates/concept_template.dita Tue Nov 14 08:42:25 2006
@@ -0,0 +1,70 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--Arbortext, Inc., 1988-2005, v.4002-->
+<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN"
+ "../dtd/concept.dtd">
+<!-- 
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements.  See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License.  You may obtain a copy of the License at      
+
+http://www.apache.org/licenses/LICENSE-2.0  
+
+Unless required by applicable law or agreed to in writing, software  
+distributed under the License is distributed on an "AS IS" BASIS,  
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  
+See the License for the specific language governing permissions and  
+limitations under the License.
+-->
+<concept id="concept_template" xml:lang="en-us">
+<!--TOPIC TITLE:  The title should reflect the conceptual information
+that is contained in the topic. Capitalize only the first word of a title, except for
+proper nouns within it. DO NOT use gerunds (verbs with "ing" at the end) 
+such as "Storing", "Coding". Those titles reflect a TASK, not a CONCEPT. 
+Examples
+Application development overview
+Storage and recovery
+Code your applications
+-->
+<title>concept_template</title>
+<!--SHORT DESCRIPTION: The short description is used for the first paragraph in the 
+topic and as an abstract. Short descriptions can be 1-3 sentences long.-->
+<shortdesc></shortdesc>
+<!--INDEX ENTRIES: Below is the tagging needed for index entries.  To add an 
+index entry, insert the <indexterm> tag inside the <keywords> tag.
+See the Derby Documentation page for guidelines on indexing a topic. -->
+<prolog><metadata>
+<keywords><indexterm>templates<indexterm>concept</indexterm></indexterm></keywords>
+</metadata></prolog>
+<!--CONBODY: The <conbody> tag is the only REQUIRED tag in a concept topic.  
+All of the text for the concept must reside within the conbody tag.-->
+<conbody>
+<!--PARAGRAPHS: Use the <p> tag when you want to start a new paragraph.-->
+<p>Type your text here. </p>
+<!--NOTES: Use the <note> tag when you want to insert a note.  
+Notes do not need to be inside of a <p> tag. You can specify a type of note, which
displays 
+as the label for the note text in the output. If you do not specify the type of note,  
+the label is "Note:".
+Commonly used types are: attention, fastpath, important, remember, restriction, and tip.

+This tag is optional. -->
+<note type="fastpath"></note>
+<!--UNORDERED LISTS: Use the <ul> tag when you want to create a bulleted 
+(aka unordered) list. 
+This tag is optional. -->
+<ul>
+<li>An interesting point</li>
+<li>Another interesting point</li>
+</ul>
+<!--SECTION: Use the <section> tag to create a subsection within the Concept topic.
+Use the <title> tag to specify the heading for the subsection. 
+This tag is optional. -->
+<section><title>Subheading</title><p>Here is a subsection inside
a concept
+topic.</p> </section>
+<!--EXAMPLE: Use the <example> tag to create a subsection for an example.  
+This tag is optional. -->
+<example><title>Example</title><p>Here is an example section inside
a concept
+topic.</p> </example>
+</conbody>
+</concept>

Propchange: db/derby/docs/trunk/templates/concept_template.dita
------------------------------------------------------------------------------
    svn:eol-style = native

Added: db/derby/docs/trunk/templates/reference_template.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/templates/reference_template.dita?view=auto&rev=474863
==============================================================================
--- db/derby/docs/trunk/templates/reference_template.dita (added)
+++ db/derby/docs/trunk/templates/reference_template.dita Tue Nov 14 08:42:25 2006
@@ -0,0 +1,117 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--Arbortext, Inc., 1988-2005, v.4002-->
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
+ "../dtd/reference.dtd">
+<!-- 
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements.  See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License.  You may obtain a copy of the License at      
+
+http://www.apache.org/licenses/LICENSE-2.0  
+
+Unless required by applicable law or agreed to in writing, software  
+distributed under the License is distributed on an "AS IS" BASIS,  
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  
+See the License for the specific language governing permissions and  
+limitations under the License.
+-->
+<reference id="reference_template" xml:lang="en-us">
+<!--TOPIC TITLE:  The title should reflect the reference information
+that is contained in the topic. Capitalize only the first word of a title, except for
+proper nouns within it. 
+Examples
+GRANT statement 
+Supported data types
+java.sql.DatabaseMetaData
+-->
+<title>reference_template</title>
+<!--SHORT DESCRIPTION: The short description is used for the first paragraph in the 
+topic and as an abstract. Short descriptions can be 1-3 sentences long.-->
+<shortdesc></shortdesc>
+<!--INDEX ENTRIES: Below is the tagging needed for index entries.  To add an 
+index entry, insert the <indexterm> tag inside the <keywords> tag.
+See the Derby Documentation page for guidelines on indexing a topic. -->
+<prolog><metadata>
+<keywords><indexterm>templates<indexterm>concept</indexterm></indexterm></keywords>
+</metadata></prolog>
+<!--REFBODY: The <refbody> tag is the only REQUIRED tag in a reference topic.  
+All of the text for the reference must reside within the refbody tag.-->
+<refbody>
+<!--SYNTAX WITH RESTRICTIONS: If you are doocumeting the syntax for a 
+command or statement, and there are restrictions to using the command or statement, 
+add a section without a title before the <REFSYN> tag. 
+Then add a <note type=restriction> tag. For example:-->
+<section><note type="restriction"></note></section>
+<!--REFSYN: Use the <refsyn> tag to create a special section inside the reference

+topic that contains the syntax or signature content. For example, a command-line 
+utility's calling syntax, or an API's signature. -->
+<refsyn> <title>Syntax</title> <codeblock>CREATE [ UNIQUE ] INDEX
<varname>IndexName</varname>
+   ON <varname>TableName</varname> (<varname>SimpleColumnName</varname>
[ , <varname>SimpleColumnName</varname>] * )
+</codeblock> </refsyn>
+<!--EXAMPLE: When creating a reference topic that provides the syntax for a 
+command or statement, you should include a section that shows 1 or more examples of 
+using the command or statement. You can use the <codeblock> or <pre> tag for
the examples.-->
+<example> <title>Example</title> <pre>CREATE UNIQUE INDEX <varname>Index1</varname>
+   ON <varname>Table1</varname> (<varname>Column1</varname>, <varname>Column2</varname>)
+</pre> </example>
+<!--SECTIONS and TITLES: Use the <section> and <title> tag to identify different

+parts of a reference topic. This template shows a few examples that you might use.-->
+<section> <title>A Section</title> </section>
+<section> <title>Other tags that you might use</title>  
+<!--PARAGRAPHS: Use the <p> tag when you want to start a new paragraph. 
+A paragraph is a block of text containing a single main idea.--> 
+<p>Type your text here.</p>   
+<!--LINKS: Use the <xref> tag to create a cross reference link to a Web site.-->

+<xref href="http://db.apache.org/derby/manuals/index.html" scope="external">Type
+link text here
+</xref>  
+<!--TABLE: Use a <table> when you have a lot of reference information to convey

+to the user.  The first row should contain headings for each of the columns. If you need
to 
+adjust the column widths or change the text alignment, see the instructions on the Derby

+Documentation Writing Guidelines page at http://db.apache.org/derby/manuals/guidelines.html.-->
+<table>
+<title>Add your table description here</title>
+<tgroup cols="3">
+<colspec colname="col1" colwidth="25*"/>
+<colspec colname="col2" colwidth="25*"/>
+<colspec colname="col3" colwidth="50*"/>
+<thead>
+<row valign="bottom">
+<entry colname="col1">Parameter</entry>
+<entry colname="col2">Valid values</entry>
+<entry colname="col3">Description</entry>
+</row>
+</thead>
+<tbody>
+<row>
+<entry colname="col1">Parameter name 1</entry>
+<entry colname="col2"></entry>
+<entry colname="col3"></entry>
+</row>
+<row>
+<entry colname="col1">Parameter name 2</entry>
+<entry colname="col2"></entry>
+<entry colname="col3"></entry>
+</row>
+<row>
+<entry colname="col1">Parameter name 3</entry>
+<entry colname="col2"></entry>
+<entry colname="col3"></entry>
+</row>
+</tbody>
+</tgroup>
+</table>
+<!--NOTES: Use the <note> tag when you want to insert information, differentiated

+from the main text, that expands on or calls attention to a particular point. 
+Notes are displayed in their own paragraph and do not need to be inside of a paragraph <p>
tag.  
+You can specify a type of note, which displays as the lable for the note text in the output.

+If you do not specify the type of note,  the label is "Note:".
+Commonly used types are: Attention, Fastpath, Important, Remember, Restriction, and Tip.

+This tag is optional.-->
+<note type="important"> </note> 
+</section>
+</refbody>
+</reference>

Propchange: db/derby/docs/trunk/templates/reference_template.dita
------------------------------------------------------------------------------
    svn:eol-style = native

Added: db/derby/docs/trunk/templates/task_template.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/templates/task_template.dita?view=auto&rev=474863
==============================================================================
--- db/derby/docs/trunk/templates/task_template.dita (added)
+++ db/derby/docs/trunk/templates/task_template.dita Tue Nov 14 08:42:25 2006
@@ -0,0 +1,99 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--Arbortext, Inc., 1988-2005, v.4002-->
+<!DOCTYPE task PUBLIC "-//OASIS//DTD DITA Task//EN"
+ "../dtd/task.dtd">
+<!-- 
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements.  See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License.  You may obtain a copy of the License at      
+
+http://www.apache.org/licenses/LICENSE-2.0  
+
+Unless required by applicable law or agreed to in writing, software  
+distributed under the License is distributed on an "AS IS" BASIS,  
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  
+See the License for the specific language governing permissions and  
+limitations under the License.
+-->
+<!--TOPIC TITLE:  Clearly and succinctly identify the task. 
+Begin the title with the gerund (the -ing form) of a specific verb, such as 
+Subscribing, and maintain a verb-object structure. Avoid nonspecific verbs like 
+"Using" or "Working with".
+For example: Encrypting databases with a new external encryption key
+Capitalize only the first word of a title, except for proper nouns within it.-->
+<task id="task_template" xml:lang="en-us">
+<title>task_template</title>
+<!--SHORT DESCRIPTION: The short description is used for the first paragraph in the 
+topic and as an abstract. Short descriptions can be 1-3 sentences long.-->
+<shortdesc></shortdesc>
+<!--INDEX ENTRIES: Below is the tagging needed for index entries.  To add an 
+index entry, insert the <indexterm> tag inside the <keywords> tag.
+See the Derby Documentation page for guidelines on indexing a topic. -->
+<prolog><metadata>
+<keywords><indexterm>templates<indexterm>task</indexterm></indexterm></keywords>
+</metadata></prolog>
+<taskbody>
+<!--PREREQUISITES: If there are prerequisites that the user must complete 
+BEFORE performing this task, add the prerequisites in the <prereq> section.  
+This tag is optional. -->
+<prereq></prereq>
+<!--CONTEXT: If there is additional introductory information for this task that 
+the short description does not cover, type it in the <context> section. -->
+<context> <p>To [ do this task] ...</p> </context>
+<!--STEPS: The tags that you use for the steps depend on what you are asking 
+the user to do. 
+REQUIRED TAGS: You must use the <steps> <step> and <cmd> tags.  
+OPTIONAL TAGS: You can use other tags within the <steps> tag to help structure the
steps, 
+such as <stepresult> <choices> <substeps> and <choicetable>-->
+<steps>
+<step><cmd>Do this</cmd>
+<!--Use <stepresult> if you need to indicate to the user the result of a step.
+For example, if something specific displays back to the user that is helpful. -->
+<stepresult></stepresult></step>
+<step><cmd>Then this</cmd>
+<!--Use <choices> for a bulleted list of options on a single step.-->
+<choices>
+<choice>Using this method</choice>
+<choice>Or this method</choice>
+</choices>
+</step>
+<step><cmd>Then this</cmd>
+<!--Use <substeps> when there are distinct parts to a step. It is often helpful

+to have an example. Use the <stepxmp> tag and the <codeblock> tag for examples.

+Do NOT bold the text inside the codeblock.-->
+<substeps>
+<substep><cmd>which is done by doing this</cmd></substep>
+<substep><cmd>and then this.</cmd><stepxmp>For example:  <codeblock>CREATE
TABLE <varname>tablename</varname> 
+   (col1 INT NOT NULL, col2 DATE NOT NULL, col3 INT DEFAULT 0)
+</codeblock> </stepxmp></substep>
+</substeps>
+</step>
+<step><cmd>And finally, this.</cmd>
+<!--Use a <choicetable> when there is more than one way to do something -->
+<choicetable>
+<chhead><choptionhd>Operating System</choptionhd><chdeschd>Step</chdeschd>
+</chhead>
+<chrow><choption>On Linux</choption><chdesc></chdesc></chrow>
+<chrow><choption>On Windows</choption><chdesc></chdesc></chrow>
+</choicetable>
+</step>
+</steps>
+<!--RESULT: Use the <result> tag when you want to provide the user with a result
for 
+the overall task.  You can use the <stepresult> tag if you need to let the user know
about 
+something before they proceed to the next step. This tag is optional. -->
+<result></result>
+<!--EXAMPLE: Use the <example> tag when you want to provide an example for the 
+entire task. It is better to add short examples within the steps (see substep b) 
+instead of using this tag.  This tag is optional. 
+Alternatively, you can create a reference topic for the example.
+Use a reference topic for your example if your example is really long. 
+-->
+<example></example>
+<!--POSTREQ: Use the <postreq> tag when you want to describe to the user what 
+they can do after they complete this task.  This tag is optional. -->
+<postreq></postreq>
+</taskbody>
+</task>

Propchange: db/derby/docs/trunk/templates/task_template.dita
------------------------------------------------------------------------------
    svn:eol-style = native



Mime
View raw message