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

Author: max.andersen(a)jboss.com Date: 2011-04-07 07:05:32 -0400 (Thu, 07 Apr 2011) New Revision: 30407 Added: trunk/module_template/docs/reference/README trunk/module_template/docs/reference/en-US/ trunk/module_template/docs/reference/en-US/author_group.xml trunk/module_template/docs/reference/en-US/book_info.xml trunk/module_template/docs/reference/en-US/concepts.xml trunk/module_template/docs/reference/en-US/getting_started.xml trunk/module_template/docs/reference/en-US/images/ trunk/module_template/docs/reference/en-US/latest_developments.xml trunk/module_template/docs/reference/en-US/master.xml trunk/module_template/docs/reference/en-US/preface.xml trunk/module_template/docs/reference/en-US/reference.xml trunk/module_template/docs/reference/en-US/revision_history.xml trunk/module_template/docs/reference/en-US/tasks.xml trunk/module_template/docs/reference/en-US/template.ent trunk/module_template/docs/reference/en-US/template.xml trunk/module_template/docs/reference/en-US/troubleshooting.xml trunk/module_template/docs/reference/pom.xml trunk/module_template/docs/reference/publican.cfg Log: committed 'scrubbed' version of isaacs initial doc template Added: trunk/module_template/docs/reference/README =================================================================== --- trunk/module_template/docs/reference/README (rev 0) +++ trunk/module_template/docs/reference/README 2011-04-07 11:05:32 UTC (rev 30407) @@ -0,0 +1,21 @@ +Template for reference guide. + +How to build everything: + mvn install + +Just build just html-single: + mvn -Phtml-single install + + Other profiles: pdf, html, eclipse + + Look for other <profile>'s in parent pom. + +Guidelines: + use lowercase names for filenames to avoid casing issues + on various OS's and to make it easier to search for names/content. + + Comment out chapters/sections that is not correct/actively maintained. + +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 Added: trunk/module_template/docs/reference/en-US/author_group.xml =================================================================== --- trunk/module_template/docs/reference/en-US/author_group.xml (rev 0) +++ trunk/module_template/docs/reference/en-US/author_group.xml 2011-04-07 11:05:32 UTC (rev 30407) @@ -0,0 +1,10 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE authorgroup PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<authorgroup> + <author> + <firstname>Your First Name</firstname> + <surname>Your Surname</surname> + </author> +</authorgroup> + Added: trunk/module_template/docs/reference/en-US/book_info.xml =================================================================== --- trunk/module_template/docs/reference/en-US/book_info.xml (rev 0) +++ trunk/module_template/docs/reference/en-US/book_info.xml 2011-04-07 11:05:32 UTC (rev 30407) @@ -0,0 +1,35 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<bookinfo id="book-template-template"> + <title>Template</title> + <subtitle> + Provides information about the use of the <application>JBoss Developer Studio</application> from a beginners level. + </subtitle> + + <productname>JBoss Developer Studio</productname> + + <productnumber>0.0</productnumber> + + <edition>0.0.0</edition> + + <pubsnumber>0</pubsnumber> + + <abstract> + <para> + The Template for creating new books for <application>JBoss Developer Studio</application> and <application>JBoss Tools</application>. It is intended for developers who wish to document their creations. + </para> + </abstract> + + <corpauthor> + <inlinemediaobject> + <imageobject> + <imagedata fileref="Common_Content/images/title_logo.svg" format="SVG" /> + </imageobject> + </inlinemediaobject> + </corpauthor> + + <xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + + <xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> +</bookinfo> Added: trunk/module_template/docs/reference/en-US/concepts.xml =================================================================== --- trunk/module_template/docs/reference/en-US/concepts.xml (rev 0) +++ trunk/module_template/docs/reference/en-US/concepts.xml 2011-04-07 11:05:32 UTC (rev 30407) @@ -0,0 +1,30 @@ +<?xml version='1.0' encoding='utf-8' ?> + +<chapter id="chap-template-concepts"> + <title>Concepts</title> + <para> + This chapter discusses the underlying concepts behind the Tool. General information is provided here. The rules associated with the implementation of a particular feature or concept should be listed in the relevant section. e.g the requirement to have a zero argument constructor for a persistent class in Hibernate. + </para> + <para> + Begin with a general overview of the basis of the Tool, with a new section for each new concept + </para> + <section id="sect-template-concepts-first_new_concept"> + <title>First new concept</title> + <para> + Concept information. + </para> + <para> + &lt;Link to a task that implements the concept&gt; + </para> + </section> + <section id="sect-template-concepts-second_new_concept"> + <title>Second new concept</title> + <para> + Concept information. + </para> + <para> + &lt;Link to a task that implements the concept&gt; + </para> + </section> +</chapter> + Added: trunk/module_template/docs/reference/en-US/getting_started.xml =================================================================== --- trunk/module_template/docs/reference/en-US/getting_started.xml (rev 0) +++ trunk/module_template/docs/reference/en-US/getting_started.xml 2011-04-07 11:05:32 UTC (rev 30407) @@ -0,0 +1,50 @@ +<?xml version='1.0' encoding='utf-8' ?> + +<chapter id="chap-template-getting_started"> + <title>Getting Started</title> + <para> + The following sections detail the installations required to use The Tool and provide a quick overview + of The Tool and its use. + </para> + <section id="sect-template-getting_started-required_installations"> + <title>Required installations</title> + <para> + The Tool requires the following installations to be present on the user's system: + </para> + <variablelist> + <title>Ensure that the following applications are pre-configured on your system.</title> + <varlistentry> + <term>JBoss Developer Studio x.x.</term> + <listitem> + <para> + <ulink url="https://access.redhat.com/jbossnetwork/restricted/listSoftware.... Developer Studio software downloads</ulink> + </para> + <para> + <ulink url="http://docs.redhat.com/docs/en-US/JBoss_Developer_Studio/index.... Developer Studio documentation</ulink> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Java Development Kit 1.6</term> + <listitem> + <para> + <ulink url="https://cds.sun.com/is-bin/INTERSHOP.enfinity/WFS/CDS-CDS_Devel... Development Kit 1.6 download</ulink> + </para> + <para> + <ulink url="http://java.sun.com/javase/6/webnotes/adoption/adoptionguide.ht... 6 Adoption Guide</ulink> + </para> + </listitem> + </varlistentry> + </variablelist> + </section> + <section id="sect-template-getting_started-quick_start"> + <title>Quick start</title> + <para> + This section should detail a short procedure that will allow a user to become familiar with the tool interface and create a basic project. + </para> + <para> + To gain a greater understanding of the ideas and concepts behind the tool, see &lt;link to concepts section&gt;. For informaiton on further tasks that can be performed, see &lt;link to the tasks section&gt;. + </para> + </section> +</chapter> + Added: trunk/module_template/docs/reference/en-US/latest_developments.xml =================================================================== --- trunk/module_template/docs/reference/en-US/latest_developments.xml (rev 0) +++ trunk/module_template/docs/reference/en-US/latest_developments.xml 2011-04-07 11:05:32 UTC (rev 30407) @@ -0,0 +1,31 @@ +<?xml version='1.0' encoding='utf-8' ?> + +<chapter id="chap-template-latest_developments"> + <title>Latest developments</title> + <para> + The following are new features added to the Tool in release x.x. + </para> + <table frame='all'><title>New features</title> + <tgroup cols='3' align='left' colsep='1' rowsep='1'> + <colspec colname='c1'/> + <colspec colname='c2'/> + <colspec colname='c3'/> + <thead> + <row> + <entry>Feature name</entry> + <entry>Description</entry> + <entry>Further information</entry> + </row> + </thead> + <tbody> + <row> + <entry>Name of the feature</entry> + <entry>Describe new feature, why it's been created</entry> + <entry>Link to task section for new feature and concept section (if it is also a new concept)</entry> + </row> + </tbody> + </tgroup> + + </table> +</chapter> + Added: trunk/module_template/docs/reference/en-US/master.xml =================================================================== --- trunk/module_template/docs/reference/en-US/master.xml (rev 0) +++ trunk/module_template/docs/reference/en-US/master.xml 2011-04-07 11:05:32 UTC (rev 30407) @@ -0,0 +1,53 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3CR3//EN" +"http://www.oasis-open.org/docbook/xml/4.3CR3/docbookx.dtd" + +[<!ENTITY Latest_Developments SYSTEM "Latest_Developments.xml"> +<!ENTITY Getting_Started SYSTEM "Getting_Started.xml"> +<!ENTITY Concepts SYSTEM "Concepts.xml"> +<!ENTITY Tasks SYSTEM "Tasks.xml"> +<!ENTITY Reference SYSTEM "Reference.xml"> +<!ENTITY Troubleshooting SYSTEM "Troubleshooting.xml"> +<!ENTITY Revision_History SYSTEM "Revision_History.xml"> +]> + +<book> + + <bookinfo> + <title>Template</title> + <corpauthor> + <inlinemediaobject> + <imageobject role="fo"> + <imagedata format="PNG" fileref="images/jbosstools_logo.png" /> + </imageobject> + <imageobject role="html"> + <imagedata/> + </imageobject> + </inlinemediaobject> + </corpauthor> + + <author> + <firstname>Your First Name</firstname> + <surname>Your Surname</surname> + </author> + + <copyright> + <year>2011</year> + <holder>JBoss by Red Hat</holder> + </copyright> + <releaseinfo> + Version: x.x.x + </releaseinfo> + + </bookinfo> + + <toc/> + &Latest_Developments; + &Getting_Started; + &Concepts; + &Tasks; + &Reference; + &Troubleshooting; + &Revision_History; + +</book> Added: trunk/module_template/docs/reference/en-US/preface.xml =================================================================== --- trunk/module_template/docs/reference/en-US/preface.xml (rev 0) +++ trunk/module_template/docs/reference/en-US/preface.xml 2011-04-07 11:05:32 UTC (rev 30407) @@ -0,0 +1,16 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!--<!DOCTYPE preface PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "Cloud_Tools_Reference_Guide.ent"> +%BOOK_ENTITIES; +]> --> +<preface id="pref-cloud_tools_reference_guide-preface"> + <title>Preface</title> + <para> + This manual uses several conventions to highlight certain words and phrases and draw attention to specific pieces of information. To get more information on these conventions please refer to the <guilabel>Document Conventions</guilabel> manual, which can be found on the <ulink url="http://docs.redhat.com/docs/en-US/JBoss_Developer_Studio/index.... Hat Documentation</ulink> website under the <guilabel>JBoss Developer Studio</guilabel> section. + </para> + <!--<xi:include href="Common_Content/Conventions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"><xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"><xi:include href="Common_Content/Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + </xi:fallback> + </xi:include>--> +</preface> + Added: trunk/module_template/docs/reference/en-US/reference.xml =================================================================== --- trunk/module_template/docs/reference/en-US/reference.xml (rev 0) +++ trunk/module_template/docs/reference/en-US/reference.xml 2011-04-07 11:05:32 UTC (rev 30407) @@ -0,0 +1,135 @@ +<?xml version='1.0' encoding='utf-8' ?> + +<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. + </para> + <section id="sect-template-reference-wizards"> + <title>Wizards</title> + <para> + Explain what a wizard is in one paragraph + </para> + <section id="sect-template-reference-wizards-wizard_one"> + <title>Wizard one</title> + <para> + Placeholder text + </para> + </section> + <section id="sect-template-reference-wizards-wizard_two"> + <title>Wizard two</title> + <para> + Placeholder text + </para> + </section> + </section> + <section id="sect-template-reference-perspectives"> + <title>Perspectives</title> + <para> + Explain what a perspective is in one paragraph + </para> + <section id="sect-template-reference-perspectives-perspective_one"> + <title>Perspective one</title> + <para> + Placeholder text + </para> + </section> + <section id="sect-template-reference-perspectives-perspective_two"> + <title>Perspective two</title> + <para> + Placeholder text + </para> + </section> + </section> + <section id="sect-template-reference-views"> + <title>Views</title> + <para> + Explain what a view is in one paragraph + </para> + <section id="sect-template-reference-views-view_one"> + <title>View one</title> + <para> + Placeholder text + </para> + </section> + <section id="sect-template-reference-views-view_two"> + <title>View two</title> + <para> + Placeholder text + </para> + </section> + </section> + <section id="sect-template-reference-editors"> + <title>Views</title> + <para> + Explain what an editor is in one paragraph + </para> + <section id="sect-template-reference-editors-editor_one"> + <title>Editor one</title> + <para> + Placeholder text + </para> + </section> + <section id="sect-template-reference-editors-editor_two"> + <title>Editor two</title> + <para> + Placeholder text + </para> + </section> + </section> + <section id="sect-template-reference-preference_pages"> + <title>Preference pages</title> + <para> + Explain what preference pages are in one paragraph + </para> + <section id="sect-template-reference-preference_pages-preference_page_one"> + <title>Preference page one</title> + <para> + Placeholder text + </para> + </section> + <section id="sect-template-reference-preference_pages-preference_page_two"> + <title>Preference page two</title> + <para> + Placeholder text + </para> + </section> + </section> + <section id="sect-template-reference-dialogs"> + <title>Dialogs</title> + <para> + Explain what a dialog is in one paragraph + </para> + <section id="sect-template-reference-dialogs-dialog_one"> + <title>Dialog one</title> + <para> + Placeholder text + </para> + </section> + <section id="sect-template-reference-dialogs-dialog_two"> + <title>Dialog two</title> + <para> + Placeholder text + </para> + </section> + </section> + <section id="sect-template-reference-icons_and_buttons"> + <title>Icons and Buttons</title> + <para> + Explain what icons and buttons are in one paragraph + </para> + <section id="sect-template-reference-icons_and_buttons-icons_and_buttons_set_one"> + <title>Icons and Buttons set one</title> + <para> + Placeholder text + </para> + </section> + <section id="sect-template-reference-icons_and_buttons-icons_and_buttons_set_two"> + <title>Icons and Buttons set two</title> + <para> + Placeholder text + </para> + </section> + </section> +</chapter> + Added: trunk/module_template/docs/reference/en-US/revision_history.xml =================================================================== --- trunk/module_template/docs/reference/en-US/revision_history.xml (rev 0) +++ trunk/module_template/docs/reference/en-US/revision_history.xml 2011-04-07 11:05:32 UTC (rev 30407) @@ -0,0 +1,27 @@ +<?xml version='1.0' encoding='utf-8' ?> + +<appendix id="appe-beginners_guide-revision_history"> + <title>Revision History</title> + <simpara> + <revhistory> + <revision> + <!-- Incremental --> + <revnumber>0</revnumber> + + <!-- Date example --> + <!-- <date>Tue Apr 05 2011</date> --> + <date>ddd mmm dd yyyy</date> + <author> + <firstname>Your First Name</firstname> + <surname>Your Surname</surname> + </author> + <revdescription> + <simplelist> + <member>Description of update here (or of first creation so we know how old a book is)</member> + </simplelist> + </revdescription> + </revision> + </revhistory> + </simpara> +</appendix> + Added: trunk/module_template/docs/reference/en-US/tasks.xml =================================================================== --- trunk/module_template/docs/reference/en-US/tasks.xml (rev 0) +++ trunk/module_template/docs/reference/en-US/tasks.xml 2011-04-07 11:05:32 UTC (rev 30407) @@ -0,0 +1,45 @@ +<?xml version='1.0' encoding='utf-8' ?> + +<chapter id="chap-template-tasks"> + <title>Tasks</title> + <para> + This chapter discusses the numerous tasks used to achieve some of the more common goals. + </para> + <section id="sect-template-tasks-general_tasks"> + <title>General tasks</title> + <para> + These tasks are not related to any specific concept discussed in the Concepts section. + </para> + <section id="sect-template-tasks-general_tasks-task_one"> + <title>Task one</title> + <para> + First task in this section + </para> + </section> + <section id="sect-template-tasks-general_tasks-task_two"> + <title>Task two</title> + <para> + Second task in this section + </para> + </section> + </section> + <section id="sect-template-tasks-concept_name_tasks"> + <title>Concept name tasks</title> + <para> + These tasks are related to a specific concept discussed in the Concepts section. + </para> + <section id="sect-template-tasks-concept_name_tasks-task_one"> + <title>Task one</title> + <para> + First task in this section + </para> + </section> + <section id="sect-template-tasks-concept_name_tasks-task_two"> + <title>Task two</title> + <para> + Second task in this section + </para> + </section> + </section> +</chapter> + Added: trunk/module_template/docs/reference/en-US/template.ent =================================================================== --- trunk/module_template/docs/reference/en-US/template.ent (rev 0) +++ trunk/module_template/docs/reference/en-US/template.ent 2011-04-07 11:05:32 UTC (rev 30407) @@ -0,0 +1,4 @@ +<!ENTITY PRODUCT "JBoss"> +<!ENTITY BOOKID "Template"> +<!ENTITY YEAR "2011"> +<!ENTITY HOLDER "Red Hat"> Added: trunk/module_template/docs/reference/en-US/template.xml =================================================================== --- trunk/module_template/docs/reference/en-US/template.xml (rev 0) +++ trunk/module_template/docs/reference/en-US/template.xml 2011-04-07 11:05:32 UTC (rev 30407) @@ -0,0 +1,15 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<book> + <xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="Preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="Latest_Developments.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="Getting_Started.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="Concepts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="Tasks.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="Reference.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="Troubleshooting.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> +</book> + Added: trunk/module_template/docs/reference/en-US/troubleshooting.xml =================================================================== --- trunk/module_template/docs/reference/en-US/troubleshooting.xml (rev 0) +++ trunk/module_template/docs/reference/en-US/troubleshooting.xml 2011-04-07 11:05:32 UTC (rev 30407) @@ -0,0 +1,21 @@ +<?xml version='1.0' encoding='utf-8' ?> + +<chapter id="chap-template-troubleshooting"> + <title>Troubleshooting</title> + <para> + The following sections list the error messages and warnings that may be encountered. + </para> + <section id="sect-template-troubleshooting-error_messages"> + <title>Error messages</title> + <para> + Information concerning error messages displayed by the tool. + </para> + </section> + <section id="sect-template-troubleshooting-warning_messages"> + <title>Warning messages</title> + <para> + Information concerning warning messages displayed by the tool. + </para> + </section> +</chapter> + Added: trunk/module_template/docs/reference/pom.xml =================================================================== --- trunk/module_template/docs/reference/pom.xml (rev 0) +++ trunk/module_template/docs/reference/pom.xml 2011-04-07 11:05:32 UTC (rev 30407) @@ -0,0 +1,23 @@ +<?xml version="1.0" encoding="utf-8"?> +<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> + + <modelVersion>4.0.0</modelVersion> + <parent> + <relativePath>../../../documentation/parent/pom.xml</relativePath> + <groupId>org.jboss.tools</groupId> + <artifactId>org.jboss.tools.documentation.parent.pom</artifactId> + <version>1.0.0-SNAPSHOT</version> + </parent> + + <groupId>org.jboss.tools.template.documentation</groupId> + <artifactId>${docname}-${translation}</artifactId> + <version>1.0</version> + <packaging>jdocbook</packaging> + <name>${bookname}-(${translation})</name> + + <properties> + <docname>template_reference</docname> + <bookname>template_refeerence</bookname> + </properties> + +</project> Added: trunk/module_template/docs/reference/publican.cfg =================================================================== --- trunk/module_template/docs/reference/publican.cfg (rev 0) +++ trunk/module_template/docs/reference/publican.cfg 2011-04-07 11:05:32 UTC (rev 30407) @@ -0,0 +1,9 @@ +# Config::Simple 4.59 +# Fri Nov 27 08:57:18 2009 + +xml_lang: en-US +type: Book +brand: JBoss +debug: 1 + +