You are viewing a plain text version of this content. The canonical link for it is here.
Posted to derby-commits@db.apache.org by fu...@apache.org on 2006/11/16 02:19:56 UTC
svn commit: r475517 - in /db/derby/docs/trunk/templates:
concept_template.dita reference_template.dita task_template.dita
Author: fuzzylogic
Date: Wed Nov 15 17:19:55 2006
New Revision: 475517
URL: http://svn.apache.org/viewvc?view=rev&rev=475517
Log:
DERBY-2088: Add comment about changing reference IDs.
Committed for Laura Stewart <sc...@gmail.com>
Modified:
db/derby/docs/trunk/templates/concept_template.dita
db/derby/docs/trunk/templates/reference_template.dita
db/derby/docs/trunk/templates/task_template.dita
Modified: db/derby/docs/trunk/templates/concept_template.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/templates/concept_template.dita?view=diff&rev=475517&r1=475516&r2=475517
==============================================================================
--- db/derby/docs/trunk/templates/concept_template.dita (original)
+++ db/derby/docs/trunk/templates/concept_template.dita Wed Nov 15 17:19:55 2006
@@ -1,5 +1,4 @@
<?xml version="1.0" encoding="utf-8"?>
-<!--Arbortext, Inc., 1988-2005, v.4002-->
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN"
"../dtd/concept.dtd">
<!--
@@ -18,6 +17,14 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
+<!--##### DO NOT CHANGE ANYTHING ABOVE THIS LINE #####-->
+<!--CONCEPT_ID: When you use this template to create a new concept topic,
+you must edit the concept id and change "concept_template" to whatever the topic
+filename is. For example, if the topic filename is crefoverview.dita,
+then the concept id should be
+concept id="crefoverview"
+instead of
+concept id="concept_template"-->
<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
Modified: db/derby/docs/trunk/templates/reference_template.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/templates/reference_template.dita?view=diff&rev=475517&r1=475516&r2=475517
==============================================================================
--- db/derby/docs/trunk/templates/reference_template.dita (original)
+++ db/derby/docs/trunk/templates/reference_template.dita Wed Nov 15 17:19:55 2006
@@ -1,5 +1,4 @@
<?xml version="1.0" encoding="utf-8"?>
-<!--Arbortext, Inc., 1988-2005, v.4002-->
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
"../dtd/reference.dtd">
<!--
@@ -18,6 +17,14 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
+<!--##### DO NOT CHANGE ANYTHING ABOVE THIS LINE #####-->
+<!--REFERENCE_ID: When you use this template to create a new reference topic,
+you must edit the reference id and change "reference_template" to whatever the topic
+filename is. For example, if the topic filename is rrefstatement.dita,
+then the reference id should be
+reference id="rrefstatement"
+instead of
+reference id="reference_template"-->
<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
@@ -60,24 +67,21 @@
<!--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>
+<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>
+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.-->
+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*"/>
+<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>
@@ -103,15 +107,12 @@
</row>
</tbody>
</tgroup>
-</table>
-<!--NOTES: Use the <note> tag when you want to insert information, differentiated
+</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>
+This tag is optional.--> <note type="important"> </note> </section>
</refbody>
</reference>
Modified: db/derby/docs/trunk/templates/task_template.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/templates/task_template.dita?view=diff&rev=475517&r1=475516&r2=475517
==============================================================================
--- db/derby/docs/trunk/templates/task_template.dita (original)
+++ db/derby/docs/trunk/templates/task_template.dita Wed Nov 15 17:19:55 2006
@@ -1,5 +1,4 @@
<?xml version="1.0" encoding="utf-8"?>
-<!--Arbortext, Inc., 1988-2005, v.4002-->
<!DOCTYPE task PUBLIC "-//OASIS//DTD DITA Task//EN"
"../dtd/task.dtd">
<!--
@@ -18,13 +17,21 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
+<!--##### DO NOT CHANGE ANYTHING ABOVE THIS LINE #####-->
+<!--TASK ID: When you use this template to create a new task topic,
+you must edit the task id and change "task_template" to whatever the topic
+filename is. For example, if the topic filename is treftask.dita,
+then the task id should be
+task id="treftask"
+instead of
+task id="task_template"-->
+<task id="task_template" xml:lang="en-us">
<!--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.-->