Menu
▾
▴
[Scstudio-commits] SF.net SVN: scstudio:[1278] trunk/doc/help
|
From: <xr...@us...> - 2012-01-12 09:36:42
|
Revision: 1278
http://scstudio.svn.sourceforge.net/scstudio/?rev=1278&view=rev
Author: xrehak
Date: 2012-01-12 09:36:31 +0000 (Thu, 12 Jan 2012)
Log Message:
-----------
New CMakeList for generating html files from %.head.htm + menu[i].htm + %.body.htm
Modified Paths:
--------------
trunk/doc/help/CMakeLists.txt
trunk/doc/help/index.html
Added Paths:
-----------
trunk/doc/help/index.body.htm
trunk/doc/help/index.head.htm
trunk/doc/help/menu.htm
trunk/doc/help/menui.htm
trunk/doc/help/race/race.body.htm
trunk/doc/help/race/race.head.htm
Modified: trunk/doc/help/CMakeLists.txt
===================================================================
--- trunk/doc/help/CMakeLists.txt 2012-01-11 07:36:47 UTC (rev 1277)
+++ trunk/doc/help/CMakeLists.txt 2012-01-12 09:36:31 UTC (rev 1278)
@@ -1,26 +1,60 @@
-FIND_PACKAGE(HTMLHelp)
-IF(HTML_HELP_COMPILER)
- ADD_CUSTOM_TARGET(help ALL
- DEPENDS scstudio.chm
+# auxiliary files are names %.htm (because all %.html files are included
+# into installation package of SCStudio)
+
+# list of files generated by preprocessing from %.head.htm + menu.htm + %.body.htm
+set( HTML_FILES
+ index.html
+)
+
+# list of files generated by preprocessing from %/%.head.htm + menui.htm + %/%.body.htm
+set( iHTML_FILES
+ race/race.html
+)
+
+IF(WIN32)
+ set(TYPEORCAT "type")
+ELSE(WIN32)
+ set(TYPEORCAT "cat")
+ENDIF(WIN32)
+
+ADD_CUSTOM_TARGET(HTML ALL
+ DEPENDS menu.htm menui.htm ${HTML_FILES} ${iHTML_FILES}
+)
+
+
+# changes file path to native (win vs. linux) and erase ".html" at the end
+MACRO(SHORT_NAT_PATH inputvar outputvar)
+ FILE(TO_NATIVE_PATH ${${inputvar}} NATIVE_FILE)
+ STRING(REPLACE ".html" "" ${outputvar} ${NATIVE_FILE})
+ENDMACRO(SHORT_NAT_PATH)
+
+
+# ${HTML_FILES} with menu.htm
+FOREACH(FILE ${HTML_FILES})
+ # new %.html file is composed from from %.head.htm + menu.htm + %.body.htm
+ SHORT_NAT_PATH(FILE SHORT_FILE)
+ ADD_CUSTOM_COMMAND(
+# TARGET HTML
+ OUTPUT ${FILE}
+ COMMAND ${TYPEORCAT} ${SHORT_FILE}.head.htm menu.htm ${SHORT_FILE}.body.htm >${FILE}
+ DEPENDS ${SHORT_FILE}.head.htm menu.htm ${SHORT_FILE}.body.htm
+ WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
)
+ENDFOREACH(FILE)
+
+# ${iHTML_FILES} with menui.htm
+FOREACH(FILE ${iHTML_FILES})
+ # new %.html file is composed from from %.head.htm + menui.htm + %.body.htm
+ SHORT_NAT_PATH(FILE SHORT_FILE)
ADD_CUSTOM_COMMAND(
- OUTPUT scstudio.chm
- COMMAND ${CMAKE_COMMAND} -DHTML_HELP_COMPILER=${HTML_HELP_COMPILER} -P ${CMAKE_CURRENT_SOURCE_DIR}/hhc.cmake
- DEPENDS
- help.css
- algorithms.html
- frontend.html
- localChoice/localchoice.html
- membership/membership.html
- fifo/fifo.html
- deadlock/deadlock.html
- livelock/livelock.html
- race/race.html
- realizability/realizability.html
- boundedness/boundedness.html
+# TARGET HTML
+ OUTPUT ${FILE}
+ COMMAND ${TYPEORCAT} ${SHORT_FILE}.head.htm menui.htm ${SHORT_FILE}.body.htm >${FILE}
+ DEPENDS ${SHORT_FILE}.head.htm menui.htm ${SHORT_FILE}.body.htm
WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
)
-ENDIF(HTML_HELP_COMPILER)
+ENDFOREACH(FILE)
# $Id$
+
Added: trunk/doc/help/index.body.htm
===================================================================
--- trunk/doc/help/index.body.htm (rev 0)
+++ trunk/doc/help/index.body.htm 2012-01-12 09:36:31 UTC (rev 1278)
@@ -0,0 +1,25 @@
+ <div class="content">
+<h1>Basic Overview</h1>
+
+<p>
+The Sequence Chart Studio (scstudio) is a user-friendly drawing and verification tool for Message Sequence Charts (basic MSC, HMSC) and UML Sequence Diagrams. It provides several verification algorithms and offers an open interface for additional modules. The graphical front-end is implemented as a Microsoft Visio add-on, but integration with other applications is possible.
+</p>
+<p>
+The Sequence Chart Studio enables users of Microsoft Visio 2003/2007 to: </p>
+
+<ul>
+
+ <li>Draw basic MSC: line instances, messages, coregions, general ordering, time constraints and measurements</li>
+ <li>Draw HMSC: references, conditions, connections</li>
+ <li>Export and import the ITU-T Z.120 textual format (.mpr)</li>
+ <li>Perform graphical syntax verification</li>
+ <li>Execute verification algorithms: detect deadlock/livelock, detect cycles, race conditions and universal boundedness</li>
+ <li>Determine probability distribution of time constraints using Monte Carlo simulation</li>
+ <li>Develop proprietary stencils and verification/export modules</li>
+</ul>
+
+<img src="pictures/scstudio.png" alt="SCStudio screenshot" title="SCStudio screenshot"/>
+
+ </div>
+ </body>
+</html>
Property changes on: trunk/doc/help/index.body.htm
___________________________________________________________________
Added: svn:keywords
+ Date Revision Author HeadURL Id
Added: svn:eol-style
+ native
Added: trunk/doc/help/index.head.htm
===================================================================
--- trunk/doc/help/index.head.htm (rev 0)
+++ trunk/doc/help/index.head.htm 2012-01-12 09:36:31 UTC (rev 1278)
@@ -0,0 +1,14 @@
+<?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>
+ <link href="help.css" rel="stylesheet" type="text/css" />
+ <title>
+ Sequence Chart Studio - help
+ </title>
+ </head>
+ <body>
Property changes on: trunk/doc/help/index.head.htm
___________________________________________________________________
Added: svn:keywords
+ Date Revision Author HeadURL Id
Added: svn:eol-style
+ native
Modified: trunk/doc/help/index.html
===================================================================
--- trunk/doc/help/index.html 2012-01-11 07:36:47 UTC (rev 1277)
+++ trunk/doc/help/index.html 2012-01-12 09:36:31 UTC (rev 1278)
@@ -8,7 +8,7 @@
<head>
<link href="help.css" rel="stylesheet" type="text/css" />
<title>
- Content
+ Sequence Chart Studio - help
</title>
</head>
<body>
Added: trunk/doc/help/menu.htm
===================================================================
--- trunk/doc/help/menu.htm (rev 0)
+++ trunk/doc/help/menu.htm 2012-01-12 09:36:31 UTC (rev 1278)
@@ -0,0 +1,100 @@
+ <div class="menu">
+ <h1>
+ <a href="index.html">Sequence Chart Studio</a>
+ </h1>
+ <ul>
+ <li>
+ Microsoft Visio Front-end
+ <ul>
+ <li>
+ <a href="frontend/shape_selection.html">Shape selection</a>
+ </li>
+ <li>
+ <a href="frontend/automatic_drawing.html">Automatic drawing</a>
+ </li>
+ <li>
+ <a href="frontend/message_numbering.html">Element numbering</a>
+ </li>
+ <li>
+ <a href="frontend/flip_message_direction.html">Flip message direction</a>
+ </li>
+ <li>
+ <a href="frontend/settings.html">Options</a>
+ </li>
+ </ul>
+ </li>
+ <li>
+ Verification Algorithms
+ <ul>
+ <li>
+ <a href="acyclic/acyclic.html">Acyclic property</a>
+ </li>
+ <li>
+ <a href="time_syntax/time_syntax.html">Correct Time Constraint
+ Syntax</a>
+ </li>
+ <li>
+ <a href="deadlock/deadlock.html">Deadlock Free</a>
+ </li>
+ <li>
+ <a href="fifo/fifo.html">FIFO - First In First Out</a>
+ </li>
+ <li>
+ <a href="livelock/livelock.html">Livelock Free</a>
+ </li>
+ <li>
+ <a href="localchoice/localchoice.html">Local Choice</a>
+ </li>
+ <li>
+ <a href="recursivity/recursivity.html">Nonrecursivity</a>
+ </li>
+ <li>
+ <a href="race/race.html">Race Condition</a>
+ </li>
+ <li>
+ <a href="realizability/realizability.html">Strong Realizability</a>
+ </li>
+ <li>
+ <a href="time_consistency/time_consistency.html">Time Consistent</a>
+ </li>
+ <li>
+ <a href="time_trace_race/time_race.html">Time Race</a>
+ </li>
+ <li>
+ <a href="unique_instance/unique_instance.html">Unique Instance
+ Names</a>
+ </li>
+ <li>
+ <a href="boundedness/boundedness.html">Universal Boundedness</a>
+ </li>
+ </ul>
+ </li>
+ <li>
+ <a href="membership/membership.html">Find Flow</a>
+ </li>
+ <li>
+ <a href="montecarlo/montecarlo.html">Monte Carlo Simulation</a>
+ </li>
+ <li>
+ Drawing Transformers
+ <ul>
+
+ <li>
+ <a href="beautify/beautify.html">Beautify</a>
+ </li>
+ <li>
+ <a href="time_tighten/time_tighten.html">Tighten Time</a>
+ </li>
+ <li>
+ Repaint
+ </li>
+ </ul>
+ </li>
+ </ul>
+ <div class="footer">
+ <p><a href="http://scstudio.sourceforge.net/" target="_blank">scstudio homepage</a></p>
+ <p><a href="http://sourceforge.net/projects/scstudio/" target="_blank">scstudio on sourceforge</a></p>
+ <p>The software is freely available under <a target="_blank" href="http://www.gnu.org/licenses/lgpl.html">LGPL</a>.</p>
+ <p>© 2010</p>
+ </div>
+ </div>
Property changes on: trunk/doc/help/menu.htm
___________________________________________________________________
Added: svn:keywords
+ Date Revision Author HeadURL Id
Added: svn:eol-style
+ native
Added: trunk/doc/help/menui.htm
===================================================================
--- trunk/doc/help/menui.htm (rev 0)
+++ trunk/doc/help/menui.htm 2012-01-12 09:36:31 UTC (rev 1278)
@@ -0,0 +1,100 @@
+ <div class="menu">
+ <h1>
+ <a href="../index.html">Sequence Chart Studio</a>
+ </h1>
+ <ul>
+ <li>
+ Microsoft Visio Front-end
+ <ul>
+ <li>
+ <a href="../frontend/shape_selection.html">Shape selection</a>
+ </li>
+ <li>
+ <a href="../frontend/automatic_drawing.html">Automatic drawing</a>
+ </li>
+ <li>
+ <a href="../frontend/message_numbering.html">Element numbering</a>
+ </li>
+ <li>
+ <a href="../frontend/flip_message_direction.html">Flip message direction</a>
+ </li>
+ <li>
+ <a href="../frontend/settings.html">Options</a>
+ </li>
+ </ul>
+ </li>
+ <li>
+ Verification Algorithms
+ <ul>
+ <li>
+ <a href="../acyclic/acyclic.html">Acyclic property</a>
+ </li>
+ <li>
+ <a href="../time_syntax/time_syntax.html">Correct Time Constraint
+ Syntax</a>
+ </li>
+ <li>
+ <a href="../deadlock/deadlock.html">Deadlock Free</a>
+ </li>
+ <li>
+ <a href="../fifo/fifo.html">FIFO - First In First Out</a>
+ </li>
+ <li>
+ <a href="../livelock/livelock.html">Livelock Free</a>
+ </li>
+ <li>
+ <a href="../localchoice/localchoice.html">Local Choice</a>
+ </li>
+ <li>
+ <a href="../recursivity/recursivity.html">Nonrecursivity</a>
+ </li>
+ <li>
+ <a href="../race/race.html">Race Condition</a>
+ </li>
+ <li>
+ <a href="../realizability/realizability.html">Strong Realizability</a>
+ </li>
+ <li>
+ <a href="../time_consistency/time_consistency.html">Time Consistent</a>
+ </li>
+ <li>
+ <a href="../time_trace_race/time_race.html">Time Race</a>
+ </li>
+ <li>
+ <a href="../unique_instance/unique_instance.html">Unique Instance
+ Names</a>
+ </li>
+ <li>
+ <a href="../boundedness/boundedness.html">Universal Boundedness</a>
+ </li>
+ </ul>
+ </li>
+ <li>
+ <a href="../membership/membership.html">Find Flow</a>
+ </li>
+ <li>
+ <a href="../montecarlo/montecarlo.html">Monte Carlo Simulation</a>
+ </li>
+ <li>
+ Drawing Transformers
+ <ul>
+
+ <li>
+ <a href="../beautify/beautify.html">Beautify</a>
+ </li>
+ <li>
+ <a href="../time_tighten/time_tighten.html">Tighten Time</a>
+ </li>
+ <li>
+ Repaint
+ </li>
+ </ul>
+ </li>
+ </ul>
+ <div class="footer">
+ <p><a href="http://scstudio.sourceforge.net/" target="_blank">scstudio homepage</a></p>
+ <p><a href="http://sourceforge.net/projects/scstudio/" target="_blank">scstudio on sourceforge</a></p>
+ <p>The software is freely available under <a target="_blank" href="http://www.gnu.org/licenses/lgpl.html">LGPL</a>.</p>
+ <p>© 2010</p>
+ </div>
+ </div>
Property changes on: trunk/doc/help/menui.htm
___________________________________________________________________
Added: svn:keywords
+ Date Revision Author HeadURL Id
Added: svn:eol-style
+ native
Added: trunk/doc/help/race/race.body.htm
===================================================================
--- trunk/doc/help/race/race.body.htm (rev 0)
+++ trunk/doc/help/race/race.body.htm 2012-01-12 09:36:31 UTC (rev 1278)
@@ -0,0 +1,97 @@
+ <div class="content">
+ <h1>
+ Race Condition
+ </h1>
+ <p>
+ Informally, two events are in race if they are specified by user to
+ perform in some order, but there is a possibility that they can perform in
+ an inverse order. Race condition occurs in a BMSC whenever a pair of
+ events is drawn in a particular order but there exists a execution with a
+ different order. If the real implementation is based on the BMSC
+ specification, it may lead to a system failure. Do not mix up race
+ condition with <a href="../fifo/fifo.html">FIFO</a>; race
+ condition is only applicable for BMSCs that satisfy FIFO.
+ </p>
+ <p>
+ SCStudio finds all pairs of events in a given BMSC and also in BMSCs
+ referenced by an HMSC. On the next picture there is an example of an BMSC
+ which contains race condition:
+ </p>
+ <ul class="gallery">
+ <li>
+ <ul>
+ <li>
+ <img src="pictures/easyrace_1.png" width="300" border="0"
+ alt="Input BMSC" title="Input BMSC" />
+ </li>
+ <li class="caption">
+ Input BMSC
+ </li>
+ </ul>
+ </li>
+ <li>
+ <ul>
+ <li>
+ <img src="pictures/easyrace_2.png" width="300" border="0"
+ alt="Possible execution" title="Possible execution" />
+ </li>
+ <li class="caption">
+ Possible execution
+ </li>
+ </ul>
+ </li>
+ <li>
+ <ul>
+ <li>
+ <img src="pictures/easyrace_result.png" width="300" border="0"
+ alt="SCStudio result" title="SCStudio result" />
+ </li>
+ <li class="caption">
+ SCStudio result
+ </li>
+ </ul>
+ </li>
+ </ul>
+ <p>
+ The race condition may also occur between events from different BMSC
+ within an HMSC. HMSC contains race if there exists path which contains a
+ race. SCStudio is capable of finding one such occurrence:
+ </p>
+ <ul class="gallery">
+ <li>
+ <ul>
+ <li>
+ <img src="pictures/trickyrace_1.png" width="100" border="0"
+ alt="Input HMSC" title="Input HMSC" />
+ </li>
+ <li class="caption">
+ Input HMSC with a race
+ </li>
+ </ul>
+ </li>
+ <li>
+ <ul>
+ <li>
+ <img src="pictures/trickyrace_2.png" width="300" border="0"
+ alt="MSC A" title="MSC A" />
+ </li>
+ <li class="caption">
+ MSC A
+ </li>
+ </ul>
+ </li>
+ <li>
+ <ul>
+ <li>
+ <img src="pictures/trickyrace_3.png" width="300" border="0"
+ alt="MSC B" title="MSC B" />
+ </li>
+ <li class="caption">
+ MSC B
+ </li>
+ </ul>
+ </li>
+ </ul>
+</div>
+ </body>
+</html>
Property changes on: trunk/doc/help/race/race.body.htm
___________________________________________________________________
Added: svn:keywords
+ Date Revision Author HeadURL Id
Added: svn:eol-style
+ native
Added: trunk/doc/help/race/race.head.htm
===================================================================
--- trunk/doc/help/race/race.head.htm (rev 0)
+++ trunk/doc/help/race/race.head.htm 2012-01-12 09:36:31 UTC (rev 1278)
@@ -0,0 +1,15 @@
+<?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>
+ Race Condition
+ </title>
+ <meta name="author" content="Martin Chmelik" />
+ <link href="../help.css" rel="stylesheet" type="text/css" />
+ </head>
+ <body>
Property changes on: trunk/doc/help/race/race.head.htm
___________________________________________________________________
Added: svn:keywords
+ Date Revision Author HeadURL Id
Added: svn:eol-style
+ native
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
