[jbosstools-issues] [JBoss JIRA] Created: (TOOLSDOC-134) Moving Typographical conventions into a seperate book for JBDS

[Isaac Rooskov (JIRA)]

Moving Typographical conventions into a seperate book for JBDS
--------------------------------------------------------------

                 Key: TOOLSDOC-134
                 URL: https://issues.jboss.org/browse/TOOLSDOC-134
             Project: Documentation for JBoss Tools and Developer Studio
          Issue Type: Task
      Security Level: Public (Everyone can see)
          Components: General documentation issues
            Reporter: Max Andersen
            Assignee: Matthew Casperson
            Priority: Critical
             Fix For: 3.2.0.Final


We need to shorten the Preface chapter content in the front-matter of our books (from a usability standpoint). To do this we will be separating the typographic convention information into a new book on its own, and referring to it in the Preface for each book.

To do this undertake the following:

To remove, just comment out the following
in Preface.xml:

<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="Common_Content/Conventions.xml">
     <xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude">
       <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="fallback_content/Conventions.xml"/>
     </xi:fallback>
</xi:include>

1. Make a book called "JBoss Developer Studio Documentation Typographic
Conventions".

2. Put the Typographic Conventions in it and nothing else.

3. Publish the book.

4. Write a new Preface.xml for all the other JBDS books.

5. Mention the Typographic Conventions book in the new Preface.xml as the place readers should go to for the convention information.

Be sure not to actually place a hard url link to the new typographic conventions book as if the location ever changes all the links will become useless and it presents a huge maintenance issue. When referring to any other book (ever), refer to it by name and users will find it in the list of JBDS books for the release. 

When you create the book, store it in the SVN repo for JBT in the documentation/guides folder with the release notes, beginners guide etc...

Note: I have made Max the reporter of this issue as it originally came out of his query on the issue. 

Note 2: Make sure to note the creation of this new book and the reasoning for it as a release note for JBDS 4.0

Thanks, 

Isaac


-- 
This message is automatically generated by JIRA.
-
For more information on JIRA, see: http://www.atlassian.com/software/jira