User development, The document "Jboss Tools/JBDS guides structure", was updated Jan 20, 2010 by Max Andersen.
To view the document, visit: http://community.jboss.org/docs/DOC-14510#cf Document: -------------------------------------------------------------- While creating a new or updating already existed JBoss Tools/JBDS guide, please keep to the following structure (JBoss Portlet Tools User Guide structure as an example): 1. Introduction 1.1. What is JBoss Portal and Portlet Tools? 1.2. Key Features of JBoss Portlet Tools 1.3. Requirements and Installation 2. JBoss Portlet Tools Tasks 2.1. Creating and Deploying a Java Portlet 2.1.1. Creating a Web Project with JBoss Portlet Capabilities 2.1.2. Adding a Java Portlet to a Web Project 2.1.3. Deploying a Portlet to JBoss Portal 2.2. Creating and Deploying a JSF Portlet 2.2.1. Creating a JSF Project with JSF Portlet Capabilities 2.2.2. Adding a JSF Protlet to the Project and Deploying It to JBoss Portal 2.3. Creating and Deploying a Seam Portlet 2.3.1. Creating a Seam Project with Seam Portlet Capabilities 2.3.2. Adding a Seam Protlet to the Project and Deploying It to JBoss Portal 3. Reference 3.1. JBoss Portlet Descriptors 3.2. Wizards 3.2.1. Java Portlet Wizard 3.2.2. JSF/Seam Portlet Wizard 3.3. JBoss Portlet Preferences 4. Summary 4.1. Other Relevant Resources on the Topic * * *Comments:* * The "Key Features of [plugin name]" section should contain the table included key features (wizards, editors, tasks, etc.) of the plugin you're describing with short descriptions and references to the appropriate guide section. * The "Requirements and Installation" section should provide minimal requirements on the environment the plugin needs and installation procedure (or reference to it). * All procedural operations must be put into the "[plugin name] Tasks" chapter. Each section of the chapter is a tutorial on a particular topic. * The referential data should be stored in the "Reference" chapter. * Remember to summarize the results and provide the links to other relevent resources in the "Summary" chapter. --------------------------------------------------------------
_______________________________________________ jboss-user mailing list [email protected] https://lists.jboss.org/mailman/listinfo/jboss-user
