Menu
▾
▴
[Scstudio-commits] SF.net SVN: scstudio:[724] trunk/doc/help
|
From: <ob...@us...> - 2010-04-25 14:42:32
|
Revision: 724
http://scstudio.svn.sourceforge.net/scstudio/?rev=724&view=rev
Author: obouda
Date: 2010-04-25 14:42:25 +0000 (Sun, 25 Apr 2010)
Log Message:
-----------
Reorganized Frontend help
Modified Paths:
--------------
trunk/doc/help/frontend.html
trunk/doc/help/help.css
trunk/doc/help/scstudio.hhc
Added Paths:
-----------
trunk/doc/help/frontend/
trunk/doc/help/frontend/automatic-drawing.html
trunk/doc/help/frontend/pictures/
trunk/doc/help/frontend/pictures/add_instances_options.png
trunk/doc/help/frontend/pictures/frontend.png
trunk/doc/help/frontend/pictures/icon_select_add_instances.png
trunk/doc/help/frontend/pictures/icon_select_add_messages.png
trunk/doc/help/frontend/pictures/icon_select_instances.png
trunk/doc/help/frontend/pictures/icon_select_messages.png
trunk/doc/help/frontend/shape-selection.html
trunk/doc/help/frontend/shortcuts.html
Removed Paths:
-------------
trunk/doc/help/pictures/
Added: trunk/doc/help/frontend/automatic-drawing.html
===================================================================
--- trunk/doc/help/frontend/automatic-drawing.html (rev 0)
+++ trunk/doc/help/frontend/automatic-drawing.html 2010-04-25 14:42:25 UTC (rev 724)
@@ -0,0 +1,38 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+<html>
+<head>
+<title>Automatic Drawing – SCStudio frontend</title>
+<link href="../help.css" rel="stylesheet" type="text/css">
+</head>
+<body>
+<h1>Automatic drawing</h1>
+<p>With all required shapes available in the BMSC and HMSC stencils, it is possible
+to draw virtually any MSC diagram. In practice, there are many stereotypes, however.
+SCStudio helps the user draw some frequently used patterns by several automatic
+drawing functions.</p>
+
+<h2 id="add_instances">Add Instances</h2>
+<p>The first of them is the <code>Add Instances</code> function accessible via menu
+<code>Check → Drawing → Add Instances</code>, or <code>Ctrl+Alt+F</code>
+keyboard shortcut. It is available in the context (right-click) menu of the document, too.
+The function draws a given number of instances on the active
+page of the document, with constant or dynamic space between each two of them.</p>
+<p>When invoked, the following dialog appears:</p>
+<img class="big" src="pictures/add_instances_options.png" alt="Add Instances options dialog">
+<p>The first two fields set the number of instances to be drawn and their length.
+Next two fields set the starting point from which to start drawing. If the cursor
+was in the document drawing area in the time of Add Instances invocation (that is,
+the keyboard shortcut or context-menu was used), the start position fields are
+filled with the cursor position, i.e. drawing will start from the point where
+the cursor was.</p>
+<p>In the Options panel, if the Total width switch is chosen, all the instances
+will be drawn in the place of a width given, so the gaps between instances will be
+calculated to fit this area. On the contrary, the Spacing switch sets constant gaps
+between the instances not limiting the total width.</p>
+<p>All numbers in the dialog are in units of the current page of the document.</p>
+
+<h2 id="message_sequence">Message Sequence</h2>
+<p><i>Under development…</i></p>
+
+</body>
+</html>
Copied: trunk/doc/help/frontend/pictures/add_instances_options.png (from rev 723, trunk/doc/help/pictures/add_instances_options.png)
===================================================================
(Binary files differ)
Copied: trunk/doc/help/frontend/pictures/frontend.png (from rev 723, trunk/doc/help/pictures/frontend.png)
===================================================================
(Binary files differ)
Copied: trunk/doc/help/frontend/pictures/icon_select_add_instances.png (from rev 723, trunk/doc/help/pictures/icon_select_add_instances.png)
===================================================================
(Binary files differ)
Copied: trunk/doc/help/frontend/pictures/icon_select_add_messages.png (from rev 723, trunk/doc/help/pictures/icon_select_add_messages.png)
===================================================================
(Binary files differ)
Copied: trunk/doc/help/frontend/pictures/icon_select_instances.png (from rev 723, trunk/doc/help/pictures/icon_select_instances.png)
===================================================================
(Binary files differ)
Copied: trunk/doc/help/frontend/pictures/icon_select_messages.png (from rev 723, trunk/doc/help/pictures/icon_select_messages.png)
===================================================================
(Binary files differ)
Added: trunk/doc/help/frontend/shape-selection.html
===================================================================
--- trunk/doc/help/frontend/shape-selection.html (rev 0)
+++ trunk/doc/help/frontend/shape-selection.html 2010-04-25 14:42:25 UTC (rev 724)
@@ -0,0 +1,30 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+<html>
+<head>
+<title>Shape Selection – SCStudio frontend</title>
+<link href="../help.css" rel="stylesheet" type="text/css">
+</head>
+<body>
+<h1>Shape Selection</h1>
+<p>On top of standard Visio functions for selecting shapes (such as <code>Ctrl+A</code>
+shortcut for selecting all shapes), SCStudio offers several useful selection functions.</p>
+<p>The first toolbar button
+<img src="pictures/icon_select_instances.png" alt="Select instances button">
+selects all instances in the current page of active document. The second button
+<img src="pictures/icon_select_messages.png" alt="Select messages button">
+selects all messages in the current page of active document. These functions are
+also available via menu
+<code>Check → Drawing → Select → All Instances</code>, or
+<code>All Messages</code>, respectively. Keyboard shortcuts are assigned to
+these functions, too: <code>Ctrl+Alt+I</code> for selecting all instances and
+<code>Ctrl+Alt+M</code> for selecting all messages.</p>
+<p>While holding <code>Ctrl</code> or <code>Shift</code>, the first two buttons
+alter their face and functionality, however:
+<img src="pictures/icon_select_add_instances.png" alt="Add instances to selection button">
+<img src="pictures/icon_select_add_messages.png" alt="Add messages to selection button">
+In that case, they <em>add</em> all
+instances (or messages) to the current selection instead of making a new
+selection.</p>
+
+</body>
+</html>
Added: trunk/doc/help/frontend/shortcuts.html
===================================================================
--- trunk/doc/help/frontend/shortcuts.html (rev 0)
+++ trunk/doc/help/frontend/shortcuts.html 2010-04-25 14:42:25 UTC (rev 724)
@@ -0,0 +1,19 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+<html>
+<head>
+<title>SCStudio Visio addon keyboard accelerators</title>
+<link href="../help.css" rel="stylesheet" type="text/css">
+</head>
+<body>
+<h1>Visio addon keyboard accelerators</h1>
+<p>The following keyboard accelerators are defined by SCStudio Visio addon:</p>
+<table>
+<col width="100"> <col>
+<tr><td><code>Ctrl+Alt+I</code></td><td><a href="shape-selection.html">Select all instances</a></td></tr>
+<tr><td><code>Ctrl+Alt+M</code></td><td><a href="shape-selection.html">Select all message</a></td></tr>
+<tr><td><code>Ctrl+Alt+F</code></td><td><a href="automatic-drawing.html#add_instances">Add instances</a></td></tr>
+<tr><td><code>Ctrl+Alt+S</code></td><td><a href="automatic-drawing.html#message_sequence">Message sequence</a></td></tr>
+</table>
+
+</body>
+</html>
Modified: trunk/doc/help/frontend.html
===================================================================
--- trunk/doc/help/frontend.html 2010-04-23 23:57:59 UTC (rev 723)
+++ trunk/doc/help/frontend.html 2010-04-25 14:42:25 UTC (rev 724)
@@ -11,59 +11,17 @@
SCStudio.</p>
<p>When an MSC document is opened, the Sequence Chart Studio toolbar and menu Check
are available:</p>
-<img class="big" src="pictures/frontend.png" alt="SCStudio toolbar and menu in MS Visio">
+<img class="big" src="frontend/pictures/frontend.png" alt="SCStudio toolbar and menu in MS Visio">
-<h2>Shape Selection</h2>
-<p>On top of standard Visio functions for selecting shapes (such as <code>Ctrl+A</code>
-shortcut for selecting all shapes), SCStudio offers several useful selection functions.</p>
-<p>The first toolbar button
-<img src="pictures/icon_select_instances.png" alt="Select instances button">
-selects all instances in the current page of active document. The second button
-<img src="pictures/icon_select_messages.png" alt="Select messages button">
-selects all messages in the current page of active document. These functions are
-also available via menu
-<code>Check → Drawing → Select → All Instances</code>, or
-<code>All Messages</code>, respectively. Keyboard shortcuts are assigned to
-these functions, too: <code>Ctrl+Alt+I</code> for selecting all instances and
-<code>Ctrl+Alt+M</code> for selecting all messages.</p>
-<p>While holding <code>Ctrl</code> or <code>Shift</code>, the first two buttons
-alter their face and functionality, however:
-<img src="pictures/icon_select_add_instances.png" alt="Add instances to selection button">
-<img src="pictures/icon_select_add_messages.png" alt="Add messages to selection button">
-In that case, they <em>add</em> all
-instances (or messages) to the current selection instead of making a new
-selection.</p>
+<p>SCStudio functions extending Visio are divided into the following categories:</p>
+<ul>
+<li><a href="frontend/shape-selection.html">Shape selection</a></li>
+<li><a href="frontend/automatic-drawing.html">Automatic drawing</a></li>
+</ul>
+<p>Many SCStudio functions define their own keyboard accelerators.
+See the <a href="frontend/shortcuts.html">Keyboard accelerators</a> section to
+list all of them.</p>
-<h2>Automatic drawing</h2>
-<p>With all required shapes available in the BMSC and HMSC stencils, it is possible
-to draw virtually any MSC diagram. In practice, there are many stereotypes, however.
-SCStudio helps the user draw some frequently used patterns by several automatic
-drawing functions.</p>
-
-<h3>Add Instances</h3>
-<p>The first of them is the <code>Add Instances</code> function accessible via menu
-<code>Check → Drawing → Add Instances</code>, or <code>Ctrl+Alt+F</code>
-keyboard shortcut. It is available in the context (right-click) menu of the document, too.
-The function draws a given number of instances on the active
-page of the document, with constant or dynamic space between each two of them.</p>
-<p>When invoked, the following dialog appears:</p>
-<img class="big" src="pictures/add_instances_options.png" alt="Add Instances options dialog">
-<p>The first two fields set the number of instances to be drawn and their length.
-Next two fields set the starting point from which to start drawing. If the cursor
-was in the document drawing area in the time of Add Instances invocation (that is,
-the keyboard shortcut or context-menu was used), the start position fields are
-filled with the cursor position, i.e. drawing will start from the point where
-the cursor was.</p>
-<p>In the Options panel, if the Total width switch is chosen, all the instances
-will be drawn in the place of a width given, so the gaps between instances will be
-calculated to fit this area. On the contrary, the Spacing switch sets constant gaps
-between the instances not limiting the total width.</p>
-<p>All numbers in the dialog are in units of the current page of the document.</p>
-
-<h3>Message Sequence</h3>
-<p><i>Under development…</i></p>
-
-
</body>
</html>
Modified: trunk/doc/help/help.css
===================================================================
--- trunk/doc/help/help.css 2010-04-23 23:57:59 UTC (rev 723)
+++ trunk/doc/help/help.css 2010-04-25 14:42:25 UTC (rev 724)
@@ -25,4 +25,7 @@
code {
font-size: 1.2em;
}
+table {
+ font-size: 1em;
+}
Modified: trunk/doc/help/scstudio.hhc
===================================================================
--- trunk/doc/help/scstudio.hhc 2010-04-23 23:57:59 UTC (rev 723)
+++ trunk/doc/help/scstudio.hhc 2010-04-25 14:42:25 UTC (rev 724)
@@ -12,6 +12,20 @@
<param name="Name" value="Frontend">
<param name="Local" value="frontend.html">
</OBJECT>
+ <UL>
+ <LI> <OBJECT type="text/sitemap">
+ <param name="Name" value="Shape selection">
+ <param name="Local" value="frontend\shape-selection.html">
+ </OBJECT>
+ <LI> <OBJECT type="text/sitemap">
+ <param name="Name" value="Automatic drawing">
+ <param name="Local" value="frontend\automatic-drawing.html">
+ </OBJECT>
+ <LI> <OBJECT type="text/sitemap">
+ <param name="Name" value="Keyboard accelerators">
+ <param name="Local" value="frontend\shortcuts.html">
+ </OBJECT>
+ </UL>
<LI> <OBJECT type="text/sitemap">
<param name="Name" value="Algorithms">
<param name="Local" value="algorithms.html">
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
