Configurazione con le variabili dei documenti

Le variabili di KatePart sono l'implementazione di KatePart delle variabili dei documenti, simili ai file modeline di Emacs e di vi. Nella componente KatePart le righe hanno la seguente forma: kate: NOME_VARIABILE VALORE; [ NOME_VARIABILE VALORE; ... ]. Le righe possono naturalmente essere in un commento, se il formato del file lo prevede. I nomi delle variabili sono costituiti da una sola parola (cioè senza spazi), e tutto quello che c'è fino al successivo punto e virgola è il valore. Il punto e virgola è necessario.

Ecco un esempio di riga di variabili, che impone le regole di rientro per un file C++, Java o JavaScript:

// kate: replace-tabs on; indent-width 4; indent-mode cstyle;

Nota

Le righe di variabili vengono cercate solo nelle prime e nelle ultime dieci righe.

Inoltre, le variabili dei documenti possono essere messe in un file chiamato .kateconfig in qualsiasi cartella, e le impostazioni configurate saranno applicate come se le modeline fossero inserite su ogni file nella cartella e nelle sue sottocartelle. Le variabili dei documenti in .kateconfig usano la stessa sintassi delle modeline, ma con delle opzioni estese.

In KatePart ci sono variabili per gestire quasi tutte le configurazioni; inoltre, anche le estensioni possono usare le variabili, il ché andrebbe documentato nel manuale dell'estensione.

KatePart supporta la lettura delle configurazioni dai file .editorconfig se è installata la libreria editorconfig. KatePart cerca automaticamente un .editorconfig quando apri un file, pur dando priorità ai file .kateconfig.

Come KatePart usa le variabili

Quando legge la configurazione, KatePart cerca i questi posti (nell'ordine):

  • la configurazione globale;

  • valori facoltativi di sessione;

  • la configurazione «Tipi di file»;

  • variabili del documento in .kateconfig;

  • variabili del documento presenti nel documento stesso;

  • impostazioni modificate in fase di modifica da menu o dalla riga di comando.

Come puoi vedere, le variabili del documento possono essere sostituite solo da modifiche fatte al momento dell'esecuzione. Ogni volta che un documento viene salvato, le sue variabili verranno rilette e sovrascriveranno i cambiamenti fatti con voci di menu o dalla riga di comando.

Ogni variabile non elencata qui sotto può essere inserita nel documento e ritrovata da altri oggetti, come estensioni, che possono usarle per i propri scopi. Per esempio, la modalità di rientro variabile usa le variabili dei documenti per la propria configurazione.

Le variabili qui elencate documentano KatePart versione 5.38. In futuro potrebbero essere aggiunte altre variabili. Ci sono tre possibili tipi di valori per le variabili, con le seguenti espressioni valide:

  • BOOL - on|off|true|false|1|0

  • INT - un numero intero

  • STRING - qualsiasi altra cosa

Variabili disponibili

auto-brackets [BOOL]

Abilita l'inserimento automatico delle parentesi.

auto-center-lines [INT]

Imposta il numero di righe autocentranti.

background-color [STRING]

Imposta il colore di sfondo del documento. Il valore deve essere qualcosa leggibile come un colore valido, come #ff0000.

backspace-indents [BOOL]

Abilita o disabilita la rimozione del rientro alla pressione di Backspace.

block-selection [BOOL]

Attiva o disattiva la selezione a blocchi.

bom | byte-order-mark | byte-order-marker [BOOL]

Attiva o disattiva il marcatore dell'ordine dei byte quando si salvano dei file in formato Unicode (utf8, utf16, utf32).

Da: Kate 3.4 (KDE 4.4)

bracket-highlight-color [STRING]

Imposta il colore per l'evidenziazione delle parentesi. Deve essere qualcosa leggibile come un colore valido, come #ff0000.

current-line-color [STRING]

Imposta il colore della riga attuale. Il valore deve essere qualcosa leggibile come un colore valido, come #ff0000.

default-dictionary [STRING]

Imposta il dizionario predefinito da usare per il controllo ortografico.

Da: Kate 3.4 (KDE 4.4)

dynamic-word-wrap [BOOL]

Attiva o disattiva l'andata a capo dinamica.

eol | end-of-line [STRING]

Imposta la modalità di fine riga. Le impostazioni valide sono unix, mac e dos.

folding-markers [BOOL]

Attiva o disattiva la visualizzazione degli indicatori di raggruppamento.

folding-preview [BOOL]

Abilita l'anteprima del ripiegamento nei bordi dell'editor.

font-size [INT]

Imposta la dimensione in punti dei caratteri del documento.

font [STRING]

Imposta il carattere del documento. Il valore deve essere un nome di carattere valido, per esempio courier.

hl | syntax [STRING]

Imposta l'evidenziazione della sintassi. Le stringhe valide sono tutti i nomi disponibili nel menu. Per esempio, per il C++ basta scrivere C++.

icon-bar-color [STRING]

Imposta il colore della barra delle icone. Il valore deve essere qualcosa leggibile come un colore valido, come #ff0000.

icon-border [BOOL]

Attiva o disattiva la visualizzazione del bordo delle icone.

indent-mode [STRING]

Imposta la modalità di rientro automatico. Sono riconosciute le opzioni none, normal, cstyle, haskell, lilypond, lisp, python, ruby e xml. Vedi la sezione chiamata «Usare il rientro automatico» per i dettagli.

indent-pasted-text [BOOL]

Attiva o disattiva la regolazione del rientro del testo incollato dagli appunti.

Da: Kate 3.11 (KDE 4.11)

indent-width [INT]

Imposta la larghezza del rientro.

keep-extra-spaces [BOOL]

Imposta se tenere gli spazi aggiuntivi quando si calcola la larghezza del rientro.

line-numbers [BOOL]

Attiva o disattiva la visualizzazione del numero di riga.

newline-at-eof [BOOL]

Aggiungi una riga vuota alla fine del file (EOF) al salvataggio del documento.

Da: Kate 3.9 (KDE 4.9)

overwrite-mode [BOOL]

Attiva o disattiva la modalità sovrascrittura.

persistent-selection [BOOL]

Attiva o disattiva la selezione persistente.

replace-tabs-save [BOOL]

Attiva o disattiva la conversione di tabulazioni in spazi in fase di salvataggio.

replace-tabs [BOOL]

Attiva o disattiva la conversione dinamica di tabulazioni in spazi.

remove-trailing-spaces [STRING]

Rimuove gli spazi finali durante il salvataggio del documento. Le opzioni valide sono:

  • none, - o 0: non rimuovere mai gli spazi finali.

  • modified, mod, + o 1: rimuovi gli spazi finali solo nelle righe modificate. Le righe modificate vengono evidenziate dal sistema di evidenziazione delle righe.

  • all, * o 2: rimuovi gli spazi finali in tutto il documento.

Da: KDE 4.10.

scrollbar-minimap [BOOL]

Mostra minimappa di scorrimento.

scrollbar-preview [BOOL]

Mostra l'anteprima nella barra di scorrimento.

scheme [STRING]

Imposta lo schema di colori. Per avere effetto, La stringa deve essere il nome di uno schema di colori presente nella configurazione.

selection-color [STRING]

Imposta il colore della selezione. Il valore deve essere qualcosa leggibile come un colore valido, come #ff0000.

show-tabs [BOOL]

Attiva o disattiva il carattere di tabulazione visibile.

smart-home [BOOL]

Attiva o disattiva la navigazione all'inizio intelligente.

tab-indents [BOOL]

Attiva o disattiva il rientro col tasto Tab.

tab-width [INT]

Imposta la larghezza a schermo del carattere di tabulazione.

undo-steps [INT]

Imposta il numero di passi di annullamento da memorizzare.

Nota: deprecato da Kate 3 in KDE 4. Questa variabile è ignorata. Il numero massimo di annullamenti è illimitato.

word-wrap-column [INT]

Imposta la larghezza dell'andata a capo dinamica.

word-wrap-marker-color [STRING]

Imposta il colore per l'indicatore di andata a capo. Il valore deve essere qualcosa leggibile come un colore valido, come #ff0000.

word-wrap [BOOL]

Attiva o disattiva l'andata a capo statica.

Opzioni estese nei file .kateconfig

KatePart cerca sempre un file .kateconfig per i file locali (non per quelli remoti), inoltre è possibile impostare delle opzioni basate sui caratteri jolly (estensioni dei file) come segue:

kate: tab-width 4; indent-width 4; replace-tabs on;
kate-wildcard(*.xml): indent-width 2;
kate-wildcard(Makefile): replace-tabs off;

In questo esempio tutti i file usano un valore di tab-width ed uno di indent-width di 4 spazi, e le tabulazioni sono sostituite con gli spazi. Tuttavia la larghezza di rientro è impostata a 2 spazi per tutti i file *.xml e i Makefile usano le tabulazioni, cioè queste non sono sostituite dagli spazi.

I caratteri jolly sono separati da virgole, ad esempio puoi specificare più estensioni di file così:

kate-wildcard(*.json;*.xml): indent-width 2;

Inoltre puoi usare il tipo MIME per associare certi file; ad esempio per indentare tutti i file sorgente C con 4 spazi puoi scrivere:

kate-mimetype(text/x-c++src): indent-width 4;

Nota

Oltre al supporto nei file .kateconfig i caratteri jolly e le variabili dei documenti dipendenti dal tipo MIME sono anche supportati nel file stesso come commenti.