Thread: [Scstudio-commits] SF.net SVN: scstudio:[974] trunk/doc/help (Page 2)

SourceForge Headquarters 1320 Columbia Street Suite 310 San Diego, CA 92101 +1 (858) 422-6466

Revision: 974
          http://scstudio.svn.sourceforge.net/scstudio/?rev=974&view=rev
Author:   mbezdeka
Date:     2010-09-18 18:06:18 +0000 (Sat, 18 Sep 2010)

Log Message:
-----------
frontend help fixed:
- added deleted message_numbering.html
- fixed page names in index.html, shortcuts.html

Modified Paths:
--------------
    trunk/doc/help/frontend/shortcuts.html
    trunk/doc/help/index.html

Added Paths:
-----------
    trunk/doc/help/frontend/message_numbering.html

Added: trunk/doc/help/frontend/message_numbering.html
===================================================================

--- trunk/doc/help/frontend/message_numbering.html	                        (rev 0)
+++ trunk/doc/help/frontend/message_numbering.html	2010-09-18 18:06:18 UTC (rev 974)
@@ -0,0 +1,75 @@
+<?xml version="1.0" encoding="utf-8"?>
+
+<!DOCTYPE html
+   PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd" >
+   
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<title>Message Numbering &ndash; SCStudio frontend</title>
+<link href="../help.css" rel="stylesheet" type="text/css">
+</head>
+<body>
+<h1>Message Numbering</h1>
+<p>Message numbering allows users to enumerate all types of message shapes (left, right, lost, found).<br>
+You can enumerate all messages on the active page (if no messages are selected) or the selection.<br>
+</p>
+
+<h2>Enable message numbering</h2>
+<p>By pressing Message numbering button <img src="pictures/icon_message_enumeration.png" alt="Message Numbering">, via menu <code>Check->Drawing->Message numbering->Message numbering</code> or by using hotkey <Code>Ctrl+Alt+E</Code> the dialog with options will be shown:</p>
+
+<p>
+<img src="pictures/message_numbering_options.png" alt="Message Numbering options dialog">
+</p>
+
+<p>You can choose:<br>
+- specific numbering type (numbers, letters, capital letters, romans)<br>
+- starting index (1-9999 for number, letters and capital letters and 1-3999 for romans)<br>
+- and additional string following the index such as ".", "-", &hellip; (max 4 chars). A space between the index and the message label is added automatically.<br>
+</p>
+
+<p>
+When the OK button is pressed, messages are numbered according to their positions on the page from left to right and then from top to bottom.<br>
+Already numbered messages will be overwritten by new numbering.
+ </p> 
+
+<h2>Disable message numbering</h2>
+<p>Numbering can be deleted by pressing Delete numbering button <img src="pictures/icon_message_enumeration_disable.png" alt="Disable message numbering"> on the toolbar, via menu <code>Check->Drawing->Message numbering->Delete numbering</code> or by using hotkey <Code>Ctrl+Alt+D.</Code></p>
+
+<p>
+Using <code>Delete numbering</code> on selection causes other messages indexes will be recomputed. <br>
+If no selection is used all numbering indexes will be deleted. 
+</p>
+
+<h2>Numbering group selection</h2>
+<p>When a group of messages is numbered, user can select it by right-click on any of numbered messages from group and choose <code>Select numbering group</code> from context menu. Example is shown in the following picture:</p>
+
+<p>
+<img src="pictures/select_numbering_group.png" alt="Select numbering group">
+</p>
+
+<h2>Auto numbering</h2>
+<p>New messages can be automatically numbered after they are dropped on the page. Specific behavior can be set via menu <code>Check->Drawing->Settings</code>, tab Numbering. Following dialog will be shown:</p>
+
+<p>
+<img src="pictures/message_numbering_autoenum_options.png" alt="Auto numbering options">
+</p>
+
+<p>
+Options are:<br>
+</p>
+
+<p>
+<code>automatic numbering new messages</code><br>
+&nbsp; &nbsp;- sets whether auto numbering is enabled, otherwise all other options are disabled.<br><br>
+<code>as nearest message</code><br>
+&nbsp; &nbsp;- new messages will be numbered according to the group of the closest message on the active page. All message indexes in the current group will be recounted. If the closest message isn't numbered, new one won't be either. <br>
+<code>as nearest numbered message</code><br>
+&nbsp; &nbsp;- new messages will be numbered according to the closest <b>numbered</b> message on the active page. If there are no numbered messages on the active page you can choose between: <br><br>
+&nbsp; &nbsp; &nbsp;<code>don't number</code><br>
+&nbsp; &nbsp; &nbsp;&nbsp; &nbsp;- don't number new messages if there are no numbered messages on the page.<br>
+&nbsp; &nbsp; &nbsp;<code>use numbering style</code><br>
+&nbsp; &nbsp; &nbsp;&nbsp; &nbsp;- use specific numbering style if there are no numbered messages on the page.<br>
+</p>
+</body>
+</html>
\ No newline at end of file

Modified: trunk/doc/help/frontend/shortcuts.html
===================================================================
--- trunk/doc/help/frontend/shortcuts.html	2010-09-18 17:43:26 UTC (rev 973)
+++ trunk/doc/help/frontend/shortcuts.html	2010-09-18 18:06:18 UTC (rev 974)
@@ -26,7 +26,7 @@
           <code>Ctrl+Alt+I</code>
         </td>
         <td>
-          <a href="shape-selection.html">Select all instances</a>
+          <a href="shape_selection.html">Select all instances</a>
         </td>
       </tr>
       <tr>
@@ -34,7 +34,7 @@
           <code>Ctrl+Alt+M</code>
         </td>
         <td>
-          <a href="shape-selection.html">Select all message</a>
+          <a href="shape_selection.html">Select all message</a>
         </td>
       </tr>
       <tr>
@@ -42,7 +42,7 @@
           <code>Ctrl+Alt+F</code>
         </td>
         <td>
-          <a href="automatic-drawing.html#add_instances">Add instances</a>
+          <a href="automatic_drawing.html#add_instances">Add instances</a>
         </td>
       </tr>
       <tr>
@@ -50,7 +50,7 @@
           <code>Ctrl+Alt+S</code>
         </td>
         <td>
-          <a href="automatic-drawing.html#message_sequence">Message sequence</a>
+          <a href="automatic_drawing.html#message_sequence">Message sequence</a>
         </td>
       </tr>
       <tr>
@@ -58,7 +58,7 @@
           <code>Ctrl+Alt+E</code>
         </td>
         <td>
-          <a href="message-numbering.html">Message Numbering</a>
+          <a href="message_numbering.html">Message Numbering</a>
         </td>
       </tr>
       <tr>
@@ -66,7 +66,7 @@
           <code>Ctrl+Alt+D</code>
         </td>
         <td>
-          <a href="message-numbering.html">Delete message numbering</a>
+          <a href="message_numbering.html">Delete message numbering</a>
         </td>
       </tr>
     </table>

Modified: trunk/doc/help/index.html
===================================================================
--- trunk/doc/help/index.html	2010-09-18 17:43:26 UTC (rev 973)
+++ trunk/doc/help/index.html	2010-09-18 18:06:18 UTC (rev 974)
@@ -20,16 +20,16 @@
         <a href="frontend.html">Microsoft Visio Front-end</a>
         <ul>
           <li>
-            <a href="frontend/shape-selection.html">Shape Selection</a>
+            <a href="frontend/shape_selection.html">Shape Selection</a>
           </li>
           <li>
-            <a href="frontend/automatic-drawing.html">Automatic Drawing</a>
+            <a href="frontend/automatic_drawing.html">Automatic Drawing</a>
           </li>
           <li>
-            <a href="frontend/message-numbering.html">Message Numbering</a>
+            <a href="frontend/message_numbering.html">Message Numbering</a>
           </li>
           <li>
-            <a href="frontend/message-snapping.html">Message Snapping</a>
+            <a href="frontend/message_snapping.html">Message Snapping</a>
           </li>
           <li>
             <a href="frontend/shortcuts.html">Keyboard Accelerators</a>


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.




Thread: [Scstudio-commits] SF.net SVN: scstudio:[974] trunk/doc/help (Page 2)

scstudio-commits