<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [

  <!ENTITY kappname "&rocs;">
  <!ENTITY package "kdeedu">
  <!ENTITY % addindex "IGNORE">
  <!ENTITY % Estonian  "INCLUDE"
> 
]>
<book lang="&language;">

<bookinfo>
<title
>&rocs;i käsiraamat</title>
<authorgroup>
<author
><personname
> <firstname
>Tomaz</firstname
> <surname
>Canabrava</surname
> </personname
> <email
>tomaz.canabrava@gmail.com</email
> </author>
<othercredit role="translator"
><firstname
>Marek</firstname
><surname
>Laane</surname
><affiliation
><address
><email
>bald@smail.ee</email
></address
></affiliation
><contrib
>Tõlge eesti keelde</contrib
></othercredit
> 
</authorgroup>

<copyright>
<year
>2009</year>
<holder
>Tomaz Canabrava</holder>
</copyright>
<legalnotice
>&FDLNotice;</legalnotice>

<date
>2009-11-05</date>
<releaseinfo
>1.0</releaseinfo>

<abstract>
<para
>&rocs; on KDE graafiteooria kujutamise tööriist. </para>
</abstract>

<keywordset>
<keyword
>KDE</keyword>
<keyword
>kdeedu</keyword>
<keyword
>matemaatika</keyword>
<keyword
>matemaatika</keyword>
<keyword
>graafid</keyword>
<keyword
>tipp</keyword>
<keyword
>seos</keyword>
</keywordset>

</bookinfo>

<chapter id="introduction">
<title
>Sissejuhatus</title>
<para
>&rocs;i eesmärk on olla graafiteooria arenduskeskkond, mis aitab professoritel kuvada graafialgoritmi tulemusi ning tudengitel iseseisvalt algoritme koostada.</para>

<para
>&rocs;il on oma skriptimoodul, mille aluseks on Qt Script, mis teeb koostööd kujutatud graafiga, nii et iga graafiga seotud skriptis tehtud muudatus kajastub kohe ka näidataval graafil.</para>
</chapter>

<chapter id="using-rocs">
<title
>&rocs;i kasutamine</title>
<para
>Kasutajaliides jaguneb kaheks: </para
> 

<itemizedlist>
<listitem
><para
>ülal paremal kuvatakse graafi, all paremal aga saab luua algoritmi, </para
></listitem>
<listitem
><para
>vasakul külgribal on näha kõik avatud graafid (graafe võib ühes failis olla ka mitu). </para
></listitem>
</itemizedlist>


<sect1 id="rocs-features">
<title
>&rocs;i globaalsed seadistused</title>
<para
>Vasakul külgribal leiab valikud kõigi avatud graafide jaoks. Kõik need on globaalsed iga graafi jaoks ning neid võib muuda tipu või seose jaoks vastavalt tipu või seose omaduste dialoogis.</para>
<itemizedlist>
<listitem
><para>
<guilabel
>Graafi nimi</guilabel>
</para
></listitem>
<listitem
><para
><guilabel
>Tipu värv</guilabel
> uute tippude jaoks: klõpsuga nupule <guilabel
>Kõik</guilabel
> saab muuta kõigi aktiivsete tippude värvi </para
></listitem>
<listitem
><para>
<guilabel
>Seose värv</guilabel>
</para
></listitem>
</itemizedlist>
<para
>Valikute viimane rida sisaldab klõpsatavaid nuppe:</para>
<itemizedlist>
<listitem
><para
><guilabel
>Nimede näitamise koht</guilabel
> <guilabel
>Tipud</guilabel
> või <guilabel
>Seosed</guilabel
> </para
></listitem>
<listitem
><para
><guilabel
>Väärtuste näitamise koht</guilabel
> <guilabel
>Tipud</guilabel
> või <guilabel
>Seosed</guilabel
> </para
></listitem>
<!--listitem
><para>
<guilabel
>Graph is oriented</guilabel>
</para
></listitem>
<listitem
><para>
<guilabel
>Graph is Automate</guilabel>
</para
></listitem-->
</itemizedlist>
</sect1>

<sect1 id="rocs-toolbars">
<title
>&rocs;i tööriistaribad</title>
<para
>Ülal asub kaks tööriistariba. Peamisel tööriistaribal on järgmised tööriistad:</para>
<itemizedlist>
<listitem
><para
><guilabel
>Liiguta tippu</guilabel
>: võimaldab liigutada tippu joonistusalal.</para
></listitem>
<listitem
><para
><guilabel
>Lisa tipp Node</guilabel
>: loob uue tipu kohta, kus joonistusalal klõpsad.</para
></listitem>
<listitem
><para
><guilabel
>Lisa seos</guilabel
>: loob uue seose kahe tipu vahele.</para
></listitem>
<listitem
><para
><guilabel
>Vali</guilabel
>: võimaldab valida elemente neil klõpsates.</para
></listitem>
<listitem
><para
><guilabel
>Kustuta</guilabel
>: võimaldab kustutada elemente neil klõpsates.</para
></listitem>
<listitem
><para
>Joondamistööriistadega saab asetada valitud tippe.</para
></listitem>
</itemizedlist>

<para
>Hiire parema nupuga tipul või seosel klõpsates saab avada selle tipu või seose omaduste dialoogi.</para>
<para
>Paigutusriba koosneb mitmest joondamisikoonist.</para>

<para
>Tippude joondamiseks vali tööriist <guiicon
>Vali</guiicon
>, klõpsa ja joonista lohistades ristkülik ning seejärel vali vajalik joondus. </para>
</sect1>
</chapter>

<chapter id="scripting-rocs">
<title
>&rocs;i skriptimine</title>
<para
>Kui graaf on juba ekraanil, saab hakata selle jaoks skripti looma. Vastav keel kasutab JavaScripti süntaksit. Järgnevalt on ära toodud graafi, tipu ja seose objektid.</para>

<sect1 id="script-graph">
<title
>Graaf</title>
<programlisting
>array list_nodes();
     array list_edges();
     node add_node(name);
     edge add_edge(from, to);
     node node_byname(QString&amp; name);
     node begin_node();
     array end_nodes();
</programlisting
> 
<para
>Graafi muutujad, mida saab muuta:</para>
<programlisting
>bool directed
     bool automate
     string name
     string nodeDefaultColor // in HEXA
     string edgeDefaultColor  // in HEXA 
</programlisting>
</sect1>

<sect1 id="script-nodes">
<title
>Tipud</title>
<programlisting
>array adj_nodes();
     array adj_edges();
     array  input_edges();
     array output_edges();
     array loop_edges();
     array connected_edges(Node *n);
     void self_remove();
</programlisting
> 
<para
>Tipu muutujad:</para>
<programlisting
>double x
    double y
    double width
    string value
    string name
    string color  // in HEXA
    bool begin
    bool end
</programlisting>
</sect1>

<sect1 id="script-edges">
<title
>Seosed</title>
<programlisting
>string color ( em hexa )
    string value
    string name
    double width
    string style ( dot, dash, dash dot, solid )

    node start();
    node  end();

    void self_remove();
</programlisting
> 
</sect1>

<sect1 id="script-example">
<title
>Näide</title>
<para
>Selle on lihtne näidisskript, mis määrab kindlaks esimese graafi nelja esimese tipu värvi:</para>
<programlisting
>/* A simple example that sets the color of the 4 first nodes in the first 
graph: */
 
var colours = new Array("red", "green", "blue", "yellow");

/* graphs is an array of graphs, you can access a graph by its index in the 
array or by its name, so if the first graph's name is Untitled0, the following 
sentence are right  */
var list1= graphs[0].list_nodes(); //  1st form.
var list2=Untitled0.list_nodes();              // 2nd form
 
 for ( var i = 0; i &lt; colours.length; i++){
        if (i 
> list2.length) break;
        list2[i].color = colours[i]
 }
</programlisting>
</sect1>

</chapter>

<chapter id="commands">
<title
>Käskude seletused</title>

<sect1 id="rocs-mainwindow">
<title
>Menüüd ja kiirklahvid</title>

<sect2>
<title
>Menüü <guimenu
>Fail</guimenu
></title>
<variablelist>
<varlistentry>
<term
><menuchoice
><shortcut
> <keycombo action="simul"
>&Ctrl;<keycap
>Q</keycap
></keycombo
> </shortcut
> <guimenu
>Fail</guimenu
> <guimenuitem
>Välju</guimenuitem
> </menuchoice
></term>
<listitem
><para
><action
>Lõpetab</action
> &rocs;i töö</para
></listitem>
</varlistentry>
</variablelist>

</sect2>


<sect2>
<title
>Menüü <guimenu
>Seadistused</guimenu
></title>

<variablelist>
<varlistentry>
<term
><menuchoice
><guimenu
>Seadistused</guimenu
> <guisubmenu
>Näidatavad tööriistaribad</guisubmenu
> </menuchoice
></term>
<listitem
><para
><action
>Lülitab</action
> <guimenuitem
>peamise</guimenuitem
> ja <guimenuitem
>paigutuse</guimenuitem
> tööriistariba näitamise sisse ja välja.</para
></listitem>
</varlistentry>


<varlistentry>
<term
><menuchoice
><guimenu
>Seadistused</guimenu
> <guimenuitem
>Olekuriba näitamine</guimenuitem
> </menuchoice
></term>
<listitem
><para
><action
>Lülitab</action
> olekuriba näitamise sisse ja välja.</para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>Seadistused</guimenu
> <guimenuitem
>Kiirklahvide seadistamine...</guimenuitem
> </menuchoice
></term>
<listitem
><para
><action
>Avab</action
> &kde; standardse kiirklahvide seadistamise dialoogi, kus saab määrata toimingutele kiirklahve. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>Seadistused</guimenu
> <guimenuitem
>Tööriistaribade seadistamine...</guimenuitem
> </menuchoice
></term>
<listitem
><para
><action
>Võimaldab seadistada</action
> tööriistaribade välimust. </para
></listitem>
</varlistentry>

</variablelist>

</sect2>

<sect2>
<title
>Menüü <guimenu
>Abi</guimenu
></title>
&help.menu.documentation; </sect2>
</sect1>
</chapter>


<chapter id="credits">

<title
>Autorid ja litsents</title>

<para
>&rocs; </para>
<para
>Rakenduse autoriõigus 2009: Tomaz Canabrava tcanabrava at kde dot org </para>

<para
>Dokumentatsiooni autoriõigus 2009: &Anne-Marie.Mahfouf; &Anne-Marie.Mahfouf.mail; ja Tomaz Canabrava tcanabrava at kde dot org </para>

<para
>Tõlge eesti keelde: Marek Laane <email
>bald@smail.ee</email
></para
> 
&underFDL; &underGPL; </chapter>

<appendix id="installation">
<title
>Paigaldamine</title>

<sect1 id="getting-rocs">
<title
>&rocs;i hankimine</title>
&install.intro.documentation; </sect1>

<sect1 id="compilation">
<title
>Kompileerimine ja paigaldamine</title>
&install.compile.documentation; </sect1>
</appendix>

&documentation.index;
</book>
<!--
Local Variables:
mode: sgml
sgml-minimize-attributes: nil
sgml-general-insert-case: lower
sgml-indent-step:0
sgml-indent-data:nil
End:
-->