Warning, /graphics/symboleditor/doc/commands.docbook is written in an unsupported language. File is not indexed.

0001 <chapter id="commands" >
0002     <title>Command Reference</title>
0003 
0004     <sect1 id="menus" >
0005         <title>&symboleditor; Menus</title>
0006         <sect2>
0007             <title>The File Menu</title>
0008             <para>
0009                 <variablelist>
0010                     <varlistentry>
0011                         <term><menuchoice><shortcut><keycombo>&Ctrl;<keycap>N</keycap></keycombo></shortcut><guimenuitem>New</guimenuitem></menuchoice></term>
0012                         <listitem><simpara><action>Creates a new library</action></simpara></listitem>
0013                     </varlistentry>
0014                     <varlistentry>
0015                         <term><menuchoice><shortcut><keycombo>&Ctrl;<keycap>O</keycap></keycombo></shortcut><guimenuitem>Open</guimenuitem></menuchoice></term>
0016                         <listitem><simpara><action>Opens an existing library</action></simpara></listitem>
0017                     </varlistentry>
0018                     <varlistentry>
0019                         <term><menuchoice><guimenuitem>Open Recent</guimenuitem></menuchoice></term>
0020                         <listitem><simpara><action>Open a recently used library</action></simpara></listitem>
0021                     </varlistentry>
0022                     <varlistentry>
0023                         <term><menuchoice><shortcut><keycombo>&Ctrl;<keycap>S</keycap></keycombo></shortcut><guimenuitem>Save</guimenuitem></menuchoice></term>
0024                         <listitem><simpara><action>Saves the library</action></simpara></listitem>
0025                     </varlistentry>
0026                     <varlistentry>
0027                         <term><menuchoice><shortcut><keycombo>&Ctrl;&Shift;<keycap>S</keycap></keycombo></shortcut><guimenuitem>Save As</guimenuitem></menuchoice></term>
0028                         <listitem><simpara><action>Saves the library under a new name</action></simpara></listitem>
0029                     </varlistentry>
0030                     <varlistentry>
0031                         <term><menuchoice><guimenuitem>Save Symbol</guimenuitem></menuchoice></term>
0032                         <listitem><simpara><action>Save the symbol being edited</action></simpara>
0033                         <simpara>If the symbol being edited was selected from the library, saving will
0034                             update that symbol. If it is a new symbol, it will be appended to the
0035                             library and subsequent saves will append another new symbol to the library.
0036                         </simpara></listitem>
0037                     </varlistentry>
0038                     <varlistentry>
0039                         <term><menuchoice><guimenuitem>Save Symbol as New</guimenuitem></menuchoice></term>
0040                         <listitem><simpara><action>Save the symbol being edited as a new symbol</action></simpara>
0041                         <simpara>When a symbol is saved as new it will be appended to the library regardless
0042                             of it having originally been selected from the library for editing.
0043                             Subsequent saves will append another new symbol to the library.
0044                         </simpara></listitem>
0045                     </varlistentry>
0046                     <varlistentry>
0047                         <term><menuchoice><guimenuitem>Import Library</guimenuitem></menuchoice></term>
0048                         <listitem><simpara><action>Import a library appending the contained symbols into the current library</action></simpara></listitem>
0049                     </varlistentry>
0050                     <varlistentry>
0051                         <term><menuchoice><shortcut><keycombo>&Ctrl;<keycap>W</keycap></keycombo></shortcut><guimenuitem>Close</guimenuitem></menuchoice></term>
0052                         <listitem><simpara><action>Close the library</action></simpara></listitem>
0053                     </varlistentry>
0054                     <varlistentry>
0055                         <term><menuchoice><shortcut><keycombo>&Ctrl;<keycap>Q</keycap></keycombo></shortcut><guimenuitem>Quit</guimenuitem></menuchoice></term>
0056                         <listitem><simpara><action>Quits &symboleditor;</action></simpara></listitem>
0057                     </varlistentry>
0058                 </variablelist>
0059             </para>
0060         </sect2>
0061 
0062         <sect2>
0063             <title>The Edit Menu</title>
0064             <para>&symboleditor; has the common &kde; <guimenu>Edit</guimenu> menu items, for more information read the sections about the 
0065             <ulink url="help:/fundamentals/menus.html#menus-edit">Edit Menu</ulink> of the &kde; Fundamentals.
0066             </para>
0067         </sect2>
0068 
0069         <sect2>
0070             <title>The Rendering Menu and Toolbar</title>
0071             <screenshot>
0072                 <screeninfo>Here is a screen shot of the rendering toolbar</screeninfo>
0073                 <mediaobject>
0074                     <imageobject>
0075                         <imagedata fileref="renderer-toolbar.png" format="PNG" />
0076                     </imageobject>
0077                 </mediaobject>
0078                 </screenshot>
0079             <para>
0080                 <variablelist>
0081                     <varlistentry>
0082                         <term><menuchoice><guimenuitem>Fill Path</guimenuitem></menuchoice></term>
0083                         <listitem><simpara><action>Enable filling of the path</action></simpara></listitem>
0084                     </varlistentry>
0085                     <varlistentry>
0086                         <term><menuchoice><guimenuitem>Winding Fill</guimenuitem></menuchoice></term>
0087                         <listitem><simpara><action>Select the winding fill method</action></simpara></listitem>
0088                     </varlistentry>
0089                     <varlistentry>
0090                         <term><menuchoice><guimenuitem>Odd Even Fill</guimenuitem></menuchoice></term>
0091                         <listitem><simpara><action>Select the odd even fill method</action></simpara></listitem>
0092                     </varlistentry>
0093                     <varlistentry>
0094                         <term><menuchoice><guimenuitem>Flat Cap</guimenuitem></menuchoice></term>
0095                         <listitem><simpara><action>Select the flat cap line end type</action></simpara></listitem>
0096                     </varlistentry>
0097                     <varlistentry>
0098                         <term><menuchoice><guimenuitem>Square Cap</guimenuitem></menuchoice></term>
0099                         <listitem><simpara><action>Select the square cap line end type</action></simpara></listitem>
0100                     </varlistentry>
0101                     <varlistentry>
0102                         <term><menuchoice><guimenuitem>Round Cap</guimenuitem></menuchoice></term>
0103                         <listitem><simpara><action>Select the round cap line end type</action></simpara></listitem></varlistentry>
0104                     <varlistentry>
0105                         <term><menuchoice><guimenuitem>Bevel Join</guimenuitem></menuchoice></term>
0106                         <listitem><simpara><action>Select the bevel line join type</action></simpara></listitem>
0107                     </varlistentry>
0108                     <varlistentry>
0109                         <term><menuchoice><guimenuitem>Miter Join</guimenuitem></menuchoice></term>
0110                         <listitem><simpara><action>Select the miter line join type</action></simpara></listitem>
0111                     </varlistentry>
0112                     <varlistentry>
0113                         <term><menuchoice><guimenuitem>Round Join</guimenuitem></menuchoice></term>
0114                         <listitem><simpara><action>Select the round line join type</action></simpara></listitem>
0115                     </varlistentry>
0116                     <varlistentry>
0117                         <term><menuchoice><guimenuitem>Increase Line Width</guimenuitem></menuchoice></term>
0118                         <listitem><simpara><action>Increase the path line width</action></simpara></listitem>
0119                     </varlistentry>
0120                     <varlistentry>
0121                         <term><menuchoice><guimenuitem>Decrease Line Width</guimenuitem></menuchoice></term>
0122                         <listitem><simpara><action>Decrease the path line width</action></simpara></listitem>
0123                     </varlistentry>
0124                 </variablelist>
0125             </para>
0126         </sect2>
0127 
0128         <sect2>
0129             <title>The Tools Menu and Toolbar</title>
0130             <para>
0131                 A number of tools are available to aid the design of the symbols. The symbols are
0132                 composed of a series of sub paths and each sub path is composed of a move to the
0133                 start position (this defaults to 0,0 for new symbols) followed by lines and curves.
0134                 The curves are cubic splines having a start, an end and two control points defining
0135                 the curve. There are convenience tools to create rectangles and ellipses, but these
0136                 will be broken down into lines and curves.
0137             </para>
0138             <para>
0139                 All points created for the elements are moveable by dragging them to their new
0140                 position. All points can be snapped to the grid intersections if the snap option is
0141                 turned on, otherwise they can be positioned anywhere.
0142             </para>
0143             <para>
0144                 The symbol can be rotated clockwise and counter clockwise and also flipped vertically
0145                 and horizontally. This allows multiple symbols to be easily created based on the same
0146                 design. Remember to use the save symbol as new option for this.
0147             </para>
0148             <screenshot>
0149                 <screeninfo>Here is a screen shot of the tools toolbar</screeninfo>
0150                 <mediaobject>
0151                     <imageobject>
0152                         <imagedata fileref="tool-toolbar.png" format="PNG" />
0153                     </imageobject>
0154                 </mediaobject>
0155                 </screenshot>
0156             <para>
0157                 <variablelist>
0158                     <varlistentry>
0159                         <term><menuchoice><guimenuitem>Move To</guimenuitem></menuchoice></term>
0160                         <listitem>
0161                             <simpara><action>Move the starting position of the sub path</action></simpara>
0162                             <simpara>If an existing sub path is being created, this will be closed and
0163                                 a new sub path started at the new position</simpara>
0164                             </listitem>
0165                     </varlistentry>
0166                     <varlistentry>
0167                         <term><menuchoice><guimenuitem>Draw To</guimenuitem></menuchoice></term>
0168                         <listitem><simpara><action>Draw a line to the next selected point</action></simpara></listitem>
0169                     </varlistentry>
0170                     <varlistentry>
0171                         <term><menuchoice><guimenuitem>Cubic To</guimenuitem></menuchoice></term>
0172                         <listitem><simpara><action>Draw a bezier curve using two control points and an end point</action></simpara></listitem>
0173                     </varlistentry>
0174                     <varlistentry>
0175                         <term><menuchoice><guimenuitem>Rectangle</guimenuitem></menuchoice></term>
0176                         <listitem>
0177                             <simpara><action>Draw a rectangle between two opposite corners</action></simpara>
0178                             <simpara>This closes any existing sub path and creates a new sub path
0179                                 consisting of the rectangle.</simpara>
0180                         </listitem>
0181                     </varlistentry>
0182                     <varlistentry>
0183                         <term><menuchoice><guimenuitem>Ellipse</guimenuitem></menuchoice></term>
0184                         <listitem>
0185                             <simpara><action>Draw an ellipse between two opposite corners</action></simpara>
0186                             <simpara>This closes any existing sub path and creates a new sub path
0187                                 consisting of the ellipse.</simpara>
0188                         </listitem>
0189                     </varlistentry>
0190                     <varlistentry>
0191                         <term><menuchoice><guimenuitem>Insert Character</guimenuitem></menuchoice></term>
0192                         <listitem>
0193                             <simpara><action>Select a character from a font and insert it into the editor</action></simpara>
0194                             <simpara>This will overwrite any existing paths</simpara>
0195                             <screenshot>
0196                                 <screeninfo>Here is a screen shot of the character selector</screeninfo>
0197                                 <mediaobject>
0198                                     <imageobject>
0199                                         <imagedata fileref="charselect-dialog.png" format="PNG" />
0200                                     </imageobject>
0201                                 </mediaobject>
0202                             </screenshot>
0203                             <simpara>The character selector dialog is the standard KDE dialog and allows
0204                                 selection of characters from any font. The size is not used as the
0205                                 character is scaled to fit within the preferred size guide.</simpara>
0206                             <simpara>Double clicking a character will insert that character into the
0207                                 editor. The dialog will stay open so that another character could be
0208                                 inserted, although this will overwrite the first. This does allow an
0209                                 insert character, save, insert character, save workflow to quickly
0210                                 build up a library of symbols. Ensure that the symbol being edited is
0211                                 a new symbol and not one previously selected from the library, otherwise
0212                                 saving would keep overwriting the one in the library.</simpara>
0213                         </listitem>
0214                     </varlistentry>
0215                     <varlistentry>
0216                         <term><menuchoice><guimenuitem>Rotate Left</guimenuitem></menuchoice></term>
0217                         <listitem><simpara><action>Rotate the whole symbol counter clockwise 90 degrees</action></simpara></listitem>
0218                     </varlistentry>
0219                     <varlistentry>
0220                         <term><menuchoice><guimenuitem>Rotate Right</guimenuitem></menuchoice></term>
0221                         <listitem><simpara><action>Rotate the whole symbol clockwise 90 degrees</action></simpara></listitem>
0222                     </varlistentry>
0223                     <varlistentry>
0224                         <term><menuchoice><guimenuitem>Flip Horizontal</guimenuitem></menuchoice></term>
0225                         <listitem><simpara><action>Flip the symbol across the vertical axis</action></simpara></listitem>
0226                     </varlistentry>
0227                     <varlistentry>
0228                         <term><menuchoice><guimenuitem>Flip Vertical</guimenuitem></menuchoice></term>
0229                         <listitem><simpara><action>Flip the symbol across the horizontal axis</action></simpara></listitem>
0230                     </varlistentry>
0231                     <varlistentry>
0232                         <term><menuchoice><guimenuitem>Scale to Preferred Size</guimenuitem></menuchoice></term>
0233                         <listitem>
0234                             <simpara><action>Scale the symbol to fit within the defined preferred size</action></simpara>
0235                             <simpara>Note that this only affects the points; where a non filled symbol
0236                                 is created and a line width is defined, this may extend beyond the
0237                                 guide size.</simpara>
0238                             </listitem>
0239                     </varlistentry>
0240                     <varlistentry>
0241                         <term><menuchoice><guimenuitem>Enable Snap</guimenuitem></menuchoice></term>
0242                         <listitem><simpara><action>Enable snapping of points to the grid</action></simpara></listitem>
0243                     </varlistentry>
0244                     <varlistentry>
0245                         <term><menuchoice><guimenuitem>Guide Lines</guimenuitem></menuchoice></term>
0246                         <listitem><simpara><action>Enable the generation of guide lines</action></simpara></listitem>
0247                     </varlistentry>
0248                 </variablelist>
0249             </para>
0250         </sect2>
0251 
0252         <sect2>
0253             <title>The Settings and Help Menu</title>
0254             <para>&symboleditor; has the common &kde; <guimenu>Settings</guimenu> and <guimenu>Help</guimenu>
0255             menu items, for more information read the sections about the <ulink url="help:/fundamentals/menus.html#menus-settings">Settings 
0256             Menu</ulink> and <ulink url="help:/fundamentals/menus.html#menus-help">Help Menu</ulink> of the &kde; Fundamentals.
0257             </para>
0258         </sect2>
0259     </sect1>
0260 </chapter>