[jboss-svn-commits] JBL Code SVN: r34045 - in labs/jbossrules/trunk/drools-docs: drools-docs-expert/src/main/docbook/en-US/Chapter-Rule_Language and 1 other directories.

jboss-svn-commits at lists.jboss.org jboss-svn-commits at lists.jboss.org
Mon Jul 19 14:45:25 EDT 2010 

Author: ge0ffrey
Date: 2010-07-19 14:45:24 -0400 (Mon, 19 Jul 2010)
New Revision: 34045

Modified:
   labs/jbossrules/trunk/drools-docs/doc-authoring-guideline-and-cheatsheet.txt
   labs/jbossrules/trunk/drools-docs/drools-docs-expert/src/main/docbook/en-US/Chapter-Rule_Language/Section-Rule.xml
   labs/jbossrules/trunk/drools-docs/drools-docs-introduction/src/main/docbook/en-US/Chapter-Install/Section-Checkout.xml
   labs/jbossrules/trunk/drools-docs/drools-docs-introduction/src/main/docbook/en-US/Chapter-Install/Section-Eclipse.xml
   labs/jbossrules/trunk/drools-docs/drools-docs-introduction/src/main/docbook/en-US/Chapter-Install/Section-Maven_build.xml
Log:
JBRULES-2581 use command and filename instead of literal where needed

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-19 18:25:22 UTC (rev 34044)
+++ labs/jbossrules/trunk/drools-docs/doc-authoring-guideline-and-cheatsheet.txt	2010-07-19 18:45:24 UTC (rev 34045)
@@ -16,10 +16,12 @@
 
 * Keywords may be enclosed in <kw></kw>, rendered in boldface Courier
 
-* Use <literal> for class names, method names, ...
+* Use <literal> for class names, method names, ...: <literal>Serializable</literal>
 
-* Use <filename> for filenames
+* Use <filename> for directories and filenames: <filename>pom.xml</filename>
 
+* Use <command> for commands: <command>mvn clean install</command>
+
 * Please link svg image files instead of png bitmaps in the text whenever
   possible.
   

Modified: labs/jbossrules/trunk/drools-docs/drools-docs-expert/src/main/docbook/en-US/Chapter-Rule_Language/Section-Rule.xml
===================================================================
--- labs/jbossrules/trunk/drools-docs/drools-docs-expert/src/main/docbook/en-US/Chapter-Rule_Language/Section-Rule.xml	2010-07-19 18:25:22 UTC (rev 34044)
+++ labs/jbossrules/trunk/drools-docs/drools-docs-expert/src/main/docbook/en-US/Chapter-Rule_Language/Section-Rule.xml	2010-07-19 18:45:24 UTC (rev 34045)
@@ -734,9 +734,8 @@
               <title>soundslike</title>
 
               <para>Similar to <literal>'matches'</literal>, but checks if a word has
-              almost the same sound as the given value. Uses the 'Soundex'
-              algorithm
-              (<literal>http://en.wikipedia.org/wiki/Soundex</literal>).</para>
+              almost the same sound as the given value. Uses the
+              <link xlink:href="http://en.wikipedia.org/wiki/Soundex">Soundex</link> algorithm.</para>
 
               <example>
                 <title>Text with soundslike (Sounds Like)</title>

Modified: labs/jbossrules/trunk/drools-docs/drools-docs-introduction/src/main/docbook/en-US/Chapter-Install/Section-Checkout.xml
===================================================================
--- labs/jbossrules/trunk/drools-docs/drools-docs-introduction/src/main/docbook/en-US/Chapter-Install/Section-Checkout.xml	2010-07-19 18:25:22 UTC (rev 34044)
+++ labs/jbossrules/trunk/drools-docs/drools-docs-introduction/src/main/docbook/en-US/Chapter-Install/Section-Checkout.xml	2010-07-19 18:45:24 UTC (rev 34045)
@@ -100,7 +100,7 @@
   <para>Although, we highly recommend command line tools to work with repository you can also use both Eclipse's integrated SVN client or TortoiseSVN</para> 
 
   <para>Setup TortoiseSVN to checkout from the subversion repository and click
-  <literal>'OK'</literal> Once the checkout has finished you should see the
+  <literal>OK</literal>. Once the checkout has finished you should see the
   folders as shown below.</para>
 
   <screenshot>

Modified: labs/jbossrules/trunk/drools-docs/drools-docs-introduction/src/main/docbook/en-US/Chapter-Install/Section-Eclipse.xml
===================================================================
--- labs/jbossrules/trunk/drools-docs/drools-docs-introduction/src/main/docbook/en-US/Chapter-Install/Section-Eclipse.xml	2010-07-19 18:25:22 UTC (rev 34044)
+++ labs/jbossrules/trunk/drools-docs/drools-docs-introduction/src/main/docbook/en-US/Chapter-Install/Section-Eclipse.xml	2010-07-19 18:45:24 UTC (rev 34045)
@@ -55,7 +55,7 @@
       </mediaobject>
     </screenshot>
 
-    <para>When calling <literal>'mvn install'</literal> all the project
+    <para>When calling <command>mvn install</command> all the project
     dependencies were downloaded and added to the local Maven repository.
     Eclipse cannot find those dependencies unless you tell it where that
     repository is. To do this setup an M2_REPO classpath variable.</para>

Modified: labs/jbossrules/trunk/drools-docs/drools-docs-introduction/src/main/docbook/en-US/Chapter-Install/Section-Maven_build.xml
===================================================================
--- labs/jbossrules/trunk/drools-docs/drools-docs-introduction/src/main/docbook/en-US/Chapter-Install/Section-Maven_build.xml	2010-07-19 18:25:22 UTC (rev 34044)
+++ labs/jbossrules/trunk/drools-docs/drools-docs-introduction/src/main/docbook/en-US/Chapter-Install/Section-Maven_build.xml	2010-07-19 18:45:24 UTC (rev 34045)
@@ -43,7 +43,7 @@
 
     <para>As maven builds each module it will install the resulting jars in
     the local Maven 2 repository automatically. Where it can be easily used
-    from other project <literal>pom.xml</literal> or copied else where.</para>
+    from other project <filename>pom.xml</filename> or copied else where.</para>
 
     <screenshot>
       <info>Installed Drools Jars</info>
@@ -92,10 +92,10 @@
       </listitem>
     </itemizedlist>
 
-    <para>The manual can be generated from the project pom.xml by
-    calling <literal>'mvn package'</literal> in the drools-docs directory or adding the -Ddocumentation switch when you build the sources.
-    Documentation is generated into each drools-docs subdirectory's <literal>'target/'</literal> directory. Running <literal>'mvn -Ddocumentation package assembly:assembly'</literal>
-    in the Drools project root generates and copies the documentation into a zip file. This zip file is located in the root folders <literal>'target/'</literal>
+    <para>The manual can be generated from the project <filename>pom.xml</filename> by
+    calling <command>mvn package</command> in the drools-docs directory or adding the -Ddocumentation switch when you build the sources.
+    Documentation is generated into each drools-docs subdirectory's <filename>target/</filename> directory. Running <command>mvn -Ddocumentation package assembly:assembly</command>
+    in the Drools project root generates and copies the documentation into a zip file. This zip file is located in the root folders <filename>target/</filename>
     directory.
 
     <programlisting>[trikkola at trikkola trunk]$ mvn -Ddocumentation clean package assembly:assembly
@@ -197,7 +197,7 @@
 [INFO] ------------------------------------------------------------------------&gt;</programlisting>
     </para>
     <para>The generated manual can be found in the
-    <literal>target\drools-docs$VERSION.jar'</literal> file, a compressed archive with all formats.</para>
+    <filename>target/drools-docs-$VERSION.jar</filename> file, a compressed archive with all formats.</para>
 
   </section>

More information about the jboss-svn-commits mailing list