List:Commits« Previous MessageNext Message »
From:tony.bedford Date:June 2 2010 10:26am
Subject:svn commit - mysqldoc@docsrva: r20996 - trunk/workbench
View as plain text  
Author: tbedford
Date: 2010-06-02 12:26:38 +0200 (Wed, 02 Jun 2010)
New Revision: 20996

Log:
Further restructuring

Removed:
   trunk/workbench/scripting-shell.xml
Renamed/Moved:
   trunk/workbench/extending.xml (from rev 20994, trunk/workbench/scripting-shell.xml)
Modified:
   trunk/workbench/Makefile.depends
   trunk/workbench/workbench.xml


Modified: trunk/workbench/Makefile.depends
===================================================================
--- trunk/workbench/extending.xml	                        (rev 0)
+++ trunk/workbench/extending.xml	2010-06-02 10:26:38 UTC (rev 20996)
Changed blocks: 12, Lines Added: 334, Lines Deleted: 28; 14995 bytes

@@ -127,6 +127,7 @@
 	metadata/dbdoc-templates.idmap \
 	metadata/documenting-sakila.idmap \
 	metadata/eer-diagram-editor.idmap \
+	metadata/extending.idmap \
 	metadata/foreign-key-relationships.idmap \
 	metadata/forward-engineering.idmap \
 	metadata/images.idmap \

@@ -140,7 +141,6 @@
 	metadata/printing.idmap \
 	metadata/reporting.idmap \
 	metadata/reverse-engineering.idmap \
-	metadata/scripting-shell.idmap \
 	metadata/sql-development.idmap \
 	metadata/stored-procedures.idmap \
 	metadata/table-editor.idmap \

@@ -301,6 +301,28 @@
 eer-diagram-editor-manprepped.xml: $(eer_diagram_editor_SOURCES) $(eer_diagram_editor_IDMAPS)
 eer-diagram-editor-remprepped.xml: $(eer_diagram_editor_SOURCES) $(eer_diagram_editor_IDMAPS)
 
+extending_INCLUDES = \
+	../common/fixedchars.ent \
+	../common/phrases.ent \
+	../refman-common/urls.ent \
+	all-entities.ent \
+	images/published/wb-scripting-shell.png \
+	version.ent \
+	workbench.ent
+extending_IMAGES = \
+	images/published/wb-scripting-shell.png
+extending_SOURCES = extending.xml $(extending_INCLUDES)
+extending_IDMAPS =
+extending.validpure: $(extending_SOURCES)
+extending.titles: $(extending_SOURCES)
+extending.useless: $(extending_SOURCES)
+extending.valid: $(extending_SOURCES) $(extending_IDMAPS)
+extending.validwarn: $(extending_SOURCES) $(extending_IDMAPS)
+extending-prepped.xml: $(extending_SOURCES) $(extending_IDMAPS)
+extending-helpprepped.xml: $(extending_SOURCES) $(extending_IDMAPS)
+extending-manprepped.xml: $(extending_SOURCES) $(extending_IDMAPS)
+extending-remprepped.xml: $(extending_SOURCES) $(extending_IDMAPS)
+
 faq_INCLUDES = \
 	../common/fixedchars.ent \
 	../common/phrases.ent \

@@ -649,6 +671,7 @@
 menus_SOURCES = menus.xml $(menus_INCLUDES)
 menus_IDMAPS = \
 	metadata/documenting-sakila.idmap \
+	metadata/extending.idmap \
 	metadata/forward-engineering.idmap \
 	metadata/manage-db-connections.idmap \
 	metadata/menus.idmap \

@@ -658,7 +681,6 @@
 	metadata/printing.idmap \
 	metadata/reporting.idmap \
 	metadata/reverse-engineering.idmap \
-	metadata/scripting-shell.idmap \
 	metadata/sql-development.idmap \
 	metadata/tutorial.idmap \
 	metadata/validation-plugins.idmap

@@ -750,7 +772,7 @@
 plugins_IMAGES =
 plugins_SOURCES = plugins.xml $(plugins_INCLUDES)
 plugins_IDMAPS = \
-	metadata/scripting-shell.idmap
+	metadata/extending.idmap
 plugins.validpure: $(plugins_SOURCES)
 plugins.titles: $(plugins_SOURCES)
 plugins.useless: $(plugins_SOURCES)

@@ -846,28 +868,6 @@
 reverse-engineering-manprepped.xml: $(reverse_engineering_SOURCES) $(reverse_engineering_IDMAPS)
 reverse-engineering-remprepped.xml: $(reverse_engineering_SOURCES) $(reverse_engineering_IDMAPS)
 
-scripting_shell_INCLUDES = \
-	../common/fixedchars.ent \
-	../common/phrases.ent \
-	../refman-common/urls.ent \
-	all-entities.ent \
-	images/published/wb-scripting-shell.png \
-	version.ent \
-	workbench.ent
-scripting_shell_IMAGES = \
-	images/published/wb-scripting-shell.png
-scripting_shell_SOURCES = scripting-shell.xml $(scripting_shell_INCLUDES)
-scripting_shell_IDMAPS =
-scripting-shell.validpure: $(scripting_shell_SOURCES)
-scripting-shell.titles: $(scripting_shell_SOURCES)
-scripting-shell.useless: $(scripting_shell_SOURCES)
-scripting-shell.valid: $(scripting_shell_SOURCES) $(scripting_shell_IDMAPS)
-scripting-shell.validwarn: $(scripting_shell_SOURCES) $(scripting_shell_IDMAPS)
-scripting-shell-prepped.xml: $(scripting_shell_SOURCES) $(scripting_shell_IDMAPS)
-scripting-shell-helpprepped.xml: $(scripting_shell_SOURCES) $(scripting_shell_IDMAPS)
-scripting-shell-manprepped.xml: $(scripting_shell_SOURCES) $(scripting_shell_IDMAPS)
-scripting-shell-remprepped.xml: $(scripting_shell_SOURCES) $(scripting_shell_IDMAPS)
-
 server_administration_INCLUDES = \
 	../common/fixedchars.ent \
 	../common/phrases.ent \

@@ -1200,6 +1200,7 @@
 	dynxml-local-third-party.xml \
 	editions.xml \
 	eer-diagram-editor.xml \
+	extending.xml \
 	faq.xml \
 	foreign-key-relationships.xml \
 	forward-engineering.xml \

@@ -1305,7 +1306,6 @@
 	preferences.xml \
 	printing.xml \
 	reverse-engineering.xml \
-	scripting-shell.xml \
 	server-administration.xml \
 	sql-development.xml \
 	stored-procedures.xml \

@@ -1417,6 +1417,7 @@
 	metadata/dbdoc-templates.idmap \
 	metadata/documenting-sakila.idmap \
 	metadata/eer-diagram-editor.idmap \
+	metadata/extending.idmap \
 	metadata/foreign-key-relationships.idmap \
 	metadata/forward-engineering.idmap \
 	metadata/images.idmap \

@@ -1431,7 +1432,6 @@
 	metadata/printing.idmap \
 	metadata/reporting.idmap \
 	metadata/reverse-engineering.idmap \
-	metadata/scripting-shell.idmap \
 	metadata/server-administration.idmap \
 	metadata/sql-development.idmap \
 	metadata/stored-procedures.idmap \

Copied: trunk/workbench/extending.xml (from rev 20994, trunk/workbench/scripting-shell.xml)
===================================================================
--- trunk/workbench/extending.xml	                        (rev 0)
+++ trunk/workbench/extending.xml	2010-06-02 10:26:38 UTC (rev 20996)

@@ -0,0 +1,306 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
+[
+<!ENTITY % all.entities SYSTEM "all-entities.ent">
+%all.entities;
+]>
+<chapter id="wb-extending">
+
+  <title>Extending Workbench</title>
+
+  <para>
+    &workbench; provides an extension and scripting system that allows
+    the developer to extend &workbench; according to requirements. While
+    the core of &workbench; is developed using C++, it is possible to
+    harness this core functionality using both the Lua and Python
+    scripting languages. &workbench; also provides access to a
+    cross-platform GUI library, <literal>mforms</literal>, which enables
+    the creation of extensions that feature a graphical user interface.
+  </para>
+
+  <para>
+    The extension capabilities enable the following:
+  </para>
+
+  <itemizedlist>
+
+    <listitem>
+      <para>
+        Automate common tasks
+      </para>
+    </listitem>
+
+    <listitem>
+      <para>
+        Extend the Workbench user-interface
+      </para>
+    </listitem>
+
+    <listitem>
+      <para>
+        Create plugins (code which can be invoked from the Workbench
+        menu system)
+      </para>
+    </listitem>
+
+    <listitem>
+      <para>
+        Manipulate schemata
+      </para>
+    </listitem>
+
+    <listitem>
+      <para>
+        Create custom Workbench features
+      </para>
+    </listitem>
+
+  </itemizedlist>
+
+  <section id="wb-scripting-shell">
+
+    <title>The &wbss;</title>
+
+    <para>
+      The &wbss; provides a means for entering and executing scripts.
+      Through the use of the scripting shell, &workbench; can support
+      new behavior and data sources using code written in Lua and
+      Python. The shell can also be used to explore the current
+      Workbench GRT (Generic Runtime) facilities.
+    </para>
+
+    <para>
+      The scripting shell is not only useful for expanding &workbench;.
+      You can use a script file from the scripting shell command line to
+      perform repetitive tasks programmatically.
+    </para>
+
+    <para>
+      The default development language is <literal>Lua</literal>, a
+      lightweight scripting language expressly designed for extending
+      applications. For more information about this language see
+      <ulink url="http://www.lua.org/">lua.org</ulink>.
+    </para>
+
+    <para>
+      The Python language is also supported, further details of this
+      language can be found from the official
+      <ulink url="http://www.python.org">Python site</ulink>.
+    </para>
+
+    <para>
+      The programming language to be used in &wbss; can be selected from
+      the General tab of the Workbench Preferences dialog. The Workbench
+      Preferences dialog can be displayed using the main menu item
+      <guimenu>Edit</guimenu>, <guimenu>Preferences</guimenu>.
+    </para>
+
+    <section id="wb-exploring-scripting-shell">
+
+      <title>Exploring the &wbss;</title>
+
+      <para>
+        To open the &wbss;, select <guimenu>Scripting</guimenu>,
+        <guimenu>Scripting Shell</guimenu> from the main menu. You can
+        also open the &wbss; using the
+        <keycap>Ctrl</keycap>+<keycap>F3</keycap> key combination on
+        Windows and Linux, <keycap>cmd</keycap> <keycap>F3</keycap> on
+        Mac OS X, or by clicking the shell button above the EER diagram
+        navigator. The &wbss; will then open in a new dialog.
+      </para>
+
+      <para>
+        The following screenshot shows the &wbss; dialog:
+      </para>
+
+      <figure id="wb-scripting-shell-console">
+        <title>The &wbss;</title>
+        <mediaobject>
+          <imageobject>
+            <imagedata fileref="images/published/wb-scripting-shell.png" format="PNG" lang="en"/>
+          </imageobject>
+          <textobject>
+            <phrase lang="en">The &wbss;</phrase>
+          </textobject>
+        </mediaobject>
+      </figure>
+
+    </section>
+
+    <section id="wb-scripting-shell-window">
+
+      <title>The Shell Window</title>
+
+      <para>
+        The &wbss; is primarily used for running Lua or Python scripts
+        or typing commands in these languages directly. However, you can
+        also use it to access the &wbss; Scripting Library functions and
+        global functions and objects. To see the available commands type
+        <quote><literal>?</literal></quote>. You can also cut and paste
+        text to and from the shell window.
+      </para>
+
+      <remark>
+        [APB] - Snippets tab has temporarily been removed. It will be
+        added back at some point in the future. Commented out for now.
+      </remark>
+
+<!--
+    <para>
+      The <literal>Snippets</literal> tab functions as a scratch pad for
+      saving code snippets. This makes it easy to reuse code and does
+      away with the need to retype it at the command line.
+    </para>
+
+    <para>
+      If you have opened script files, there may be any number of tabs
+      to the right of the <literal>Snippets</literal> tab. These tabs
+      will be labeled with the names of the script files. As with the
+      <literal>Snippets</literal> tab you can cut and paste to or from
+      any of the tabs. This gives you the opportunity to test code from
+      the command line.
+    </para>
+-->
+
+      <para>
+        While individual commands can be entered into the shell, it is
+        also possible to run a longer script, stored in an external
+        file, using the main menu option <guimenu>Scripting</guimenu>,
+        <guimenu>Run Workbench Script File</guimenu>. When scripts are
+        run outside of the shell, to see the output use the main menu
+        item <guimenu>View</guimenu>, <guimenu>Output</guimenu>.
+      </para>
+
+      <para>
+        It is also possible to run script files directly from the shell.
+        For details on running script files, type <command>?
+        run</command> at the &wbss; prompt. The following message is
+        displayed:
+      </para>
+
+<programlisting>
+  Shell Command - shell.run
+  -------------------------
+  Load and execute a lua script file.
+
+  run filename
+
+  Parameters:
+  filename       File that should be loaded and executed.
+
+  Examples:
+  run scripts/test.lua
+  Runs the script scripts/test.lua.
+</programlisting>
+
+      <para>
+        Within the &wbss;, on the left side panel, are three tabs:
+        <guilabel>Globals</guilabel>, <guilabel>Classes</guilabel>, and
+        <guilabel>Modules</guilabel>. Discussion of these additional
+        tabs follows.
+      </para>
+
+    </section>
+
+    <section id="wb-scripting-modules-palettes">
+
+      <title>The Globals, Classes, and Modules Tabs</title>
+
+      <para>
+        The &wbss; features the <guilabel>Globals</guilabel>,
+        <guilabel>Classes</guilabel> and <guilabel>Modules</guilabel>
+        tabs, in addition to the main <guilabel>Shell</guilabel> tab.
+      </para>
+
+      <para>
+        <emphasis role="bold">The Globals Tab</emphasis>
+      </para>
+
+      <para>
+        At the top of the window is a drop down list box that is used to
+        select the starting point, or root, of the GRT Globals tree
+        displayed beneath it. By default this starting point is the root
+        of the tree - '/'. The GRT Globals tree can be expanded and
+        collapsed as required. The GRT Globals tree is the structure in
+        which &workbench; stores document data. Clicking on any item
+        will result in its name and value being displayed in the panel
+        below the tree.
+      </para>
+
+      <para>
+        <emphasis role="bold">The Classes Tab</emphasis>
+      </para>
+
+      <para>
+        A <literal>class</literal> is a user-defined data type formed by
+        combining primitive data types: integers, doubles, strings,
+        dicts, lists, and objects. This tab shows the definitions of the
+        classes used by the objects in the <literal>Modules</literal>
+        tab. Clicking on a class causes a brief description of the class
+        to be displayed in a panel below the classes explorer.
+      </para>
+
+      <para>
+        When the <guilabel>Classes</guilabel> tab is selected, the
+        dropdown listbox lists the following items:
+
+        <itemizedlist>
+
+          <listitem>
+            <para>
+              <guilabel>Group by Name</guilabel>: Group by the object
+              name
+            </para>
+          </listitem>
+
+          <listitem>
+            <para>
+              <guilabel>Group by Hierarchy</guilabel>: Group by
+              inheritance
+            </para>
+          </listitem>
+
+          <listitem>
+            <para>
+              <guilabel>Group by Package</guilabel>: Group by
+              functionality
+            </para>
+          </listitem>
+
+        </itemizedlist>
+      </para>
+
+      <para>
+        The default view for this tab is <guilabel>Group By
+        Name</guilabel>. This view simply shows all the different
+        objects arranged alphabetically. Click the
+        <guibutton>+</guibutton> icon or double click a package to show
+        the properties of the struct.
+      </para>
+
+      <para>
+        If you switch to the hierarchical view you will see
+        <literal>GrtObject</literal> - the parent object from which all
+        other objects are derived.
+      </para>
+
+      <para>
+        <emphasis role="bold">The Modules Tab</emphasis>
+      </para>
+
+      <para>
+        The <guilabel>Modules</guilabel> tab allows you to browse the
+        &workbench; installed modules and their functions. Clicking on a
+        module within the explorer causes its details to be displayed in
+        a panel below the explorer. This facility is useful for
+        exploring the available modules, and their supported functions.
+        It is also a way to check if custom modules have been correctly
+        installed.
+      </para>
+
+    </section>
+
+  </section>
+
+</chapter>


Modified: trunk/workbench/workbench.xml
===================================================================
--- trunk/workbench/workbench.xml	2010-06-02 10:21:14 UTC (rev 20995)
+++ trunk/workbench/workbench.xml	2010-06-02 10:26:38 UTC (rev 20996)
Changed blocks: 1, Lines Added: 1, Lines Deleted: 3; 852 bytes

@@ -73,12 +73,10 @@
 
   <xi:include href="server-administration.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
 
-  <xi:include href="scripting-shell.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+  <xi:include href="extending.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
 
 <!--xi:include href="writing-scripts.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/-->
 
-<!--xi:include href="expanding.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/-->
-
   <xi:include href="plugins.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
 
   <xi:include href="keys.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>


Thread
svn commit - mysqldoc@docsrva: r20996 - trunk/workbenchtony.bedford2 Jun