Author: abogachuk Date: 2008-09-26 08:47:06 -0400 (Fri, 26 Sep 2008) New Revision: 10503 Added: trunk/birt/docs/en/ trunk/birt/docs/en/images/ trunk/birt/docs/en/images/esb_editor/ trunk/birt/docs/en/images/esb_editor/01_esb_tree_view.png trunk/birt/docs/en/images/esb_editor/02_esb_source_view.png trunk/birt/docs/en/images/esb_editor/03_esb_outline_view.png trunk/birt/docs/en/images/esb_editor/04_esb_add_provider.png trunk/birt/docs/en/images/esb_editor/05_esb_add_service.png trunk/birt/docs/en/images/esb_editor/06_esb_add_listener.png trunk/birt/docs/en/images/esb_editor/08_esb_features.png trunk/birt/docs/en/images/esb_editor/09_esb_features.png trunk/birt/docs/en/images/esb_editor/10_esb_features.png trunk/birt/docs/en/images/esb_support/ trunk/birt/docs/en/images/esb_support/01_create_esb.png trunk/birt/docs/en/images/esb_support/02_create_esb.png trunk/birt/docs/en/images/favicon.ico trunk/birt/docs/en/images/new.png trunk/birt/docs/en/images/updated.png trunk/birt/docs/en/master.xml trunk/birt/docs/en/modules/ trunk/birt/docs/en/modules/birt_designer.xml trunk/birt/docs/en/modules/birt_support.xml trunk/birt/docs/en/modules/introduction.xml trunk/birt/docs/pom.xml Log: https://jira.jboss.org/jira/browse/JBDS-388 - structure updated Added: trunk/birt/docs/en/images/esb_editor/01_esb_tree_view.png =================================================================== (Binary files differ) Property changes on: trunk/birt/docs/en/images/esb_editor/01_esb_tree_view.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/birt/docs/en/images/esb_editor/02_esb_source_view.png =================================================================== (Binary files differ) Property changes on: trunk/birt/docs/en/images/esb_editor/02_esb_source_view.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/birt/docs/en/images/esb_editor/03_esb_outline_view.png =================================================================== (Binary files differ) Property changes on: trunk/birt/docs/en/images/esb_editor/03_esb_outline_view.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/birt/docs/en/images/esb_editor/04_esb_add_provider.png =================================================================== (Binary files differ) Property changes on: trunk/birt/docs/en/images/esb_editor/04_esb_add_provider.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/birt/docs/en/images/esb_editor/05_esb_add_service.png =================================================================== (Binary files differ) Property changes on: trunk/birt/docs/en/images/esb_editor/05_esb_add_service.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/birt/docs/en/images/esb_editor/06_esb_add_listener.png =================================================================== (Binary files differ) Property changes on: trunk/birt/docs/en/images/esb_editor/06_esb_add_listener.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/birt/docs/en/images/esb_editor/08_esb_features.png =================================================================== (Binary files differ) Property changes on: trunk/birt/docs/en/images/esb_editor/08_esb_features.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/birt/docs/en/images/esb_editor/09_esb_features.png =================================================================== (Binary files differ) Property changes on: trunk/birt/docs/en/images/esb_editor/09_esb_features.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/birt/docs/en/images/esb_editor/10_esb_features.png =================================================================== (Binary files differ) Property changes on: trunk/birt/docs/en/images/esb_editor/10_esb_features.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/birt/docs/en/images/esb_support/01_create_esb.png =================================================================== (Binary files differ) Property changes on: trunk/birt/docs/en/images/esb_support/01_create_esb.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/birt/docs/en/images/esb_support/02_create_esb.png =================================================================== (Binary files differ) Property changes on: trunk/birt/docs/en/images/esb_support/02_create_esb.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/birt/docs/en/images/favicon.ico =================================================================== (Binary files differ) Property changes on: trunk/birt/docs/en/images/favicon.ico ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/birt/docs/en/images/new.png =================================================================== (Binary files differ) Property changes on: trunk/birt/docs/en/images/new.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/birt/docs/en/images/updated.png =================================================================== (Binary files differ) Property changes on: trunk/birt/docs/en/images/updated.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/birt/docs/en/master.xml =================================================================== --- trunk/birt/docs/en/master.xml (rev 0) +++ trunk/birt/docs/en/master.xml 2008-09-26 12:47:06 UTC (rev 10503) @@ -0,0 +1,37 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" +"?http://www.docbook.org/xsd/4.3/docbook.xsd" + +[ +<!ENTITY introduction SYSTEM "modules/introduction.xml"> +<!ENTITY birt_support SYSTEM "modules/birt_support.xml"> +<!ENTITY birt_designer SYSTEM "modules/birt_designer.xml"> + + + +]> +<book> + <bookinfo> + <title>Birt Plugin Reference Guide</title> + + <author&gt;&lt;firstname&gt;Anastasiya&lt;/firstname&gt;&lt;surname&gt;Bogachuk&lt;/surname&gt;&lt;email&gt;abogachuk(a)exadel.com&lt;/email&gt;&lt;/author&gt; + + + <pubdate>August 2008</pubdate> + <copyright> + <year>2008</year> + <holder>JBoss, a division of Red Hat Inc.</holder> + </copyright> + <releaseinfo> + Version: 1.0.0.alpha + </releaseinfo> + </bookinfo> + + <toc/> + + &introduction; + &birt_support; + &birt_designer; + + +</book> \ No newline at end of file Added: trunk/birt/docs/en/modules/birt_designer.xml =================================================================== --- trunk/birt/docs/en/modules/birt_designer.xml (rev 0) +++ trunk/birt/docs/en/modules/birt_designer.xml 2008-09-26 12:47:06 UTC (rev 10503) @@ -0,0 +1,213 @@ +<?xml version='1.0' encoding='UTF-8'?> +<chapter id="birt_designer" xreflabel="birt_designer"> + <?dbhtml filename="birtDesigner.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss BIRT</keyword> + <keyword>BIRT</keyword> + <keyword>BIRT Designer</keyword> + + </keywordset> + </chapterinfo> + + <title>BIRT Designer</title> + + <para>text here</para> + + <section id="esb_file"> + + <title>ESB File Editor</title> + <para><property>ESB File Editor</property> is a powerful and customizable tool. ESB File Editor allows developing an + application using ESB technology.</para> + + <para>ESB file editor has two tabs: Tree and Source.</para> + + <para>You can switch to Tree. The Tree view for the editor displays all ESB artifacts in a tree format. + By selecting any node you can see and edit its properties which will appear in the right-hand area. For example, a Provider:</para> + <figure> + <title>Tree View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/01_esb_tree_view.png" scale="90"/> + </imageobject> + </mediaobject> + </figure> + + <para>You can easily switch from Tree to Source by selecting the Source tab at the bottom of the editor and work in <link linkend="sourceView">Source view</link>.</para> + + <figure id="sourceView"> + <title>Source View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/02_esb_source_view.png"/> + </imageobject> + </mediaobject> + </figure> + <para>The Source view for the editor displays a text content of the ESB file. It is always synchronized with tree view, + so any changes made in one of the views will immediately appear in the other.</para> + <para>No matter what view you select, you get full integration with <!--Properties and -->Outline view<!-- views -->. + For example, you can work in the Source view with the help of the Outline view. The Outline view shows a tree structure of the ESB file. + Simply select any element in the Outline view and it will jump to the same place in the Source editor, + so you can navigate through the source code with Outline view.</para> + <figure> + <title>Outline View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/03_esb_outline_view.png" scale="70"/> + </imageobject> + </mediaobject> + </figure> + + <para>Adding, editing or deleting of some artifacts operations are available right in the <property>Tree</property> view. Right-click any node and select one of the available actions in the context menu. + For example, you can easily add a new provider:</para> + <para></para> + <figure> + <title>Adding new provider</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/04_esb_add_provider.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>You can easily add a new service too:</para> + <figure> + <title>Adding new service</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/05_esb_add_service.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The same way you can create a listener for service and other elements of ESB:</para> + <figure> + <title>Adding new listener for service</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/06_esb_add_listener.png"/> + </imageobject> + </mediaobject> + </figure> + <para>The same actions can be done in the right part of <property>Tree</property> view tab + using <property>Add</property>, <property>Edit</property> and <property>Remove</property> buttons.</para> + </section> + + + + <section id="esb_editors_features"> + + <title>ESB Editors Features</title> + <para>JBoss ESB tooling has powerful editor features that help you easily make use of content and code assist.</para> + + <section id="ESBsyntaxvalidation84"> + + <title>ESB syntax validation</title> + <para>When working in JBoss ESB editor you are constantly provided with feedback + and contextual error checking as you type. In the Source viewer, if at any point a tag is incorrect or incomplete, an error will be indicated next to the line and also in the Problems view below.</para> + </section> + + <section id="ESBSupportXMLSchema"> + <title>Support for XML Schema</title> + + <para>JBoss ESB Framework fully + <link linkend="sourceView">supports XML files based on schemas as well as DTDs</link>.</para> + </section> + + <!--<section id="OpenOnSelection"> + + <title>OpenOn</title> + + <para><property>OpenOn</property> let&apos;s you easily navigate through your + project without using the Package Explorer view (project tree). With OpenOn, you can + simply click on a reference to another file and that file will be opened.</para> + + <para>OpenOn is available for the XML files </para> + + <para>Press and hold down the Ctrl key. As you move the mouse cursor over different + file references in the file, they display an underline. When you have the mouse + cursor over the name of the file you want to open, click and the file will open + in its own editor. In this example the managed bean NameBean will open.</para> + + </section> + --> + + <section id="ESBContentAssist"> + + <title>Content Assist for ESB XML file</title> + + <para>When you work with any ESB XML file <property>Content Assist</property> is available to help you. + It provides pop-up tip to help you complete your code statements. + It allows you to write your code faster and with more accuracy. + Content assist is always available in the Source mode. Simply type <emphasis> + <property>Ctrl-Space</property></emphasis> to see what is available.</para> + + <para>Content Assist for ESB XML file:</para> + <figure> + <title>Content Assist for ESB XML file</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/esb_editor/08_esb_features.png" scale="80"/> + </imageobject> + </mediaobject> + </figure> + + <para>Content Assist for attributes:</para> + <figure> + <title>Content Assist for attributes:</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/esb_editor/09_esb_features.png" scale="80"/> + </imageobject> + </mediaobject> + </figure> + <!-- </section> + + <section id="ContentAssistWithinTreeEditor"> + + <title>Content Assist within Tree ESB Editor</title> + + <para>JBoss Developer Studio also provides Content Assist when working within the Tree ESB editor. + Just click <emphasis><property>Ctrl-Space</property>.</emphasis></para> + <figure> + <title>Content Assist in Tree ESB Editor</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/esb_file/09_editors_features.png" scale="85"/> + </imageobject> + </mediaobject> + </figure> + </section> --> + </section> + + <section id="FullControlOverSourceFiles-SynchronizedSourcAndVisualEditing"> + + <title>Synchronized Source and Visual Editing</title> + + <para>ESB file can be edited in either source + or extra visual modes at the same time.</para> + + <para>JBoss Tools provide you two different editors to speed your development: a graphical view (<property>Tree</property>) and source + (<property>Source</property>). At the same time, you always have full control over esb source file. Any changes you + make in the source view will immediately appear in the tree view. Both views are synchronized, you can edit the file in any view.</para> + + <figure> + <title>Two Views are Synchronized</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/10_esb_features.png" scale="70"/> + </imageobject> + </mediaobject> + </figure> + + </section> + + <para>The last chapter covers capabilities on how you can use ESB editor.</para> + + <para>In summary, this reference supplies you with all necessary information on the functionality + that JBoss ESB Editor provides for work with JBoss ESB.</para> + </section> +</chapter> Added: trunk/birt/docs/en/modules/birt_support.xml =================================================================== --- trunk/birt/docs/en/modules/birt_support.xml (rev 0) +++ trunk/birt/docs/en/modules/birt_support.xml 2008-09-26 12:47:06 UTC (rev 10503) @@ -0,0 +1,90 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="esb_support"> + <?dbhtml filename="esb_support.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Eclipse</keyword> + <keyword>BIRT</keyword> + <keyword>Java</keyword> + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> + + <title>BIRT Support</title> + + <para>In this section we will focus more on all concepts that JBoss Tools integrates for + working with BIRT.</para> + + <section> + <title>BIRT Plugin Installation</title> + + <para>This chapter will provide you with detailed information on how to install BIRT plugin into JBoss Developer Studio.</para> + + <para>Since BIRT plugin is one of the modules of JBoss Tools project it has a dependence on other modules and will require their pre-installation. </para> + + <para>These are the prerequisites to create a web project including Seam and BIRT capabilities:</para> + <itemizedlist> + <listitem><para>Eclipse Version 3.4 SDK</para></listitem> + <listitem><para>DTP Version 1.6 Release</para></listitem> + <listitem><para>EMF Version 2.4 Release EMF+XSD</para></listitem> + <listitem><para>GEF Version 3.4 Release runtime</para></listitem> + <listitem><para>WTP Version 3.0 Release</para></listitem> + <listitem><para>BIRT Report Designer SDK 2.3.0 Release or BIRT Report Designer 2.3.0 Release <ulink url="http://repository.jboss.org/eclipse/birt/2.3.0/birt-report-fram... here</ulink></para></listitem> + <listitem><para>JBoss Application Server 4.2.2 GA</para></listitem> + <listitem><para>JBoss Seam 2.0.1 GA</para></listitem> + <listitem><para>BIRT Web Tools Integration <ulink url="http://repository.jboss.org/eclipse/birt/2.3.0/birt-wtp-integra... here</ulink></para></listitem> + <listitem><para>JBoss Tools nightly build</para></listitem> + + </itemizedlist> + + + + </section> + +<section> + + <title>JBoss BIRT Integration</title> + <para>To understand Hibernate configuration, integration with Seam, and deployment see <ulink url="http://docs.jboss.org/tools/whatsnew/birt/birt-news-1.0.0.Alpha... BIRT Integration 1.0.0.alpha1 - New and Noteworthy</ulink>.</para> + +</section> + + <section> + <title>Creating a BIRT Report</title> + <para>In this chapter we suggest a step-by-step walk-through of creating your own BIRT report.</para> + + <para>We will show you how to use the Creation wizard for creating a new BIRT report.</para> + + <para>Select <emphasis><property>File &gt;New &gt; Other...</property> + </emphasis> in the main menu bar or context menu for selected project and then <emphasis><property>ESB &gt; ESB File</property></emphasis> in the New dialog:</para> + + <figure> + <title>New Dialog</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_support/01_create_esb.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> Clicking <emphasis><property>Next</property></emphasis> brings us to the wizard page where it&apos;s necessary to specify the + folder, name and version for the file. We choose, for example, <emphasis><property>jboss-esb.xml</property> + </emphasis> as the name and accept the selected projects folder and default version.</para> + <figure> + <title>Folder, Name and Version</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_support/02_create_esb.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Thus, our file will be created in the selected projects folder by default. If you want to change the folder + for your future file click <emphasis><property>Browse...</property></emphasis> button to set needed folder or simply type it.</para> + + <para>Clicking on <emphasis><property>Finish</property> + </emphasis> results in the file being generated. The wizard creates one xml file.</para> + + </section> + +</chapter> Added: trunk/birt/docs/en/modules/introduction.xml =================================================================== --- trunk/birt/docs/en/modules/introduction.xml (rev 0) +++ trunk/birt/docs/en/modules/introduction.xml 2008-09-26 12:47:06 UTC (rev 10503) @@ -0,0 +1,47 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="introduction"> + <?dbhtml filename="introduction.html"?> + + <chapterinfo> + <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> + + <title>Introduction</title> + + <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>With the help of BIRT you can generate a great number of reports to be used in your application:</para> + + <itemizedlist> + <listitem><para>Lists</para></listitem> + <listitem><para>Charts</para></listitem> + <listitem><para>Crosstabs, or cross-tabulation, or matrix</para></listitem> + <listitem><para>Letters and Documents</para></listitem> + <listitem><para>Compound Reports</para></listitem> + </itemizedlist> + + <para>In this guide we provide you with the information on BIRT Designer which allows you to create a report much faster and with far fewer errors so sparing your time.</para> + + <literallayout> </literallayout> + <para>You can find detailed information on the BIRT report types and anatomy here:</para> + <ulink url="http://www.eclipse.org/birt/phoenix/intro/">JBoss ESB</ulink> + + <para>All JBoss Developer Studio/JBoss Tools documentation you can find <ulink url="http://www.jboss.com/products/devstudio/docs">here</... + <para>The latest documentation builds are available <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">her... + + </section> + + + +</chapter> Added: trunk/birt/docs/pom.xml =================================================================== --- trunk/birt/docs/pom.xml (rev 0) +++ trunk/birt/docs/pom.xml 2008-09-26 12:47:06 UTC (rev 10503) @@ -0,0 +1,103 @@ +<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> + + <groupId>org.jboss.tools</groupId> + <artifactId>birt-reference-guide-${translation}</artifactId> + <version>1.0-SNAPSHOT</version> + <packaging>jdocbook</packaging> + <name>Birt_Reference_Guide</name> + + <build> + <plugins> + <plugin> + <groupId>org.jboss.maven.plugins</groupId> + <artifactId>maven-jdocbook-plugin</artifactId> + <version>2.1.0-200803311251UTC-MPJDOCBOOK-8</version> + <extensions>true</extensions> + + <dependencies> + <dependency> + <groupId>org.jboss</groupId> + <artifactId>jbossorg-docbook-xslt</artifactId> + <version>1.1.0</version> + </dependency> + <dependency> + <groupId>org.jboss</groupId> + <artifactId>jbossorg-jdocbook-style</artifactId> + <version>1.1.0</version> + <type>jdocbook-style</type> + </dependency> + </dependencies> + + <configuration> + <sourceDocumentName>master.xml</sourceDocumentName> + <sourceDirectory>${pom.basedir}/en</sourceDirectory> + <imageResource> + <directory>${pom.basedir}/en</directory> + <includes> + <include>images/**/*</include> + </includes> + </imageResource> + <cssResource> + <directory>${pom.basedir}/${cssdir}</directory> + </cssResource> + + <formats> + <format> + <formatName>pdf</formatName> + <stylesheetResource>file:${pom.basedir}/${stylesdir}/xslt/org/jboss/tools/pdf.xsl</stylesheetResource> + <finalName>${pom.name}.pdf</finalName> + </format> + <format> + <formatName>html</formatName> + <stylesheetResource>file:${pom.basedir}/${stylesdir}/xslt/org/jboss/tools/xhtml.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format> + <format> + <formatName>html_single</formatName> + <stylesheetResource>file:${pom.basedir}/${stylesdir}/xslt/org/jboss/tools/xhtml-single.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format> + <format> + <formatName>eclipse</formatName> + <stylesheetResource>file:${pom.basedir}/${stylesdir}/xslt/org/jboss/tools/eclipse.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format> + </formats> + <options> + <xincludeSupported>true</xincludeSupported> + <xmlTransformerType>saxon</xmlTransformerType> + <!-- needed for uri-resolvers; can be ommitted if using 'current' uri scheme --> + <!-- could also locate the docbook dependency and inspect its version... --> + <docbookVersion>1.72.0</docbookVersion> + </options> + </configuration> + </plugin> + </plugins> + </build> + + <distributionManagement> + <repository> + <!-- Copy the dist to the local checkout of the JBoss maven2 repo ${maven.repository.root} --> + <!-- It is anticipated that ${maven.repository.root} be set in user's settings.xml --> + <!-- todo : replace this with direct svn access once the svnkit providers are available --> + <id>repository.jboss.org</id> + <url>file://${maven.repository.root}</url> + </repository> + <snapshotRepository> + <id>snapshots.jboss.org</id> + <name>JBoss Snapshot Repository</name> + <url>dav:https://snapshots.jboss.org/maven2</url> + </snapshotRepository> + </distributionManagement> + + <properties> + <stylesdir>../../../documentation/jbosstools-docbook-xslt/src/main/resources</stylesdir> + <cssdir>../../../documentation/jbosstools-jdocbook-style/src/main/org/css</cssdir> + <translation>en-US</translation> + </properties> + +</project>