3:19 a.m.
Author: ochikvina
Date: 2009-04-08 04:19:07 -0400 (Wed, 08 Apr 2009)
New Revision: 14592
Modified:
trunk/birt/docs/en/modules/introduction.xml
Log:
https://jira.jboss.org/jira/browse/JBDS-687 - updating the chapter;
Modified: trunk/birt/docs/en/modules/introduction.xml
===================================================================
--- trunk/birt/docs/en/modules/introduction.xml 2009-04-08 08:18:42 UTC (rev 14591)
+++ trunk/birt/docs/en/modules/introduction.xml 2009-04-08 08:19:07 UTC (rev 14592)
@@ -6,11 +6,9 @@
<keywordset>
<keyword>JBoss Developer Studio</keyword>
<keyword>Eclipse</keyword>
- <keyword>Java</keyword>
<keyword>JBoss</keyword>
<keyword>JBoss Tools</keyword>
<keyword>JBDS</keyword>
- <keyword>BIRT</keyword>
<keyword>BIRT Plugin</keyword>
</keywordset>
</chapterinfo>
@@ -20,11 +18,10 @@
<section>
<title>What is BIRT?</title>
- <para>BIRT plugin for JBoss Developer Studio is an Eclipse-based open
source reporting
- system for web applications based on Java and J2EE. BIRT consists of two
main
- components: a report designer based on Eclipse, and a runtime component that
can be
- added to your app server. BIRT also offers a charting engine that lets you
add charts to
- your own Web application.</para>
+ <para>BIRT plugin is an Eclipse-based open source reporting system for web
applications
+ based on Java and J2EE. BIRT consists of two main components: a report
designer based on
+ Eclipse, and a runtime component that can be added to your app server. BIRT
also offers
+ a charting engine that lets you add charts to your own Web
application.</para>
<para>With the help of BIRT you can generate a great number of reports to
be used in your
application:</para>
@@ -46,19 +43,78 @@
</listitem>
</itemizedlist>
- <para>In this guide we provide you with the information on BIRT Designer
which allows to
- create a report much faster and with far fewer errors to spare your
time.</para>
+ <para>You can find more detailed information on the BIRT plugin, its report
types and
+ anatomy on the <ulink
url="http://www.eclipse.org/birt/phoenix/intro/">BIRT
Homepage</ulink>.</para>
- <literallayout> </literallayout>
- <para>You can find detailed information on the BIRT report types and
anatomy here: <ulink
- url="http://www.eclipse.org/birt/phoenix/intro/">JBoss
BIRT</ulink></para>
+ <para>To understand the basic BIRT concepts and to know how to create a
basic BIRT report,
+ refer to the <ulink
url="http://www.eclipse.org/birt/phoenix/tutorial/">Eclipse BIRT
+ Tutorials</ulink>. What extensions <property>JBoss
Tools</property> provides for
+ Eclipse BIRT you'll find out in the next sections.</para>
+ </section>
+ <section>
+ <title>JBoss BIRT Integration Functionality Overview</title>
- <para>All JBoss Developer Studio/JBoss Tools documentation you can find
on<ulink
- url="http://docs.jboss.org/tools/">documentation release
page</ulink>.</para>
- <para>The latest documentation builds are available on <ulink
-
url="http://download.jboss.org/jbosstools/nightly-docs/">doc...
nightly builds page</ulink>.</para>
+ <para>This reference guide describes the one module of the
<property>JBoss Tools</property> project which
+ performs the integration with BIRT. The integration includes the following
functionalities:</para>
+ <itemizedlist>
+ <listitem>
+ <para>Hibernate ODA driver that includes a dialog to create HQL
queries with
+ syntax-highlighting, content-assist, formatting as well as other
functionalities
+ available in the HQL editor. There is also a possibility to add
+ parameters.</para>
+ </listitem>
+ <listitem>
+ <para>possibility to add JBoss BIRT functionality to the standard
Seam web
+ project</para>
+ </listitem>
+ <listitem>
+ <para>BIRT JSF/Seam control</para>
+ </listitem>
+ <listitem>
+ <para>deployment of BIRT reports within web projects (Seam, JSF,
etc.)</para>
+ </listitem>
+ </itemizedlist>
+ <para>To enable <property>JBoss Tools</property> integration
with BIRT you are intended to
+ have the next:</para>
+ <itemizedlist>
+ <listitem>
+ <para>Eclipse with <property>JBoss Tools</property>
+ installed (how to install <property>JBoss
Tools</property> on Eclipse, what
+ dependences and versions requirements are needed reed in the
<link
+
linkend="http://download.jboss.org/jbosstools/nightly-docs/en/Gettin...
+ >JBoss Tools Installation</link> section)</para>
+ </listitem>
+ <listitem>
+ <para>BIRT Report Designer (BIRT Report Designer 2.3.2 (the latest
stable version)
+ you can download from <ulink
+
url="http://www.eclipse.org/downloads/download.php?file=/birt/downlo...
+ >here</ulink>)</para>
+ </listitem>
+ <listitem>
+ <para>BIRT Web Tools Integration ( BIRT WTP Integration 2.3.2 you
can download from
+ <ulink
+
url="http://www.eclipse.org/downloads/download.php?file=/birt/downlo...
+ >here</ulink>)</para>
+ </listitem>
+ </itemizedlist>
+
+ <note>
+ <title>Note:</title>
+ <para>Versions of BIRT framework and BIRT WTP integration should be no
less than RC4 in
+ order to the BIRT facet works correctly.</para>
+ </note>
</section>
+ <section id="birt_plugin_rel_resources">
+ <title>Other Relevant Resources on the Topic</title>
+
+ <para>All JBoss Developer Studio/JBoss Tools documentation you can find on
the <ulink
+ url="http://docs.jboss.org/tools/">documentation release
page</ulink></para>
+ <para>The latest documentation builds are available on the <ulink
+
url="http://download.jboss.org/jbosstools/nightly-docs/">doc...
nightly
+ builds page</ulink></para>
+ </section>
+
</chapter>