<appendix id="highlight">
<title
>Töö süntaksi esiletõstmisega</title>

<sect1 id="highlight-overview">

<title
>Ülevaade</title>

<para
>Süntaksi esiletõstmine paneb redaktori automaatselt näitama teksti erinevates stiilides ja värvides vastavalt stringi funktsioonile failis. Rakenduse lähtetekstis võivad koodi juhtelemendid olla näiteks rasvases kirjas, andmetüübid ja kommentaarid aga ülejäänud tekstist erinevat värvi. See hõlbustab märgatavalt teksti redigeerimist ning aitab autoril tõhusamalt ja tootlikumalt töötada.</para>

<mediaobject
> <imageobject
><imagedata format="PNG" fileref="highlighted.png"/></imageobject
> <textobject
><phrase
>Perli funktsioon, esitatud süntaksi esiletõstu kasutades.</phrase
></textobject
> <caption
><para
>Perli funktsioon, esitatud süntaksi esiletõstu kasutades.</para
> </caption
> </mediaobject>

<mediaobject
> <imageobject
><imagedata format="PNG" fileref="unhighlighted.png"/></imageobject
> <textobject
><phrase
>Sama perli funktsioon ilma esiletõstuta.</phrase
></textobject
> <caption
><para
>Sama perli funktsioon ilma esiletõstuta.</para
></caption
> </mediaobject>

<para
>Kumba kahest näitest on hõlpsam lugeda?</para>

<para
>&kate; kasutab paindlikku, seadistatavat ja võimsat süntaksi esiletõstmise süsteemi ning ka tavalise distributsiooniga käib kaasas väga ulatuslik programmeerimis-, märke- ja skriptikeelte ning muude tekstifaili vormingute definitsioone. Lisaks võid luua omaenda definitsioonid tavaliste &XML;-failide kujul.</para>

<para
>&kate; tuvastab faili avamisel selle &MIME; tüübile tuginedes (mille määrab kindlaks faililaiend või kui seda ei ole, siis sisu) automaatselt sobiva süntaksi ja selle reeglid. Kui sinu arvates on valik valesti langetatud, võid kasutatava süntaksi määrata käsitsi menüüst <menuchoice
><guimenu
>Dokumendid</guimenu
><guisubmenu
>Esiletõstu režiim</guisubmenu
></menuchoice
>.</para>

<para
>Iga süntaksi esiletõstu määratluse stiilid ja värvid, samuti &MIME; tüübid saab ise seada <link linkend="config-dialog"
>seadistustedialoogi</link
> leheküljel <link linkend="config-dialog-editor-hl"
>Esiletõstmine</link
>.</para>

<note
> <para
>Süntaksi esiletõstmine on mõeldud parandama korrektse teksti lugemist, kuid seda ei peaks kasutama teksti korrektsuse kontrollimiseks. Teksti süntaksi märkimine on sõltuvalt kasutatavast vormingust päris keeruline ettevõtmine ja mõnel juhul on süntaksireeglite autorid väga uhked, kui suudavad korrektselt esitada 98% tekstist, kuigi enamasti läheb sul vaja mõnda päris haruldast stiili, et näha mittekorrektset 2%.</para
> </note>

<tip
> <para
>Uusi või uuendatud süntaksi esiletõstu definitsioone saab alla laadida &kate; veebileheküljelt klõpsuga nupule <guibutton
>Allalaadimine</guibutton
> <link linkend="config-dialog"
>seadistustedialoogi</link
> leheküljel <link linkend="config-dialog-editor-hl"
>Esiletõstmine</link
>.</para
> </tip>

</sect1>

<sect1 id="katehighlight-system">

<title
>&kate; süntaksi esiletõstmise süsteem</title>

<para
>See sektsioon tutvustab põhjalikumalt &kate; süntaksi esiletõstmise mehhanismi. See on mõeldud neile, kes soovivad sellest rohkem teada saada või soovivad süntaksi definitsioone muuta või uusi luua.</para>

<sect2 id="katehighlight-howitworks">

<title
>Kuidas see töötab</title>

<para
>Kui sa faili avad, püüab &kate; redaktor kõigepealt tuvastada, millist süntaksi definitsooni antud faili puhul kasutada. Faili teksti lugedes, samuti ajal, mil sa seda redigeerid, analüüsib süntaksi esiletõstu süsteem teksti, kasutades selleks süntaksi definitsioonis antud määratlusi, ning märgistab erinevad kontekstid ja stiilid vastavalt reeglitele.</para>

<para
>Dokumenti uue teksti trükkimise ajal analüüsitakse ja märgistatakse see käigult, nii et kui kustutad märgi, mis tähistas mingi kontekst algust või lõppu, siis muutub vastavalt ka ümbritseva teksti stiil.</para>

<para
>Süntaksi definitsioonid, mida &kate; kasutab esiletõstu süsteemis, on &XML;-failid, mis sisaldavad endas <itemizedlist
> <listitem
><para
>reegleid kontekstiblokkideks organiseeritud teksti rolli määramiseks</para
></listitem
> <listitem
><para
>võtmesõnade loendeid</para
></listitem
> <listitem
><para
>stiilielementide definitsioone</para
></listitem
> </itemizedlist
> </para>

<para
>Teksti analüüsides hinnatakse tuvastusreegleid vastavalt nende defineerimise järjekorrale ja kui mingi stringi algus vastab reeglile, siis kasutatakse vastavat konteksti. Alguspunktist liigutakse punkti, kus reegli kohaselt kontekst lõpeb, ning sealt algab reegli uus osa, mis võib olla erinevalt märgistatud.</para>

</sect2>

<sect2 id="highlight-system-rules">
<title
>Reeglid</title>

<para
>Tuvastusreeglid on esiletõstu tuvastamise tuum. Reegel on string, märk või <link linkend="regular-expressions"
>regulaaravaldis</link
>, millega sobivuse osas teksti analüüsitaksegi. Selles sisaldub info, millist stiili kasutada sobiva tekstiosa puhul. Reegel võib lülitada süsteemi töökonteksti kas otseselt maintud kontekstile või varem tekstis kasutatud kontekstile.</para>

<para
>Reeglid on organiseeritud kontekstigruppidesse. Kontekstigruppi kasutatakse vormingu peamiste tekstiosiste jaoks, milleks võivad näiteks olla jutumärkides tekstistringid või kommenteeritud tekstiblokid. See tagab, et esiletõstu süsteem ei pea läbi lappama kõiki reegleid, kui seda ei ole vaja, ja et mõnngaid järjestikusi märke tekstis võib tõlgendada erinevalt sõltuvalt hetkekontekstist. </para>

</sect2>

<sect2 id="highlight-context-styles-keywords">
<title
>Kontekstistiilid ja võtmesõnad</title>

<para
>Mõnes programmeerimiskeeles tõlgendab kompilaator (rakendus, mis teisendab lähtekoodi binaarkoodiks) täisarve teisiti kui ujukomaarve ning mõnikord võib esineda ka märke, mis omandavad eritähenduse, kui nad asuvad jutumärkide vahel. Sellisel juhul on mõttekas käsitleda neid ümbritsevast erinevalt, nii et neid saaks teksti lugedes hõlpsasti eristada. Seepärast võib süntaksi esiletõstmise süsteem käsitleda neid erikontekstina ja vastavalt ka märkida, isegi kui nad seda tegelikult ei ole.</para>

<para
>Süntaksi definitsioon võib sisaldada nii palju stiile, kui vähegi on vaja katmaks vorminguelemente, mille tuvastamiseks ta mõeldud on.</para>

<para
>Mitme vormingu puhul esinevad sõnaloendid, mis esindavad erikontseptsiooni. Näiteks programmeerimiskeeltes on juhtlaused, andmetüübid ja keele sisseehitatud funktsioonid erinevad kontseptsioonid. &kate; süntaksi esiletõstu süsteem kasutab selliseid loendeid tuvastamaks ja märkimaks tekstis sõnu, mis vastavad tekstivormingu kontseptsioonidele.</para>

</sect2>

<sect2 id="kate-highlight-system-default-styles">
<title
>Vaikestiilid</title>

<para
>Kui avad &kate;s C++ lähtetekstifaili, &Java; lähtetekstifaili ja <acronym
>HTML</acronym
>-dokumendi, märkad, et kuigi vormingud on erinevad ja seepärast on erikohtlemise osaks saanud erinevad sõnad, on kasutatavad värvid ühesugused. Selle põhjuseks on asjaolu, et &kate; kasutab eelnevalt määratud vaikestiilide loendit, mida siis omakorda kasutavad konkreetsed süntaksi määratlused.</para>

<para
>See võimaldab hõlpsasti tuvastada ühesuguseid kontseptsioone erinevate tekstivormingute puhul. Nii esinevad näiteks kommentaarid peaaegu igas programmeerimis-, skripti- või märkekeeles ja kui nende märkimiseks kasutatakse igas keeles ühesugust värvi, siis ei pea te uut faili avades nägema vaeva nende leidmisega.</para>

<tip
> <para
>Kõik stiilid süntaksi definitsioonis kasutavad üht vaikestiili. Mõned süntaksi definitsioonid võivad kasutada rohkem stiile, kui neid on vaikimisi määratud, nii et kui kasutad tihti sellist vormingut, võiks olla nutikas tegu avada seadistustedialoog ja järele vaadata, kas mõningad kontseptsioonid kasutavad üht ja sama stiili. Näiteks on ainult üks vaikestiil stringide jaoks, kuid programmeerimiskeel perl kasutab kaht tüüpi stringe, mistõttu esiletõstu saab parandada neile veidi erinevaid omadusi andes.</para
> </tip>

</sect2>

</sect1>

<sect1 id="katehighlight-xml-format">
<title
>Esiletõstu määratluse &XML; vorming</title>

<sect2>
<title
>Ülevaade</title>

<para
>See sektsioon annab ülevaate esiletõstu definitsiooni &XML; vormingust, kirjeldades põhikomponente, nende tähendust ja kasutamist. Samuti süüvitakse siin tuvastusreeglite olemusse.</para>

<para
>Formaalne määratlus ehk <acronym
>DTD</acronym
> on salvestatud faili <filename
>language.dtd</filename
>, mis peaks olema paigaldatud teie süsteemis kataloogi <filename
>$<envar
>KDEDIR</envar
>/share/apps/kate/syntax</filename
>.</para>

<variablelist
> <title
>&kate; esiletõstu definitsiooni põhikomponendid</title
> <varlistentry
> <term
>Üldsektsioon</term
> <listitem
> <para
>Selles sektsioonis on juttu kirjeldatava keele kommentaarivormingust, samuti sellest, millised võtmesõnad on tõstutundlikud.</para
> </listitem
> </varlistentry
> <varlistentry
> <term
>Esiletõstmine</term
> <listitem
> <para
>Esiletõstmise sektsioon sisaldab kõiki andmeid, mida läheb vaja teksti analüüsimiseks ja teisendamiseks. Nende hulka kuuluvad:</para
> <variablelist
> <varlistentry
> <term
>ItemData-d</term
> <listitem
><para
>Sisaldavad ItemData elemente, mis kõik määravad stiili.</para
></listitem
> </varlistentry
> <varlistentry
> <term
>võtmesõnade loendeid</term
> <listitem
> <para
>Igal loendil on oma nimi ja selles võib sisalduda suvaline arv elemente.</para
> </listitem
> </varlistentry
> <varlistentry
> <term
>Kontekstid</term
> <listitem
> <para
>Sisaldab kontekste, mis samuti sisaldavad süntaksi tuvastamise reegleid.</para
> </listitem
> </varlistentry
> </variablelist
> </listitem
> </varlistentry
> </variablelist>

</sect2>

</sect1>

<sect1 id="kate-highlight-rules-detailled">
<title
>Esiletõstu tuvastamise reeglid</title>

<para
>See sektsioon kirjeldab esiletõstu tuvastamise reegleid.</para>

<para
>Iga reegel otsib sobivust null või enama märgi osas stringis, mida ta testib. Kui reegel leiab sobivuse, omistatakse sobiva(te)le märgile/märkidele reeglis määratud stiil või <emphasis
>atribuut</emphasis
> ning reegel võib soovitada konteksti vahetamist.</para>

<para
>Kõigil reeglitel on olemas atribuudid <emphasis
>atribuut</emphasis
> ja <emphasis
>kontekst</emphasis
>.</para>

<para
>Reegel näeb välja selline:</para>

<programlisting
>&lt;ReegliNimi atribuut=&quot;(identifitseerija)&quot; kontekst=&quot;(identifitseerija|korraldus)&quot; [reegli spetsiifilised atribuudid] /&gt;</programlisting>

<para
><emphasis
>Atribuut</emphasis
> identifitseerib nime või indeksi järgi stiili, mida kasutada sobivate märkide puhul, ning <emphasis
>kontekst</emphasis
> indetifitseerib vajaliku konteksti.</para>

<para
><emphasis
>Atribuuti</emphasis
> võib identifitseerida nime või tema ItemData-de grupis leiduva nullipõhise indeksi järgi.</para>

<para
><emphasis
>Konteksti</emphasis
> saab identifitseerida:</para>

<itemizedlist
> <listitem
> <para
><emphasis
>identifitseerija</emphasis
> järgi; praegu on kasutusel vaid kontekstigrupis paiknev nullipõhine indeks.</para
> </listitem
> <listitem
> <para
><emphasis
>korralduse</emphasis
> järgi, mis annab mootorile käsu jääda praeguse konteksti juurde (<userinput
>#stay</userinput
>) või hüpata tagasi eelmisele stringis kasutatud kontekstile (<userinput
>#pop</userinput
>).</para
> <para
>Minemaks rohkem samme tagasi, võib võtmesõna #pop korrata: <userinput
>#pop#pop#pop</userinput
></para
> </listitem
> </itemizedlist>

<para
>Mõnel reeglil võivad olla <emphasis
>alamreeglid</emphasis
>, mida kaalutakse siis ja ainult siis, kui põhireegel on sobivuse leidnud. Kogu sobivale stringile antakse põhireeglis määratud atribuut. Alamreegliga reegel näeb välja selline:</para>

<programlisting>
&lt;ReegliNimi (atribuudid)&gt;
  &lt;AlamReegliNimi (atribuudid) /&gt;
  ...
&lt;/ReegliNimi&gt;
</programlisting>


<para
>Reegli spetsiifilised atribuudid on mitmekesised ja neid kirjeldatakse järgnevas loendis.</para
> 

<variablelist
> <title
>Reeglid üksikasjalikult</title
> <varlistentry
> <term
>DetectChar</term
> <listitem
> <para
>Tuvastab üksikut konkreetset märki. Tavaliselt kasutatakse näiteks jutumärkides stringi alguse ja lõpu leidmiseks.</para
> <programlisting
>&lt;DetectChar char=&quot;(märk)&quot; (tavalised atribuudid) /&gt;</programlisting
> <para
>Atribuut <userinput
>char</userinput
> määrab otsitava märgi.</para
> </listitem
> </varlistentry
> <varlistentry
> <term
>Detect2Chars</term
> <listitem
> <para
>Tuvastab kaks konkreetset märki määratud järjekorras.</para
> <programlisting
>&lt;Detect2Chars char=&quot;(märk)&quot; char1=&quot;(märk)&quot; (tavalised atribuudid) /&gt;</programlisting
> <para
>Atribuut <userinput
>char</userinput
> defineerib esimese otsitava märgi, <userinput
>char1</userinput
> teise.</para
> </listitem
> </varlistentry
> <varlistentry
> <term
>AnyChar</term
> <listitem
> <para
>Tuvastab ühe märgi konkreetsete märkide hulgast.</para
> <programlisting
>&lt;AnyChar String=&quot;(string)&quot; (tavalised atribuudid) /&gt;</programlisting
> <para
>Atribuut <userinput
>String</userinput
> määrab märgikogumi.</para
> </listitem
> </varlistentry
> <varlistentry
> <term
>StringDetect</term
> <listitem
> <para
>Tuvastab täpse stringi.</para
> <programlisting
>&lt;StringDetect String=&quot;(string)&quot; [insensitive=&quot;TRUE|FALSE;&quot;] (tavalised atribuudid) /&gt;</programlisting
> <para
>Atribuut <userinput
>String</userinput
> määrab otsitava stringi. Atribuut <userinput
>insensitive</userinput
> on vaikimisi <userinput
>FALSE</userinput
> ning seda kasutab stringivõrdlusfunktsioon. Kui väärtus on <userinput
>TRUE</userinput
>, kasutatakse tundetut võrdlust.</para
> </listitem
> </varlistentry
> <varlistentry
> <term
>RegExpr</term
> <listitem
> <para
>Otsib regulaaravaldise sobivust.</para
> <programlisting
>&lt;RegExpr String=&quot;(string)&quot; [insensitive=&quot;TRUE|FALSE;&quot;] [minimal=&quot;TRUE|FALSE&quot;] (tavalised atribuudid) /&gt;</programlisting
> <para
>Atribuut <userinput
>String</userinput
> määrab regulaaravaldise.</para
> <para
><userinput
>insensitive</userinput
> on vaikimisi <userinput
>FALSE</userinput
> ja seda kasutab regulaaravaldise mootor.</para
> <para
><userinput
>minimal</userinput
> on vaikimisi <userinput
>FALSE</userinput
> ja seda kasutab regulaaravaldise mootor.</para
> <para
>Kuna reeglid otsivad sobivust alati aktiivse stringi algusest, siis viitab regulaaravaldis, mille alguses seisab juurdelisamismärk (<literal
>^</literal
>), et reegel peab sobivust otsima ainult rea algusest.</para
> <para
>Täpsemat infot vaata peatükist <link linkend="regular-expressions"
>Regulaaravaldised</link
>.</para
> </listitem
> </varlistentry
> <varlistentry
> <term
>Keyword</term
> <listitem
> <para
>Tuvastab võtmesõna määratud loendist.</para
> <programlisting
>&lt;keyword String=&quot;(loendi nimi)&quot; (tavalised atribuudid) /&gt;</programlisting
> <para
>Atribuut <userinput
>String</userinput
> identifitseerib võtmesõnaloendi nime järgi. Sellise nimega loend peab eksisteerima.</para
> </listitem
> </varlistentry
> <varlistentry
> <term
>Int</term
> <listitem
> <para
>Tuvastab täisarvu.</para
> <para
><programlisting
>&lt;Int (tavalised atribuudid) /&gt;</programlisting
></para
> <para
>Sellel reeglil ei ole spetsiifilisi atribuute. Tihti kasutatakse alamreegeldi, et tuvastada numbri järel <userinput
>L</userinput
> ja <userinput
>U</userinput
> kombinatsioone, mis osutavad programmikoodis täisarvu tüübile.</para
> </listitem
> </varlistentry
> <varlistentry
> <term
>Float</term
> <listitem
> <para
>Tuvastab ujukomaarvu.</para
> <para
><programlisting
>&lt;Float (tavalised atribuudid)
/&gt;</programlisting
></para
> <para
>Sellel reeglil ei ole spetsiifilisi atribuute.</para
> </listitem
> </varlistentry
> <varlistentry
> <term
>HICOct</term
> <listitem
> <para
>Tuvastab kaheksandsüsteemis arvu.</para
> <para
><programlisting
>&lt;HICOct (tavalised atribuudid) /&gt;</programlisting
></para
> <para
>Sellel reeglil ei ole spetsiifilisi atribuute.</para
> </listitem
> </varlistentry
> <varlistentry
> <term
>HICHex</term
> <listitem
> <para
>Tuvastab kuueteistkümnendsüsteemis arvu.</para
> <para
><programlisting
>&lt;Int (tavalised atribuudid) /&gt;</programlisting
></para
> <para
>Sellel reeglil ei ole spetsiifilisi atribuute.</para
> </listitem
> </varlistentry
> <varlistentry
> <term
>HICStringChar</term
> <listitem
> <para
>Tuvastab paomärgi.</para
> <para
><programlisting
>&lt;HICStringChar (tavalised atribuudid)
/&gt;</programlisting
></para
> <para
>Sellel reeglil ei ole spetsiifilisi atribuute.</para
> <para
>See otsib sobivusi nähtamatutele märkidele, mida tihti programmikoodis kasutatakse, näiteks <userinput
>\n</userinput
> (uus rida) või <userinput
>\t</userinput
> (tabeldusklahvi vaste).</para
> <para
>Leitakse järgmised märgid, kui neile eelneb längkriips (<literal
>\</literal
>): <userinput
>abefnrtv&quot;'?</userinput
>. Lisaks leitakse kuueteistkümnendsüsteemis paomärgid, näiteks <userinput
>\xff</userinput
>, ja kaheksandsüsteemis paomärgid, näiteks <userinput
>\033</userinput
>.</para
> </listitem
> </varlistentry
> <varlistentry
> <term
>RangeDetect</term
> <listitem
> <para
>Tuvastab stringi määratud algus- ja lõpumärgiga.</para
> <programlisting
>&lt;RangeDetect char=&quot;(märk)&quot;  char1=&quot;(märk)&quot; (tavalised atribuudid) /&gt;</programlisting
> <para
><userinput
>char</userinput
> määrab vahemikku alustava märgi ning <userinput
>char2</userinput
> seda lõpetava märgi.</para
> <para
>See on kasulik näiteks väiksemate jutumärkides stringides ja muu sellise leidmiseks, kuid tasub tähele panna, et esiletõstu mootor töötab korraga ühel real ega leida stringe, mis ulatuvad üle reapiiri.</para
> </listitem
> </varlistentry
> <varlistentry
> <term
>LineContinue</term
> <listitem
> <para
>Tuvastab sobivused rea lõpus.</para
> <programlisting
>&lt;LineContinue (tavalised atribuudid) /&gt;</programlisting
> <para
>Sellel reeglil ei ole spetsiifilisi atribuute.</para
> <para
>See reegel on kasulik konteksti vahetamiseks rea lõpus.</para
> </listitem
> </varlistentry
> </variablelist>

</sect1>

</appendix>

