shared/Workbench/QuickStart/QuickStart.xml

<?xml version="1.0" encoding="UTF-8"?>
<section version="5.0"
         xsi:schemaLocation="http://docbook.org/ns/docbook http://www.docbook.org/xml/5.0/xsd/docbook.xsd http://www.w3.org/1999/xlink http://www.docbook.org/xml/5.0/xsd/xlink.xsd"
         xml:base="../../" xml:id="wb.QuickStart"
         xmlns="http://docbook.org/ns/docbook"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xmlns:xs="http://www.w3.org/2001/XMLSchema"
         xmlns:xlink="http://www.w3.org/1999/xlink"
         xmlns:xi="http://www.w3.org/2001/XInclude"
         xmlns:ns2="http://www.w3.org/1998/Math/MathML"
         xmlns:ns="http://docbook.org/ns/docbook">
  <title>Quick Start</title>

  <para>These steps help you get started with minimum of effort.</para>

  <para>They should not be a substitute for reading the documentation in
  full.</para>

  <section xml:id="wb.QuickStartAddRepository">
    <title>Add repository</title>

    <para>Create a new repository to hold your project by selecting the
    Administration Perspective.</para>

    <figure>
      <title>Selecting Administration perspective</title>

      <mediaobject>
        <imageobject>
          <imagedata align="center"
                     fileref="images/Workbench/QuickStart/QuickStart1.png"
                     format="PNG"/>
        </imageobject>
      </mediaobject>
    </figure>

    <para>Select the "New repository" option from the menu.</para>

    <figure>
      <title>Creating new repository</title>

      <mediaobject>
        <imageobject>
          <imagedata align="center"
                     fileref="images/Workbench/QuickStart/QuickStart2.png"
                     format="PNG"/>
        </imageobject>
      </mediaobject>
    </figure>

    <para>Enter the required information.</para>

    <figure>
      <title>Entering repository information step 1/2</title>

      <mediaobject>
        <imageobject>
          <imagedata align="center"
                     fileref="images/Workbench/QuickStart/QuickStart3.png"
                     format="PNG"/>
        </imageobject>
      </mediaobject>
    </figure>

    <figure>
      <title>Entering repository information step 2/2 (only for managed repositories)</title>

      <mediaobject>
        <imageobject>
          <imagedata align="center"
                     fileref="images/Workbench/QuickStart/QuickStart3b.png"
                     format="PNG"/>
        </imageobject>
      </mediaobject>
    </figure>

  </section>

  <section xml:id="wb.QuickStartAddProject">
    <title>Add project</title>

    <para>Select the Authoring Perspective to create a new project.</para>

    <figure>
      <title>Selecting Authoring perspective</title>

      <mediaobject>
        <imageobject>
          <imagedata align="center"
                     fileref="images/Workbench/QuickStart/QuickStart4.png"
                     format="PNG"/>
        </imageobject>
      </mediaobject>
    </figure>

    <para>Select "Project" from the "New Item" menu.</para>

    <figure>
      <title>Creating new project</title>

      <mediaobject>
        <imageobject>
          <imagedata align="center"
                     fileref="images/Workbench/QuickStart/QuickStart5.png"
                     format="PNG"/>
        </imageobject>
      </mediaobject>
    </figure>

    <para>Enter a project name first.</para>

    <figure>
      <title>Entering project name</title>

      <mediaobject>
        <imageobject>
          <imagedata align="center"
                     fileref="images/Workbench/QuickStart/QuickStart6.png"
                     format="PNG"/>
        </imageobject>
      </mediaobject>
    </figure>

    <para>Enter the project details next.</para>

    <itemizedlist>
      <listitem>
        <para>Group ID follows Maven conventions.</para>
      </listitem>

      <listitem>
        <para>Artifact ID is pre-populated from the project name.</para>
      </listitem>

      <listitem>
        <para>Version is set as 1.0 by default.</para>
      </listitem>
    </itemizedlist>

    <figure>
      <title>Entering project details</title>

      <mediaobject>
        <imageobject>
          <imagedata align="center"
                     fileref="images/Workbench/QuickStart/QuickStart7.png"
                     format="PNG"/>
        </imageobject>
      </mediaobject>
    </figure>
  </section>

  <section xml:id="wb.QuickStartDefineDataModel">
    <title>Define Data Model</title>

    <para>After a project has been created you need to define Types to be used
    by your rules.</para>

    <para>Select "Data Object" from the "New Item" menu.</para>

    <note>
      <para>You can also use types contained in existing JARs.</para>

      <para>Please consult the full documentation for details.</para>
    </note>

    <figure>
      <title>Creating "Data Object"</title>

      <mediaobject>
        <imageobject>
          <imagedata align="center"
                     fileref="images/Workbench/QuickStart/QuickStart8.png"
                     format="PNG"/>
        </imageobject>
      </mediaobject>
    </figure>

    <para>Set the name and select a package for the new type.</para>

    <figure>
      <title>Creating a new type</title>

      <mediaobject>
        <imageobject>
          <imagedata align="center"
                     fileref="images/Workbench/QuickStart/QuickStart9.png"
                     format="PNG"/>
        </imageobject>
      </mediaobject>
    </figure>

    <para>Set field name and type and click on "Create" to create a field for the type.</para>

    <figure>
      <title>Click "Create" and add the field</title>

      <mediaobject>
        <imageobject>
          <imagedata align="center"
                     fileref="images/Workbench/QuickStart/QuickStart10.png"
                     format="PNG"/>
        </imageobject>
      </mediaobject>
    </figure>

    <para>Click "Save" to update the model.</para>

    <figure>
      <title>Clicking "Save"</title>

      <mediaobject>
        <imageobject>
          <imagedata align="center"
                     fileref="images/Workbench/QuickStart/QuickStart11.png"
                     format="PNG"/>
        </imageobject>
      </mediaobject>
    </figure>
  </section>

  <section xml:id="wb.QuickStartDefineRule">
    <title>Define Rule</title>

    <para>Select "DRL file" (for example) from the "New Item" menu.</para>

    <figure>
      <title>Selecting "DRL file" from the "New Item" menu</title>

      <mediaobject>
        <imageobject>
          <imagedata align="center"
                     fileref="images/Workbench/QuickStart/QuickStart12.png"
                     format="PNG"/>
        </imageobject>
      </mediaobject>
    </figure>

    <para>Enter a file name for the new rule.</para>

    <figure>
      <title>Entering file name for rule</title>

      <mediaobject>
        <imageobject>
          <imagedata align="center"
                     fileref="images/Workbench/QuickStart/QuickStart13.png"
                     format="PNG"/>
        </imageobject>
      </mediaobject>
    </figure>

    <para>Enter a definition for the rule.</para>

    <para>The definition process differs from asset type to asset type.</para>

    <para>The full documentation has details about the different
    editors.</para>

    <figure>
      <title>Defining a rule</title>

      <mediaobject>
        <imageobject>
          <imagedata align="center"
                     fileref="images/Workbench/QuickStart/QuickStart14.png"
                     format="PNG"/>
        </imageobject>
      </mediaobject>
    </figure>

    <para>Once the rule has been defined it will need to be saved.</para>

    <figure>
      <title>Saving the rule</title>

      <mediaobject>
        <imageobject>
          <imagedata align="center"
                     fileref="images/Workbench/QuickStart/QuickStart15.png"
                     format="PNG"/>
        </imageobject>
      </mediaobject>
    </figure>
  </section>

  <section xml:id="wb.QuickStartBuildAndDeloy">
    <title>Build and Deploy</title>

    <para>Once rules have been defined within a project; the project can be
    built and deployed to the Workbench's Maven Artifact Repository.</para>

    <para>To build a project select the "Project Editor" from the "Project"
    menu.</para>

    <figure>
      <title>Selecting "Project Editor"</title>

      <mediaobject>
        <imageobject>
          <imagedata align="center"
                     fileref="images/Workbench/QuickStart/QuickStart16.png"
                     format="PNG"/>
        </imageobject>
      </mediaobject>
    </figure>

    <para>Click "Build and Deploy" to build the project and deploy it to the
    Workbench's Maven Artifact Repository.</para>

    <para>When you select Build &amp; Deploy the workbench will deploy to any repositories defined
      in the Dependency Management section of the pom in your workbench project. You can edit the
      pom.xml file associated with your workbench project under the Repository View of the project
      explorer. Details on dependency management in maven can be found here :
      http://maven.apache.org/guides/introduction/introduction-to-dependency-mechanism.html</para>

    <para>If there are errors during the build process they will be reported
    in the "Problems Panel".</para>

    <figure>
      <title>Building and deploying a project</title>

      <mediaobject>
        <imageobject>
          <imagedata align="center"
                     fileref="images/Workbench/QuickStart/QuickStart17.png"
                     format="PNG"/>
        </imageobject>
      </mediaobject>
    </figure>

    <para>Now the project has been built and deployed; it can be referenced
    from your own projects as any other Maven Artifact.</para>

    <para>The full documentation contains details about integrating projects
    with your own applications.</para>
  </section>
</section>