Anpassa med dokumentvariablerVariabler i KatePart är KateParts implementering av dokumentvariabler, som liknar modelines i Emacs och Vi. I Kate-programdelen har raderna följande format: kate: VARIABELNAMN VÄRDE; [ VARIABELNAMN VÄRDE; ... ]. Raderna kan förstås finnas i en kommentar, om filen har ett format med kommentarer. Variabelnamn är enstaka ord (inga blanktecken), och allt fram till nästa semikolon är värdet. Semikolonet är nödvändigt.
Här är ett exempel på en variabelrad, som styr indenteringsinställningar för en C++, Java™ eller JavaScript-fil:
// kate: replace-tabs on; indent-width 4; indent-mode cstyle;
Notera
Bara de första och sista 10 raderna söks igenom efter variabelrader.
Dessutom kan dokumentvariabler placeras i en fil som heter .kateconfig i vilken katalog som helst, och de angivna inställningarna verkställs som om modelines skrivits in i varje fil i katalogen och i dess underkataloger. Dokumentvariabler i .kateconfig använder samma syntax som modelines, men med utökade alternativ.
Det finns variabler som stöder nästan alla inställningar i KatePart, och ytterligare insticksprogram kan använda variabler, som i så fall ska vara dokumenterade i insticksprogrammets dokumentation.
KatePart har stöd för att läsa inställningar från .editorconfig-filer, där biblioteket editorconfig är installerat. KatePart söker automatiskt efter .editorconfig så fort en fil öppnas. Den ger dock prioritet till .kateconfig-filer.
När inställningarna läses, letar Kate-programdelen på följande ställen (i denna ordning):
Den allmänna inställningen.
Valfri sessionsdata.
Inställningen under "filtyp".
Dokumentvariabler i
.kateconfig.Dokumentvariabler i själva dokumentet.
Inställningar som görs under redigering från menyn eller kommandoraden.
Som du märker överskrids dokumentvariabler av ändringar som görs under körning. Så fort ett dokument sparas, läses dokumentvariablerna om, och skriver över ändringar som gjorts med menyalternativ eller från kommandoraden.
Alla variabler som inte anges nedan lagras i dokumentet och kan läsas av andra objekt, exempelvis insticksprogram, som kan använda dem för egna syften. Det variabelbaserade indenteringsläget använder till exempel dokumentvariabler för sin inställning.
Variablerna som anges här dokumenterar KatePart version 5.38. Fler variabler kan läggas till i framtiden. Det finns tre möjliga typer av värden för variabler, med följande giltiga uttryck:
BOOL - on|off|true|false|1|0
HELTAL - vilket heltal som helst
STRÄNG - allt annat
auto-brackets [BOOL]
Aktivera automatisk infogning av hakparenteser.
auto-center-lines [HELTAL]
Ange rader för automatisk centrering.
background-color [STRÄNG]
Ställ in dokumentets bakgrundsfärg. Värdet måste vara något som kan tolkas som en giltig färg, till exempel
#ff0000.backspace-indents [BOOL]
Aktivera eller inaktivera avindentering när backsteg trycks ner.
block-selection [BOOL]
Sätt på eller stäng av blockmarkering.
bom | byte-order-mark | byte-order-marker [BOOL]
Aktivera eller inaktivera byte-ordningsmarkering (BOM) när filer sparas med Unicode-format (utf8, utf16, utf32).
Sedan: Kate 3.4 (KDE 4.4)
bracket-highlight-color [STRÄNG]
Ställer in färgen för markering av parenteser. Värdet måste vara något som kan tolkas som en giltig färg, till exempel
#ff0000.current-line-color [STRÄNG]
Ställer in färgen för nuvarande rad. Värdet måste vara något som kan tolkas som en giltig färg, till exempel
#ff0000.default-dictionary [STRÄNG]
Ställer in förvald ordlista använd vid stavningskontroll.
Sedan: Kate 3.4 (KDE 4.4)
dynamic-word-wrap [BOOL]
Sätter på eller stänger av dynamisk radbrytning.
eol | end-of-line [STRÄNG]
Ställer in radslutsläget. Giltiga inställningar är
unix,macochdos.folding-markers [BOOL]
Sätter på eller stänger av visning av vikmarkörer.
folding-preview [BOOL]
Aktivera förhandsgranskning av vikning längs editorns kant.
font-size [HELTAL]
Ange dokumentets teckenstorlek i punkter.
font [STRÄNG]
Ställer in dokumentets teckensnitt. Värdet måste vara ett giltigt teckensnittsnamn, till exempel
courier.hl | syntax [STRÄNG]
Ställer in syntaxfärgläggning. Giltiga strängar är alla namn tillgängliga i menyerna. Skriv exempelvis helt enkelt
C++för C++.icon-bar-color [STRÄNG]
Ställer in ikonradens färg. Värdet måste vara något som kan tolkas som en giltig färg, till exempel
#ff0000.icon-border [BOOL]
Sätter på eller stänger av visning av ikonkanten.
indent-mode [STRÄNG]
Ställer in automatiskt indenteringsläge. Alternativen
none,normal,cstyle,haskell,lilypond,lisp,python,rubyochxmlkänns igen. Se avsnittet ”Att använda automatisk indentering” för detaljinformation.indent-pasted-text [BOOL]
Aktivera eller inaktivera Justering av indentering för text som klistrats in från klippbordet.
Sedan: Kate 3.11 (KDE 4.11)
indent-width [HELTAL]
Ange indenteringsbredden.
keep-extra-spaces [BOOL]
Ställer in om extra mellanslag ska behållas när indenteringsbredden beräknas.
line-numbers [BOOL]
Sätt på eller stäng av visning av radnummer.
newline-at-eof [BOOL]
Lägg till en tom rad i slutet av filen (EOF) när dokumentet sparas.
Sedan: Kate 3.9 (KDE 4.9)
overwrite-mode [BOOL]
Sätter på eller stänger av överskrivningsläge.
persistent-selection [BOOL]
Sätt på eller stäng av långlivade markeringar.
replace-tabs-save [BOOL]
Sätter på eller stänger av konvertering av tabulatortecken till mellanslag.
replace-tabs [BOOL]
Sätter på eller stänger av dynamisk konvertering av tabulatortecken till mellanslag.
remove-trailing-spaces [STRÄNG]
Tar bort avslutande mellanslag när dokumentet sparas. Giltig alternativ är:
none,-eller0: ta aldrig bort avslutande mellanslag.modified,mod,+eller1: ta bara bort avslutande mellanslag på ändrade rader. De ändrade raderna markeras av radändringssystemet.all,*eller2: ta bort avslutande mellanslag i hela dokumentet.
scrollbar-minimap [BOOL]
Visa rullningslistens miniavbildning.
scrollbar-preview [BOOL]
Visa rullningslistens förhandsgranskning.
scheme [STRÄNG]
Ställer in färgschemat. Strängen måste vara namnet på ett färgschema som finns i dina inställningar för att ha någon effekt.
selection-color [STRÄNG]
Ställer in markeringsfärgen. Värdet måste vara något som kan tolkas som en giltig färg, till exempel
#ff0000.show-tabs [BOOL]
Sätter på eller stänger av synligt tabulatortecken.
smart-home [BOOL]
Sätter på eller stänger av smart Home-navigering.
tab-indents [BOOL]
Sätter på eller stänger av indentering med tabulatortecken.
tab-width [HELTAL]
Ställer in tabulatorvisningsbredden.
undo-steps [HELTAL]
Ange antalet ångra-steg som ska kommas ihåg ( = oändigt)
Observera: Användning avråds från sedan Kate 3 i KDE 4. Variabeln ignoreras. Det maximala antalet steg som kan ångras är obegränsat.
word-wrap-column [HELTAL]
Ställer in bredden för hård radbrytning.
word-wrap-marker-color [STRÄNG]
Ställer in färgen som markerar radbrytningar. Värdet måste vara något som kan tolkas som en giltig färg, till exempel
#ff0000.word-wrap [BOOL]
Sätter på eller stänger av hård radbrytning.
KatePart letar alltid efter en .kateconfig-fil för lokala filer (inte fjärrfiler). Dessutom är det möjligt att ange alternativ baserat på jokertecken (filändelser) enligt följande:
kate: tab-width 4; indent-width 4; replace-tabs on; kate-wildcard(*.xml): indent-width 2; kate-wildcard(Makefile): replace-tabs off;
I exemplet använder alla filer tabulatorbredd (tab-width) 4 mellanslag, indenteringsbredd (indent-width) 4 mellanslag och tabulatorer ersätts expanderade till mellanslag. För alla *.xml-filer är dock indenteringsbredden inställd till 2 mellanslag. Och Makefile-filer använder tabulatorer, dvs. tabulatorer ersätts inte med mellanslag.
Jokertecken skiljs åt av semikolon, dvs. det går också att ange flera filändelser enligt följande:
kate-wildcard(*.json;*.xml): indent-width 2;
Dessutom kan MIME-typer också användas för att matcha vissa filer, för att t.ex. indentera all C++ källkodsfiler med 4 mellanslag kan man skriva:
kate-mimetype(text/x-c++src): indent-width 4;
Notera
Förutom stödet i .kateconfig-filer, stöds också dokumentvariabler som beror på jokertecken och MIME-typer i själva filerna som kommentarer.