Author: irooskov(a)redhat.com
Date: 2011-06-20 00:32:36 -0400 (Mon, 20 Jun 2011)
New Revision: 32185
Modified:
trunk/portlet/docs/reference/en-US/Book_Info.xml
trunk/portlet/docs/reference/en-US/Feedback.xml
trunk/portlet/docs/reference/en-US/JBoss_Portlet_Tools_User_Guide.ent
trunk/portlet/docs/reference/en-US/JBoss_Portlet_Tools_User_Guide.xml
trunk/portlet/docs/reference/en-US/Preface.xml
trunk/portlet/docs/reference/en-US/intro.xml
Log:
updated with new Feedback file and JBDS 4.1.0 branding
Modified: trunk/portlet/docs/reference/en-US/Book_Info.xml
===================================================================
--- trunk/portlet/docs/reference/en-US/Book_Info.xml 2011-06-20 04:29:07 UTC (rev 32184)
+++ trunk/portlet/docs/reference/en-US/Book_Info.xml 2011-06-20 04:32:36 UTC (rev 32185)
@@ -5,9 +5,9 @@
<title>JBoss Portlet Tools User Guide</title>
<subtitle>Provides information relating to the JBoss Portlet Tools
set.</subtitle>
<productname>JBoss Developer Studio</productname>
- <productnumber>4.0</productnumber>
- <edition>4.0.0</edition>
- <pubsnumber>6</pubsnumber>
+ <productnumber>4.1</productnumber>
+ <edition>4.1.0</edition>
+ <pubsnumber>1</pubsnumber>
<abstract>
<para>The JBoss Portlet Tools User Guide explains how to begin with and manage
JBoss Portlet Tools.</para>
</abstract>
Modified: trunk/portlet/docs/reference/en-US/Feedback.xml
===================================================================
--- trunk/portlet/docs/reference/en-US/Feedback.xml 2011-06-20 04:29:07 UTC (rev 32184)
+++ trunk/portlet/docs/reference/en-US/Feedback.xml 2011-06-20 04:32:36 UTC (rev 32185)
@@ -1,20 +1,92 @@
<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "../Document_Conventions.ent">
+%BOOK_ENTITIES;
+]>
+<appendix id="sect_JBoss-Getting_Help_and_Giving_Feedback"
lang="en-US">
+ <title>Getting Help and Giving Feedback</title>
+ <section id="sect_JBoss-Do_You_Need_Help">
+ <title>Do You Need Help?</title>
+ <indexterm>
+ <primary>help</primary>
+ <secondary>getting help</secondary>
-<section id="sect-Beginners_Guide-We_Need_Feedback"
lang="en-US">
- <title>We Need Feedback!</title>
- <indexterm>
- <primary>feedback</primary>
- <secondary>contact information for this manual</secondary>
- </indexterm>
- <para>
- If you find a typographical error in this manual, or if you have thought of a way to
make this manual better, we would love to hear from you! Please submit a report in JIRA
against JBoss Developer Studio: <ulink
url="https://jira.jboss.org/jira/secure/CreateIssue.jspa?pid=1231050...
- </para>
- <para>
- When submitting a bug report, be sure to mention the manual's name and to select
the "documentation" component.
- </para>
- <para>
- If you have a suggestion for improving the documentation, try to be as specific as
possible when describing it. If you have found an error, please include the section number
and some of the surrounding text so we can find it easily.
- </para>
-</section>
+ </indexterm>
+ <para>
+ If you experience difficulty with a procedure described in this documentation, visit
the Red Hat Customer Portal at <ulink url="http://access.redhat.com" />.
Through the customer portal, you can:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ search or browse through a knowledgebase of technical support articles about Red Hat
products.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ submit a support case to Red Hat Global Support Services (GSS).
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ access other product documentation.
+ </para>
+
+ </listitem>
+
+ </itemizedlist>
+ <para>
+ Red Hat also hosts a large number of electronic mailing lists for discussion of Red
Hat software and technology. You can find a list of publicly available mailing lists at
<ulink
url="https://www.redhat.com/mailman/listinfo" />. Click on the name
of any mailing list to subscribe to that list or to access the list archives.
+ </para>
+
+ </section>
+
+ <section id="jboss-feedback">
+ <title>Give us Feedback</title>
+ <!-- NOTE: You will need the following entities defined in your .ent file.
+ You will need to replace _YOUR_PRODUCT_HERE_, _YOUR_COMPONENT_
+ and _YOUR_SUMMARY_ - entities are not replaced in URLs.
+ <!ENTITY PRODUCT "JBoss Product Name">
+ <!ENTITY BZCOMPONENT "doc-triage">
+ <!ENTITY BZURL "<ulink
url='https://bugzilla.example.com/enter_bug.cgi?product=_YOUR_PRODUCT...
+
+ These entities should not affect translated documents, since Bugzilla is not
localised.
+ --> <indexterm>
+ <primary>feedback</primary>
+ <secondary>contact information for this manual</secondary>
+
+ </indexterm>
+ <para>
+ If you find a typographical error, or know how this guide can be improved, we would
love to hear from you. Submit a report in Bugzilla against the product
<literal>&BZPRODUCT;</literal> and the component
<literal>&BZCOMPONENT;</literal>. The following link will take you to a
pre-filled bug report for this product: &BZURL;.
+ </para>
+ <para>
+ Fill out the following template in Bugzilla's
<literal>Description</literal> field. Be as specific as possible when
describing the issue; this will help ensure that we can fix it quickly.
+ </para>
+
+<screen>Document URL:
+
+
+Section Number and Name:
+
+
+Describe the issue:
+
+
+Suggestions for improvement:
+
+
+Additional information:
+
+
+</screen>
+ <para>
+ Be sure to give us your name so that you can receive full credit for reporting the
issue.
+ </para>
+
+ </section>
+
+
+</appendix>
+
+
Modified: trunk/portlet/docs/reference/en-US/JBoss_Portlet_Tools_User_Guide.ent
===================================================================
--- trunk/portlet/docs/reference/en-US/JBoss_Portlet_Tools_User_Guide.ent 2011-06-20
04:29:07 UTC (rev 32184)
+++ trunk/portlet/docs/reference/en-US/JBoss_Portlet_Tools_User_Guide.ent 2011-06-20
04:32:36 UTC (rev 32185)
@@ -2,3 +2,6 @@
<!ENTITY BOOKID "JBoss_Portlet_Tools_Reference_Guide">
<!ENTITY YEAR "2011">
<!ENTITY HOLDER "Red Hat">
+<!ENTITY BZPRODUCT "JBoss Developer Studio">
+<!ENTITY BZCOMPONENT "Portlet Tools User Guide">
+<!ENTITY BZURL "<ulink
url='https://bugzilla.redhat.com/enter_bug.cgi?product=JBoss&perc...
Modified: trunk/portlet/docs/reference/en-US/JBoss_Portlet_Tools_User_Guide.xml
===================================================================
--- trunk/portlet/docs/reference/en-US/JBoss_Portlet_Tools_User_Guide.xml 2011-06-20
04:29:07 UTC (rev 32184)
+++ trunk/portlet/docs/reference/en-US/JBoss_Portlet_Tools_User_Guide.xml 2011-06-20
04:32:36 UTC (rev 32185)
@@ -8,5 +8,6 @@
<xi:include href="portlet_tools_tasks.xml"
xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include>
<xi:include href="reference.xml"
xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include>
<xi:include href="summary.xml"
xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include>
+<xi:include href="Feedback.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Revision_History.xml"
xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include>
</book>
Modified: trunk/portlet/docs/reference/en-US/Preface.xml
===================================================================
--- trunk/portlet/docs/reference/en-US/Preface.xml 2011-06-20 04:29:07 UTC (rev 32184)
+++ trunk/portlet/docs/reference/en-US/Preface.xml 2011-06-20 04:32:36 UTC (rev 32185)
@@ -8,9 +8,5 @@
<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>
Modified: trunk/portlet/docs/reference/en-US/intro.xml
===================================================================
--- trunk/portlet/docs/reference/en-US/intro.xml 2011-06-20 04:29:07 UTC (rev 32184)
+++ trunk/portlet/docs/reference/en-US/intro.xml 2011-06-20 04:32:36 UTC (rev 32185)
@@ -7,7 +7,7 @@
Starting from 3.0.0.Alpha1 version, the JBoss set of plugins includes tools for
supporting <property>JBoss Portal</property> and JSR-186/JSR-286 portlets.
Thus, this guide provides instructions on how to get started and manage
<property>JBoss Portlet Tools</property>.
</para>
<section>
- <title>What is JBoss Portal and Portlet Tools?</title>
+ <title>What JBoss Portal and Portlet Tools are</title>
<para>
<property>JBoss Portal</property> provides an open source platform for
hosting and serving a portal's Web interface, publishing and managing its content, and
customizing its experience. It supports a wide range of features, including standard
portlets, single sign-on, clustering, and internationalization. More about
<property>JBoss Portal</property> can be found by visiting its home page at:
<ulink
url="http://www.jboss.org/jbossportal/">http://www.jboss.org...;.
</para>
@@ -102,14 +102,35 @@
<para>JDK 5 or higher</para>
</listitem>
<listitem>
- <para>JBoss Portal + JBoss AS bundle from: <ulink
url="http://www.jboss.org/jbossportal/download/index.html">h...
+ <para>
+ One of the following technologies:
</para>
- <note>
- <title>Note:</title>
- <para>
- JBoss Portlet Tools has been tested using 2.6.5 and 2.7.0.ALPHA versions of
<property>JBoss Portal</property>. Remember, if you want to use Portlet
version 2.0 (JSR-268), you have to choose JBoss Portal 2.7.
- </para>
- </note>
+ <itemizedlist>
+ <listitem>
+ <para>
+ JBoss Enterprise Portal Platform version 4.3 or 5.1
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ GateIn and JBoss Application Server
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ JBoss Portal and JBoss Application Server
+ </para>
+ <para>
+ A specific JBoss Portal and JBoss Application Server bundle is available from:
<ulink
url="http://www.jboss.org/jbossportal/download/index.html">h...
+ </para>
+ <note>
+ <title>Note:</title>
+ <para>
+ JBoss Portlet Tools has been tested using 2.6.5 and 2.7.0.ALPHA versions of
<property>JBoss Portal</property>. Remember, if you want to use Portlet
version 2.0 (JSR-268), you have to choose JBoss Portal 2.7.
+ </para>
+ </note>
+ </listitem>
+ </itemizedlist>
</listitem>
<listitem>
<para>JBoss Portlet Bridge (optionally) from: <ulink
url="http://www.jboss.org/portletbridge/downloads.html">http...
@@ -120,6 +141,12 @@
<para>
<property>JBoss Portlet Tools</property> is included as part of the
<property>JBoss Tools</property> project.
Refer to <ulink
url="http://www.jboss.org/tools/download/installation.html">...
- for <property>JBoss Tools</property> installation
instructions.</para>
+ for <property>JBoss Tools</property> installation instructions.
+ </para>
+ <note>
+ <para>
+ This guide will only refer to JBoss Portal from here, however you can use (and it is
recommended to use) JBoss Enterprise Portal Platform or GateIn instead, as mentioned
above.
+ </para>
+ </note>
</section>
</chapter>