[jbosstools-commits] JBoss Tools SVN: r30511 - in trunk/module_template/docs/reference: en-US and 1 other directory.

Tue Apr 12 00:33:12 EDT 2011

Author: irooskov at redhat.com
Date: 2011-04-12 00:33:12 -0400 (Tue, 12 Apr 2011)
New Revision: 30511

Modified:
   trunk/module_template/docs/reference/README
   trunk/module_template/docs/reference/en-US/latest_developments.xml
   trunk/module_template/docs/reference/en-US/reference.xml
Log:
updated with new info in readme and new code in xml files


Modified: trunk/module_template/docs/reference/README
===================================================================

--- trunk/module_template/docs/reference/README	2011-04-12 04:31:27 UTC (rev 30510)
+++ trunk/module_template/docs/reference/README	2011-04-12 04:33:12 UTC (rev 30511)
@@ -1,21 +1,46 @@
 Template for reference guide.
 
-How to build everything:
- mvn install
+MAVEN:
 
-Just build just html-single:
- mvn -Phtml-single install
+  How to build everything:
+    mvn install or mvn compile
 
- Other profiles: pdf, html, eclipse
+  Just build html-single:
+    mvn -Phtml-single install
 
- Look for other <profile>'s in parent pom.
-   
+  All profiles available: html-single, html, pdf, eclipse
+
+  Look for other <profile>'s in parent pom.
+
+PUBLICAN:
+
+  How to build everything:
+    publican build --formats=html-single,eclipse,html,pdf --langs=en-US
+
+  Just build html-single:
+    publican build --formats=html-single --langs=en-US
+
+  All profiles available: html-single, html, pdf, eclipse
+ 
+
+  
 Guidelines: 
  use lowercase names for filenames to avoid casing issues
  on various OS's and to make it easier to search for names/content.
+ EXCEPTIONS:
+	Book_Info.xml
+	Name_of_book.xml
+	Name_of_book.ent
+ The above files must be mixed case for compatability with Publican
 
- Comment out chapters/sections that is not correct/actively maintained.
+ Comment out chapters/sections that are not correct/actively maintained.
 
+ Code in template is there as a guide of which tags are to be used.
+ Before committing a revision or new content in a book, ensure it
+ is buildable in both Maven and Publican - if you can 
+ (Publican currently available for Linux and Windows 
+ - talk with irooskov at redhat.com if you can assist with testing on Mac). 
+
 Known issues: 
- Translation dependds on ${docname} and other variables
- in artifactid but that is not really supported/recommended by Maven
\ No newline at end of file
+ Translation depends on ${docname} and other variables
+ in artifactid but that is not really supported/recommended by Maven

Modified: trunk/module_template/docs/reference/en-US/latest_developments.xml
===================================================================
--- trunk/module_template/docs/reference/en-US/latest_developments.xml	2011-04-12 04:31:27 UTC (rev 30510)
+++ trunk/module_template/docs/reference/en-US/latest_developments.xml	2011-04-12 04:33:12 UTC (rev 30511)
@@ -1,5 +1,7 @@
 <?xml version='1.0' encoding='utf-8' ?>
 
+   <!-- This chapter only relates to the enterprise version (JBoss Developer Studio), as the community (JBoss Tools) already has their 'What's New' webpage for this information -->
+
 <chapter id="chap-Template-Latest_developments">
 	<title>Latest developments</title>
 	<para>

Modified: trunk/module_template/docs/reference/en-US/reference.xml
===================================================================
--- trunk/module_template/docs/reference/en-US/reference.xml	2011-04-12 04:31:27 UTC (rev 30510)
+++ trunk/module_template/docs/reference/en-US/reference.xml	2011-04-12 04:33:12 UTC (rev 30511)
@@ -3,7 +3,7 @@
 <chapter id="chap-template-reference">
 	<title>Reference</title>
 	<para>
-		This section should detail the actual screen and interface that a user interacts with. For instance, if a user is attempting to create a project through a wizard, then each of the screen should be available here, documenting what each section of the screen means. In this way, a user may not be wishing to undertake a perdefined task as mentioned in the task section, but still need assistance with what should go in certain fields and such.
+		This section should detail the actual screen and interface that a user interacts with. For instance, if a user is attempting to create a project through a wizard, then each of the screens should be available here, documenting what each section of the screen means. In this way, a user may not be wishing to undertake a pre-defined task as mentioned in the task section, but still need assistance with what should go in certain fields and such.
 	</para>
 	<section id="sect-template-reference-wizards">
 		<title>Wizards</title>
@@ -15,6 +15,23 @@
 			<para>
 				Placeholder text
 			</para>
+			<!-- ensure that all images are PNG format, with an image size of 96 pixels -->
+			<figure>
+				<title>Title of the screenshot</title>
+				<mediaobject>
+					<imageobject>
+						<imagedata fileref="images/reference/wizard_one/wizard_screenshot_one.png" format="PNG"/>
+					</imageobject>
+					<textobject>
+						<phrase>Alternate text for the visually impared</phrase>
+					</textobject>
+					<caption>
+						<para>
+							Caption referring to the wizard screenshot - if necessary
+						</para>
+					</caption>
+				</mediaobject>
+			</figure>
 		</section>
 		<section id="sect-template-reference-wizards-wizard_two">
 			<title>Wizard two</title>

