Configurando com as Variáveis do DocumentoAs variáveis do KatePart são a implementação do KatePart para as variáveis do documento, de forma semelhante à que acontece no Emacs e no VI. Na 'katepart', as linhas têm o seguinte formato: kate: NOMEVARIÁVEL VALOR; [ NOMEVARIÁVEL VALOR; ... ]. As linhas poderão estar, claro, num comentário, se o arquivo estiver num formato que suporte comentários. Os nomes das variáveis são palavras únicas (sem espaços) e tudo o que estiver até o próximo ponto e vírgula é o valor. Esse ponto e vírgula é obrigatório.
Aqui está uma linha de variável de exemplo, obrigando a configuração do recuo para um arquivo em C++, Java™ ou JavaScript:
// kate: replace-tabs on; indent-width 4; indent-mode cstyle;
Nota
Só as primeiras e últimas 10 linhas serão pesquisadas pelas linhas de variáveis.
Além disso, as variáveis do documento podem ser colocadas em um arquivo chamado .kateconfig em qualquer diretório, e as opções configuradas serão aplicadas se as modelines forem inseridas em qualquer arquivo no diretório e subdiretórios. As variáveis de documento no .kateconfig usam a mesma sintaxe das modelines, mas com opções estendidas.
Existem variáveis para suportar quase todas as configurações no KatePart e os plugins adicionais podem usar as variáveis; nesse caso, isto deverá estar indicado na documentação do plugin.
O KatePart oferece suporte à leitura de configurações de arquivos .editorconfig, quando a biblioteca editorconfig está instalada. O KatePart busca automaticamente por um arquivo .editorconfig sempre que você abre um arquivo. No entanto, ele dá prioridade a arquivos .kateconfig.
Ao ler a configuração, o 'katepart' procura nos seguintes locais (nesta ordem):
A configuração global.
Os dados opcionais da sessão.
A configuração do "Tipo de arquivo".
As variáveis do documento no
.kateconfig.As variáveis do próprio documento.
As configurações feitas durante a edição do menu ou da linha de comando.
Como pode ver, as variáveis do documento somente podem ser sobrepostas por alterações feitas no momento da execução. Sempre que um documento for salvo, as variáveis do documento são lidas novamente e irão sobrepor as alterações feitas, usando os itens do menu ou nas linhas de comando.
Todas as variáveis que não estejam indicadas abaixo são guardadas no documento e poderão ser pesquisadas por outros objetos, como os plugins, usando-as para os seus próprios fins. Por exemplo, o modo de recuo variável usa as variáveis do documento para a sua própria configuração.
As variáveis aqui listadas dizem respeito ao KatePart versão 5.38. Poderão ser adicionadas mais variáveis no futuro. Existem 3 tipos de valores definidos para as variáveis, com as seguintes expressões válidas:
BOOL - on|off|true|false|1|0
INTEIRO - qualquer número inteiro
TEXTO - todo o resto
auto-brackets [BOOL]
Ativar a inserção automática de parênteses.
auto-center-lines [INT]
Define o número de linhas de centralização automática.
background-color [TEXTO]
Define a cor de fundo do documento. O valor deverá ser algo que possa ser avaliado como uma cor válida, como por exemplo,
#ff0000.backspace-indents [BOOLEANO]
Ativa ou desativa a remoção do recuo quando o Backspace é pressionado.
block-selection [BOOL]
Ativa ou desativa a seleção em bloco.
bom | byte-order-mark | byte-order-marker [BOOL]
Ativar/desativar o marcador da ordem dos bytes (BOM) ao salvar os arquivos no formato Unicode (utf8, utf16, utf32).
Desde: Kate 3.4 (KDE 4.4)
bracket-highlight-color [TEXTO]
Define a cor de realce dos parênteses. O valor deverá ser algo que possa ser avaliado como uma cor válida, como por exemplo,
#ff0000.current-line-color [TEXTO]
Define a cor da linha atual. O valor deverá ser algo que possa ser avaliado como uma cor válida, como por exemplo
#ff0000.default-dictionary [TEXTO]
Configurar o dicionário padrão usado na verificação ortográfica.
Desde: Kate 3.4 (KDE 4.4)
dynamic-word-wrap [BOOL]
Ativa ou desativa a quebra de linha dinâmica.
eol | end-of-line [TEXTO]
Define o modo de fim-de-linha. Os valores válidos são o
unix, omace odos.folding-markers [BOOL]
Ativa ou desativa a visualização dos marcadores de expansão/contração do código.
folding-preview [BOOL]
Ativar a visualização de dobragem no contorno do editor.
font-size [INT]
Define o tamanho em pontos da fonte do documento.
font [TEXTO]
Define o tipo de fonte do documento. O valor deverá ser um nome de fonte válido, como por exemplo,
courier.hl | syntax [TEXTO]
Define o realce de sintaxe. Os textos usados são todos os nomes disponíveis nos menus. Por exemplo, para o C++, basta digitar
C++.icon-bar-color [TEXTO]
Define a cor da barra de ícones. O valor deverá ser algo que possa ser avaliado como uma cor válida, como por exemplo,
#ff0000.icon-border [BOOL]
Ativa ou desativa a visibilidade da borda dos ícones.
indent-mode [TEXTO]
Define o modo de recuo automático. As opções
none,normal,cstyle,haskell,lilypond,lisp,python,rubyexmlsão reconhecidas. Veja a seção “Usando o recuo automático” para mais detalhes.indent-pasted-text [BOOLEANO]
Ativa/desativa o ajuste de recuo do texto colado da área de transferência.
Desde: Kate 3.11 (KDE 4.11)
indent-width [INTEIRO]
Define a largura do recuo.
keep-extra-spaces [BOOL]
Define se deseja manter os espaços extras ao calcular a largura do recuo.
line-numbers [BOOL]
Ativa ou desativa a visibilidade dos números de linha.
newline-at-eof [BOOLEANO]
Adiciona uma linha vazia no fim do arquivo (EOF) ao salvar o documento.
Desde: Kate 3.9 (KDE 4.9)
overwrite-mode [BOOL]
Ativa ou desativa o modo de sobreposição.
persistent-selection [BOOL]
Ativa ou desativa as seleções persistentes.
replace-tabs-save [BOOL]
Ativa ou desativa a conversão de tabulações para espaços no salvamento.
replace-tabs [BOOL]
Ativa ou desativa a conversão dinâmica de tabulações para espaços no salvamento.
remove-trailing-spaces [TEXTO]
Remove os espaços finais ao salvar o documento. As opções válidas são:
none,-ou0: nunca remove os espaços finais.modified,mod,+ou1: remove os espaços finais apenas nas linhas modificadas. Estas linhas são marcadas pelo sistema de modificação de linhas.all,*ou2: remove os espaços finais no documento inteiro.
scrollbar-minimap [BOOL]
Mostrar minimapa na barra de rolagem.
scrollbar-preview [BOOL]
Mostrar a visualização na barra de rolagem.
scheme [TEXTO]
Define o esquema de cores. O texto deverá ser o nome de um esquema de cores que exista na sua configuração, para que faça qualquer efeito.
selection-color [TEXTO]
Define a cor da seleção. O valor deverá ser algo que possa ser avaliado como uma cor válida, como por exemplo
#ff0000.show-tabs [BOOL]
Ativa ou desativa o caractere de tabulação visível.
smart-home [BOOL]
Ativa ou desativa a navegação inteligente do Home.
tab-indents [BOOLEANO]
Ativa ou desativa o recuo com Tab.
tab-width [INT]
Define a largura de exibição do caractere de tabulação.
undo-steps [INT]
Define o número de passos a recordar no Desfazer/Refazer.
Nota: Obsoleto desde o Kate 3 no KDE4. Esta variável é ignorada. O número máximo de passos de anulação é ilimitado.
word-wrap-column [INT]
Define a largura da quebra de linha estática.
word-wrap-marker-color [TEXTO]
Define a cor do marcador de quebra de linha. O valor deverá ser algo que possa ser avaliado como uma cor válida, como por exemplo,
#ff0000.word-wrap [BOOL]
Ativa ou desativa a quebra de linha estática.
O KatePart sempre procura um arquivo .kateconfig para arquivos locais (não arquivos remotos). Além disso, é possível definir opções com base em curingas (extensões de arquivo) da seguinte forma:
kate: tab-width 4; indent-width 4; replace-tabs on; kate-wildcard(*.xml): indent-width 2; kate-wildcard(Makefile): replace-tabs off;
Neste exemplo, todos os arquivos usam uma largura de tabulação de 4 espaços, uma largura de recuo de 4 espaços e as tabulações são substituídas por espaços quando expandidas. No entanto, para todos os arquivos *.xml, a largura do recuo é definida como 2 espaços. E os Makefiles usam tabulações, isto é as tabulações não são substituídas por espaços.
Os caracteres curinga são separados por ponto e vírgula, isto é você também pode especificar várias extensões de arquivo da seguinte forma:
kate-wildcard(*.json;*.xml): indent-width 2;
Além disso, você também pode usar o tipo MIME para corresponder a determinados arquivos, por exemplo para indentar todos os arquivos de origem C++ com 4 espaços, você pode escrever:
kate-mimetype(text/x-c++src): indent-width 4;
Nota
Além do suporte em arquivos .kateconfig, curingas e variáveis de documento dependentes do tipo MIME também são suportados nos próprios arquivos como comentários.