Commit 637c4d6c authored by Christophe Demarey's avatar Christophe Demarey
Browse files

Add fscript plugin doc.

parent 6b52caf8
......@@ -267,4 +267,61 @@
</mediaobject>
</screenshot>
</section>
<section>
<title>FraSCAti Script plugin</title>
<para>Another useful plugin is available: the FraSCAti Script console
plugin. It allows to use the FraSCAti Script from the explorer. In order
to use it, you have to use the dedicated FraSCAti Script profile for the
explorer.</para>
<para>You can simply run the FraSCAti Script console plugin by
right-clicking on a component (or composite) and calling the
<action>FraSCAti SCript console</action> action.</para>
<screenshot>
<screeninfo>Running the FraSCAti Script console</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/explorer-frascati-script-action.png" />
</imageobject>
</mediaobject>
</screenshot>
<para>A default action is then performed: the selected composite/component
is registered in the FraSCAti Script context as the
<varname>root</varname> variable, so it can be used later in
queries.</para>
<screenshot>
<screeninfo>The FraSCAti Script console</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/explorer-frascati-script-console.png" />
</imageobject>
</mediaobject>
</screenshot>
<para>When the FraSCAti Script console appears, the default registered
variable is displayed. </para>
<screenshot>
<screeninfo>A sample query</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/explorer-frascati-script-console-cmd.png" />
</imageobject>
</mediaobject>
</screenshot>
<para>Here, you can type in whatever valid FraSCAti Script query. The
query is evaluated when the return key is pressed. Then, the result is
displayes on the console. For more details about FraSCAti Script, please
refer to the <link linkend="fscript">FraSCAti Script
section</link>.</para>
</section>
</chapter>
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment