&erik.kjaer.pedersen.role;

# Arbejde med Fremhævning

## Overblik

Syntaksfremhævning er det der får en editor til automatisk at vise tekst i forskellig stil/farve, afhængig af funktionen for strengen i relation til filens formål. I kildekode til et program for eksempel, kan kontroludsagn blive vist som fede, mens datatyper og kommentarer får forskellige farver fra resten af teksten. Dette gør det meget nemmere at læse teksten, og hjælper således forfatteren med at være mere effektiv og produktiv.

En perl-funktion, vist med syntaksfremhævning.

En perl-funktion, vist med syntaksfremhævning.

Den samme perl-funktion, uden fremhævning.

Den samme perl-funktion, uden fremhævning.

Af de to eksempler, hvilket er nemmest at læse?

&kate; kommer med et fleksibelt, indstilleligt og brugbart system til at lave syntaksfremhævning, og standarddistributionen giver definitioner for et vidt omfang af programmeringssprog, opmarkerings og script-sprog og andre tekstfil-formater. Derudover kan du give dine egne definitions i simple &XML;-filer.

&kate; vil detektere de rigtige syntaksregler automatisk når du åbner en fil, baseret på filens &MIME;-type, bestemt ved dens endelse, eller, hvis den ingen har, indholdet. Skulle du komme ud for et dårligt valg, kan du sætte syntaksen der skal bruges manuelt fra Dokumenter Fremhævningstilstand-menuen.

Stil og farver brugt af hver syntaksfremhævnings-definition, så vel som hvilke &MIME;-typer de skal bruges på, kan indstilles ved brug af Fremhæv-siden i Config-dialogen.

Syntaksfremhævning er der for at gøre det nemmer at læse rigtig tekst, men du kan ikke stole på at det vil være en godkendelse af din tekst. Markering af tekst for syntaks er vanskeligt og afhængigt af det format du bruger, og i visse tilfælde vil forfatterne af syntaksreglerne være stolte hvis 98% af teksten blive vist rigtigt, selvom du for det meste skal bruge en sjælden stil for at se de ukorrekte 2%.

Du kan nedtage opdaterede eller ekstra syntaksfremhævningsdefinitioner fra &kate;'s netside ved at klikke på Nedtag-knappen i Fremhæv siden for Config-dialogen.

## &kate;'s syntaksfremhævning-system

dette afsnit vil diskutere &kate;'s syntaksfremhævning-mekanismen i større detalje. Det er beregnet på dig, hvis du gerne vil kende til det, eller hvis du ønsker at ændre eller lave syntaksdefinitioner.

### Hvordan virker det

Når du åbner en fil er en af de første ting som &kate;-editoren gør at detektere hvilke syntaksdefinitioner der skal bruges for filen. Mens filens tekst læses, og mens du skriver i den, vil syntaksfremhævningssystemet analysere teksten ved brug af de regler der er defineret af syntaksdefinitioner og markere i filen hvor forskellige sammenhænge og stiler begynder og slutter.

Når du skriver i dokumentet, bliver den nye tekst analyseret og markeret langs af sted, så hvis du sletter et tegn der er markeret som begyndelsen eller slutningen af en sammenhæng, vil stilen for den omgivende tekst ændret tilsvarende.

De syntaksdefinitioner der bruges af &kate;'s syntaksfremhævningssystem er &XML;-filer der indeholder

- Regler til at detektere tekstens rolle, organiseret i sammenhængsblokke

- Nøgleordslister

- Stilpunkt-definitioner

Når teksten analyseres, bliver detektionsreglerne evalueret i den rækkefølge i hvilken de er defineret, og hvis begyndelsen af den aktuelle streng matcher en regel, bruges den relaterede sammenhæng. Startpunktet i teksten flyttes til slutpunktet for hvilket denne regel matcher og en ny løkke af regler begynder, startende i den sammenhæng der er sat af den matchede regel.

### Regler

Detektionsreglerne er hjertet af fremhævnings-detektionssystemet. En regel er en streng, et tegn eller et regulært udtryk mod hvilken den tekst der bliver analyseret skal matches. Den indeholder information om hvilken stile der skal bruges for den matchende del af teksten. Den vil muligvis skifte arbejdssammenhæng for systemet enten til en eksplicit nævnt sammenhæng eller til den tidligere sammenhæng brugt af teksten.

Regler er organiserede i sammenhængsgrupper. En sammenhængsgruppe bruges til hovedtekstbegreber indenfor formatet, for eksempel citerede tekststrenge eller kommentar-blokke i programmers kildekode. Dette sikrer at fremhævningen ikke behøver at gå i løkke gennem alle regler når det ikke er nødvendigt, og at visse tegnsekvenser i teksten kan behandles anderledes afhængig af den aktuelle sammenhæng.

### Sammenhængsstil og nøgleord

I visse programmeringssprog, bliver heltal behandlet anderledes end decimaltal af compileren (det program der konverterer kildekode til en binær kørbar), og der kan være tegn der har en speciel betydning indenfor en citeret streng. I sådanne tilfælde, giver det mening at vise dem anderledes end omgivelserne, så de er nemme at identificere mens man læser teksten. Så selvom de ikke repræsenterer specielle sammenhænge, kan de ses som sådan af syntaksfremhævningssystemet, så de kan markeres til en anderledes fremvisning.

En syntaksdefinition kan indeholde så mange stile som krævet for at dække begreberne for det format den bruges til.

I mange formater, er der lister af ord der repræsenterer et bestemt begreb. For eksempel i programmeringssprog, er kontroludsagn et begreb, datatypenavne et andet, og indbyggede funktioner i sproget et tredje. &kate;'s syntaksfremhævningssystem kan bruge sådanne lister til at detektere og markere ord i teksten for at understrege begreber fra tekstformaterne.

### Standardstil

Hvis du åbner en C++ kildefil, en &Java; kildefil og et HTML-dokument i &kate;, vil du se at selvom formaterne er forskellige, og forskellige ord således vælges til speciel behandling, er de brugte farver de samme. Det er fordi &kate; har en prædefineret liste af standardstile, som anvendes af de individuelle syntaksdefinitioner.

Dette gør det nemt at genkende lignende begreber i forskellige tekstformater. For eksempel er kommentarer til stede i næsten programmerings-, script- eller opmarkeringssprog, og når de vises ved brug af den samme stil i alle sprog, skal du ikke stoppe op og tænke dig om for at identificere dem indenfor teksten.

Alle stile i en syntaksdefinition bruger en af stadardstilene. Nogle få syntaksdefinitioner bruger flere stile end der er som standard, så hvis du bruger et format ofte, er det måske besværet værd at starte indstillingsdialogen for at se om nogle begreber bruger den samme stil. For eksempel er der kun en standardstil for strenge, men da perl programmeringssproget opererer med to typer strenge, kan du udvide fremhævningen ved at indstille disse til at være en smule forskellige.

## Fremhævningsdefinitionen &XML;-format

### Overblik

Dette afsnit er et overblik over fremhævningsdefinitionen &XML;-format. Det vil beskrive hovedkomponenterne og deres betydning og brug, og gå i detalje med detektionsreglerne.

Den formelle definition, også kendt som DTD gemmes i filen `language.dtd` som skal være installeret på dit system i mappen `$`KDEDIR`/share/apps/kate/syntax`.

#### Hovedkomponenter i &kate;'s fremhævningsdefinitioner

Det generelle afsnit

  Det generelle afsnit indeholder information om kommentarformatet for det beskrevne sprog, og definerer om nøgleord er versalfølsomme.

Fremhævning

  Fremhævningsafsnittet indeholder alle data der kræves for at analysere og vise teksten. Dette inkluderer:

  Punktdata

    Indeholder punktdata-elementer, hver definerer en stil.

  Nøgleordslister

    Hver liste har et navn, og kan indeholde et vilkårligt antal punkter.

  Sammenhænge

    Indeholder sammenhænge, som igen indeholder syntaksdetektionsregler.

## Fremhævningsdetektionsregler

Dette afsnit beskriver syntaksdetektionsregler.

Hver regel kan matche nul eller flere tegn i begyndelsen af strengen de bliver bedt om at teste. Hvis reglen matcher, bliver de matchende tegn tilknyttet stilen eller attributten defineret af reglen, og en regel vil måske spørge om den aktuelle sammenhæng er skiftet.

Attributten og sammenhængs attributterne er fælles for alle regler.

En regel ser sådan her ud:

    <RuleName attribute="(identifier)" context="(identifier|order)" [regelspecifikke attributter] />

Attributten identificerer den stil der skal bruges til matchede tegn ved navn eller indeks, og sammenhængen identificerer sammenhængen der skal bruges fra nu af.

Attributten kan identificeres enten ved navn, eller ved sit nul-baserede indeks i ItemDatas-grupperne.

Sammenhængen kan identificeres ved:

- En identifikator, for øjeblikket kun dens nul-baserede indeks i sammenhængsgruppen.

- En rækkefølge der fortæller maskinen at den skal forblive i den aktuelle sammenhæng (`#stay`), eller poppe tilbage til en tidligere sammenhæng brugt i strengen (`#pop`).

  For at flere trin tilbage, kan #pop-nøgleordet gentages: `#pop#pop#pop`

Nogle regler kan have afledte regler som så bliver evaluerede hvis og kun hvis den oprindelige regel matches. Hele den matchede streng vil blive givet attributten defineret af den oprindelige regel. En regel med afledte regler ser sådan her ud:

    <RuleName (attributes)>
      <ChildRuleName (attributes) />
      ...
    </RuleName>

Regelspecifikke attributter varierer og beskrives i følgende liste.

### Reglerne i detalje

DetectChar

  Detekterer et enkelt tegn. Almindeligt brugt for eksempel til at finde slutningen af citerede strenge.

      <DetectChar char="(character)" (almindelige attributter) />

  `char`-attributten definerer tegnet der skal matches.

Detect2Chars

  Detekterer to specifikke tegn i en defineret rækkefølge.

      <Detect2Chars char="(character)" char1="(character)" (almindelige attributter) />

  `char`-attributten definerer det første tegn der skal matches, `char1` det andet.

AnyChar

  Detekterer et tegn fra et bestemt sæt angivne tegn.

      <AnyChar String="(string)" (almindelige attributter) />

  `Streng`-attributten definerer sættet af tegn.

StringDetect

  Detekterer en eksakt streng.

      <StringDetect String="(string)" [insensitive="TRUE|FALSE;"] (almindelige attributter) />

  `Streng`-attributten definerer strengen der skal matches. `insensitive`-attributten er som standard `FALSE` og fødes til strengsammenligningsfunktionen. Hvis værdien er `TRUE` bruges insensitive sammenligning.

RegExpr

  Matcher mod et regulært udtryk.

      <RegExpr String="(string)" [insensitive="TRUE|FALSE;"] [minimal="TRUE|FALSE"] (almindelige attributter) />

  `Streng`-attributten definerer det regulære udtryk.

  `insensitive` er som standard `FALSE` og fødes til den regulære udtryk maskine.

  `minimal` er som standard `FALSE` og fødes til den regulære udtryk maskine.

  Fordi reglerne altid matches imod begyndelsen af den aktuelle streng, vil et regulært udtryk der starter med en karet (`^`) indikere at reglen kun skal matches mod begyndelsen af en linje.

  Se Regulære udtryk for yderligere oplysninger om disse.

Nøgleord

  Detektér et nøgleord fra en bestemt liste.

      <keyword String="(list name)" (almindelige attributter) />

  `String`-attributten identificerer nøgleordslisten ved navn. En liste med dette navn skal eksistere.

Int

  Detektér et heltal.

      <Int (almindelige attributter) />

  Denne regel har ingen specifikke attributter. Afledte regler bruges typisk til at detektere kombinationer af `L` og `U` efter tallet, indikerende heltalstypen i programkode.

Decimaltal

  Detektér et decimaltal.

      <Float (almindelige attributter)
      />

  Denne regel har ingen specifikke attributter.

HlCOct

  Detektér en oktal pointnummer repræsentation.

      <HlCOct (almindelige attributter) />

  Denne regel har ingen specifikke attributter.

HlCHex

  Detektér en hexadecimal nummerrepræsentation.

      <Int (almindelige attributter) />

  Denne regel har ingen specifikke attributter.

HlCStringChar

  Detektér et escape-tegn.

      <HlCStringChar (almindelige attributter)
      />

  Denne regel har ingen specifikke attributter.

  Den matcher bogstavelige repræsentationer af usynlige tegn som er almindeligt brugte i programkode, for eksempel `\n` (nylinje) eller `\t` (TAB).

  Følgende tegn vil matche hvis de følger efter en baglæns skråstreg (`\`): `abefnrtv"'?`. Derudover vil escape-hexadecimale tal som for eksempel `\xff` og escape-oktale tal, for eksempel `\033` matche.

RangeDetect

  Detekterer en streng med defineret start- sluttegn.

      <RangeDetect char="(character)"  char1="(character)" (almindelige attributter) />

  `char` definerer tegnet der starter området, `char2` tegnet der afslutter området.

  Nyttigt til at detektere for eksempel små citerede strenge og den slags, men bemærk at fordi hl-maskinen virker på én linje af gangen, vil den ikke finde strenge der går udover et linjebrud.

LineContinue

  Matcher slutningen af linjen.

      <LineContinue (almindelige attributter) />

  Denne regel har ingen specifikke attributter.

  Denne regel er nyttig til at skifte sammenhæng for enden af en linje.