[jboss-svn-commits] JBL Code SVN: r34436 - in labs/jbossrules/trunk/drools-docs: drools-docs-fusion/src/main/docbook/en-US/Chapter-Features/Chapter-TemporalReasoning and 1 other directories.
jboss-svn-commits at lists.jboss.org
jboss-svn-commits at lists.jboss.org
Mon Aug 2 03:12:08 EDT 2010
Author: ge0ffrey
Date: 2010-08-02 03:12:08 -0400 (Mon, 02 Aug 2010)
New Revision: 34436
Modified:
labs/jbossrules/trunk/drools-docs/doc-authoring-guideline-and-cheatsheet.txt
labs/jbossrules/trunk/drools-docs/drools-docs-fusion/src/main/docbook/en-US/Chapter-Features/Chapter-TemporalReasoning/Section-TemporalReasoning_TemporalOperators.xml
labs/jbossrules/trunk/drools-docs/drools-docs-guvnor/src/main/docbook/en-US/Chapter-Guvnor/Section-UserGuide.xml
Log:
replace all <caution> by <warning> (or <important>) as stipulated by the JBoss Documentation Guide.
Modified: labs/jbossrules/trunk/drools-docs/doc-authoring-guideline-and-cheatsheet.txt
===================================================================
--- labs/jbossrules/trunk/drools-docs/doc-authoring-guideline-and-cheatsheet.txt 2010-08-02 05:20:06 UTC (rev 34435)
+++ labs/jbossrules/trunk/drools-docs/doc-authoring-guideline-and-cheatsheet.txt 2010-08-02 07:12:08 UTC (rev 34436)
@@ -3,6 +3,8 @@
External documentation
----------------------
+
+JBoss Documentation Guide: http://jboss.org/pressgang/jdg.html (a must read from chapter 6: Structure guidelines)
JDocBook plugin: http://docs.jboss.org/docbook/userguide/html_single/index.html
DocBook: http://www.docbook.org/tdg5/en/html/docbook.html
http://www.sagehill.net/docbookxsl/
@@ -33,14 +35,13 @@
Marking paragraphs
------------------
-* You can encapsulate a paragraph or more in note, tip, etc:
+* You can encapsulate a paragraph or more in note, warning, etc:
<note><para></para></note>
- <tip><para></para></tip>
- <caution><para></para></caution>
<warning><para></para></warning>
<important><para></para></important>
Always use one or more <para>'s (or other elements) inside it,
never write text directly (which gives visual bugs).
+ Note: the JBoss Documentation Guide disallow the use of <caution> and <tip>
* Use <programlisting> for longer code, commands or log listings:
<programlisting><![CDATA[public interface Move ...]]></programlisting>
Modified: labs/jbossrules/trunk/drools-docs/drools-docs-fusion/src/main/docbook/en-US/Chapter-Features/Chapter-TemporalReasoning/Section-TemporalReasoning_TemporalOperators.xml
===================================================================
--- labs/jbossrules/trunk/drools-docs/drools-docs-fusion/src/main/docbook/en-US/Chapter-Features/Chapter-TemporalReasoning/Section-TemporalReasoning_TemporalOperators.xml 2010-08-02 05:20:06 UTC (rev 34435)
+++ labs/jbossrules/trunk/drools-docs/drools-docs-fusion/src/main/docbook/en-US/Chapter-Features/Chapter-TemporalReasoning/Section-TemporalReasoning_TemporalOperators.xml 2010-08-02 07:12:08 UTC (rev 34436)
@@ -164,10 +164,10 @@
<programlisting>abs( $eventA.startTimestamp - $eventB.startTimestamp ) <= 15s &&
abs( $eventA.endTimestamp - $eventB.endTimestamp ) <= 10s </programlisting>
- <caution>
+ <warning>
<para>It makes no sense to use negative interval values for the
parameters and the engine will raise an error if that happens.</para>
- </caution>
+ </warning>
</section>
<section>
@@ -271,10 +271,10 @@
<programlisting>$eventB.startTimestamp < $eventA.startTimestamp &&
abs( $eventA.endTimestamp - $eventB.endTimestamp ) <= 5s </programlisting>
- <caution>
+ <warning>
<para>It makes no sense to use a negative interval value for the
parameter and the engine will raise an exception if that happens.</para>
- </caution>
+ </warning>
</section>
<section>
@@ -309,10 +309,10 @@
<programlisting>$eventA.startTimestamp < $eventB.startTimestamp &&
abs( $eventA.endTimestamp - $eventB.endTimestamp ) <= 5s </programlisting>
- <caution>
+ <warning>
<para>It makes no sense to use a negative interval value for the
parameter and the engine will raise an exception if that happens.</para>
- </caution>
+ </warning>
</section>
<section>
@@ -414,10 +414,10 @@
<programlisting>abs( $eventB.startTimestamp - $eventA.endTimestamp) <= 5s </programlisting>
- <caution>
+ <warning>
<para>It makes no sense to use a negative interval value for the
parameter and the engine will raise an exception if that happens.</para>
- </caution>
+ </warning>
</section>
<section>
@@ -449,10 +449,10 @@
<programlisting>abs( $eventA.startTimestamp - $eventB.endTimestamp) <= 5s </programlisting>
- <caution>
+ <warning>
<para>It makes no sense to use a negative interval value for the
parameter and the engine will raise an exception if that happens.</para>
- </caution>
+ </warning>
</section>
<section>
@@ -590,10 +590,10 @@
<programlisting>abs( $eventA.startTimestamp - $eventB.startTimestamp ) <= 5s &&
$eventA.endTimestamp < $eventB.endTimestamp </programlisting>
- <caution>
+ <warning>
<para>It makes no sense to use a negative interval value for the
parameter and the engine will raise an exception if that happens.</para>
- </caution>
+ </warning>
</section>
<section>
@@ -626,9 +626,9 @@
<programlisting>abs( $eventA.startTimestamp - $eventB.startTimestamp ) <= 5s &&
$eventA.endTimestamp > $eventB.endTimestamp </programlisting>
- <caution>
+ <warning>
<para>It makes no sense to use a negative interval value for the
parameter and the engine will raise an exception if that happens.</para>
- </caution>
+ </warning>
</section>
</section>
Modified: labs/jbossrules/trunk/drools-docs/drools-docs-guvnor/src/main/docbook/en-US/Chapter-Guvnor/Section-UserGuide.xml
===================================================================
--- labs/jbossrules/trunk/drools-docs/drools-docs-guvnor/src/main/docbook/en-US/Chapter-Guvnor/Section-UserGuide.xml 2010-08-02 05:20:06 UTC (rev 34435)
+++ labs/jbossrules/trunk/drools-docs/drools-docs-guvnor/src/main/docbook/en-US/Chapter-Guvnor/Section-UserGuide.xml 2010-08-02 07:12:08 UTC (rev 34436)
@@ -1694,8 +1694,8 @@
to click any button, and the errors/warnings are shown in a more
fashionable way!</para>
- <caution><para>The problem with real-time validation is that right now only
- support "top level" Patterns.</para></caution>
+ <warning><para>The problem with real-time validation is that right now only
+ support "top level" Patterns.</para></warning>
</section>
More information about the jboss-svn-commits
mailing list