/usr/share/sitplus/doc/activities.html

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
    "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.2.7" />
<style type="text/css">
/* Debug borders */
p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
/*
  border: 1px solid red;
*/
}

body {
  margin: 1em 5% 1em 5%;
}

a {
  color: blue;
  text-decoration: underline;
}
a:visited {
  color: fuchsia;
}

em {
  font-style: italic;
  color: navy;
}

strong {
  font-weight: bold;
  color: #083194;
}

tt {
  color: navy;
}

h1, h2, h3, h4, h5, h6 {
  color: #527bbd;
  font-family: sans-serif;
  margin-top: 1.2em;
  margin-bottom: 0.5em;
  line-height: 1.3;
}

h1, h2, h3 {
  border-bottom: 2px solid silver;
}
h2 {
  padding-top: 0.5em;
}
h3 {
  float: left;
}
h3 + * {
  clear: left;
}

div.sectionbody {
  font-family: serif;
  margin-left: 0;
}

hr {
  border: 1px solid silver;
}

p {
  margin-top: 0.5em;
  margin-bottom: 0.5em;
}

ul, ol, li > p {
  margin-top: 0;
}

pre {
  padding: 0;
  margin: 0;
}

span#author {
  color: #527bbd;
  font-family: sans-serif;
  font-weight: bold;
  font-size: 1.1em;
}
span#email {
}
span#revision {
  font-family: sans-serif;
}

div#footer {
  font-family: sans-serif;
  font-size: small;
  border-top: 2px solid silver;
  padding-top: 0.5em;
  margin-top: 4.0em;
}
div#footer-text {
  float: left;
  padding-bottom: 0.5em;
}
div#footer-badges {
  float: right;
  padding-bottom: 0.5em;
}

div#preamble,
div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
div.admonitionblock {
  margin-right: 10%;
  margin-top: 1.5em;
  margin-bottom: 1.5em;
}
div.admonitionblock {
  margin-top: 2.5em;
  margin-bottom: 2.5em;
}

div.content { /* Block element content. */
  padding: 0;
}

/* Block element titles. */
div.title, caption.title {
  color: #527bbd;
  font-family: sans-serif;
  font-weight: bold;
  text-align: left;
  margin-top: 1.0em;
  margin-bottom: 0.5em;
}
div.title + * {
  margin-top: 0;
}

td div.title:first-child {
  margin-top: 0.0em;
}
div.content div.title:first-child {
  margin-top: 0.0em;
}
div.content + div.title {
  margin-top: 0.0em;
}

div.sidebarblock > div.content {
  background: #ffffee;
  border: 1px solid silver;
  padding: 0.5em;
}

div.listingblock {
  margin-right: 0%;
}
div.listingblock > div.content {
  border: 1px solid silver;
  background: #f4f4f4;
  padding: 0.5em;
}

div.quoteblock {
  padding-left: 2.0em;
}
div.quoteblock > div.attribution {
  padding-top: 0.5em;
  text-align: right;
}

div.verseblock {
  padding-left: 2.0em;
}
div.verseblock > div.content {
  white-space: pre;
}
div.verseblock > div.attribution {
  padding-top: 0.75em;
  text-align: left;
}
/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
div.verseblock + div.attribution {
  text-align: left;
}

div.admonitionblock .icon {
  vertical-align: top;
  font-size: 1.1em;
  font-weight: bold;
  text-decoration: underline;
  color: #527bbd;
  padding-right: 0.5em;
}
div.admonitionblock td.content {
  padding-left: 0.5em;
  border-left: 2px solid silver;
}

div.exampleblock > div.content {
  border-left: 2px solid silver;
  padding: 0.5em;
}

div.imageblock div.content { padding-left: 0; }
div.imageblock img { border: 1px solid silver; }
span.image img { border-style: none; }

dl {
  margin-top: 0.8em;
  margin-bottom: 0.8em;
}
dt {
  margin-top: 0.5em;
  margin-bottom: 0;
  font-style: normal;
}
dd > *:first-child {
  margin-top: 0.1em;
}

ul, ol {
    list-style-position: outside;
}
div.olist > ol {
  list-style-type: decimal;
}
div.olist2 > ol {
  list-style-type: lower-alpha;
}

div.tableblock > table {
  border: 3px solid #527bbd;
}
thead {
  font-family: sans-serif;
  font-weight: bold;
}
tfoot {
  font-weight: bold;
}

div.hlist {
  margin-top: 0.8em;
  margin-bottom: 0.8em;
}
div.hlist td {
  padding-bottom: 15px;
}
td.hlist1 {
  vertical-align: top;
  font-style: normal;
  padding-right: 0.8em;
}
td.hlist2 {
  vertical-align: top;
}

@media print {
  div#footer-badges { display: none; }
}

div#toctitle {
  color: #527bbd;
  font-family: sans-serif;
  font-size: 1.1em;
  font-weight: bold;
  margin-top: 1.0em;
  margin-bottom: 0.1em;
}

div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
  margin-top: 0;
  margin-bottom: 0;
}
div.toclevel2 {
  margin-left: 2em;
  font-size: 0.9em;
}
div.toclevel3 {
  margin-left: 4em;
  font-size: 0.9em;
}
div.toclevel4 {
  margin-left: 6em;
  font-size: 0.9em;
}
/* Workarounds for IE6's broken and incomplete CSS2. */

div.sidebar-content {
  background: #ffffee;
  border: 1px solid silver;
  padding: 0.5em;
}
div.sidebar-title, div.image-title {
  color: #527bbd;
  font-family: sans-serif;
  font-weight: bold;
  margin-top: 0.0em;
  margin-bottom: 0.5em;
}

div.listingblock div.content {
  border: 1px solid silver;
  background: #f4f4f4;
  padding: 0.5em;
}

div.quoteblock-attribution {
  padding-top: 0.5em;
  text-align: right;
}

div.verseblock-content {
  white-space: pre;
}
div.verseblock-attribution {
  padding-top: 0.75em;
  text-align: left;
}

div.exampleblock-content {
  border-left: 2px solid silver;
  padding-left: 0.5em;
}

/* IE6 sets dynamically generated links as visited. */
div#toc a:visited { color: blue; }

/* Because IE6 child selector is broken. */
div.olist2 ol {
  list-style-type: lower-alpha;
}
div.olist2 div.olist ol {
  list-style-type: decimal;
}
</style>
<script type="text/javascript">
/*<![CDATA[*/
window.onload = function(){generateToc(2)}
/* Author: Mihai Bazon, September 2002
 * http://students.infoiasi.ro/~mishoo
 *
 * Table Of Content generator
 * Version: 0.4
 *
 * Feel free to use this script under the terms of the GNU General Public
 * License, as long as you do not remove or alter this notice.
 */

 /* modified by Troy D. Hanson, September 2006. License: GPL */
 /* modified by Stuart Rackham, October 2006. License: GPL */

function getText(el) {
  var text = "";
  for (var i = el.firstChild; i != null; i = i.nextSibling) {
    if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
      text += i.data;
    else if (i.firstChild != null)
      text += getText(i);
  }
  return text;
}

function TocEntry(el, text, toclevel) {
  this.element = el;
  this.text = text;
  this.toclevel = toclevel;
}

function tocEntries(el, toclevels) {
  var result = new Array;
  var re = new RegExp('[hH]([2-'+(toclevels+1)+'])');
  // Function that scans the DOM tree for header elements (the DOM2
  // nodeIterator API would be a better technique but not supported by all
  // browsers).
  var iterate = function (el) {
    for (var i = el.firstChild; i != null; i = i.nextSibling) {
      if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
        var mo = re.exec(i.tagName)
        if (mo)
          result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
        iterate(i);
      }
    }
  }
  iterate(el);
  return result;
}

// This function does the work. toclevels = 1..4.
function generateToc(toclevels) {
  var toc = document.getElementById("toc");
  var entries = tocEntries(document.getElementsByTagName("body")[0], toclevels);
  for (var i = 0; i < entries.length; ++i) {
    var entry = entries[i];
    if (entry.element.id == "")
      entry.element.id = "toc" + i;
    var a = document.createElement("a");
    a.href = "#" + entry.element.id;
    a.appendChild(document.createTextNode(entry.text));
    var div = document.createElement("div");
    div.appendChild(a);
    div.className = "toclevel" + entry.toclevel;
    toc.appendChild(div);
  }
  if (entries.length == 0)
    document.getElementById("header").removeChild(toc);
}
/*]]>*/
</script>
<title>SITPLUS script syntax</title>
</head>
<body>
<div id="header">
<h1>SITPLUS script syntax</h1>
<span id="author">Cesar Mauri</span><br />
<span id="email"><tt>&lt;<a href="mailto:cesar@crea-si.com">cesar@crea-si.com</a>&gt;</tt></span><br />
<div id="toc">
  <div id="toctitle">Table of Contents</div>
  <noscript><p><b>JavaScript must be enabled in your browser to display the table of contents.</b></p></noscript>
</div>
</div>
<div id="preamble">
<div class="sectionbody">
<div class="para"><p>This document the syntax of the scripting language used by the SITPLUS
project. These scripts usually have the .sp and .sps extensions.</p></div>
</div>
</div>
<h2 id="_comments">Comments</h2>
<div class="sectionbody">
<div class="para"><p>Line comments start with <em>#</em>.</p></div>
<div class="para"><p>Blank lines are ignored.</p></div>
</div>
<h2 id="_commands">Commands</h2>
<div class="sectionbody">
<div class="vlist"><dl>
<dt>
<strong><tt>type &lt;id&gt;</tt></strong>
</dt>
<dd>
<p>
        Sets the name which identifies the component class that is being
        defined. Used when creating (see create below) instances of this component.
</p>
</dd>
<dt>
<strong><tt>name &lt;name&gt;</tt></strong>
</dt>
<dd>
<p>
        Name given to the component. Must appear at the very beginning
        of the script, otherwise parsing will fail. It is usually used as a title
        for GUI elements.
</p>
</dd>
<dt>
<strong><tt>args &lt;arguments_declaration&gt;</tt></strong>
</dt>
<dd>
<p>
        Allows to declare the formal parameters that the component expects. Each
        parameter name must begin with a dash <tt>-</tt>. Once declared an argument
        can be used inside the script by just enclosing its name between <tt>$</tt>
        symbols. That is, if the argument is called <tt>-v</tt>, you can       instantiate it by
        writing <tt>$-v$</tt>. When an argument is instantiated it is  simply replaced by
        its value.
</p>
<div class="vlist"><dl>
<dt>
Parameters are passed when the component is created (see <tt>create</tt> command       below) and all expected arguments are mandatory.
</dt>
<dt>
Apart from the formal parameters, the parameter <tt>$SP_DATA_DIR$</tt> is always       available an is replaced by the absolute path in which data files are   supposed to be.
</dt>
<dt>
See <tt>sp/examples/arguments</tt> for more information and examples.
</dt>
<dd>
</dd>
</dl></div>
</dd>
<dt>
<strong><tt>create &lt;component type&gt; &lt;name&gt; [args]</tt></strong>
</dt>
<dd>
<p>
        Creates a new component of a given type with the given name.
        The type can refer a core registered type, a subcomponent or an imported
        component. The name must be unique within the same scope.
        args are optional and component dependent.
</p>
</dd>
<dt>
<strong><tt>connect &lt;src component&gt; &lt;src_pin&gt; &lt;dst component&gt; &lt;dst_pin&gt;</tt></strong>
</dt>
<dd>
<p>
        Connects src_pin of src component to dst_pin of dst component.
</p>
</dd>
</dl></div>
<div class="para"><p><strong><tt>export_ipin &lt;component&gt; &lt;pin name&gt; [&lt;new name&gt; [&lt;new type&gt;]]</tt></strong></p></div>
<div class="vlist"><dl>
<dt>
<strong><tt>export_opin &lt;component&gt; &lt;pin name&gt; [&lt;new name&gt; [&lt;new type&gt;]]</tt></strong>
</dt>
<dd>
<p>
        Registers the input/output pin of a certain component as if where part of
        this component and optionally rename it. NOTE: renaming the pin
        actually means that     the pin name also changes for the original component.
        If parameter new type is passed tries to change the type of the pin.
        The new type must be only of the types registered in the core.
        Note that changing the type is only possible for type "any" pins.
</p>
<div class="vlist"><dl>
<dt>
As a rule of thumb always put the exportation statement at the end of the script or the subcomponent.
</dt>
<dd>
</dd>
</dl></div>
</dd>
<dt>
<strong><tt>import &lt;file-name&gt;</tt></strong>
</dt>
<dd>
<p>
        Imports a component which is defined in an external file.
</p>
</dd>
</dl></div>
</div>
<h2 id="_defining_subcomponents">Defining subcomponents</h2>
<div class="sectionbody">
<div class="para"><p>Subcomponents allow to define new types of components which are
composed of other components. Use</p></div>
<div class="literalblock">
<div class="content">
<pre><tt>`subcomponent`</tt></pre>
</div></div>
<div class="para"><p>keyword to begin a subcomponent definition and end it with</p></div>
<div class="literalblock">
<div class="content">
<pre><tt>`subcomponent_end`</tt></pre>
</div></div>
</div>
<h2 id="_gui_layout">GUI layout</h2>
<div class="sectionbody">
<div class="para"><p>Each component inside a graph could provide a GUI panel. The layout definition
allows to arrange those panels to build a consistent user interface.</p></div>
<h3 id="_gui_layout_commands">GUI layout commands</h3><div style="clear:left"></div>
<div class="para"><p>The full layout definition must be enclosed between the commands
<tt>begin_gui_layout</tt> and <tt>end_gui_layout</tt>.</p></div>
<div class="para"><p>The layout definition is composed of layout managers and components:</p></div>
<div class="vlist"><dl>
<dt>
<strong><tt>layout_begin &lt;arg&gt;</tt></strong>
</dt>
<dd>
<p>
        Begins a layout manager. <tt>arg</tt> can be:
</p>
<div class="ilist"><ul>
<li>
<p>
<tt>hbox [name]</tt>
                        Horizontal box layout, if name is provided, a surrounding
                        box with the name is painted around the enclosed GUI elements.
</p>
</li>
<li>
<p>
<tt>vbox [name]</tt>
                        Vertical box layout.
</p>
</li>
<li>
<p>
<tt>book</tt>
                        Notebook layout.
</p>
</li>
<li>
<p>
<tt>book_page</tt>
                        Notebook layout page.
</p>
</li>
<li>
<p>
<tt>collapsible</tt>
                        Panel which can be shown/hidden by pressing a button.
</p>
</li>
</ul></div>
</dd>
<dt>
<strong><tt>layout_end</tt></strong>
</dt>
<dd>
<p>
        Ends a layout manager. Each layout_begin must have its corresponding
        <tt>layout_end</tt>.
</p>
</dd>
<dt>
<strong><tt>component &lt;name&gt;</tt></strong>
</dt>
<dd>
<p>
        Places a component panel.
</p>
</dd>
</dl></div>
<div class="para"><p>See <tt>sp/</tt> directory for more information and examples.</p></div>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2011-06-21 18:45:15 CEST
</div>
</div>
</body>
</html>
sitplus-data 1.0.3-4build1 / usr / share / sitplus / doc / activities.html
