svn commit - mysqldoc@docsrva: r9833 - trunk/workbench

[plavin]

Author: plavin
Date: 2008-02-14 21:03:16 +0100 (Thu, 14 Feb 2008)
New Revision: 9833

Log:
Whoops -- forgot to svn add the new text objects file


Added:
   trunk/workbench/text-objects.xml


Added: trunk/workbench/text-objects.xml
===================================================================
--- trunk/workbench/text-objects.xml	                        (rev 0)
+++ trunk/workbench/text-objects.xml	2008-02-14 20:03:16 UTC (rev 9833)
Changed blocks: 1, Lines Added: 107, Lines Deleted: 0; 4128 bytes

@@ -0,0 +1,107 @@
+<?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-text-objects">
+
+  <title>Creating Text Objects</title>
+
+  <para>
+   Text objects are applicable to an EER diagram only.
+   They can be used for documentation purposes, for example,
+   to explain a grouping of schema objects. They are also
+   useful for creating titles for an EER diagram should you decide to
+   export a diagram as a PDF or PNG file.
+  </para>
+
+  <section id="wb-using-text-object-tool">
+    
+    <title>Adding Text Objects to an EER Diagram</title>
+    
+    <para>
+      Text objects can be added to an EER Diagram using the
+      <literal>Text Object</literal> tool on the vertical toolbar. To do this
+      make sure that the <literal>EER Diagram</literal> tab is selected,
+      and right click the text object icon on the vertical toolbar. The text
+      object icon is the rectangular icon found below the label icon.
+    </para>
+    
+    <para>
+      Clicking the mouse on this icon changes the mouse pointer to a
+      text object pointer. You can also change the mouse pointer to a text object
+      pointer by pressing the <keycap>N</keycap> key.
+      <remark>[PL]This should change</remark>
+    </para>
+    
+    <para>
+      Choosing the <literal>Text Object</literal> tool changes the contents of
+      the toolbar that appears immediately below the menu bar. When the
+      <literal>Text Object</literal> pointer is active, this toolbar contains a drop
+      down color chart. Use this list box to select the color accent for
+      the new text object. The color of your note can easily be changed later
+      using the <literal>Properties</literal> palette.
+    </para>
+    
+    <para>
+      Create a text object by clicking anywhere on the EER Diagram canvas. This
+      creates a new text object with the default name <literal>text1</literal>.
+      To revert to the default mouse pointer, click the arrow icon at
+      the top of the vertical toolbar.
+    </para>
+    
+    <para>
+      Right clicking a text object opens a pop-up menu.
+      These menu options are identical to the options for
+      other objects. However, since a text object is not a database object,
+      there is no confirmation dialog box when you delete a
+      text object.
+    </para>    
+        
+  </section>
+  
+  <section id="wb-text-object-editor">
+    
+    <title>The Text Object Editor</title>
+    
+    <para>
+      You can invoke the text object editor by double clicking a text object on
+      the EER Diagram canvas. Doing this opens the editor docked at
+      the bottom of the application. Double clicking the title bar
+      undocks the editor. Do the same to redock it. Any number of text objects
+      may be open at the same time. Each additional text objects appears as a
+      tab at the top of the text editor editor,
+    </para>
+    
+    <para>
+      Using the editor you can change the name of a text object 
+      or its contents.
+    </para>
+    
+   
+    <section id="wb-modifying-text-object">
+      
+      <title>Modifying a Text Object Using the Properties Palette</title>
+      
+      <para>
+        When you select a text object on the EER Diagram canvas, its properties
+        are displayed in the <literal>Properties</literal> palette. Most
+        of the properties accessible from the
+        <literal>Properties</literal> palette apply to the appearance of
+        a view on the EER Diagram canvas.
+      </para>
+      
+      <para>
+        For a list of the properties accessible through
+        the <literal>Properties</literal> palette see
+        <xref linkend="wb-properties-palette"/>.
+      </para>      
+      
+    </section>
+    
+  </section>    
+    
+
+</chapter>