[jboss-svn-commits] JBL Code SVN: r34183 - in labs/jbossrules/trunk/drools-docs: drools-docs-guvnor/src/main/docbook/en-US/Chapter-Guvnor and 2 other directories.
jboss-svn-commits at lists.jboss.org
jboss-svn-commits at lists.jboss.org
Mon Jul 26 08:30:46 EDT 2010
Author: ge0ffrey
Date: 2010-07-26 08:30:46 -0400 (Mon, 26 Jul 2010)
New Revision: 34183
Modified:
labs/jbossrules/trunk/drools-docs/doc-authoring-guideline-and-cheatsheet.txt
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-integration/src/main/docbook/en-US/Chapter-Camel/Section-API/Section-CamelRoutesCreation.xml
labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Camel/Section-API/Section-CreatingDroolsCommands.xml
labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Camel/Section-API/Section-SendingMessagesExchanges.xml
labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Server/Section-Configuration/Section-Configuration.xml
Log:
<note>, <caution>, etc should always have a <para> or another element
Modified: labs/jbossrules/trunk/drools-docs/doc-authoring-guideline-and-cheatsheet.txt
===================================================================
--- labs/jbossrules/trunk/drools-docs/doc-authoring-guideline-and-cheatsheet.txt 2010-07-26 12:21:22 UTC (rev 34182)
+++ labs/jbossrules/trunk/drools-docs/doc-authoring-guideline-and-cheatsheet.txt 2010-07-26 12:30:46 UTC (rev 34183)
@@ -33,18 +33,19 @@
Marking paragraphs
------------------
-* <caution><para></para></caution>
+* You can encapsulate a paragraph or more in note, tip, 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).
-* <important><para></para></important>
-
-* <note><para></para></note>
-
-* <tip><para></para></tip>
-
-* <warning><para></para></warning>
-
* Use <programlisting> for longer code, commands or log listings:
<programlisting><![CDATA[public interface Move ...]]></programlisting>
+ Do not use <programlisting> inside <para> as it is a paragraph style
+ (which gives code coloring bugs).
* Use <programlisting role="JAVA"> for java code to get color highlighting.
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-07-26 12:21:22 UTC (rev 34182)
+++ labs/jbossrules/trunk/drools-docs/drools-docs-guvnor/src/main/docbook/en-US/Chapter-Guvnor/Section-UserGuide.xml 2010-07-26 12:30:46 UTC (rev 34183)
@@ -1694,8 +1694,8 @@
to click any button, and the errors/warnings are shown in a more
fashionable way!</para>
- <caution>The problem with real-time validation is that right now only
- support "top level" Patterns.</caution>
+ <caution><para>The problem with real-time validation is that right now only
+ support "top level" Patterns.</para></caution>
</section>
Modified: labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Camel/Section-API/Section-CamelRoutesCreation.xml
===================================================================
--- labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Camel/Section-API/Section-CamelRoutesCreation.xml 2010-07-26 12:21:22 UTC (rev 34182)
+++ labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Camel/Section-API/Section-CamelRoutesCreation.xml 2010-07-26 12:30:46 UTC (rev 34183)
@@ -49,6 +49,6 @@
consumer, which in this case will process the XML command.</para>
<note>
- Bear in mind that when you send a XML command to a route, the format must the same as the dataFormat transformer used in the route creation.
+ <para>Bear in mind that when you send a XML command to a route, the format must the same as the dataFormat transformer used in the route creation.</para>
</note>
</section>
Modified: labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Camel/Section-API/Section-CreatingDroolsCommands.xml
===================================================================
--- labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Camel/Section-API/Section-CreatingDroolsCommands.xml 2010-07-26 12:21:22 UTC (rev 34182)
+++ labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Camel/Section-API/Section-CreatingDroolsCommands.xml 2010-07-26 12:30:46 UTC (rev 34183)
@@ -77,7 +77,7 @@
<para>In the next sections you will see how to marshall/unmarshall the
commands to XML to XStream and JAXB</para>
- <para><note>
- For more information check the Drools Commands documentation
- </note></para>
+ <note>
+ <para>For more information check the Drools Commands documentation</para>
+ </note>
</section>
Modified: labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Camel/Section-API/Section-SendingMessagesExchanges.xml
===================================================================
--- labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Camel/Section-API/Section-SendingMessagesExchanges.xml 2010-07-26 12:21:22 UTC (rev 34182)
+++ labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Camel/Section-API/Section-SendingMessagesExchanges.xml 2010-07-26 12:30:46 UTC (rev 34183)
@@ -139,7 +139,7 @@
<para></para>
<note>
- The XML output conversion is not required, but is recommended to have a more legible data output.
+ <para>The XML output conversion is not required, but is recommended to have a more legible data output.</para>
</note>
<para></para>
Modified: labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Server/Section-Configuration/Section-Configuration.xml
===================================================================
--- labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Server/Section-Configuration/Section-Configuration.xml 2010-07-26 12:21:22 UTC (rev 34182)
+++ labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Server/Section-Configuration/Section-Configuration.xml 2010-07-26 12:30:46 UTC (rev 34183)
@@ -178,7 +178,7 @@
<drools-service:startup-command/></programlisting></para>
<note>
- Remember to add the <![CDATA[ ]]> tag to don't break the XML parser.
+ <para>Remember to add the <![CDATA[ ]]> tag to don't break the XML parser.</para>
</note>
</section>
More information about the jboss-svn-commits
mailing list