docs/kstars/scriptbuilder.docbook

<sect1 id="tool-scriptbuilder">
<title
>Skriptilooja tööriist</title>
<indexterm
><primary
>Tööriistad</primary>
<secondary
>Skriptilooja</secondary>
</indexterm>

<para
>KDE rakendusi saab juhtida väljastpoolt mõnest muust rakendusest, konsoolilt või shelliskriptiga niinimetatud protsessidevahelist kommunikatsiooniprotokolli kasutades (&DBus;). &kstars; kasutab seda võimalust ära selleks, et võimaldada ka üpris keerukat käitumist kirja panna ning suvalisel ajal käivitada skripti abil. Seda on võimalik näiteks tarvitada koolitundides demona mõne astronoomilise mõiste selgitamisel. </para>
<para
>&DBus;-skriptide hädaks on see, et nende kirjutamine näeb välja nagu korralik programmeerimine ja kui kasutajal ei ole programmeerimisega erilisi kokkupuuteid, võib see lausa eemale peletada. Skriptilooja pakub omalt poolt <abbrev
>GUI</abbrev
>, mis laseb ka lihtsalt hiirega klõpsates luua &kstars;ile &DBus;-skripte, olgu need siis kui tahes keerukad. </para>

<sect2 id="sb-intro">
<title
>Skriptilooja sissejuhatus</title>

<para
>Enne skriptilooja kasutamise selgitamist tutvustan lühidalt kõiki <abbrev
>GUI</abbrev
> elemente. Kui soovid nende kohta rohkem infot, kasuta võimalust "Mis see on?" </para>

<screenshot>
<screeninfo
>Skriptilooja tööriist </screeninfo>
<mediaobject>
  <imageobject>
    <imagedata fileref="scriptbuilder.png" format="PNG"/>
  </imageobject>
  <textobject>
    <phrase
>Skriptilooja tööriist</phrase>
  </textobject>
</mediaobject>
</screenshot>

<para
>Nagu pildil näha, asub skriptilooja vasakul pool <firstterm
>käesoleva skript</firstterm
>i kast, kus on näha käsud, millest koosneb parajasti töötav skript. Paremal asub <firstterm
>funktsioonivalija</firstterm
>, mis näitab kõiki saadaolevaid skriptifunktsioone. Funktsioonivalija all on väike paneel, mis näitab valijas esile tõstetud funktsiooni kohta lühiinfot. Käesoleva skripti kasti all paikneb <firstterm
>funktsiooni argumentide paneel</firstterm
>, kus juhul, kui mõni funktsioon on ära märgitud käesoleva skripti kastis, on näha kõigi skriptile vajalike argumentide väärtused. </para
><para
>Akna ülaosas on nupurida, mis võimaldab manipuleerida skripti kui tervikuga. Paremalt vasakule on nupud järgmised: <guibutton
>Uus skript</guibutton
>, <guibutton
>Ava skript</guibutton
>, <guibutton
>Salvesta skript</guibutton
>, <guibutton
>Salvesta skript kui...</guibutton
> ja <guibutton
>Testi skripti</guibutton
>. Nende mõte peaks olema ilmselge, kui vahest välja jätta viimane nupp. Klõps nupule <guibutton
>Testi skripti</guibutton
> püüab käivitada käesoleva skripti &kstars;i peaaknas. Skriptilooja aken oleks mõttekas enne selle nupu kasutamist kuhugi kõrvale nihutada, et näha, mida skript siis KStarsis ette võtab. </para
><para
>Keset akent on nupurida, mis manipuleerib konkreetsete skriptifunktsioonidega. Ülalt alla on nupud järgmised: <guibutton
>Lisa funktsioon</guibutton
>, <guibutton
>Eemalda funktsioon</guibutton
>, <guibutton
>Kopeeri funktsioon</guibutton
>, <guibutton
>Liiguta üles</guibutton
> ja <guibutton
>Liiguta alla</guibutton
>. <guibutton
>Lisa funktsioon</guibutton
> lisab funktsioonivalijas parajasti esile tõstetud funktsiooni käesoleva skripti kasti (funktsiooni saab lisada ka selle nimel topeltklõpsu tehes). Ülejäänud nupud käivad käesoleva skripti kohta, eemaldades sealt esile tõstetud funktsiooni, kopeerides selle või muutes selle asukoha skriptis. </para>
</sect2>

<sect2 id="sb-using">
<title
>Skriptilooja kasutamine</title>
<para
>Skriptilooja kasutamise selgitamiseks näitame, kuidas valmistada skript, mis jälgib Kuud, samal ajal kui kell töötab kiirendusega. </para
><para
>Kui tahame Kuud jälgida, tuleb mõistagi kõigepealt vaade talle tsentreerida. Selleks tuleb kasutada funktsiooni <firstterm
>lookToward</firstterm
>. Märgi see funktsioonivalijas ning tutvu ka kasti alla ilmuva infoga. Klõpsa nupule <guibutton
>Lisa funktsioon</guibutton
>, et funktsioon liiguks käesoleva skripti kasti. Funktsiooni argumentide paneelil on nüüd näha liitkast märkega <quote
>suund</quote
>. See on suund, kuhu vaade tuleks tsentreerida. Liitkastis on ainult põhiilmakaared, mitte Kuu või mingeid muid taevakehasid. Soovi korral võib kirjutada kasti käsitsi <quote
>Kuu</quote
> või siis klõpsata nupule <guibutton
>Objekt</guibutton
>, mis avab <guilabel
>objekti leidmise</guilabel
> dialoogi, kus saab nimekirjast Kuu valida. Arvesta, et nagu ikka, toob objektile tsentreerimine automaatselt kaasa selle jälgimise, mistõttu ei ole funktsioonile lookToward vaja lisada funktsiooni <firstterm
>setTracking</firstterm
>. </para
><para
>Nüüd, kui vaade on suunatud Kuule, tuleb panna aeg kiiremini käima. Selleks sobib funktsioon <firstterm
>setClockScale</firstterm
>. Lisa see käesoleva skripti kasti, tehes funktsiooni nimel funktsioonivalijas topeltklõpsu. Funktsiooni argumentide paneelil on näha ajasammu kerimiskast, kus saab määrata kella vajaliku kiiruse. Määrame ajasammu väärtuseks 3 tundi. </para
><para
>Vaade on nüüd Kuul ja kell kiirendatud. Veel läheb meil vaja, et skript ootaks mõned sekundid, kuni vaade Kuud jälgib. Lisame skriptile funktsiooni <firstterm
>waitFor</firstterm
> ja määrame funktsiooni argumentide paneelil, et enne jätkamist tuleks oodata 20 sekundit. </para
><para
>Lõpetuseks seame kella ajasammu tagasi normaalväärtusele 1 sekund. Selleks lisa veel kord setClockScale ning määra selle väärtuseks 1 sekund. </para
><para
>Tegelikult ei ole see veel aga kõik. Tõenäoliselt soovime, et vaade kasutaks ekvaatorilisi koordinaate, enne kui skript hakkab kiirendatud ajasammuga Kuud jälgima. Kui kasutada horisondilisi koordinaate, hakkaks vaade hirmsa kiirusega pöörlema vastavalt Kuu tõusudele ja loojumistele. See oleks usutavasti üpris häiriv ning me väldime seda nii, et seame vaatevaliku <firstterm
>UseAltAz</firstterm
> väärtuseks <quote
>väär</quote
>. Mis tahes vaatevaliku muutmiseks tuleb kasutada funktsiooni <firstterm
>changeViewOption</firstterm
>. Lisame selle skriptile ja uurime nüüd funktsiooni argumentide paneeli. Liitkastis on kirjas kõik vaatevalikud, mida saab changeViewOption abil kasutada. Me teame, et meil läheb vaja võimalust UseAltAz, mistõttu võime selle lihtsalt liitkastist valida. Kuid nimekiri on päris pikk ja mitte miski ei seleta, mida mingi element täpselt teeb. Seepärast on mõttekam vajutada nuppu <guibutton
>Lehitse puud</guibutton
>, mis avab akna, kus vaatevalikud on teemade järgi puusse koondatud. Peale selle on iga elemendi juures ka lühiseletus ning valiku väärtuse andmetüüp. UseAltAz on kirjas kategooria <guilabel
>Taevakaardi valikud</guilabel
> all. Märgime seal selle elemendi ning vajutame nuppu <guibutton
>OK</guibutton
>, mille järel see ongi valitud funktsiooni argumentide paneelil. Lõpuks määrame selle väärtuseks <quote
>väär</quote
> või <quote
>0</quote
>. </para
><para
>Ja veel üks asi: kui muuta UseAltAz skripti lõpus, ei ole sellest mingit tolku. See tuleb muuta enne seda, kui midagi üldse juhtuma hakkab. Seepärast märgi funktsioon käesoleva skripti kastis ära ning klõpsa nupule <guibutton
>Liiguta üles</guibutton
>, kuni sellest on saanud kõige esimene funktsioon. </para
><para
>Skript on valmis ja aeg on see kettale salvestada. Klõpsa nupule <guibutton
>Salvesta skript</guibutton
>. See avab akna, kus saab anda skriptile nime ning ennast selle autoriks tunnistada. Anna nimeks näiteks <quote
>Kuu jälgimine</quote
> ning kirjuta autori kohale enda nimi ja vajuta nupule <guibutton
>OK</guibutton
>. Seejärel ilmub tavapärane &kde; failisalvestamisdialoog. Siin tuleb määrata faili nimi ja skripti salvestamiseks klõpsata taas nupule <guibutton
>OK</guibutton
>. Pane tähele, et kui sa ei kirjuta ise failinime lõppu <quote
>.kstars</quote
>, lisatakse see laiend automaatselt. Kui huvi tunned, võid hiljem skripti uurida suvalise tekstiredaktoriga. </para
><para
>Nüüd, kus skript on valmis, võib selle käivitada mitmel viisil. Konsoolilt saab selle edukalt käivitada juhul, kui &kstars; parajasti töötab. Skripti saab käivitada ka &kstars;i seest, valides menüüst <guimenu
>Fail</guimenu
> käsu <guimenuitem
>Käivita skript</guimenuitem
>. </para>
</sect2>
</sect1>