
Copyright © 2000, 2001 Thad McGinnis
Copyright © 2005 Anne-Marie Mahfouf <annma@kde.org>
, Anders Lund <anders@alweb.dk>
Copyright © 2011, 2012, 2013, 2014 T.C. Hollingsworth <tchollingsworth@gmail.com>
O KatePart é um componente de edição completo para aplicativos do Qt™ e do KDE.
Índice
- 1. Introdução
- 2. Alguns Fundamentos
- 3. Trabalhando com o Editor KatePart
- 4. Entradas de Menu
- 5. Ferramentas Avançadas de Edição
- 6. Ampliando o KatePart
- 7. Configurar o KatePart
- 8. Créditos e licença
- 9. O modo de entrada do VI
- A. Expressões Regulares
Lista de Exemplos

KatePart é um componente de edição completo, usado por muitos aplicativos do Qt™ e do KDE. O KatePart é mais que um editor de texto, tem como objetivo ser o editor do programador e poderia ser considerado pelo menos como uma alternativa parcial para a maioria dos editores mais poderosos. Uma das principais funcionalidades do KatePart é a sintaxe colorida, personalizada para muitas das diferentes linguagens de programação, como por exemplo: C/C++, Java™, Python, Perl, Bash, Modula 2, HTML e Ada.
KWrite é um editor de texto simples baseado no KatePart. Tem uma interface de documentos individuais (SDI) que permite modificar apenas um arquivo por janela. Pelo fato de o KWrite ser uma implementação muito simples do KatePart, não precisa ter uma documentação própria. Se você souber usar o KWrite, poderá usar o KatePart em qualquer lugar!

O KWrite e várias outras utilizações do KatePart são muito simples de usar. Qualquer pessoa que já usou um editor de texto não deverá ter problemas.
O KatePart usa o protocolo Arrastar e Soltar do KDE. Os arquivos podem ser arrastados e depois soltos no KatePart, a partir da Área de Trabalho, do gerenciador de arquivos Dolphin ou de algum site FTP remoto que estiver aberto em uma das janelas do Dolphin.

Embora o KWrite possa ser geralmente iniciado a partir do menu de programas do KDE ou de um ícone da área de trabalho, ele poderá ser aberto a partir da linha de comando de uma janela de terminal. Existem algumas opções úteis que estão disponíveis ao fazer isto.
Muitos outros aplicativos que usam o KatePart oferecem opções de linha de comando similares.
Especificando o caminho e nome de um arquivo específico o usuário pode fazer com que o KWrite abra (ou crie) este arquivo imediatamente após iniciar. Esta opção pode parecer algo como o seguinte:
%
kwrite
/home/eu/documentos/arquivo.txt
O método acima mencionado pode também ser usado para abrir arquivos na Internet (se o usuário tiver uma conexão ativa no momento.) Um exemplo disto pode parecer com o seguinte:
%
kwrite
ftp://ftp.kde.org/pub/kde/README
As seguintes opções de ajuda de linha de comando estão disponíveis
kwrite
--help
Apresenta as opções mais básicas disponíveis a partir da linha de comando.
kwrite
--help-qt
Isto lista as opções disponíveis para mudar a maneira como o KWrite interage com o Qt™.
kwrite
--help-kde
Isto lista as opções disponíveis para mudar a maneira com o KWrite interage com o KDE.
kwrite
--help-all
Apresenta todas as opções da linha de comando.
kwrite
--author
Lista o autor do KWrite na janela do terminal
kwrite
-v, --version
Lista as informações de versão do Qt™, do KDE e do KWrite. Também está disponível como
kwrite
-v
KWrite
--license
Mostra informações sobre a licença.
kwrite
--stdin
Faz com que o KWrite leia o conteúdo do documento a partir do STDIN. Isto é semelhante à opção comum
-
, que é usada em muitos programas de linha de comando, permitindo-lhe encaminhar o resultado dos comandos para o KWrite.kwrite
--encoding
encoding
URL
Faz com que o KWrite use a codificação indicada para o documento.
kwrite
--line
linha
URL
Vai para a linha indicada, após abrir o documento.
kwrite
--column
coluna
URL
Vai para a coluna indicada, após abrir o documento.

Muitos dos atalhos de teclado são configuráveis através do menu Configurações. Por padrão, o KatePart respeita os seguintes atalhos de teclado:
Ins | Alterna entre o modo Inserir e Sobrescrever. Quando no modo inserir o editor adicionará qualquer caractere digitado ao texto empurrando qualquer dado à direita do cursor do texto. O modo sobrescrever faz com que a entrada de cada caractere elimine o caractere imediatamente à direita do cursor de texto. |
Seta à esquerda | Move o cursor um caractere à esquerda |
Seta à direita | Move o cursor um caractere à direita |
Seta para cima | Move o cursor uma linha acima |
Seta para baixo | Move o cursor uma linha abaixo |
Page Up | Move o cursor uma página acima |
Alt+Page Up | Favorito Anterior |
Page Down | Move o cursor uma página abaixo |
Alt+Page Down | Próximo favorito |
Backspace | Apaga o caractere à esquerda do cursor |
Home | Move o cursor para o início da linha |
End | Move o cursor para o fim da linha |
Excluir | Apaga o caractere à direita do cursor (ou o texto selecionado) |
Shift+Enter | Insere uma nova linha incluindo os caracteres iniciais da linha atual, que não forem letras ou números. Isso é útil, por exemplo, para escrever comentários no código. No fim da linha “// algum texto”, pressione esse atalho para que a próxima linha inicie com “// ”. Assim, você não terá que inserir esses caracteres no início de cada nova linha com comentários. |
Shift+Seta à esquerda | Marca o texto que estiver um caractere à esquerda |
Shift+Seta Direita | Marca o texto que estiver um caractere à direita |
F1 | Ajuda |
Shift+F1 | O que é isto? |
F3 | |
Shift+F3 | |
Ctrl+H | |
Ctrl+Shift+H | |
Ctrl+A | Selecionar Tudo |
Ctrl+Shift+A | Desmarcar |
Ctrl+Shift+B | Modo de Seleção em Bloco |
Ctrl+B | Definir um favorito |
Ctrl+C | Copia o texto marcado para a área de transferência. |
Ctrl+D | Comentário |
Ctrl+Shift+D | Descomentar |
Ctrl+F | |
Ctrl+G | Vai para linha... |
Ctrl+I | Recua a seleção |
Ctrl+Shift+I | Retira o recuo da seleção |
Ctrl+J | Juntar Linhas |
Ctrl+N | Novo documento |
Ctrl+O | |
Ctrl+P | |
Ctrl+Q | Sair - fecha a cópia ativa do editor |
Ctrl+R | |
Ctrl+S | Invoca o comando Salvar. |
Ctrl+U | Maiúsculas |
Ctrl+Shift+U | Minúsculas |
Ctrl+Alt+U | Iniciais maiúsculas |
Ctrl+V | Cola o texto da área de transferência na linha de edição. |
Ctrl+W | |
Ctrl+X | Apaga o texto marcado e copia-o para a área de transferência. |
Ctrl+Z | |
Ctrl+Shift+Z | |
Ctrl+- | Recolher um nível local |
Ctrl+Shift+- | Fechar o Nível de Topo |
Ctrl++ | Expandir Um Nível Local |
Ctrl+Shift++ | Expandir o Nível de Topo |
Meta+Ctrl+V | Modo de entrada do VI |
Ctrl+Espaço | Invocar complementação de código |
F5 | |
F6 | Mostrar/Ocultar a Borda dos Ícones |
F7 | Alternar para linha de comando |
F9 | Mostrar/Ocultar as Marcas de Desdobramento |
F10 | Quebra de linha dinâmica |
F11 | Mostrar/Ocultar os Números de Linha |

O editor KatePart é a área de edição da janela do KatePart. Este editor também é usado pelo Kate e pelo KWrite, e ele pode também ser usado pelo Konqueror para exibir arquivos texto de seu computador local ou da rede.
O editor é composto pelos seguintes componentes:
- A Área do Editor
Esta é a área onde o texto de seu documento está localizado.
- As barras de rolagem
Indicam a posição da parte visível do texto do documento, e pode ser usada para mover-se pelo documento. Arrastar as barras não fará com que o cursor de inserção seja movido.
As barras de rolagem podem ser exibidas e ocultas, caso necessário.
- A Borda do Ícone
A borda do ícone é um pequeno painel do lado esquerdo do editor, exibindo um pequeno ícone próximo às linhas marcadas.
Você pode ajustar ou remover um favorito em uma linha visível clicando com o botão do mouse na borda do ícone, próximo àquela linha.
A exibição da borda do ícone pode ser alternada usando o item de menu → .
- O Painel dos Números de Linha
O painel de números de linha exibem os números de linha de todas as linhas visíveis no documento.
A exibição do Painel de Números de linha pode ser alternado usando o item de menu → .
- Painel Dobragem
A área de dobragem/desdobramento permite-lhe expandir ou recolher blocos de linhas de código. O cálculo das regiões dobráveis é feito de acordo com regras na definição de realce de sintaxe do documento.

A movimentação pelo texto no KatePart é como na maioria dos editores de texto gráficos. O usuário poderá mover o cursor com as teclas dos cursores e com as teclas Page Up, Page Down, Home e End, em conjunto com as teclas modificadoras Ctrl e Shift. A tecla Shift é sempre usada para gerar uma seleção, enquanto a tecla Ctrl pode ter efeitos diferentes nas diferentes teclas:
Para as teclas Cima e Baixo, isto significa deslocar o cursor, em vez de movê-lo.
Para as teclas Esquerda e Direita, isto significa saltar as palavras em vez de simples caracteres.
Para as teclas Page Up e Page Down, isto significa ir para o limite visível da janela, em vez de navegar.
Para as teclas Home e End, isto significa ir para o início ou fim do documento, em vez de ir para o início ou fim da linha.
O KatePart também lhe oferece uma forma de saltar rapidamente para um parênteses correspondente: Coloque o cursor no interior de um parênteses e pressione Ctrl+6 para saltar para o parênteses correspondente.
Além disso, você poderá colocar ou retirar um favorito, para saltar para posições definidas por você.

Existem duas maneiras básicas de selecionar texto no KatePart: usando o mouse e usando o teclado.
Para selecionar usando o mouse, pressione e mantenha pressionado o botão
do mouse enquanto arrasta o cursor do mouse de onde a seleção deve iniciar, até o ponto final desejado. O texto fica selecionado quando você arrasta.O clique duplo em uma palavra seleciona a mesma.
O clique triplo em uma linha seleciona a linha inteira.
Se o Shift estiver pressionado enquanto se clica, o texto será selecionado:
Se nenhum texto já estiver selecionado, da posição do cursor do texto até a posição do cursor do mouse.
Se existe uma seleção, deste essa seleção até a posição do ponteiro do mouse.
Nota
Ao selecionar o texto arrastando o mouse, o texto selecionado é copiado para a área de transferência, e pode ser coloca clicando-se com o botão do meio do mouse no editor, ou em qualquer outro aplicativo para o qual você deseja colar o texto.
Para selecionar usando o teclado, pressione mantenha pressionada a tecla Shift usando as teclas de navegação (as setas, Page Up, Page Down, Home e End , possivelmente em combinação com o Ctrl para aumentar o movimento do cursor de texto).
Veja também a seção Navegando no Texto , neste capítulo.
Para Copiar a seleção atual, use o item de menu → ou o atalho de teclado (o padrão é Ctrl+C).
Para Desmarcar a seleção atual, use o item de menu → ou o atalho de teclado (o padrão é Ctrl+Shift+A), ou clique com o botão do mouse no editor.
Quando a Seleção de Bloco estiver habilitada, você pode fazer “seleções verticais” no texto, o que significa selecionar colunas limitadas de múltiplas linhas. Isto é útil em trabalhos com linhas separadas com tabulações, por exemplo.
A Seleção de Bloco pode ser alternada usando-se o item de menu → . O atalho padrão no teclado é Ctrl+Shift+B.
Se a Seleção de Sobrescrita estiver habilitada, a digitação ou colagem de texto dentro da seleção causará a substituição do texto selecionado. Se não estiver habilitada, o novo texto será adicionado na posição do cursor do texto.
A Seleção de Sobrescrita está habilitada, por padrão.
Para alterar a configuração desta opção, veja a página Cursor & Seleção da Janela de Configuração.
Quando a Seleção Persistente estiver habilitada, a digitação de caracteres ou a movimentação do cursor não fará com que a seleção desapareça. Isto significa que você pode mover o cursor para fora da seleção e digitar o texto.
A Seleção Persistente está desabilitada, por padrão.
A Seleção Persistente pode ser ativada na página Cursor & Seleção da Janela de Configuração.
Atenção
Se a Seleção Persistente e a Seleção de Sobrescrita estiverem ambas habilitadas, a digitação e a colagem de texto, quando o cursor estiver dentro da seleção, farão com que ela seja substituída ou desmarcada.

Para copiar texto, selecione-o e use a opção do menu → . Adicionalmente, a seleção de texto com o mouse fará com que o texto selecionado seja copiado para a área de transferência.
Para colar o texto contido atualmente na área de transferência, use o item de menu → .
Adicionalmente, o texto selecionado com o mouse pode ser colando clicando-se com o botão do
do mouse na posição desejada.Dica
Se você está usando o ambiente de trabalho KDE, você pode recuperar textos copiados recentemente de qualquer aplicativo, usando o ícone do Klipper na área de notificação.

O KatePart possui uma barra de pesquisa incremental e uma barra avançada de pesquisa e substituição, que possibilita a inserção de um texto de substituição, juntamente com algumas opções adicionais.
As barras oferecem as seguintes opções comuns:
- Procurar
Aqui é onde se digita a string de busca. A interpretação da string depende de algumas das opções escritas a seguir.
- Diferenciar maiúsculas de minúsculas
Se estiver ativo, a pesquisa será limitada aos itens que correspondam a nível de capitalização (maiúsculas ou minúsculas) de cada um dos caracteres no padrão de pesquisa.
A barra de pesquisa e substituição avançadas oferece algumas opções adicionais:
- Texto Simples
Corresponde literalmente a qualquer ocorrência do texto de pesquisa.
- Palavras Completas
Se estiver selecionado, a busca somente combinará se existir uma palavra com os mesmos finais da string encontrada, o que significa que nem caracteres alfanuméricos, nem algum outro caractere visível ou um final de linha.
- Sequências de Escape
Se estiver selecionada, o botão no topo de menu de contexto das caixas de texto ficará ativo permitindo que você adicione sequências de escape para o padrão de pesquisa, usando uma lista pré-definida.
- Expressão regular
Se estiver assinalada, o texto a procurar é interpretado como uma expressão regular. O botão no topo do menu de contexto das caixas de texto ficará ativo permitindo que você crie itens de expressão regular para o padrão de pesquisa, usando como base uma lista pré-definida.
Veja em Expressões regulares para mais informações.
- Apenas a seleção
Se estiver selecionada, a pesquisa e substituição será feita apenas sobre o texto selecionado.
- Procurar todos
Ao clicar neste botão, serão realçadas todas as ocorrências no documento e será mostrado o número de ocorrências encontradas numa pequena área.
Para procurar texto, invoque a barra de pesquisa incremental com a combinação de teclas Ctrl+F ou com a opção do menu → .
Isto abre a barra de pesquisa incremental no fundo da janela do editor. Do lado esquerdo da barra, existe um botão com ícone para fechar a barra, seguido de um pequeno campo de texto para inserir o padrão a pesquisar.
Quando você começar a inserir os caracteres no seu padrão de pesquisa, a busca inicia imediatamente. Se existir uma ocorrência no texto, ela fica realçada e a cor de fundo do campo muda para verde-claro. Se o padrão de pesquisa não corresponder a nenhum texto, isto é indicado por uma cor de fundo vermelha-clara no campo e com uma mensagem Não encontrado do lado direito da barra.
Use o botão Próximo ou Anterior para saltar para a próxima ocorrência ou a anterior no documento.
As correspondências são realçadas mesmo quando você fecha a barra de pesquisa. Para limpar este realce, pressione a tecla Esc.
Você poderá escolher aqui se a pesquisa faz a distinção entre minúsculas e maiúsculas. Se selecionar a opção Diferenciar maiúsculas de minúsculas, irá limitar as pesquisas para os itens que correspondam às letras (maiúsculas ou minúsculas) de cada um dos caracteres do padrão de pesquisa.
Clique no botão com um ícone da seta verde, à direita da barra de pesquisa incremental, para mudar para a barra mais poderosa de pesquisa e substituição.
Para repetir a última operação de pesquisa, se existir alguma e sem ter que invocar a barra de pesquisa incremental, use a opção → (F3) ou → (Shift+F3).
Para substituir o texto, invoque a barra avançada de pesquisa e substituição com a opção do menu → ou com a combinação de teclas Ctrl+R.
No canto superior esquerdo da barra existe um botão com um ícone para fechar a barra, seguido de um pequeno campo de texto para inserir o padrão de pesquisa.
Você poderá controlar o modo de pesquisa selecionando as opções Texto Simples, Palavras Completas, Sequências de Escape ou Expressão Regular, que estão descritas acima.
Use o botão Próximo ou Anterior para saltar para a próxima ocorrência ou a anterior no documento.
Insira o texto de substituição no campo de texto Substituir e clique no botão , para substituir apenas o texto realçado, ou o botão para substituir o texto de pesquisa em todo o documento.
Você poderá modificar o comportamento da pesquisa e da substituição se selecionar as diferentes opções no fundo da barra. Selecionar a opção Distinguir a Capitalização irá limitar as pesquisas aos itens que correspondam, a nível de maiúsculas/minúsculas, a cada um dos caracteres no padrão de pesquisa. A opção Apenas a Seleção irá procurar e substituir apenas dentro da seleção atual. O botão Procurar Tudo irá realçar todas as ocorrências no documento e mostrar o número de ocorrências encontradas numa pequena janela.
Clique no botão com o ícone da seta verde, à direita da barra avançada de pesquisa e substituição, para mudar para a barra de pesquisa incremental.
Dica
Se estiver usando uma expressão regular para encontrar um texto a ser substituído, você pode empregar referências regressivas, para reutilizar o texto capturado em subpadrões da expressão, com parênteses.
Veja em Expressões regulares para mais informações.
Dica
Você poderá procurar, substituir e procurar de forma incremental na linha de comando.

A característica de favoritos permite a você marcar certas linhas, para ser capaz de encontrá-las facilmente de novo.
Você pode ajustar ou remover um favorito de uma linha de duas maneiras:
Movendo o cursor de inserção para essa linha e ativando o comando → (Ctrl+B).
Carregando na Borda do Ícone junto a essa linha.
Os Favoritos estão disponíveis no menu . Os favoritos individuais estão disponíveis como itens de menu, rotulados com o número da linha que contém o favorito, e os primeiros caracteres da linha. Para mover o cursor para o início da linha marcada, abra o menu e selecione o favorito.
Para saltar rapidamente entre favoritos ou para o favorito anterior/seguinte, use as opções → (Alt+PgDown) ou → (Alt+PgUp).

Esta característica permite a você ter o texto formatado de uma maneira muito simples: o texto será quebrado, e assim nenhuma linha excederá o número máximo de caracteres por linha, a menos que exista uma string mais longa sem espaços em branco.
Para desabilitar/habilitar isto, desmarque/marque a caixa de verificação na página de edição do diálogo de configuração.
Para definir o tamanho máximo da linha (número máximo de caracteres por linha), use a opção na página de Edição da janela de configuração.
Se habilitada, ele terá os seguintes efeitos:
Ao digitar, o editor inserirá automaticamente uma quebra de linha após o último espaço em branco na posição antes que o comprimento máximo de linha seja alcançado.
Ao carregar um documento, o editor quebrará o texto de modo similar, e assim nenhuma linha será maior que o comprimento máximo por linha, se elas contiverem quaisquer espaços em branco pertencentes a ela.
Nota
Não existe atualmente um modo de ajustar a quebra de linha por tipo de documento, ou até mesmo habilitar ou desabilitar a característica em um nível de documento. Isto será corrigido em versões futuras do KatePart.

O componente de edição do KatePart suporta uma variedade de modos de recuo automático, desenhado para os diferentes formatos de texto. Você poderá escolhê-los, entre os modos disponíveis, com a opção → . Os módulos de recuo automático também oferecem uma função → , que irá calcular novamente o recuo da linha atual ou a selecionada. Assim, você poderá mudar o recuo do seu documento inteiro, selecionando o texto e ativando essa opção.
Todos os modos de recuo usam a configuração de recuo no documento ativo.
Dica
Você poderá definir todos os tipos de variáveis de configuração, incluindo aqueles relacionados com o recuo com as Variáveis do documento e os Tipos de arquivo.
Modos de recuo automático disponíveis
- Nenhum
Se selecionar este modo, irá desativar o recuo automático.
- Normal
Este sistema de recuo simplesmente mantém o recuo semelhante ao da linha anterior, com o conteúdo que não corresponda a espaços em branco. Você poderá combinar isto com a utilização das ações de recuo e remoção de recuo, para poder recuar de acordo com a sua vontade.
- Estilo C
Um sistema de recuo para o C e para as linguagens semelhantes, como o C++, C#, Java, JavaScript, entre outros. Este sistema não irá funcionar para as linguagens de 'scripting', como o Perl ou o PHP.
- Haskell
Um sistema de recuo específico para a linguagem de programação Haskell.
- Lilypond
Um sistema de recuo específico para a linguagem de notação musical Lilypond.
- Lisp
Um sistema de recuo específico para a linguagem de programação Lisp e respectivos dialetos.
- Python
Um sistema de recuo específico para a linguagem de programação Python.
- Estilo XML
Um sistema de recuo específico para linguagens semelhantes ao XML.

Os indicadores de modificação de linhas do KatePart permitem-lhe ver facilmente o que você alterou recentemente em um arquivo. Por padrão, as alterações gravadas são indicadas com uma barra verde à esquerda de um documento, enquanto as alterações não gravadas são indicadas com uma barra laranja.

Os indicadores de modificação de linhas em ação.
Você poderá alterar as cores usadas no painel de configuração das Cores & Fontes ou poderá desativar esta funcionalidade por completo na página Bordas do painel de configuração da Aparência.

O minimapa na barra de rolagem exibe uma miniatura dos documentos no local da barra de rolagem. A parte visível do documento será realçada.

O minimapa na barra de rolagem mostra uma miniatura do código-fonte do Kate.
Você pode ativar ou desativar o minimapa temporariamente selecionando → ou de forma permanente na seção Aparência, da configuração do KatePart.

- → (Ctrl+N)
Isto inicia um novo documento numa janela de edição nova e independente.
- → (Ctrl+O)
Exibe o diálogo padrão do KDE Abrir Arquivo. Use o visualizador de arquivo para selecionar o arquivo que você deseja abrir, e clique em para abri-lo.
- →
Este é um atalho para os documentos recentemente salvos. Clicar neste item abrirá uma lista ao lado do menu com vários dos arquivos mais recentemente salvos. Clicar em um arquivo específico irá abri-lo no KatePart - se o arquivo ainda estiver na mesma localização.
- → (Ctrl+S)
Isto salva o documento atual. Se o documento já tiver sido salvo então isto sobrescreverá o arquivo anteriormente salvo sem pedir pela permissão do usuário. Se esta é a primeira vez que salva um novo documento a diálogo salvar como (descrito abaixo) será invocado.
- →
Isto permite que um documento seja salvo com um novo nome de arquivo. Isto é feito com a caixa de diálogo de arquivo descrita acima na seção Abrir deste arquivo de ajuda.
- → (F5)
Recarrega o arquivo ativo do disco. Este comando é útil, se outro programa ou processo tiver alterado o arquivo enquanto você o manipula no KatePart.
- → (Ctrl+P)
Abre uma janela de impressão que permite ao usuário especificar o quê, onde e como imprimir.
- →
Exporta o seu arquivo para o formato HTML para que o documento possa ser visto como uma página Web.
- → (Ctrl+W)
Fecha o arquivo ativo com este comando. Se você tiver feito alterações não salvas, será questionado se deseja salvar o arquivo antes do KatePart fechá-lo.
- → (Ctrl+Q)
Isto fechará a janela do editor. Se você tiver mais de uma instância do KatePart em execução, através dos itens de menu ou , estas instâncias não serão fechadas.

- → (Ctrl+Z)
Isto é usado para eliminar ou reverter a ação ou operação mais recente do usuário.
- → (Ctrl+Shift+Z)
Isto reverte a mudança mais recente (se houver) feita usando o Desfazer
- → (Ctrl+X)
Este comando apaga a seleção atual e coloca-a na área de transferência. A área de transferência é uma funcionalidade do KDE que funciona de forma invisível para oferecer uma forma de transferir os dados entre os aplicativos.
- → (Ctrl+C)
Isto copia o texto atualmente selecionado para a área de transferência, de modo a poder ser colado em outro local. A área de transferência é uma funcionalidade do KDE que funciona de forma invisível para oferecer uma forma de transferir os dados entre os aplicativos.
- → (Ctrl+V)
Isto irá inserir o conteúdo da área de transferência na posição do cursor. A área de transferência é uma funcionalidade do KDE que funciona, de forma invisível, para oferecer uma forma de transferir os dados entre os aplicativos.
- →
Este submenu irá mostrar a parte inicial do texto recentemente copiado para a área de transferência. Selecione um item a partir deste menu para colá-lo no arquivo aberto.
- →
Copia o texto selecionado para a área de transferência como HTML.
- → (Ctrl+A)
Isto irá selecionar todo o documento. Isto pode ser muito útil para copiar um arquivo inteiro para outro aplicativo.
- → (Ctrl+Shift+A)
Retira a seleção de texto no editor, se existir.
- → (Ctrl+Shift+B)
Ativa ou desativa o Modo de Seleção. Quando o Modo de Seleção for BLOCO, você poderá fazer seleções verticais, por exemplo selecionar as colunas de 5 a 10 nas linhas 9 a 15. A barra de estado mostra a informação sobre o Modo de Seleção, como BLOCO ou LINHA.
- → (Meta+Ctrl+V)
Muda para um modo, semelhante ao VI, de edição modal. Este modo suporta os comandos e sequências mais usadas nos modos normal e visual do 'vim', tendo uma barra de estado opcional do modo VI. Esta barra de estado mostra os comandos, à medida que vão sendo inseridos, o resultado dos comandos e o modo atual. O comportamento deste modo poderá ser configurado na aba Modo de Entrada VI da página de Edição, na janela de configuração do KatePart.
- → (Ins)
Ativa ou desativa os modos de Inserção/Sobrescrita. Quando o modo for o INS, você poderá inserir caracteres no local onde se encontra o cursor. Quando o modo for o SOB, os caracteres inseridos irão substituir os caracteres atuais, se o seu cursor tiver texto após ele. A barra de estado mostra a informação sobre o Modo de Sobreposição como INS ou SOB.
- → (Ctrl+F)
Isto abre a barra de pesquisa incremental no fundo da janela do editor. Do lado esquerdo da barra, existe um botão com um ícone para fechar a barra, seguido de um pequeno campo de texto para introduzir o padrão a pesquisar.
Quando você começar a inserir caracteres no seu padrão de pesquisa, a busca começa imediatamente. Se existir uma ocorrência no texto, ela fica realçada e a cor de fundo do campo muda para verde-claro. Se o padrão de pesquisa não corresponder a nenhum texto, isto é indicado por uma cor de fundo vermelha-clara no campo e com uma mensagem Não encontrado do lado direito da barra.
Use o botão Próximo ou Anterior para saltar para a próxima ocorrência ou a anterior no documento.
Você poderá escolher aqui se a pesquisa faz a distinção entre minúsculas e maiúsculas. Se selecionar a opção Diferenciar maiúsculas de minúsculas, irá limitar as pesquisas para os itens que correspondam às letras (maiúsculas ou minúsculas) de cada um dos caracteres do padrão de pesquisa.
Clique no botão com um ícone da seta verde, à direita da barra de pesquisa incremental, para mudar para a barra mais poderosa de pesquisa e substituição.
- → → (F3)
Isto repete a última operação de busca, se houver, sem chamar a barra de procura.
- → → (Shift+F3)
Isto repete a última operação de busca, se houver, sem chamar a barra de procura, e busca no documento para trás ao invés de para frente.
- → → (Ctrl+H)
Procura a próxima ocorrência do texto selecionado.
- → → (Ctrl+Shift+H)
Procura a ocorrência anterior do texto selecionado.
- → (Ctrl+R)
Este comando abre a barra avançada de pesquisa e substituição. No lado superior esquerdo da barra, existe um botão com um ícone para fechar a barra, seguido de um pequeno campo de texto para inserir o padrão a pesquisar.
Você pode controlar o modo de pesquisa selecionando as opções Texto simples, Palavras completas, Sequências de escape ou Expressão regular na lista.
Se Sequências de escape ou Expressão regular estiver selecionado, o item de menu na base do menu de contexto de caixas de texto será habilitado e lhe permitirá adicionar sequências de escape ou expressões regulares para pesquisa ou substituição de padrões a partir de listas pré-definidas.
Use o botão Próximo ou Anterior para saltar para a próxima ocorrência ou a anterior no documento.
Insira o texto de substituição no campo de texto Substituir e clique no botão , para substituir apenas o texto realçado, ou o botão para substituir o texto de pesquisa no documento inteiro.
Você poderá modificar o comportamento da pesquisa e da substituição ao selecionar as diferentes opções no lado direito da barra. Se selecionar a opção Distinguir a capitalização irá limitar as pesquisas apenas aos itens com capitalização correspondente (maiúsculas ou minúsculas) para cada um dos caracteres no padrão de pesquisa. A opção Apenas a seleção irá procurar e substituir apenas dentro do texto selecionado no momento. A opção Procurar Tudo realça todas as ocorrências no documento e mostra o número de correspondências encontradas em uma pequena janela de contexto.
Clique no botão com o ícone da seta verde, à direita da barra avançada de pesquisa e substituição, para mudar para a barra de pesquisa incremental.
- → (Ctrl+G)
As linhas que foram alteradas desde a abertura do arquivo são chamadas de linhas modificadas. Esta ação move o cursor para a linha modificada anterior.
- → (Ctrl+G)
As linhas que foram alteradas desde a abertura do arquivo são chamadas de linhas modificadas. Esta ação move o cursor para a próxima linha modificada.
- → (Ctrl+G)
Isto abre a barra "ir para linha" no fundo da janela, que é usada para fazer com que o cursor pule para uma linha em particular (especificada pelo número) no documento. O número da linha pode ser inserido diretamente na caixa de texto ou graficamente clicando na seta para cima e para baixo do controle de contagem ao lado da caixa de texto. A pequena seta para cima aumentará o número da linha e a seta para baixo diminuirá. Feche a barra com um clique no botão com um ícone existente no lado esquerdo da barra.

O menu permite-lhe gerenciar a configuração específica do editor ativo, bem como o gerenciamento das subjanelas.
- →
Cria outra janela que contém o documento atual. Todas as modificações feitas no documento de uma janela serão refletidos na outra janela e vice-versa.
- → (F7)
Mostra a linha de comando da componente do Kate no fundo da janela. Na linha de comando, digite
help
para obter ajuda ehelp list
para obter uma lista de comandos. Para mais informações sobre a linha de comando, veja a Linha de comando do componente de edição.- →
Seleciona um esquema de fontes.
- → (F10)
As linhas de texto serão repartidas ao atingir o limite da janela.
- →
Escolhe se e quando deverão ser mostrados os indicadores de quebra de linha. Isto só fica disponível se a opção Quebra de Linha Dinâmica estiver assinalada.
- →
Se esta opção estiver assinalada, será desenhada uma linha vertical na coluna de quebra de linha, como está definido na opção → na página de Edição. Lembre-se que o marcador de mudança de linha só é desenhado se usar uma fonte monoespaçada.
- → (F6)
Isto é um item de comutação. Se o ligar, irá ativar a Borda dos Ícones do lado esquerdo do editor ativo, e vice-versa. A borda dos ícones indica as posições das linhas marcadas no editor.
- → (F11)
Isto é um item de comutação. Se ligá-lo, irá aparecer uma área que mostra os números de linha do documento à esquerda e vice-versa.
- →
Se esta opção estiver assinalada, a janela irá mostrar algumas marcas na barra de rolagem vertical. As marcas são equivalentes às marcas na Borda do ícone.
- →
Isto irá substituir a barra de rolagem com a visualização do documento atual. Para obter mais informações sobre o minimapa na barra de rolagem, veja “O minimapa na barra de rolagem”
- → (F9)
Se esta opção estiver assinalada, as marcas de desdobramento do código serão exibidas.
- →
Recolhe a região que contém o cursor.
Expande a região que contém o cursor.
- (Ctrl+Shift+-)
Recolhe todos os níveis superiores do documento. Clique no triângulo que aponta para a direita para expandir todos os níveis superiores.
- →
Isto aumenta o tamanho da fonte usada para exibição.
- →
Isto diminui o tamanho da fonte usada para exibição.

- → (Ctrl+B)
Ativa ou remove um favorito na linha atual do documento ativo (Se já existir, é removido, caso contrário é configurado).
- →
Este comando removerá todos os marcadores do documento bem como a lista de marcadores que é anexada na base deste item de menu.
- → (Alt+PgUp)
Isto irá mover o cursor para o início da linha imediatamente acima que contiver um favorito. O texto do item do menu irá incluir o número da linha e o primeiro pedaço de texto da linha. Este item só está disponível quando houver um favorito numa linha acima do cursor.
- → (Alt+PgDown)
Isto irá mover o cursor para o início da linha imediatamente abaixo que contiver um favorito. O texto do item do menu irá incluir o número da linha e o primeiro pedaço de texto da linha. Este item só está disponível quando houver um favorito numa linha acima do cursor.
Na base deste menu, uma lista de favoritos aparece se algum favorito está disponível para esta janela.

- →
Configura o documento atual no modo Somente Leitura. Isto evita que seja adicionado qualquer texto ou formatação do documento.
- →
Escolhe o esquema de tipo de arquivos que preferir para o documento ativo. Isto substitui o modo de tipo de arquivos global definido na opção → na página de Tipos de Arquivos, somente para o seu documento atual.
- →
Escolhe o esquema de realce de sintaxe que preferir para o documento ativo. Isto substitui o modo de realce global definido na opção → , somente para o seu documento atual.
- →
Escolhe o estilo de recuo que preferir para o documento ativo. Isto substitui o modo de recuo global definido na opção → , somente para o seu documento atual.
- →
Você poderá sobrepor a codificação predefinida na opção → , na página Abrir/Salvar, para definir uma codificação diferente para o seu documento atual. A codificação que definir aqui será válida apenas para o seu documento atual.
- →
Seleciona o modo de fim de linha que preferir para o documento ativo. Isto substitui o modo de fim de linha global definido na opção → , somente para o seu documento.
- →
Se assinalar esta opção, você poderá adicionar explicitamente um marcador de ordem dos 'bytes' para os documentos codificados em Unicode. O marcador da ordem de 'bytes' é um caractere em Unicode que é usado para assinalar a ordem dos 'bytes' ('endianness') de um arquivo ou sequência de texto. Para mais informações, veja o Marcador da Ordem de 'Bytes'.
- →
Este submenu contém uma lista para todas as ações de script. A lista pode ser facilmente modificada ao se escrever seus próprios scripts. Desta maneira, o KatePart pode ser estendido por ferramentas definidas pelo usuário.
- → →
- → →
- → → →
Ordena o texto selecionado ou o documento inteiro em ordem crescente.
- → → → (Ctrl+Shift+Abaixo)
Move as linhas selecionadas para baixo.
- → → → (Ctrl+Shift+Acima)
Move as linhas selecionadas para cima.
- → → → (Ctrl+Alt+Abaixo)
Duplica as linhas selecionadas para baixo.
- → → → (Ctrl+Alt+Acima)
Duplica as linhas selecionadas para cima.
- → → →
Codifica o texto selecionado, de forma que possa ser usado como parte de um texto de pesquisa em uma URL, substituindo a seleção pelo texto codificado.
- → → →
Se parte do texto de pesquisa de uma URL estiver selecionado, isto irá descodificá-lo e substituir a seleção pelo texto original.
- → →
- → → →
Converte o texto selecionado para um par de marcas HTML ou XML abertas e fechadas. Por exemplo, se selecionar
div
, este item irá substituir isso por<div></div>
.- → → →
Envolve o texto selecionado com a marca indicada na linha de comando.
- → → →
Quando o cursor estiver dentro de um par de marcas HTML/XML, este item irá alterar a seleção para incluir o conteúdo dessas marcas de HTML/XML, sem selecionar as marcas em si.
- → → →
Quando o cursor estiver dentro de um par de marcas de HTML/XML, este item irá alterar a seleção para incluir o conteúdo dessas marcas HTML/XML, sem selecionar as marcas em si.
- → → →
Se o cursor estiver dentro de uma marca aberta HTML/XML, esta opção irá movê-lo para a marca de fechamento. Se o cursor estiver dentro da marca de fechamento, irá movê-lo para a marca de abertura.
- → → →
Se o bloco selecionado não for um comentário, esta opção irá envolver esse bloco em comentários de HTML/XML (por exemplo,
<!-- texto selecionado -->
). Se já for um comentário, as marcas do comentário serão removidas.- → → →
Se o cursor estiver dentro de uma marca de HTML/XML, este item irá excluir a marca inteira.
- → → →
Este item irá subtrair uma unidade ao texto selecionado, se for um número. Por exemplo, se tiver selecionado um
5
, irá passar para4
.- → → →
Este item irá subtrair dez unidades ao texto selecionado, se for um número. Por exemplo, se tiver selecionado um
15
, irá passar para5
.- → → →
Este item irá subtrair 0,1 ao texto selecionado, se for um número. Por exemplo, se tiver selecionado um
4,5
, irá passar para4,4
.- → → →
Este item irá adicionar uma unidade ao texto selecionado, se for um número. Por exemplo, se tiver selecionado um
5
, irá passar para6
.- → → →
Este item irá adicionar dez unidades ao texto selecionado, se for um número. Por exemplo, se tiver selecionado um
5
, irá passar para15
.- → → →
Este item irá adicionar 0,1 ao texto selecionado, se for um número. Por exemplo, se tiver selecionado um
4,5
, irá passar para4,6
.
- → (Ctrl+Espaço)
Invocar manualmente a complementação de comando, normalmente usando um atalho associado a esta ação.
- →
As opções (Ctrl+9) e (Ctrl+8) terminam o texto escrito no momento, procurando por palavras semelhantes antes ou depois da posição atual do cursor. O mostra uma janela com os itens correspondentes.
- → → (Ctrl+Shift+O)
Quando a estiver ativa, o texto errado será sublinhado no texto imediatamente.
- → →
Isto inicia o programa de verificação ortográfica - um programa que é desenhado para ajudar o usuário a descobrir e a corrigir os erros ortográficos. Ao clicar nesta opção, irá iniciar o verificador ortográfico e abrir a janela de verificação ortográfica. Existem quatro campos alinhados verticalmente no centro da janela com as suas legendas correspondentes à sua esquerda. Começando a partir do topo, elas são:
- Palavra desconhecida:
Aqui, o verificador ortográfico indica a palavra atualmente em análise. Isto acontece quando o verificador ortográfico encontra uma palavra que não se encontra no seu dicionário - um arquivo que contém uma lista com as palavras corretas com as quais compara cada palavra no editor.
- Substituir por:
Se o verificador possuir alguma palavra semelhante no seu dicionário a primeira será listada aqui. O usuário pode aceitar a sugestão, digitar nesta caixa sua correção, ou escolher uma sugestão diferente a partir da próxima caixa.
- Idioma:
Se você possuir vários dicionários instalados, poderá selecionar aqui o dicionário/idioma a ser usado.
Do lado direito da janela, existem 6 botões que permitem ao usuário controlar o processo de verificação ortográfica. São estes:
Pressionar este botão adiciona a Palavra Desconhecida: ao dicionário do verificador. Isto significa que no futuro o verificador sempre considerará esta palavra como ortograficamente correta.
- Sugerir
O verificador poderá enumerar aqui uma quantidade de substituições possíveis para a palavra em consideração. Clicar em qualquer uma das sugestões, fará com que ela seja introduzida no campo Substituir por acima.
Este botão faz o verificador substituir a palavra em consideração no documento com a palavra na caixa Substituir por.
Este botão faz com que o verificador ortográfico substitua não somente a Palavra desconhecida: atual, mas automaticamente faça a mesma substituição para qualquer outra ocorrência desta Palavra desconhecida no documento.
Ativar este botão fará com que o verificador ortográfico avance sem realizar nenhuma alteração.
Este botão faz com que o verificador não faça nada com a Palavra desconhecida: atual e em nenhuma das outras ocorrências da mesma palavra.
Nota
Isto só se aplica a esta rodada de verificação ortográfica. Se o verificador for executado de novo, mais tarde, ele irá parar na mesma palavra.
Existem mais três botões no fundo da janela de verificação ortográfica. Estes são:
Isto invoca o sistema de ajuda do KDE com a página de ajuda para esta janela.
Este botão cancela o processo de verificação ortográfica e volta para o documento.
Este botão cancela o processo de verificação ortográfica; todas as modificações são anuladas e você irá voltar ao seu documento.
- → →
Isto inicia o programa de verificação ortográfica, mas inicia a partir do cursor, em vez de começar no início do documento.
- → →
Faz uma verificação ortográfica da seleção atual.
- → →
Mostra uma lista com todos os dicionários disponíveis para verificação ortográfica no fundo da janela de edição. Isto permite a mudança rápida do dicionário de verificação ortográfica, por exemplo para a verificação automática do texto em vários idiomas.
- →
Isto limpa o recuo da seleção atual ou da linha onde o cursor se encontra. Limpar o recuo, garante que todo o seu texto selecionado segue o modo de recuo que você escolher.
- →
Faz um novo alinhamento da linha atual ou das linhas selecionadas, usando o modo de recuo e a configuração de recuo no documento.
- → (Ctrl+D)
Isto adiciona um espaço ao início da linha onde o cursor de texto está localizado ou ao início de quaisquer linhas selecionadas.
- → (Ctrl+Shift+D)
Isto remove um espaço (se existir) do início da linha onde o cursor de texto está localizado ou do início de quaisquer linhas selecionadas.
- → (Ctrl+U)
Coloca o texto selecionado ou a letra após o cursor em maiúsculo.
- → (Ctrl+Shift+U)
Coloca o texto selecionado ou a letra após o cursor em minúsculo.
- → (Ctrl+Alt+U)
Coloca em maiúsculo a primeira letra do texto selecionado ou da palavra atual.
- → (Ctrl+J)
Junta as linhas selecionadas, ou a linha atual e a seguinte, separando-as apenas com um espaço. Os espaços finais/iniciais das linhas reunidas são removidas dos extremos colados.
- →
Aplica quebra de linha estática em todo o documento. Isto significa que uma linha nova de texto irá iniciar automaticamente quando a linha atual exceder o tamanho definido na opção Quebrar Linha em da página de Edição em →
- →
Cria um novo trecho, que é um bloco de texto reutilizável que você pode inserir em qualquer parte do documento.
- →
Mostra uma lista com os trechos disponíveis.

- →
Quando habilitado, isto exibe uma pequena barra na base do editor contendo informações sobre o estado do documento atual. Quando desabilitado a barra de estado é oculta.
- →
Quando habilitado, isto exibe uma barra de ferramentas móvel que contém botões usados para iniciar os comando mais frequentemente usados. Quando desabilitado a barra de ferramentas é oculta.
- →
Quando estiver selecionada, esta opção mostra na barra de título a localização no sistema de arquivos do documento atual. Se não estiver, a localização ficará oculta.
- →
Este item de menu abre um diálogo de onde diversas configurações diferentes podem ser ajustadas.
- →
Apresenta a janela de configuração de atalhos de teclado padrão do KDE. Para mais informações sobre sua utilização, veja a seção Usar e personalizar atalhos de teclado da documentação dos Fundamentos do KDE.
- →
Apresenta a janela de configuração de barra de ferramentas padrão do KDE. Para mais informações sobre sua utilização, veja a seção Personalizar as barras de ferramentas da documentação dos Fundamentos do KDE.

- → (F1)
Invoca o sistema de ajuda do KDE, iniciando nas páginas de ajuda do KatePart. (este documento)
- → (Shift+F1)
Muda o cursor do mouse para uma combinação de seta com um ponto de interrogação. Ao clicar nos itens do KatePart uma janela de ajuda será aberta (se existir alguma para o item) explicando a função do item.
- →
Abre o diálogo para relatar erros onde você pode comunicar um erro ou “sugerir” uma funcionalidade.
- →
Abre uma caixa de diálogo onde você pode escolher o Idioma primário e o Idioma secundário para este aplicativo.
- →
Mostra a versão e as informações do autor.
- →
Mostra a versão do KDE e outras informações básicas.

Os comandos e , disponíveis no menu permitem-lhe adicionar ou remover marcações de comentários à seleção ou à linha atual, se não existir texto selecionado, se os comentários são suportados pelo formato do texto que você está editando.
As regras de como o comentário é feito são feitas nas definições de sintaxe; assim, se o realce de sintaxe não é usado, as ações de comentar/descomentar não são possíveis.
Alguns formatos definem marcas de comentários para linhas únicas, outros suportam marcas de comentários para várias linhas e alguns suportam ambas. Se não estiverem disponíveis os comentários para várias linhas, o ato de comentar uma seleção que não inclui por completo a sua última linha não é possível.
Se um marcador de linha única estiver disponível, é preferível comentar linhas simples onde for aplicável, pois isto ajuda a evitar problemas com comentários aninhados.
Ao remover marcadores de comentários, textos sem comentários devem ser selecionados; ao remover marcadores de comentários de múltiplas linhas de uma seleção, qualquer espaço em branco fora do marcador é ignorado.
Para colocar marcações de comentários, use a opção do menu → ou o atalho de teclado relacionado, que por padrão é Ctrl+D.
Para remover marcações de comentários, use a opção do menu → ou o atalho de teclado relacionado, que por padrão é o Ctrl+Shift+D.

O componente de edição do KatePart possui uma linha de comando interna, que lhe permite efetuar várias ações a partir de uma interface mínima. A linha de comando é um campo de texto no fundo da área de edição onde, para mostrá-la, você poderá selecionar a opção → ou usar o atalho (que é, por padrão, o F7). O editor oferece um conjunto de comandos, tal como está documentado abaixo, sendo oferecidos mais comandos através de plugins.
Para executar um comando, pressione a tecla Return. A linha de comando irá indicar se foi bem sucedida e, provavelmente, irá mostrar uma mensagem. Se você inseriu na linha de comando pressionando F7, ele ocultar-se-á automaticamente, ao fim de alguns segundos. Para limpar a mensagem e inserir um comando novo, pressione F7 de novo.
A linha de comando possui um sistema de ajuda embutido, podendo inserir o comando help para iniciá-lo. Para ver uma lista com todos os comandos disponíveis, invoque o comando help list; para ver a ajuda sobre um determinado comando, faça help comando
.
A linha de comando possui um histórico embutido, como tal, o usuário poderá reutilizar os comandos já digitados. Para navegar no histórico, use as teclas Cima e Baixo. Ao mostrar os comandos do histórico, a parte do argumento do comando será selecionada, o que lhe permite sobrepor facilmente os argumentos.
Tipos de argumento
- BOOLEANO
Isto é usado com os comandos que ativam ou desativam certas coisas. Os valores válidos são o
on
,off
,true
,false
,1
ou0
.- INTEIRO
Um número inteiro.
- TEXTO
Uma string separada por aspas simples (') ou aspas (") quando conter espaços.
Estes comandos são oferecidos pelo componente do editor e permitem-lhe configurar apenas o documento e a janela ativos. Isto poderá ser útil se quiser usar uma configuração diferente da pré-definida como, por exemplo, no recuo.
set-tab-width {INTEIRO largura}
Configura a largura da tabulação como sendo
largura
.set-indent-width {INTEIRO largura}
Configura a largura do recuo como
largura
. Só é usado se o usuário recuar com espaços.set-word-wrap-column {INTEIRO largura}
Configura a largura da linha para uma quebra como tendo
largura
colunas. Isto é usado se você tiver o seu texto sendo quebrado automaticamente.set-icon-border {BOOLEANO ativar}
Configura a visibilidade da borda dos ícones.
set-folding-markers {BOOLEANO ativar}
Configura a visibilidade da área de marcadores de dobra do código.
set-line-numbers {BOOLEANO ativar}
Configura a visibilidade da área de números de linha.
set-replace-tabs {BOOLEANO ativar}
Se estiver ativo, as tabulações são substituídas por espaços, à medida que você vai digitando.
set-remove-trailing-space {BOOLEANO ativar}
Se estiver ativo, os espaços finais serão removidos quando o cursor abandonar uma determinada linha.
set-show-tabs {BOOLEANO ativar}
Se estiver ativo, os caracteres de tabulação e espaços estarão visíveis através de um pequeno ponto.
set-show-indent {BOOLEANO ativar}
Se estiver ativo, o recuo será visualizado por uma linha tracejada vertical.
set-indent-spaces {BOOLEANO ativar}
Se estiver ativo, o editor irá recuar com
largura-recuo
espaços por cada nível de recuo, em vez de usar o caractere TAB.set-mixed-indent {BOOLEANO ativar}
Se estiver ativo, o KatePart irá usar uma mistura de TABs e espaços para o recuo. Cada nível de recuo irá ter um tamanho de
largura-recuo
, enquanto os restantes níveis de recuo serão otimizados para usar tantos caracteres TAB quantos possíveis.Quando for executado, este comando irá ativar o recuo com espaços e, se a largura de recuo não estiver definida, corresponderá a metade da
largura-tabulação
do documento, no momento da execução.set-word-wrap {BOOLEANO ativar}
Ativa a quebra de linha dinâmica, de acordo com o parâmetro
ativar
.set-replace-tabs-save {BOOLEANO ativar}
Quando estiver ativo, as tabulações serão substituídas por espaços em branco, sempre que o documento for salvo.
set-remove-trailing-space-save {BOOLEANO ativar}
Quando estiver ativo, os espaços finais serão removidos de cada linha, sempre que o documento for salvo.
set-indent-mode {TEXTO nome}
Configura o modo de recuo automático como
nome
. Se onome
não for conhecido, o modo é configurado como 'none' (nenhum). Os modos válidos são 'none', 'normal', 'cstyle', 'haskell', 'lilypond', 'lisp', 'python', 'ruby' e 'xml'.set-auto-ident {BOOLEANO script}
Ativa ou desativa o recuo automático.
set-highlight {TEXTO realce}
Configura o sistema de realce de sintaxe para o documento. O argumento deverá ser um nome de realce válido, como pode ser visto no menu → . Este comando oferece uma lista de completação automática para o seu argumento.
reload-scripts
Recarrega todos os scripts do JavaScript usados pelo Kate, incluindo scripts de indentação e de linha de comando.
set-mode {STRING modo}
Seleciona o esquema de tipo de arquivo para o documento atual.
nn[oremap] {TEXTO original} {TEXTO mapeado}
Mapeia a sequência
original
para amapeada
.
Estes comandos modificam o documento atual.
indent
Recua as linhas selecionadas ou a linha atual.
unindent
Remove um nível de recuo das linhas selecionadas ou da linha atual.
cleanindent
Limpa o recuo das linhas selecionadas ou da linha atual, de acordo com a configuração de recuo no documento.
comment
Insere marcações de comentários para fazer da seleção, linhas selecionadas ou da linha atual um comentário, de acordo com o formato de texto definido pela definição do realce de sintaxe para o documento.
uncomment
Remove os marcadores de comentários da seleção, linhas selecionadas ou da linha atual, de acordo com o formato de texto definido pela definição do realce de sintaxe do documento.
kill-line
Remove a linha atual.
replace { TEXTO padrão} {TEXTO substituição}
Substitui o texto correspondente ao
padrão
porsubstituição
. Se você quiser incluir espaços em branco nopadrão
, deverá colocar tanto opadrão
como asubstituição
entre aspas simples ou duplas. Se os argumentos não estiverem entre estes caracteres, a primeira palavra é usada comopadrão
e o resto como asubstituição
. Se asubstituição
estiver em branco, cada ocorrência dopadrão
será removida.Você poderá configurar opções para modificar a procura, adicionando dois pontos (:), seguidos de uma ou mais letras, onde cada uma representa uma configuração, o que corresponderá ao formato
replace:opções padrão substituição
. As opções disponíveis são:b
Pesquisar para trás.
c
Procura a partir da posição do cursor.
e
Procura apenas na área selecionada.
r
Faz uma pesquisa por uma determinada expressão regular. Se estiver ativo, você poderá usar o
\N
, onde o N é um número que representa as capturas no texto de substituição.s
Faz uma pesquisa com distinção entre maiúsculas e minúsculas.
p
Pede permissão para substituir a próxima ocorrência.
w
Faz uma correspondência apenas com palavras inteiras.
date {TEXTO formato}
Insere um texto de data/hora, tal como está definido pelo
formato
indicado, ou com o formato “aaaa-MM-dd hh:mm:ss”, se não for indicada qualquer formatação. As traduções a seguir são feitas quando for interpretado oformato
:d
O dia, como um número sem um zero inicial (1-31). dd
O dia, como um número com um zero inicial (01-31). ddd
O nome do dia abreviado, no formato regional (p.ex. 'Seg'..'Dom'). dddd
O nome do dia completo, no formato regional (p.ex. 'Segunda'..'Domingo'). M
O mês, como um número sem um zero inicial (1-12). MM
O mês, como um número com um zero inicial (01-12). MMMM
O nome completo do mês localizado (ex.: 'Janeiro'..'Dezembro'). MMM
O nome do mês abreviado, no formato regional (p.ex. 'Jan'..'Dez'). aa
O ano, como um número de dois algarismos (00-99). aaaa
O ano, como um número de quatro algarismos (1752-8000). h
As horas sem um zero inicial (0..23 ou 1..12 no caso do formato AM/PM). hh
As horas com um zero inicial (00..23 ou 01..12 no caso do formato AM/PM). m
Os minutos sem um zero inicial (0..59). mm
Os minutos com um zero inicial (00..59). s
Os segundos sem um zero inicial (0..59). ss
Os minutos com um zero inicial (00..59). z
Os milissegundos sem um zero inicial (0..999). zzz
Os milissegundos com zeros iniciais (000..999). AP
Usar o formato de horas AM/PM. O AP será substituído por "AM" ou por "PM". ap
Usar o formato de horas am/pm. O ap será substituído por "am" ou por "pm". char {TEXTO identificador}
Este comando permite que você insira caracteres literais através de suas identificações numéricas, em decimal, octal ou hexadecimal. Para usá-lo, abra o diálogo de Edição de Comando e digite
char: [número]
na caixa de entrada e clique em .- s///[ig] %s///[ig]
Este comando faz um sed como operação de procura/substituição na linha atual, ou em um arquivo inteiro (%s///).
Em resumo, é procurado o texto que combine com o padrão de busca , a expressão regular entre a primeira e a segunda barra, e quando é encontrado, a parte que combina com o texto é substituída pela expressão entre a segunda e a última barra. Os parênteses no padrão de busca criam referências anteriores, isto é, o comando lembra qual parte encontrada do texto combinou no parênteses; estas strings podem ser reutilizadas no padrão de substituição, referidas como
\1
para o primeiro conjunto de parênteses,\2
para o segundo e assim por diante.Para procurar por um caractere literal
(
ou)
, você precisa usar o caractere de escape, que é o caractere de barra invertida:\(\)
Se você puser um
i
no fim da expressão, a correspondência não fará distinção entre maiúsculas ou minúsculas. Se, por outro lado, puser umg
no fim, todas as ocorrências do padrão serão substituídas, caso contrário, só será substituída a primeira ocorrência.Exemplo 5.2. Substituindo texto na linha atual
Seu compilador parou, dizendo a você que a classe
minhaClasse
, mencionada na linha 3902 do seu arquivo fonte, não está definida."Droga!" você pensa, é claro que é
MinhaClasse
. Você vai para a linha 3902, e em vez de tentar encontrar a palavra no texto, você lança o Diálogo de Edição de Comando, digitas/minhaclasse/MinhaClasse/i
, clica no botão , salva o arquivo e compila – com sucesso, sem erros.Exemplo 5.3. Substituindo texto no arquivo inteiro
Imagine que você tem um arquivo, no qual está mencionada a string “Senhorita Jensen” várias vezes, quando aparece alguém e lhe diz que ela casou com o “Senhor Jones”. Você quer, é claro, substituir todas as ocorrências de “Senhorita Jensen” por “Senhora Jones”.
Entre na linha de comando e digite o comando
%s/Senhorita Jensen/Senhora Jones/
, pressionando RETURN para terminar.Exemplo 5.4. Um Exemplo Mais Avançado
Este exemplo tira partido das referências anteriores assim como das classes de palavras (se você não souber o que isso é, baseie-se na documentação referida abaixo).
Suponha que você possui a seguinte linha:
void MinhaClasse::DoStringOps( String &foo, String &bar, String *p, int &a, int &b )
Agora, você pode perceber que este não é um código bom, e decidir que deseja usar a palavra-chave
const
para todos os argumentos “address of”, aqueles caracterizados pelo operador & em frente ao nome do argumento. Você poderia também simplificar o espaço em branco, pois assim existiria somente um caractere de espaço em branco entre cada palavra.Abra o Diálogo de Edição de Comando, e digite
s/\s+(\w+)\s+(&)/ const \1 \2/g
e clique no botão . O caractereg
no final da expressão faz com que a expressão regular recompile cada combinação, para recuperar as referências de volta.Saída
void MinhaClasse::DoStringOps( const String &foo, const String &bar, String *p, const int &a, const int &b )
Missão completa! Agora, o que aconteceu? Bem, procuramos por espaços em branco (
\s+
) seguidos por um ou mais caracteres alfabéticos(\w+
) seguidos por mais espaços em branco (\s+
) seguidos por um E comercial, e no processo é salvo o pedaço alfabético e o E comercial para reutilização na operação de substituição. Quando substituímos a parte relacionada da nossa linha, com um espaço em branco, seguido por “const”, seguido por um espaço em branco, seguido por nosso pedaço alfabético (\1
) seguido por um espaço em branco, em por fim, seguido por nosso E comercial salvo (\2
)Em alguns casos, a parte alfabética foi “String”, em alguns “int”, assim, usar a classe de caractere
\w
e o quantificador+
provê uma vantagem considerável.sort
Ordena o texto selecionado ou todo o documento.
natsort
Ordena as linhas selecionadas ou todo o documento naturalmente.
Exemplo 5.5. sort x natsort
sort(a10, a1, a2)
resulta ema1, a10, a2
natsort(a10, a1, a2)
resulta ema1, a2, a10
moveLinesDown
Move as linhas selecionadas para baixo.
moveLinesUp
Move as linhas selecionadas para cima.
uniq
Remove linhas duplicadas do texto selecionado ou do documento inteiro.
rtrim
Remove o espaço à direita do texto selecionado ou do documento inteiro.
ltrim
Remove o espaço à esquerda do texto selecionado ou do documento inteiro.
join [TEXTO separador]
Mescla as linhas selecionadas ou o documento inteiro. Opcionalmente, recebe um parâmetro definindo um separador, por exemplo:
join ', '
rmblank
Remove todos os espaços em branco do texto selecionado ou do documento inteiro.
unwrap
Remove as quebras de linha do texto selecionado ou do documento inteiro.
each {TEXTO script}
Fornecida uma função do JavaScript como argumento, chama pela lista de linhas selecionadas e substitui-as com o valor de retorno desta chamada.
Exemplo 5.6. Mescla as linhas selecionadas
each 'function(lines){return lines.join(", ")}'
Ou, de maneira resumida:
each 'lines.join(", ")'
filter {TEXTO script}
Fornecida uma função do JavaScript como argumento, chama pela lista de linhas selecionadas e remove-as onde a chamada retorna falso.
Exemplo 5.7. Remover linhas em branco
filter 'function(1){return 1.length > 0;}'
Ou, de maneira resumida:
filter 'line.length > 0'
map {TEXTO script}
Fornecida uma função do JavaScript como argumento, chama pela lista de linhas selecionadas e substitui a linha com o valor de retorno da chamada.
Exemplo 5.8. Remover linhas em branco
map 'function(line){return line.replace(/^s+/,"");}'
Ou, de maneira resumida:
map 'line.replace(/^s+/,"")'
duplicateLinesUp
Duplica as linhas selecionadas acima da seleção atual.
duplicateLinesDown
Duplica as linhas selecionadas abaixo da seleção atual.
goto {INT linha}
Este comando vai para a linha indicada.
grep {TEXTO padrão}
Pesquisa o documento pela expressão regular
padrão
. Para mais informações, veja as Apêndice A, Expressões Regularesfind {TEXTO padrão}
Este comando vai para a primeira ocorrência do
padrão
, de acordo com a configuração. As ocorrências a seguir poderão ser encontradas com a opção → (o atalho por padrão é o F3).O comando de procura poderá ser configurado adicionando dois-pontos, seguidos de uma ou mais opções, sendo o formato
find:opções padrão
. São suportadas as seguintes opções:b
Pesquisar para trás.
c
Procura a partir da posição do cursor.
e
Procura apenas na área selecionada.
r
Faz uma pesquisa por uma determinada expressão regular. Se estiver ativo, você poderá usar o
\N
, onde o N é um número que representa as capturas no texto de substituição.s
Faz uma pesquisa com distinção entre maiúsculas e minúsculas.
w
Faz uma correspondência apenas com palavras inteiras.
ifind {TEXTO padrão}
Este comando oferece uma procura “à-medida-que-digita”. Você poderá configurar o comportamento da procura adicionando dois-pontos (:), seguidos de uma ou mais opções, como se segue:
ifind:opções padrão
. As opções permitidas sãob
Pesquisar para trás.
r
Faz uma procura por uma expressão regular.
s
Faz uma pesquisa com distinção entre maiúsculas e minúsculas.
c
Procura a partir da posição do cursor.
w
Salvar o documento atual.
wa
Salvar todos os documentos abertos.
q
Fechar o documento atual.
qa
Fechar todos os documentos abertos.
wq
Salvar e fechar o documento atual.
wqa
Salvar e fechar todos os documentos abertos.
x
Salvar e fechar o documento atual somente se ele foi modificado.
x
Salvar e fechar todos os documentos abertos somente se eles foram modificados.
bp
Ir para o documento anterior na lista de documentos.
bn
Ir para o próximo documento na lista de documentos.
new
Abrir um novo documento em uma divisão de visão horizontal.
vnew
Abrir um novo documento em uma divisão de visão vertical.
e
Recarregar o documento atual se ele tiver sido modificado em disco.
enew
Editar um novo documento.
print
Abrir a janela de impressão para imprimir o documento atual.

O desdobramento ou dobragem de código permite-lhe ocultar partes de um documento no editor, tornando mais simples analisar globalmente arquivos grandes. No KatePart, as regiões desdobráveis são calculadas com base nas regras das definições de realce de sintaxe; como tal só está disponível em alguns formatos - tipicamente em código-fonte de programas, código em XML e semelhantes. A maioria das definições de realce que suportam o desdobramento de código também lhe permitem definir manualmente regiões desdobráveis, tipicamente com as palavras-chave BEGIN
e END
.
Para usar a funcionalidade de desdobramento de código, ative os marcadores com a opção → , se não estiverem já visíveis. A área de Marcações de Dobragem, no lado esquerdo da tela, mostra uma visão gráfica sobre as regiões que poderão ser recolhidas ou expandidas, com símbolos triangulares para indicar a operação possível numa determinada região: um triângulo para baixo significa que a região é expandida; clicar sobre ele irá recolher a região, clicar em um triângulo para direita irá expandi-la.
Estão disponíveis três comandos para manipular o estado das regiões dobradas; para tal, veja a documentação do menu.
As linhas recolhidas serão lembradas quando um arquivo é fechado, assim quando você reabri-lo, os nós que estiverem recolhidos permanecerão dobrados. Isto se aplica a operações de recarregamento também.
Se você não quiser usar a funcionalidade de desdobramento do código, poderá desativar a opção Mostrar as marcações de dobragem (se disponíveis) na página Aparência do editor de configuração.

Como em qualquer componente de editor de texto avançado, o KatePart oferece uma grande variedade de formas para ampliar suas funcionalidades. Você pode criar scripts simples para adicionar funcionalidades com o JavaScript Finalmente, assim que tiver ampliado as funcionalidades do KatePart, sinta-se a vontade para se juntar a nós e compartilhar as suas melhorias com o mundo!

O Realce de Sintaxe é o que faz com que o editor exiba automaticamente o texto em diferentes cores/estilos, dependendo da função da string em questão para o propósito do arquivo. No código-fonte do programa, por exemplo, declarações de controle pode ser renderizadas em negrito, enquanto tipos de dados e comentários ficam com cores diferentes do restante do texto. Isto aumenta consideravelmente a legibilidade do texto e assim, o autor pode ser mais eficiente e produtivo.

Uma função Perl, representada com realce de sintaxe.

A mesma função Perl, sem realce de sintaxe.
Dos dois exemplos, qual é o mais fácil de ler?
O KatePart vem com um sistema flexível, configurável e capaz de fazer realce de sintaxe; a distribuição padrão oferece definições para um vasto conjunto de linguagens de programação, de manipulação e de 'scripting', bem como para outros formatos de texto. Além disso, você pode criar as suas próprias definições em arquivos XML simples.
O KatePart detectará automaticamente regras de realce de sintaxe quando você abrir um arquivo, baseado no tipo MIME do arquivo, determinado pela extensão ou, se não existir, pelo conteúdo. Se você não conseguir, ajuste manualmente a sintaxe para o uso no menu → .
Os estilos e cores usados por cada definição de realce de sintaxe podem ser configurados usando a página de Estilos de Realce de Texto da Janela de Configuração; por outro lado, os tipos MIME e as extensões de arquivos para os quais deve ser usada, podem ser configurados usando a página de Modos & Tipos de Arquivo.
Nota
O realce de sintaxe existe para aumentar a legibilidade do texto correto, mas não se pode confiar nisto para validar seu texto. Marcar o texto para sintaxe é difícil, dependendo do formato que você está usando e, em alguns casos, os autores das regras de sintaxe ficarão orgulhosos se 98% do texto é renderizado corretamente, embora muito frequentemente você precise de um estilo raro para ver os 2% incorretos.
Dica
Você pode baixar as definições de sintaxe adicionais ou atualizadas na página Web do KatePart clicando no botão na página Modos & Tipos de Arquivo da Janela de Configuração.
Esta seção irá discutir o realce de sintaxe do KatePart em detalhes. É para você, caso deseje saber mais sobre esta funcionalidade ou se quiser criar ou alterar as definições de sintaxe.
Sempre que você abrir um arquivo, uma das primeiras coisas que o editor KatePart faz é detectar qual definição de sintaxe deve ser usada para o arquivo. Ao ler o texto do arquivo, e enquanto você digita no arquivo, o sistema de realce de sintaxe analisará o texto usando as regras definidas pela definição de sintaxe, e marcará no texto onde contexto e estilos diferentes iniciarem e finalizarem.
Quando você escrever no documento, o novo texto será analisado e marcado na hora, pois se você remover um caractere que está marcado como início ou fim de um contexto, o estilo em volta do texto modifica de acordo com ele.
As definições de sintaxe usadas pelo sistema de realce de sintaxe do KatePart são arquivos XML que contém
Regras para a detecção do texto inteiro, organizado em blocos de contexto
Listas de palavras-chave
Definições de Item de Estilo
Ao analisar o texto, as regras de detecção serão avaliadas na ordem em que foram definidas, e se o início da string atual coincidir com uma regra, o contexto relacionado será usado. O ponto de partida no texto é movido para o ponto final no local onde aquela regra coincide, e um novo loop de regras inicia, começando no contexto configurado pela regra relacionada.
As regras de detecção são o "coração" do sistema de detecção de sintaxe. Uma regra é uma string, um caractere ou uma expressão regular com a qual se faz a correspondência do texto a analisar. Contém informações sobre o estilo a ser usado na parte correspondente do texto. Pode mudar do contexto atual do sistema para outro contexto explícito ou para o contexto anterior usado pelo texto.
As regras são organizadas em grupos de contexto, sendo que este é usado pelos conceitos principais do texto dentro de um formato, como por exemplo strings dentro de aspas ou blocos de comentário do código-fonte de um programa. Isto garante que o sistema de realce não precisa ficar procurando todas as regras quando não for necessário, e também que sequências de algum caractere no texto podem ser tratadas de modo diferente, dependendo do contexto atual.
As regras são organizadas em grupos de contexto, sendo que este é usado pelos conceitos principais do texto dentro de um formato, como por exemplo strings dentro de aspas ou blocos de comentário do código-fonte de um programa. Isto garante que o sistema de realce não precisa ficar procurando todas as regras quando não for necessário, e também que sequências de algum caractere no texto podem ser tratadas de modo diferente, dependendo do contexto atual.
Em algumas linguagens de programação, os números inteiros são tratados diferentemente dos números de ponto flutuante pelo compilador (o programa que converte o código-fonte para um binário executável), e podem existir caracteres que possuem significado especial dentro de uma string. Em tais casos, faz sentido renderizá-los de modo diferente dos outros, assim, são mais fáceis de identificar durante a leitura do texto. Mesmo que eles não sejam representados em contextos especiais, pode ser vistos no sistema de realce de sintaxe, e assim, podem ser marcados com uma renderização diferente.
Uma definição de sintaxe pode conter tantos estilos quanto forem necessários para cobrir os conceitos do formato no qual serão usados.
Em muitos formatos, existem listas de palavras, que representam um conceito específico; por exemplo, em linguagens de programação, as declaração de controle são um conceito, nomes de tipos de dados outro conceito, e funções pré-integradas na linguagem um terceiro conceito. O Sistema de Realce de Sintaxe do KatePart pode usar estas listas para detectar e marcar palavras no texto para enfatizar os conceitos dos formatos.
Se você abrir um arquivo de código em C++, um arquivo de Java™ e um documento em HTML no KatePart, irá ver que, ainda que os formatos sejam diferentes e, por isso, sejam selecionadas palavras diferentes para um tratamento especial, as cores usadas são as mesmas. Isto deve-se ao fato do KatePart ter uma lista pré-definida de Estilos Padrão, os quais são usados pelas definições de sintaxe individuais.
Isto faz com que fique mais fácil reconhecer conceitos similares em diferentes formatos. Por exemplo, os comentários estão presentes na maioria das linguagens de programação, script e marcação, e quando são renderizados utilizando-se o mesmo estilo em todas as linguagens, você não precisa parar e pensar para identificá-los dentro do texto.
Dica
Todos os estilos de uma definição de sintaxe usam um dos estilos padrão. Algumas definições de sintaxe usam mais estilos além dos pré-definidos, por isso se você usar um formato frequentemente, pode ser útil abrir a janela de configuração para ver se alguns conceitos usam o mesmo estilo. Por exemplo, só existe um estilo padrão para as cadeias de caracteres, mas como a linguagem de programação Perl lida com dois tipos de cadeias de caracteres, você pode melhorar o realce se configurar esses dois tipos de uma forma ligeiramente diferente. Todos os estilos padrão disponíveis serão explicados mais tarde.
Esta seção é uma introdução ao formato XML de Definição de Realce. Baseado em um pequeno exemplo, ele irá descrever as componentes principais, bem como o seu significado e utilização. A próxima seção colocará em detalhes as regras de detecção.
A definição formal, também conhecida como XSD, é armazenada no arquivo language.xsd
, o qual deve estar instalado na pasta $
do seu sistema. Nesse sentido, a variável de ambiente XDG_DATA_DIRS
/katepart5/syntaxXDG_DATA_DIRS
normalmente se expande para /usr/share
.
Seções principais dos arquivos de Definições de Realce do KatePart
- Um arquivo de realce contém um cabeçalho que define a versão do XML:
<?xml version="1.0" encoding="UTF-8"?>
- A raiz do arquivo de definição é o elemento
language
. Os atributos disponíveis são: Atributos necessários:
O
name
define o nome da linguagem. Ele aparece nos respectivos menus e janelas.O
section
indica a categoria.O
extensions
define as extensões dos arquivos, como por exemplo, "*.cpp;*.h"Atributos opcionais:
O
mimetype
associa os arquivos do tipo MIME.O
version
indica a versão atual do arquivo de definição.O
kateversion
indica a última versão suportada pelo KatePart.O
casesensitive
define se as palavras-chave fazem distinção entre maiúsculas e minúsculas.O
priority
é necessário se outro arquivo de definições de realce usar as mesmas extensões. Ganhará o que tiver maior prioridade.O
author
contém o nome do autor e o seu endereço de e-mail.O
license
contém a licença, que é normalmente a LGPL, a Artistic, a GPL ou outras.O
style
contém a linguagem fornecida e é usado pelos sistemas de recuo para o atributorequired-syntax-style
.O
hidden
define se o nome deverá aparecer nos menus do KatePart.Assim, a próxima linha se parece com o seguinte:
<language name="C++" version="1.00" kateversion="2.4" section="Sources" extensions="*.cpp;*.h" />
- A seguir vem o elemento
highlighting
, que contém o elemento opcionallist
e os elementos obrigatórioscontexts
eitemDatas
. O elemento
list
contém uma lista de palavras-chave. Neste caso, as palavras-chave são a class e a const.Você poderá adicionar tantas listas quanto desejar.O elemento
contexts
contém todos os contextos. O primeiro contexto é, por padrão, o início do realce. Existem duas regras no contexto Normal Text (Texto Normal), que correspondem à lista de palavras-chave com o nome um_nome e uma regra que detecta aspas e muda o contexto para string (cadeia de caracteres). Para aprender mais sobre as regras, leia o próximo capítulo.A terceira parte é o elemento
itemDatas
. Contém todas as cores e estilos de fonte necessários pelos contextos e regras. Neste exemplo, são usados oitemData
de Normal Text (Texto Normal), String (Cadeia de Caracteres) e Keyword (Palavra-Chave).<highlighting> <list name="um_nome"> <item> class </item> <item> const </item> </list> <contexts> <context attribute="Normal Text" lineEndContext="#pop" name="Normal Text" > <keyword attribute="Keyword" context="#stay" String="somename" /> <DetectChar attribute="String" context="string" char=""" /> </context> <context attribute="String" lineEndContext="#stay" name="string" > <DetectChar attribute="String" context="#pop" char=""" /> </context> </contexts> <itemDatas> <itemData name="Normal Text" defStyleNum="dsNormal" /> <itemData name="Keyword" defStyleNum="dsKeyword" /> <itemData name="String" defStyleNum="dsString" /> </itemDatas> </highlighting>
- A última parte de uma definição de realce é a seção opcional
general
. Ela poderá conter informações sobre as palavras-chave, expansão/recolhimento de código, comentários e recuo. A seção
comment
define com que texto é introduzido um comentário para uma única linha. Você poderá também definir comentários multilinha, usando o multiLine com o atributo adicional end. Isto é usado se o usuário pressionar o atalho correspondente para comentar/descomentar.A seção
keywords
define se as listas de palavras-chave fazem distinção entre maiúsculas e minúsculas ou não. Os outros atributos serão explicados mais tarde.<general> <comments> <comment name="singleLine" start="#"/> </comments> <keywords casesensitive="1"/> </general> </language>
Esta parte irá descrever todos os atributos disponíveis para o 'contexts', o 'itemDatas', o 'keywords', o 'comments', a expansão de código e o recuo.
- O elemento
context
pertence ao grupocontexts
. Um contexto, por si só, define as regras específicas do contexto, como o que deve acontecer se o sistema de realce chegar ao fim de uma linha. Os atributos disponíveis são: name
declara o nome do contexto. As regras irão usar esse nome para indicar o contexto para onde mudar, se a regra corresponder.O
lineEndContext
define o contexto para onde o sistema de realce salta, se atingir o fim de uma linha. Poderá ser o nome de outro contexto, o#stay
para não mudar de contexto (por exemplo, não fazer nada) ou o#pop
que fará com que saia deste contexto. É possível usar, por exemplo,#pop#pop#pop
para sair de dentro de três contextos, ou ainda#pop#pop!OutroContexto
para sair duas vezes e mudar para o contextoOutroContexto
.O
lineEmptyContext
define o contexto, se for encontrada uma linha em branco. Padrão: #stay.O
fallthrough
define se o sistema de realce salta para o contexto indicado em 'fallthroughContext' se não corresponder nenhuma regra. Padrão: false.O
fallthroughContext
define o próximo contexto, se nenhuma regra corresponder.O
dynamic
, se for true (verdadeiro), fará com que o contexto recorde os textos/sequências de substituição gravados pelas regras dinâmicas. Isto é necessário, por exemplo, para os documentos do HERE. Padrão: false.- O elemento
itemData
está no grupoitemDatas
. Define o estilo e as cores da fonte. Assim, é possível definir os seus próprios estilos e cores. Contudo, recomenda-se que usar os estilos predefinidos, para que o usuário veja sempre as mesmas cores usadas em várias linguagens. Todavia, existem casos em que não existe outra forma e, assim, é necessário mudar os atributos de cores e tipos de fonte. Os atributos 'name' e 'defStyleNum' são obrigatórios, enquanto os outros são opcionais. Os atributos disponíveis são: O
name
define o nome do 'itemData'. Os contextos e regras irão usar este nome no seu atributo attribute, para referenciar um 'itemData'.O
defStyleNum
define qual o estilo padrão usar. Os estilos pré-definidos disponíveis são explicados mais tarde em detalhes.O
color
define uma cor. Os formatos válidos são o '#rrggbb' ou '#rgb'.O
selColor
define a cor da seleção.O
italic
, se for true (verdadeiro), irá colocar o texto em itálico.O
bold
, se for true (verdadeiro), irá colocar o texto em negrito.O
underline
, se for true (verdadeiro), irá colocar o texto sublinhado.O
strikeout
, se for true (verdadeiro), o texto ficará traçado.O
spellChecking
, se for true (verdadeiro), será verificada a ortografia do texto.- O elemento
keywords
, no grupogeneral
, define as propriedades das palavras-chave. Os atributos disponíveis são: O
casesensitive
poderá ser true (verdadeiro) ou false (falso). Se for true, todas as palavras-chave farão distinção entre maiúsculas e minúsculas.O
weakDeliminator
é uma lista de caracteres que não irão atuar como separadores de palavras. Por exemplo, o ponto'.'
é um separador de palavras. Assuma que uma palavra-chave numlist
contém um ponto; nesse caso, só irá corresponder se indicar que o ponto é um delimitador fraco.O
additionalDeliminator
define os delimitadores ou separadores adicionais.O
wordWrapDeliminator
define os caracteres após os quais poderá ocorrer uma mudança de linha.Os delimitadores pré-definidos e de mudança de linha são os caracteres
.():!+,-<=>%&*/;?[]^{|}~\
, o espaço (' '
) e a tabulação ('\t'
).- O elemento
comment
, no grupocomments
, define as propriedades dos comentários que são usadas nas opções → e → . Os atributos disponíveis são: O
name
tanto poderá ser singleLine como multiLine. Se escolher o multiLine, serão necessários os atributos end e region.O
start
define o texto usado para iniciar um comentário. No C++, este será o "/*".O
end
define o texto usado para fechar um comentário. No C++, será o "*/".O
region
deverá ser o nome do comentário multi-linhas que poderá expandir ou recolher. Assuma que tem o beginRegion="Comment" ... endRegion="Comment" nas suas regras; nesse caso, deverá usar o region="Comment". Desta forma, a remoção de comentários funciona, mesmo que não tenha selecionado todo o texto do comentário multi-linhas. O cursor só precisa estar dentro deste comentário.- O elemento
folding
, no grupogeneral
, define as propriedades de dobragem/desdobramento do código. Os atributos disponíveis são: O
indentationsensitive
, se for true, aplicará os marcadores de dobragem de código com base no recuo, como acontece na linguagem de programação Python. Normalmente você não terá que definir isto, uma vez que o valor padrão é false.- O elemento
indentation
, no grupogeneral
, define qual o sistema de recuo será usado. Contudo, recomenda-se omitir esse elemento, uma vez que o sistema de recuo será normalmente definido a partir de um Tipo de Arquivo ou através da adição da linha de modo no arquivo de texto. Se você indicar um sistema de recuo, todavia, irá obrigar o usuário a usar um sistema de recuo específico, o que poderá não ser o que ele quer. Os atributos disponíveis são: O
mode
é o nome do sistema de recuo. Os sistemas disponíveis atualmente são: normal, cstyle, haskell, lilypond, lisp, python, ruby e xml.
Os estilos padrão já foram explicados, em resumo: Os estilos padrão são os estilos de cores e fontes pré-definidos.
- Estilos padrão gerais:
dsNormal
, quando não é necessário nenhum realce em especial.dsKeyword
, para as palavras-chave do idioma incorporadas.dsFunction
, nas chamadas e definições de funções.dsVariable
, se aplicável: nomes das variáveis (por exemplo, $algumaVariavel em PHP/Perl).dsControlFlow
, palavras-chave de controle de fluxo, como o 'if', 'else', 'switch', 'break', 'return', 'yield', ...dsOperator
, operadores como o + - * / :: < >dsBuiltIn
, nas funções, classes e objetos incorporados.dsExtension
, extensões comuns, como as classes e funções/macros do Qt em C++ e Python.dsPreprocessor
, para as instruções do pré-processador ou para as definições de macros.dsAttribute
, anotações como o @override e o __declspec(...).- Estilos padrão relacionados com as strings:
dsChar
, para caracteres únicos, como o 'x'.dsSpecialChar
, caracteres com significados especiais nas strings, como as sequências de escape, substituições ou operadores de expressões regulares.dsString
, para strings do tipo "olá mundo".dsVerbatimString
, strings literais como o 'raw \backlash' do Perl, CoffeeScript e das linhas de comando, assim como o r'\raw' do Python.dsSpecialString
, SQL, expressões regulares, documentação, modo matemático do LaTeX, ...dsImport
, importação, inclusão ou requisição de módulos.- Estilos padrão relacionados com números:
dsDataType
, para os tipos de dados incorporados, como o 'int', 'void', 'u64'.dsDecVal
, nos valores decimais.dsBaseN
, nos valores com uma base diferente de 10.dsFloat
, nos valores de ponto flutuante.dsConstant
, nas constantes incorporadas e definidas pelo usuário, como o PI.- Estilos padrão de comentários e relacionados com a documentação:
dsComment
, para comentários.dsDocumentation
, para /** Comentários de documentação */ ou """strings de documentação""".dsAnnotation
, para os comandos de documentação como o @param, @brief.dsCommentVar
, os nomes das variáveis usadas nos comandos acima, como o "foobar" no @param foobar.dsRegionMarker
, para marcadores de região, como o //BEGIN, //END nos comentários.- Outros estilos padrão:
dsInformation
, notas e dicas do tipo @note no doxygen.dsWarning
, para os avisos do tipo @warning no doxygen.dsAlert
, para palavras especiais como o TODO, FIXME, XXXX.dsError
, para realçar erros e sintaxes inválidas.dsOthers
, quando nada mais se aplica.
Esta seção descreve as regras de detecção de sintaxe.
Cada regra pode corresponder a zero ou mais caracteres no início do texto que é testado. Se a regra corresponder, é atribuído o estilo ou atributo definido pela regra aos caracteres correspondentes; uma regra poderá perguntar se o contexto atual será alterado.
As regras se parecem com isto:
<NomeRegra attribute="(identificador)" context="(identifier)" [atributos específicos da regra] />
O attribute identifica o estilo a usar para os caracteres correspondentes pelo nome ou índice; o context identifica, como esperado, o contexto a usar a partir daqui.
O context pode ser identificado por:
Um identificador, que é o nome do outro contexto.
Uma ordem diz ao mecanismo para ficar no contexto atual (
#stay
), ou voltar a usar um contexto usado anteriormente na string (#pop
).Para voltar mais passos, a palavra-chave #pop pode ser repetida:
#pop#pop#pop
Uma ordem seguida de um ponto de exclamação (!) e um identificador, que fará com que o mecanismo siga primeiro a ordem e depois mude para o outro contexto, por exemplo,
#pop#pop!OtherContext
.
Algumas regras podem ter regras-filhas, as quais podem ser avaliadas se e só se a regra-mãe foi verificada. O texto inteiro verificado terá o atributo definido pela regra-mãe. Uma regra com regras-filhas se pareceria com a seguinte:
<NomedaRegra (atributos)> <NomedaRegraFilha (atributos) /> ... </NomedaRegra>
Os atributos específicos da regra variam e estão descritos nas seções a seguir.
Atributos comuns
Todas as regras possuem os seguintes atributos em comum e estão disponíveis sempre que os (atributos comuns)
aparecerem. O attribute e o context são atributos obrigatórios, enquanto os outros são opcionais.
attribute: Um atributo mapeia-se para um itemData definido.
context: Indica o contexto para onde muda o sistema de realce, se a regra corresponder.
beginRegion: Inicia um bloco de dobragem de código. Padrão: não definido.
endRegion: Fecha uma região de dobragem de código. Padrão: não definido.
lookAhead: Se for true (verdadeiro), o sistema de realce não irá processar o tamanho da correspondência. Padrão: false.
firstNonSpace: Corresponder apenas se o texto for o primeiro não-espaço em branco da linha. Padrão: false.
column: Corresponder apenas se a coluna corresponder. Padrão: não definido.
Regras dinâmicas
Algumas regras permitem o atributo opcional dynamic
, do tipo booleano, cujo valor padrão é false. Se o 'dynamic' for true, uma regra poderá usar sequências de substituição que representam o texto correspondente a uma expressão regular que mudou para o contexto atual, nos seus atributos string
ou char
. Num string
, o texto de substituição %N
(em que o N é um número) será substituído pela captura correspondente a N
na expressão regular de chamada. Num char
, a sequência de substituição deverá ser um número N
que será substituído pelo primeiro caractere da captura N
da expressão regular de chamada. Sempre que uma regra permitir este atributo, irá conter um (dinâmico).
dynamic: poderá ser (true|false).
- DetectChar
Detecta um caractere específico. Comumente usado, por exemplo, para encontrar o final das strings citadas.
<DetectChar char="(caractere)" (atributos comuns) (dinâmico) />
O atributo
char
define o caractere a ser procurado.- Detect2Chars
Detecta dois caracteres específicos, em uma ordem definida.
<Detect2Chars char="(caractere)" char1="(caractere)" (atributos comuns) (dinâmico) />
O atributo
char
define o primeiro caractere a ser procurado, e o atributochar1
o segundo.- AnyChar
Detecta um caractere de um conjunto de caracteres especificados.
<AnyChar String="(string)" (atributos comuns) />
O atributo
String
define o conjunto de caracteres.- StringDetect
Detecta uma string exata.
<StringDetect String="(string)" [insensitive="true|false;"] (atributos comuns) (dinâmico) />
O atributo
String
define a sequência a encontrar. O atributoinsensitive
é por padrão false e é passado à função de comparação de cadeias de caracteres. Se o valor for true a comparação não faz distinção entre maiúsculas e minúsculas.- WordDetect
Detecta um texto exato, mas obriga adicionalmente a que esteja rodeado por limites de palavras, como um ponto
'.'
ou um espaço em branco no início e no fim da palavra. Pense em\b<texto>\b
em termos de uma expressão regular, só que é mais rápido que a regraExp Reg
.<WordDetect String="(string)" [insensitive="true|false;"] (atributos comuns) (dinâmico) />
O atributo
String
define a sequência a encontrar. O atributoinsensitive
é por padrão false e é passado à função de comparação de cadeias de caracteres. Se o valor for true a comparação não faz distinção entre maiúsculas e minúsculas.Desde: Kate 3.5 (KDE 4.5)
- RegExpr
Procura por uma expressão regular.
<RegExpr String="(texto)" [insensitive="true|false"] [minimal="true|false"] (atributos comuns) (dinâmico) />
O atributo
String
define a expressão regular.O
insensitive
é, por padrão, false e é passado ao motor de expressões regulares.O
minimal
é, por padrão, false e é passado ao motor de expressões regulares.Pelo motivo que as regras estão sempre iniciando a busca no início da string atual, uma expressão regular iniciada com um acento circunflexo (
^
) indica que a regra deve ser coincidente somente no início da linha.Veja em Expressões Regulares mais informações sobre o assunto.
- keyword
Detecta uma palavra-chave de uma lista especificada.
<keyword String="(nome da lista)" (atributos comuns) />
O atributo
String
identifica a lista de palavras-chave pelo nome. Uma lista com aquele nome, portanto, deve existir.O sistema de realce processa as regras da palavra-chave de forma muito otimizada. Isto a torna uma necessidade absoluta em que quaisquer palavras-chave a corresponder sejam envolvidas por separadores definidos, sejam eles implícitos (os separadores padrão) ou explícitos, com a propriedade additionalDeliminator da marca keywords.
Se uma palavra-chave a corresponder conter um caractere separador, este caractere respectivo deverá ser adicionado à propriedade weakDeliminator da marca keywords. Este caractere irá então perder a sua propriedade de separador em todas as regras keyword.
- Int
Detecta um número inteiro.
<Int (atributos comuns) (dinâmico) />
Esta regra não tem atributos específicos. As regras-filho são tipicamente usadas para detectar as combinações de
L
eU
depois do número, o que indica o tipo inteiro no código do programa. De fato, todas as regras são permitidas como regras-filhas, contudo, o DTD só permite a regra-filhaStringDetect
.O exemplo a seguir faz correspondência com os números inteiros, seguidos do caractere 'L'.
<Int attribute="Decimal" context="#stay" > <StringDetect attribute="Decimal" context="#stay" String="L" insensitive="true"/> </Int>
- Float
Detecta um número de ponto flutuante.
<Float (atributos comuns) />
Esta regra não tem atributos específicos. O
AnyChar
é permitido como regra-filha e é tipicamente usada para detectar combinações; veja a regraInt
para mais referências.- HlCOct
Detecta uma representação de um número octal.
<HlCOct (atributos comuns) />
Esta regra não possui atributos específicos.
- HlCHex
Detecta uma representação de um número hexadecimal.
<HlCHex (atributos comuns) />
Esta regra não possui atributos específicos.
- HlCStringChar
Detecta um caractere de escape.
<HlCStringChar (atributos comuns) />
Esta regra não possui atributos específicos.
Corresponde a representações literais dos caracteres usados normalmente no código do programa como, por exemplo, o
\n
(nova linha) ou o\t
(TAB).Os seguintes caracteres irão corresponder se estiverem após uma barra invertida (
\
):abefnrtv"'?\
. Além disso, os números escapados em hexadecimal como, por exemplo, o\xff
e os números octais escapados, como o\033
, irão corresponder.- HlCChar
Detecta um caractere do C.
<HlCChar (atributos comuns) />
Esta regra não possui atributos específicos.
Corresponde aos caracteres em C colocados dentro de um tique (Exemplo:
'c'
). Os tiques podem ser um único caractere ou um caractere de escape. Veja o 'HlCStringChar' para ver as sequências de caracteres de escape correspondentes.- RangeDetect
Detecta uma string com os caracteres de início e fim definidos.
<RangeDetect char="(caractere)" char1="(caractere)" (atributos comuns) />
O
char
define o caractere de início e ochar1
o caractere que termina o intervalo.Útil para detectar, por exemplo, pequenas cadeias de caracteres entre aspas e semelhantes, mas repare que, uma vez que o motor de realce de sintaxe funciona com uma linha de cada vez, isto não irá encontrar as cadeias de caracteres que se prolonguem por mais de uma linha.
- LineContinue
Corresponde um caractere específico indicado no fim de uma linha.
<LineContinue (atributos comuns) [char="\"] />
O atributo
char
define o caractere opcional a ser encontrado, sendo a barra invertida ('\'
). o padrão. Novidade da versão 4.13 do KDE.Esta regra é útil para mudar de contexto no fim da linha. Isso é necessário no C/C++, por exemplo, para continuar as macros ou cadeias de caracteres.
- IncludeRules
Inclui as regras de outro contexto ou linguagem/arquivo.
<IncludeRules context="ligacao_contexto" [includeAttrib="true|false"] />
O atributo
context
define o contexto a incluir.Se for texto simples, inclui todas as regras definidas no contexto atual, como por exemplo:
<IncludeRules context="outroContexto" />
Se o texto conter um
##
, o sistema de realce irá procurar por um contexto de outra definição de linguagem com o nome indicado, por exemplo,<IncludeRules context="String##C++" />
iria incluir o contexto String da definição de realce C++.
Se o atributo
includeAttrib
for true, muda o atributo de destino para o da origem. Isto é necessário para fazer, por exemplo, funcionar os comentários, se o texto correspondente ao contexto incluído for de um realce diferente do contexto-anfitrião.- DetectSpaces
Detecta espaços em branco.
<DetectSpaces (atributos comuns) />
Esta regra não possui atributos específicos.
Use esta regra se souber que poderão existir vários espaços em branco à frente como, por exemplo, no início das linhas recuadas. Esta regra irá ignorar todos os espaços em branco, em vez de testar várias regras e ignorar uma de cada vez, devido a uma falta de correspondência.
- DetectIdentifier
Detecta os textos dos identificadores (como acontece na expressão regular: [a-zA-Z_][a-zA-Z0-9_]*).
<DetectIdentifier (atributos comuns) />
Esta regra não possui atributos específicos.
Use esta regra para ignorar uma sequência de caracteres de palavras de uma vez, em vez de testar com várias regras e ignorar uma de cada vez, por falta de correspondência.
Logo que tenha compreendido como funciona a mudança de contexto, será fácil de criar definições de realce. Ainda que você deva verificar com cuidado a regra que escolher, dependendo da situação, as expressões regulares são muito poderosas, só que são lentas em comparação com as outras regras. Assim, você poderá considerar útil as seguintes dicas.
Se você só corresponder com 2 caracteres, use o
Detect2Chars
em vez doStringDetect
. O mesmo aplica-se aoDetectChar
.As expressões regulares são fáceis de usar mas, normalmente, existe outra forma muito mais rápida de obter o mesmo resultado. Assuma que só deseja corresponder com o caractere
'#'
se for o primeiro caractere da linha. Uma solução baseada em expressões regulares seria semelhante à seguinte:<RegExpr attribute="Macro" context="macro" String="^\s*#" />
Você poderá obter o mesmo se usar:
<DetectChar attribute="Macro" context="macro" char="#" firstNonSpace="true" />
Se quiser corresponder à expressão regular
'^#'
, poderá usar ainda oDetectChar
com o atributocolumn="0"
. O atributocolumn
conta como caracteres; assim, uma tabulação conta como se fosse apenas um caractere.Você poderá mudar de contextos sem processar os caracteres. Assuma que deseja mudar de contexto quando encontrar o texto
*/
, mas necessita de processar essa sequência no próximo contexto. A regra abaixo irá corresponder e o atributolookAhead
fará com que o sistema de realce mantenha o texto correspondente no próximo contexto.<Detect2Chars attribute="Comment" context="#pop" char="*" char1="/" lookAhead="true" />
Use o
DetectSpaces
se você souber que irão ocorrer vários espaços em branco.Use o
DetectIdentifier
em vez da expressão regular'[a-zA-Z_]\w*'
.Use os estilos padrão sempre que puder. Desta forma, o usuário irá encontrar um ambiente familiar.
Procure em outros arquivos XML para ver como as outras pessoas implementam as regras mais complicadas.
Você poderá validar todos os arquivos XML se usar o comando xmllint --schema language.xsd MinhaSintaxe.xml.
Se repetir algumas expressões regulares complexas com frequência, você poderá usar as ENTIDADES. Por exemplo:
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE language SYSTEM "language.dtd" [ <!ENTITY referencia "[A-Za-z_:][\w.:_-]*"> ]>
Agora, você poderá usar o &referencia; em vez da expressão regular.

O componente de edição do KatePart é facilmente extensível, através da criação de scripts. A linguagem de programação é o ECMAScript (popularmente conhecido como JavaScript). O KatePart suporta dois tipos de scripts: os de recuo e os de linha de comando.
Scripts de recuo - também conhecidos por recuadores - formatam automaticamente o código-fonte enquanto você digita o texto. Por exemplo, depois de pressionar a tecla Return, o nível de recuo costuma aumentar.
As seções a seguir descrevem, passo-a-passo, como criar o esqueleto de um módulo de recuo simples. Como primeiro passo, crie um novo arquivo *.js
, chamado de, por exemplo, javascript.js
na pasta pessoal local $
. Nesse sentido, a variável de ambiente XDG_DATA_HOME
/katepart5/script/indentationXDG_DATA_HOME
normalmente se expande para qualquer ~/.local
ou ~/.local/share
.
O cabeçalho do arquivo javascript.js
está incorporado como JSON no início do documento no seguinte formato:
var katescript = { "name": "JavaScript", "author": "Nome de Exemplo <nome.exemplo@endereco.org>", "license": "BSD License", "revision": 1, "kate-version": "5.1", "required-syntax-style": "javascript", "indent-languages": ["javascript"], "priority": 0, }; // kate-script-header, deve estar no início do arquivo, sem comentários
Cada item será agora explicado em detalhes:
name
[obrigatório]: Este é o nome do modo de recuo que aparece no menu → e na janela de configuração.author
[opcional]: O nome e a informação de contato do autor.license
[opcional]: Forma curta da licença, como por exemplo, BSD License ou LGPLv3.revision
[obrigatório]: A versão do programa. Este número deverá ser aumentado sempre que o programa for modificado.kate-version
[obrigatório]: A versão mínima do KatePart necessária.required-syntax-style
[opcional]: O estilo do sintaxe necessário, que corresponde aostyle
indicado no sintaxe dos arquivos realçados. Isto é importante para recuadores que se baseiam em informações de realce no documento. Se uma determinada realce de sintaxe dor especificada, o recuador estará disponível somente quando a realce de sintaxe apropriada estiver ativa. Isto evite um “comportamento inesperado” causado pelo uso do recuador sem o esquema de realce esperado. Por exemplo, o recuado do Ruby faz uso dos arquivosruby.js
eruby.xml
.indent-languages
[opcional]: Uma lista JSON de estilos de sintaxe que este módulo consegue recuar corretamente, por exemplo:["c++", "java"]
.priority
[opcional]: Se existirem vários módulos de recuo adequados para um determinado arquivo de realce, este campo decide qual deverá ser usado por padrão.
Tendo definido o cabeçalho, esta seção explica como funciona a programação de recuadores em si. O esqueleto básico do código parece-se com o seguinte:
// Necessário para as bibliotecas js do katepart, p.ex., range.js se você usar Range require ("range.js"); caracteresAtivacao = "{}/:;"; function indent(linha, larguraRecuo, caractere) { // invocado para cada linha nova (caractere == '\n') e todos os caracteres indicados na // variável global 'caracteresAtivacao'. Ao invocar o → // a variável 'caractere' está em branco, isto é, caractere == ''. // // ver também: API de Programação return -2; }
A função indent()
tem três parâmetros:
linha
: a linha que tem de ser recuadalarguraRecuo
: o número de espaços correspondentes a cada recuocaractere
: ou um caractere de mudança de linha (ch == '\n'
), algum dos caracteres de ativação indicados emcaracteresAtivacao
ou vazio, caso o usuário tenha invocado a ação → .
O valor devolvido pela função indent()
define como a linha será recuada. Se o valor devolvido for um número inteiro, é interpretado da seguinte forma:
valor devolvido
-2
: não fazer nadavalor devolvido
-1
: mantém o recuo (procura pela linha não-vazia anterior)valor devolvido
0
: números >= 0 definem a largura do recuo em espaços
Em alternativa, poderá ser devolvida uma lista com dois elementos:
return [ recuo, alinhamento ];
Nesse caso, o primeiro elemento é a profundidade de recuo, tendo o mesmo significado que os valores especiais. Contudo, o segundo elemento é um valor absoluto que representa uma coluna para o “alinhamento”. Se este valor for maior que o valor do recuo, a diferença representa um número de espaços a adicionar após o recuo do primeiro parâmetro. Caso contrário, o segundo número será ignorado. A utilização de tabulações e espaços nos recuos é normalmente referida como sendo um “modo misto”.
Considere o seguinte exemplo: Considerando que são usadas as tabulações para recuar, e que o tamanho da tabulação é de 4. Aqui, o <tab> representa uma tabulação e o '.' representa um espaço:
1: <tab><tab>xpto("olá", 2: <tab><tab>......."mundo");
Ao recuar a linha 2, a função indent()
devolve [8, 15]. Em função disso, são introduzidas duas tabulações para recuar até à coluna 8, e são introduzidos 7 espaços para alinhar o segundo parâmetro com o primeiro, de modo a permanecer alinhado, caso o arquivo seja visto com outro tamanho de tabulação.
Uma instalação padrão do KDE fornece o KatePart com vários módulos de recuo. O código-fonte correspondente em JavaScript poderá ser encontrado em $
. XDG_DATA_DIRS
/katepart5/script/indentation
A criação de um módulo de recuo necessita do recarregamento dos scripts, de modo a ver se as alterações se comportam de forma adequada. Em vez de reiniciar o aplicativo, basta ir para a linha de comando e executar o comando reload-scripts.
Se você criar scripts úteis, considere a hipótese de contribuir com eles para o Projeto KatePart, contactando para isso a lista de correio.
Como é difícil satisfazer as necessidades de todos, o KatePart tem suporte a algumas ferramentas auxiliares para manipular rapidamente o texto, usando para isso a linha de comando incorporada. Por exemplo, o comando sort está implementado como um script. Esta seção explica como criar arquivos *.js
que estendem o KatePart com algumas funções auxiliares arbitrárias.
Os scripts de linha de comando estão localizados na mesma pasta que os scripts de recuo. Assim, como primeiro passo, crie um arquivo *.js
novo, chamado utilitários.js
na pasta pessoal local, em $
. Nesse sentido, a variável de ambiente XDG_DATA_HOME
/katepart5/script/commandsXDG_DATA_HOME
normalmente se expande para ~/.local
ou ~/.local/share
.
O cabeçalho de cada script de linha de comando é está incorporado como JSON no início do script no seguinte formato:
var katescript = { "author": "Nome de exemplo <nome.exemplo@endereco.org>", "license": "LGPLv2+", "revision": 1, "kate-version": "5.1", "functions": ["ordenar", "descerLinhas"], "actions": [ { "function": "ordenar", "name": "Ordena o texto selecionado", "category": "Edição", "interactive": "false" }, { "function": "descerLinhas", "name": "Desce as linhas", "category": "Edição", "shortcut": "Ctrl+Shift+Down", "interactive": "false" } ] }; // kate-script-header, deve estar no início do arquivo, sem comentários
Cada item será agora explicado em detalhes:
author
[opcional]: O nome e a informação de contato do autor.license
[opcional]: Forma curta da licença, como por exemplo, BSD License ou LGPLv2.revision
[obrigatório]: A versão do programa. Este número deverá ser aumentado sempre que o programa for modificado.kate-version
[obrigatório]: A versão mínima do KatePart necessária.functions
[obrigatório]: Uma lista JSON dos comandos do script.actions
[opcional]: Lista em JSON de objetos JSON que definem as ações que aparecem no menu do aplicativo. São oferecidas informações detalhadas na seção Associar combinações de teclas.
Uma vez que o valor de functions
é uma lista em JSON, um único script é capaz de conter um número arbitrário de comandos da linha de comando. Cada função está disponível através da linha de comando incorporada do KatePart.
Todas as funções indicadas no cabeçalho terão de estar implementadas no programa. Por exemplo, o arquivo de programa do exemplo acima tem que implementar as duas funções ordenar e descerLinhas. Todas as funções têm a seguinte sintaxe:
// bibliotecas necessárias do katepart js, p.ex., range.js se você usar Range function <nome>(arg1, arg2, ...) { // ... implementação, ver também: API de Programação }
Os argumentos na linha de comando são passados à função como arg1
, arg2
, etc. Para poder indicar a documentação de cada comando, basta implementar a função 'help
', como demonstrado a seguir:
function help(cmd) { if (cmd == "sort") { return i18n("Ordena o texto selecionado."); } else if (cmd == "...") { // ... } }
Executar help sort na linha de comando, irá invocar esta função de ajuda com o argumento cmd
igual ao comando indicado, como isto é, cmd == "sort"
. O KatePart irá assim apresentar o texto devolvido como documentação ao usuário. Certifique-se de traduzir os textos.
Criar um script para a linha de comando requer o recarregamento dos scripts, de modo a ver se as alterações funcionam apropriadamente. Em vez de reiniciar o aplicativo, basta mudar para a linha de comando e executar o comando reload-scripts.
Para tornar os scripts acessíveis no menu do aplicativo e atribuir teclas de atalho, o script precisa fornecer um cabeçalho do script apropriado. No exemplo acima, ambas as funções ordenar
e descerLinhas
aparecem no menu, graças ao seguinte componente no cabeçalho do script:
var katescript = { ... "actions": [ { "function": "ordenar", "name": "Ordena o texto selecionado", "icon": "", "category": "Edição", "interactive": "false" }, { "function": "descerLinhas", "name": "Desce as linhas", "icon": "", "category": "Edição", "shortcut": "Ctrl+Shift+Down", "interactive": "false" } ] };
Os campos de uma ação são os seguintes:
function
[obrigatório]: A função que deverá aparecer no menu → .name
[obrigatório]: O texto que aparece no menu do script.icon
[opcional]: O ícone aparece após ao texto no menu. Todos os nomes de ícones do KDE poderão ser usados aqui.category
[opcional]: Se for indicada uma categoria, o programa aparece num submenu.shortcut
[opcional]: A combinação de teclas indicada aqui é o atalho de teclado padrão. Por exemplo:Ctrl+Alt+T
. Veja a documentação do Qt para mais detalhes.interactive
[opcional]: Se o script precisa de interação por parte do usuário na linha de comando, configure este valor comotrue
(verdadeiro).
Se você criar scripts úteis, considere a hipótese de contribuir com eles para o Projeto KatePart, contactando para isso a lista de correio.
A API de criação de scripts aqui apresentada está disponível em todos os scripts, isto é, os scripts de recuo e os comandos do terminal. As classes Cursor
e o Range
são fornecidas por arquivos de bibliotecas em $
. Elas serão necessárias, caso queira usar algumas das funções XDG_DATA_DIRS
/katepart5/librariesDocument
ou View
no seu script. Inclua a biblioteca necessária usando:
// bibliotecas necessárias do katepart js, p.ex., range.js se você usar Range require ("range.js");
Para ampliar a API padrão de scripts com suas funções e protótipos próprios, basta criar um arquivo novo na pasta de configuração local do KDE, em $
e incluí-lo no seu script usando: XDG_DATA_HOME
/katepart5/libraries
require ("myscriptnamehere.js");
Para estender os protótipos existentes, como o Cursor
ou o Range
, a forma recomendada é não modificar os arquivos *.js
globais. Em vez disso, altere o protótipo do cursor.js
em JavaScript, após o cursor.js
que é incluído no seu script através do require
.
Como o KatePart é um editor de texto, sempre que possível, toda a API de criação de scripts é baseada em cursores e intervalos. Um cursor é uma simples dupla (linha, coluna)
que representa uma posição de texto no documento. Um Range (Intervalo) corresponde a uma área de texto coberta desde uma posição inicial do cursor até outra posição de fim. A API é explicada em detalhes nas seções a seguir.
Cursor();
Construtor. Devolve um Cursor na posição
(0, 0)
.Exemplo:
var cursor = new Cursor();
Cursor(
int
,linha
int
);coluna
Construtor. Devolve um Cursor na posição (linha, coluna).
Exemplo:
var cursor = new Cursor(3, 42);
Cursor(
Cursor
);outro
Construtor de cópia. Devolve uma cópia do cursor
outro
.Exemplo:
var copia = new Cursor(outro);
Cursor Cursor.clone();
Devolve uma cópia do cursor.
Exemplo:
var clone = cursor.clone();
Cursor.setPosition(
int
,linha
int
);coluna
Configura a posição do cursor em
linha
ecoluna
.Desde: KDE 4.11
bool Cursor.isValid();
Verifica se o cursor é válido. O cursor é inválido no caso em que a linha e/ou coluna sejam iguais a
-1
.Exemplo:
var valido = cursor.isValid();
Cursor Cursor.invalid();
Devolve um novo cursor inválido, localizado em
(-1, -1)
.Exemplo:
var cursorInvalido = cursor.invalid();
int Cursor.compareTo(
Cursor
);outro
Compara este cursor com o cursor
outro
. Devolve-1
, se este cursor for localizado antes do cursoroutro
,0
, se ambos os cursores forem iguais e+1
, se este cursor se localizar após o cursoroutro
.
bool Cursor.equals(
Cursor
);outro
Devolve
true
(verdadeiro), se este o cursor e ooutro
forem iguais, caso contrário devolvefalse
(falso).String Cursor.toString();
Devolve o cursor como um texto no formato “
Cursor(linha, coluna)
”.
Range();
Construtor. A invocação de
new Range()
devolve um intervalo Range de (0, 0) - (0, 0).Range(
Cursor
,inicio
Cursor
);fim
Construtor. A invocação de
new Range(
devolve o intervalo (início
,fim
)início
,fim
).Range(
int
,linhaInicial
int
,colunaInicial
int
,linhaFinal
int
);colunaFinal
Construtor. A invocação de
new Range(
devolve um intervalo Range de (linhaInicial
,colunaInicial
,linhaFinal
,colunaFinal
)linhaInicial
,colunaInicial
) até (linhaFinal
,colunaFinal
).Range(
Range
);outro
Construtor de cópia. Devolve uma cópia do intervalo Range
outro
.Range Range.clone();
Devolve uma cópia do intervalo.
Exemplo:
var clone = intervalo.clone();
bool Range.isEmpty();
Devolve
true
(verdadeiro), se o cursor de início e de fim forem iguais.Exemplo:
var vazio = intervalo.isEmpty();
Desde: KDE 4.11
bool Range.isValid();
Devolve
true
(verdadeiro), se tanto o cursor de início como o de fim forem válidos, caso contrário devolvefalse
(falso).Exemplo:
var valido = intervalo.isValid();
Range Range.invalid();
Devolve o intervalo Range de (-1, -1) até (-1, -1).
bool Range.contains(
Cursor
);cursor
Devolve
true
(verdadeiro) se este intervalo contiver a posição do cursor, caso contrário, devolvefalse
(falso).bool Range.contains(
Range
);outro
Devolve
true
(verdadeiro) se este intervalo contiver o intervalo Rangeoutro
, caso contrário, devolvefalse
(falso).bool Range.containsColumn(
int
);coluna
Devolve
true
(verdadeiro) se acoluna
estiver no intervalo semiaberto[início.coluna, fim.coluna)
, caso contrário, devolvefalse
(falso).bool Range.containsLine(
int
);linha
Devolve
true
(verdadeiro) se alinha
estiver no intervalo semiaberto[início.linha, fim.linha)
, caso contrário, devolvefalse
(falso).bool Range.overlaps(
Range
);outro
Devolve
true
(verdadeiro) se este intervalo e o intervalooutro
compartilharem uma região em comum, caso contrário devolvefalse
(falso).bool Range.overlapsLine(
int
);linha
Devolve
true
(verdadeiro) se alinha
estiver no intervalo[início.linha, fim.linha]
, caso contrário devolvefalse
(falso).bool Range.overlapsColumn(
int
);coluna
Devolve
true
(verdadeiro) se acoluna
estiver no intervalo[início.coluna, fim.coluna]
, caso contrário devolvefalse
(falso).bool Range.onSingleLine();
Devolve
true
(verdadeiro) se o intervalo inicia e termina na mesma linha, isto é, seRange.start.line == Range.end.line
.Desde: KDE 4.9
bool Range.equals(
Range
);outro
Devolve
true
(verdadeiro) se este intervalo e o intervalooutro
forem iguais, caso contrário devolvefalse
(falso).String Range.toString();
Devolve o intervalo como uma string no formato “
Range(Cursor(linha, coluna), Cursor(linha, coluna))
”.
Esta seção apresenta todas as funções globais.
String read(
String
);arquivo
Irá procurar pelo
arquivo
indicado em relação à pastakatepart/script/files
e irá devolver o seu conteúdo como texto.
void require(
String
);Arquivo
Irá procurar pelo
arquivo
indicado em relação à pastakatepart/script/libraries
e avaliá-lo. Orequire
está protegido internamente contra inclusões múltiplas do mesmoarquivos
.Desde: KDE 4.10
void debug(
String
);texto
Imprime o
texto
nostdout
, mais precisamente no console que lança a aplicação.
Para um suporte regional completo, existem diversas funções para traduzir os textos nos programas, nomeadamente o i18n
, o i18nc
, o i18np
e o i18ncp
. Estas funções comportam-se exatamente como as funções de tradução do KDE.
As funções de tradução convertem os textos indicados ao sistema de traduções do KDE para o idioma usado no aplicativo. Os textos nos scripts que são desenvolvidos no âmbito do código oficial do KatePart são automaticamente extraídos e preparados para tradução. Em outras palavras, como desenvolvedor do KatePart, você não precisa que se preocupar com a extração e tradução. Contudo, a tradução só funciona dentro da infraestrutura do KDE, isto é, novos textos em scripts de terceiros, desenvolvidos fora do KDE, não são traduzidos. Dessa forma, considere contribuir com seus scripts para o Kate, para que seja possível obter uma tradução adequada.
void i18n(
String
,texto
arg1
, ...);Traduz o
texto
na língua usada pela aplicação. Os argumentosarg1
, ..., são opcionais e usados para substituir os itens%1
,%2
, etc.void i18nc(
String
,contexto
String
,texto
arg1
, ...);Traduz o
texto
na língua usada pela aplicação. Além disso, o texto docontexto
fica visível aos tradutores para que possam dar uma tradução mais adequada. Os argumentosarg1
, ..., são opcionais e são usados para substituir os itens de substituição%1
,%2
, etc.void i18np(
String
,singular
String
,plural
int
,número
arg1
, ...);Traduz tanto o texto
singular
como oplural
para a língua usada pela aplicação, dependendo donúmero
indicado. Os argumentosarg1
, ..., são opcionais e usados para substituir os itens de substituição%1
,%2
, etc.void i18ncp(
String
,contexto
String
,singular
String
,plural
int
,número
arg1
, ...);Traduz tanto o texto
singular
como oplural
para a língua usada pela aplicação, dependendo donúmero
indicado. Adicionalmente, o texto docontexto
é visível para as tradutores, para que possam fornecer uma tradução mais adequada. Os argumentosarg1
, ..., são opcionais e são usados para substituir os itens%1
,%2
, etc.
Sempre que um programa está sendo executado, existe uma variável global “view
” que representa a área de edição ativa no momento. Segue-se uma lista com todas as funções disponíveis para o View.
Cursor view.cursorPosition()
Devolve a posição atual do cursor na janela.
void view.setCursorPosition(
int
,linha
int
); void view.setCursorPosition(coluna
Cursor
);cursor
Altera a posição atual do cursor para uma (linha, coluna) qualquer ou para o cursor indicado.
Cursor view.virtualCursorPosition();
Devolve a posição virtual do cursor com cada tabulação a corresponder ao número indicado de espaços, dependente da largura de tabulação atual.
void view.setVirtualCursorPosition(
int
,linha
int
); void view.setVirtualCursorPosition(coluna
Cursor
);cursor
Altera a posição atual do cursor virtual para uma (linha, coluna) qualquer ou para o cursor indicado.
String view.selectedText();
Devolve o texto selecionado. Se não tiver nenhum texto selecionado, o texto devolvido vem vazio.
bool view.hasSelection();
Devolve
true
(verdadeiro) se a janela contiver algum texto selecionado, caso contrário, devolvefalse
(falso).Range view.selection();
Devolve o intervalo de texto selecionado. O intervalo devolvido é inválido, caso não esteja selecionado nenhum texto.
void view.setSelection(
Range
);intervalo
Altera o texto selecionado para o intervalo indicado.
void view.removeSelectedText();
Remove o texto selecionado. Se a janela não tiver nenhuma seleção feita, isto não faz nada.
void view.selectAll();
Seleciona todo o texto no documento.
void view.clearSelection();
Limpa a seleção de texto atual, sem remover o texto.
Sempre que um script estiver em execução, existe um objeto global (variável) “document
” representando o documento ativo atual. A seguir é apresentada uma lista de todas as funções disponíveis para o Document.
String document.fileName();
Devolve o nome do arquivo do documento, ou então um texto vazio para as janelas de texto ainda por salvar.
String document.url();
Devolve o URL completo do documento, ou então um texto vazio para as janelas de texto ainda por salvar.
String document.mimeType();
Devolve o tipo MIME do documento, ou então o tipo
application/octet-stream
se não for encontrado qualquer tipo MIME apropriado.String document.encoding();
Devolve a codificação usada atualmente para salvar o arquivo.
String document.highlightingMode();
Devolve o modo de realce global usado para todo o documento.
String document.highlightingModeAt(
Cursor
);pos
Devolve o modo de realce usado na posição do cursor indicada do documento.
Array document.embeddedHighlightingModes();
Devolve uma lista com os modos de realce incorporados neste documento.
bool document.isModified();
Devolve
true
(verdadeiro) se o documento tiver alguma alteração por salvar, caso contrário devolvefalse
.String document.text();
Devolve o conteúdo inteiro do documento numa única sequência de texto. As mudanças de linha estão marcadas com o caractere de mudança de linha “
\n
”.String document.text(
int
,daLinha
int
,daColuna
int
,paraLinha
int
); String document.text(paraColuna
Cursor
,de
Cursor
); String document.text(para
Range
);intervalo
Devolve o texto no intervalo indicado. Recomenda-se que use a versão baseada nos cursores e nos intervalos, de modo a ter uma melhor visibilidade do código-fonte.
String document.line(
int
);linha
Devolve a linha de texto indicada como uma sequência de texto. O texto devolvido fica em branco, caso a linha pedida esteja fora do intervalo.
String document.wordAt(
int
,linha
int
); String document.wordAt(coluna
Cursor
);cursor
Devolve a palavra na posição do cursor indicada.
-
Range document.wordRangeAt(
int
,linha
int
); Range document.wordRangeAt(coluna
Cursor
);cursor
Devolve o intervalo da palavra na posição indicada do cursor. O intervalo devolvido é inválido (ver Range.isValid()), caso a posição do texto esteja após o fim de uma linha. Se não existir nenhuma palavra no cursor indicado, é devolvido um intervalo vazio.
Desde: KDE 4.9
String document.charAt(
int
,linha
int
); String document.charAt(coluna
Cursor
);cursor
Devolve o caractere na posição do cursor indicada.
String document.firstChar(
int
);linha
Devolve o primeiro caractere na
linha
que não seja um espaço em branco. O primeiro caractere encontra-se na coluna 0. Se a linha estiver em branco ou conter apenas espaços, a string devolvida será vazia.String document.lastChar(
int
);linha
Devolve o último caractere da
linha
indicada que não seja um espaço em branco. O primeiro caractere encontra-se na coluna 0. Se a linha estiver em branco ou só tiver espaços em branco, o texto devolvido vem vazio.bool document.isSpace(
int
,linha
int
); bool document.isSpace(coluna
Cursor
);cursor
Devolve
true
(verdadeiro), se o caractere na posição indicada do cursor for um espaço em branco, caso contrário, devolvefalse
(falso).bool document.matchesAt(
int
,linha
int
,coluna
String
); bool document.matchesAt(texto
Cursor
,cursor
String
);texto
Devolve
true
(verdadeiro) se otexto
indicado corresponder à posição indicada do cursor, caso contrário, devolvefalse
(falso).bool document.startsWith(
int
,linha
String
,texto
bool
);ignorarEspacos
Devolve
true
(verdadeiro) se a linha começar portexto
, caso contrário, devolvefalse
(falso). O argumentoignorarEspacos
controla se os espaços envolventes são ignorados ou não.bool document.endsWith(
int
,linha
String
,texto
bool
);ignorarEspacos
Devolve
true
(verdadeiro), caso a linha termine emtexto
, caso contrário devolvefalse
(falso). O argumentoignorarEspacos
controla se os espaços envolventes são ignorados.bool document.setText(
String
);texto
Altera o texto do documento por inteiro.
bool document.clear();
Limpa o texto no documento por inteiro.
bool document.truncate(
int
,linha
int
); bool document.truncate(coluna
Cursor
);cursor
Trunca a linha indicada, na coluna ou posição do cursor indicadas. Devolve
true
(verdadeiro) em caso de sucesso oufalse
(falso) se a linha não estiver dentro do intervalo do documento.bool document.insertText(
int
,linha
int
,coluna
String
); bool document.insertText(texto
Cursor
,cursor
String
);texto
Insere o
texto
na posição do cursor indicada. Devolvetrue
, em caso de sucesso, oufalse
(falso), se o documento estiver apenas para leitura.bool document.removeText(
int
,daLinha
int
,daColuna
int
,paraLinha
int
); bool document.removeText(paraColuna
Cursor
,de
Cursor
); bool document.removeText(para
Range
);intervalo
Remove o texto no intervalo indicado. Devolve
true
(verdadeiro), em caso de sucesso, oufalse
(falso), se o documento estiver no modo apenas para leitura.bool document.insertLine(
int
,linha
String
);texto
Insere o texto na linha indicada. Devolve
true
(verdadeiro), em caso de sucesso, oufalse
(falso), caso o documento esteja apenas para leitura ou se a linha não estiver no intervalo do documento.bool document.removeLine(
int
);linha
Remove a linha de texto indicada. Devolve
true
(verdadeiro), em caso de sucesso, oufalse
(falso), caso o documento esteja no modo apenas para leitura ou se a linha não estiver no intervalo do documento.bool document.wrapLine(
int
,linha
int
); bool document.wrapLine(coluna
Cursor
);cursor
Reparte a linha na posição indicada pelo cursor. Devolve
true
(verdadeiro) em caso de sucesso oufalse
(falso) se, por exemplo, a linha < 0.Desde: KDE 4.9
void document.joinLines(
int
,linhaInicial
int
);linhaFinal
Junta as linhas de
linhaInicial
atélinhaFinal
. Duas linhas de texto sucessivas estão sempre separadas por um espaço em branco.int document.lines();
Devolve o número de linhas do documento.
bool document.isLineModified(
int
);linha
Devolve
true
(verdadeiro), se alinha
contém dados que não foram salvos.Desde: KDE 5.0
bool document.isLineSaved(
int
);linha
Devolve
true
(verdadeiro), se alinha
foi alterada, mas o documento foi salvo. Assim, a linha não contém dados não salvos.Desde: KDE 5.0
bool document.isLineTouched(
int
);linha
Devolve
true
(verdadeiro), se alinha
contém dados que não foram salvos ou foi anteriormente alterado.Desde: KDE 5.0
bool document.findTouchedLine(
int
,linhaInicial
bool
);abaixo
Procura pela próxima linha tocada que comece na
linha
. A pesquisa é efetuada tanto para cima como para baixo, dependendo da direção de pesquisa indicada embaixo
.Desde: KDE 5.0
int document.length();
Devolve o número de caracteres do documento.
int document.lineLength(
int
);linha
Devolve o comprimento da
linha
.void document.editBegin();
Inicia um grupo de edição para agrupar operações a desfazer/refazer. Certifique-se de invocar sempre o
editEnd()
tantas vezes quanto invoca oeditBegin()
. A invocação doeditBegin()
usa um contador de referências interno, isto é, esta chamada pode ser encadeada.void document.editEnd();
Termina um grupo de edição. A última invocação do
editEnd()
(isto é, a correspondente à primeira chamada doeditBegin()
) termina o passo de edição.int document.firstColumn(
int
);linha
Devolve a primeira coluna não em branco para a
linha
indicada. Se só existirem espaços em branco na linha, o valor devolvido é-1
.int document.lastColumn(
int
);linha
Devolve a última coluna que não esteja em branco para a
linha
indicada. Se só existirem espaços em branco na linha, o valor devolvido é-1
.int document.prevNonSpaceColumn(
int
,linha
int
); int document.prevNonSpaceColumn(coluna
Cursor
);cursor
Devolve a coluna com caracteres não-brancos que começa na posição de cursor indicada e pesquisa para trás.
int document.nextNonSpaceColumn(
int
,linha
int
); int document.nextNonSpaceColumn(coluna
Cursor
);cursor
Devolve a coluna com caracteres não-brancos que começa na posição de cursor indicada e pesquisa para a frente.
int document.prevNonEmptyLine(
int
);linha
Devolve a primeira linha não-vazia que contém caracteres não-nulos, pesquisando depois para trás.
int document.nextNonEmptyLine(
int
);linha
Devolve a primeira linha não-vazia que contém caracteres não-nulos, pesquisando depois para a frente.
bool document.isInWord(
String
,caractere
int
);atributo
Devolve
true
(verdadeiro), caso ocaractere
eatributo
indicados possam fazer parte de uma palavra, caso contrário devolvefalse
(falso).bool document.canBreakAt(
String
,caractere
int
);atributo
Devolve
true
(verdadeiro) se ocaractere
indicado com oatributo
indicado for adequado para mudar de linha, caso contrário devolvefalse
.bool document.canComment(
int
,atributoInicial
int
);atributoFinal
Devolve
true
(falso), caso um intervalo que começa e termina com os atributos indicados possa ser comentado; caso contrário, devolvefalse
(falso).String document.commentMarker(
int
);atributo
Devolve o marcador de comentários, usado em linhas únicas, para um determinado
atributo
.String document.commentStart(
int
);atributo
Devolve o marcador de início de comentários, usado em linhas múltiplas, para um determinado
atributo
.String document.commentEnd(
int
);atributo
Devolve o marcador de fim de comentários, usado em linhas múltiplas, para um determinado
atributo
.Range document.documentRange();
Devolve um intervalo que engloba todo o documento.
Cursor documentEnd();
Devolve um cursor posicionado na última coluna da última linha do documento.
bool isValidTextPosition(
int
,linha
int
); bool isValidTextPosition(coluna
Cursor
);cursor
Devolve
true
(verdadeiro), se a posição atual do cursor estiver em uma posição de texto válida. Uma posição de texto é válida apenas se estiver localizada no início, no meio ou no fim de uma linha válida. Além disso, uma posição de texto é inválida se estiver localizada em um substituto Unicode.Desde: KDE 5.0
int document.attribute(
int
,linha
int
); int document.attribute(coluna
Cursor
);cursor
Devolve o atributo na posição do cursor indicada.
bool document.isAttribute(
int
,linha
int
,coluna
int
); bool document.isAttribute(atributo
Cursor
,cursor
int
);atributo
Devolve
true
(verdadeiro), se o atributo na posição do cursor indicada for igual aatributo
, caso contrário devolvefalse
(falso).String document.attributeName(
int
,linha
int
); String document.attributeName(coluna
Cursor
);cursor
Devolve o nome do atributo como um texto legível. Isto é igual ao nome
itemData
dos arquivos de realce de sintaxe.bool document.isAttributeName(
int
,linha
int
,coluna
String
); bool document.isAttributeName(nome
Cursor
,cursor
String
);nome
Devolve
true
(verdadeiro), se o nome do atributo, numa dada posição do cursor, corresponder aonome
indicado, caso contrário devolvefalse
(falso).String document.variable(
String
);chave
Devolve o valor da variável do documento identificada pela
chave
. Se a variável do documento não existir, o valor devolvido é um texto em branco.void document.setVariable(
String
,chave
String
);valor
Define o valor da variável do documento solicitada pela
chave
.Veja também: Variáveis de documento do Kate
Desde: KDE 4.8
int document.firstVirtualColumn(
int
);linha
Devolve a coluna virtual do primeiro caractere não-nulo na linha indicada, ou então
-1
se a linha estiver em branco ou só tiver caracteres de espaços em branco.int document.lastVirtualColumn(
int
);linha
Devolve a coluna virtual do último caractere não-nulo na linha indicada, ou então
-1
se a linha estiver em branco ou só tiver caracteres de espaços em branco.int document.toVirtualColumn(
int
,linha
int
); int document.toVirtualColumn(coluna
Cursor
); Cursor document.toVirtualCursor(cursor
Cursor
);cursor
Converte a posição do cursor “real” para uma posição virtual, retornando um int ou um objeto Cursor.
int document.fromVirtualColumn(
int
,linha
int
); int document.fromVirtualColumn(colunaVirtual
Cursor
); Cursor document.fromVirtualCursor(cursorVirtual
Cursor
);cursorVirtual
Converte a posição virtual do cursor para uma posição do cursor “real”, retornando um int ou um objeto Cursor.
Cursor document.anchor(
int
,linha
int
,coluna
Char
); Cursor document.anchor(caractere
Cursor
,cursor
Char
);caractere
Pesquisa para trás pelo caractere indicado, começando na posição do cursor indicada. Por exemplo, se for passado o '(', como caractere, esta função irá devolver a posição do '(' de abertura. Isto implica uma contagem das referências, isto é, os outros '(...)' são ignorados.
Cursor document.rfind(
int
,linha
int
,coluna
String
,texto
int
); Cursor document.rfind(atributo
= -1Cursor
,cursor
String
,texto
int
);atributo
= -1Pesquisa para trás pelo texto indicado, com o
atributo
apropriado. O argumentoatributo
é ignorado se for igual a-1
. O cursor devolvido é inválido, caso o texto não tenha sido encontrado.int document.defStyleNum(
int
,linha
int
); int document.defStyleNum(coluna
Cursor
);cursor
Devolve o estilo padrão que é usado na posição do cursor indicada.
bool document.isCode(
int
,linha
int
); bool document.isCode(coluna
Cursor
);cursor
Devolve
true
(verdadeiro) se o atributo na posição do cursor indicada não for igual a todos os seguintes estilos:dsComment
,dsString
,dsRegionMarker
,dsChar
,dsOthers
.bool document.isComment(
int
,linha
int
); bool document.isComment(coluna
Cursor
);cursor
Devolve
true
se o atributo do caractere na posição do cursor fordsComment
, caso contrário, devolvefalse
.bool document.isString(
int
,linha
int
); bool document.isString(coluna
Cursor
);cursor
Devolve
true
(verdadeiro) se o atributo do caractere na posição do cursor fordsString
, caso contrário, devolvefalse
(falso).bool document.isRegionMarker(
int
,linha
int
); bool document.isRegionMarker(coluna
Cursor
);cursor
Devolve
true
(verdadeiro) se o atributo do caractere na posição do cursor fordsRegionMarker
, caso contrário, devolvefalse
(falso).bool document.isChar(
int
,linha
int
); bool document.isChar(coluna
Cursor
);cursor
Devolve
true
(verdadeiro) se o atributo do caractere na posição do cursor fordsChar
, caso contrário, devolvefalse
(falso).bool document.isOthers(
int
,linha
int
); bool document.isOthers(coluna
Cursor
);cursor
Devolve
true
(verdadeiro) se o atributo do caractere na posição do cursor fordsOthers
, caso contrário, devolvefalse
(falso).

A seleção de → , a partir do menu, provoca o aparecimento da caixa de diálogo Configurar. Esta caixa de diálogo pode ser usada para alterar algumas das várias opções existentes. As opções disponíveis para alteração podem variar de acordo com a categoria que o usuário seleciona, numa lista vertical do lado esquerdo da janela. Recorrendo aos três botões na parte inferior da janela, o usuário poderá controlar o processo.
Você pode invocar o sistema de Ajuda, aceitar as configurações atuais e fechar o diálogo através do botão ou . As categorias Aparência, Fontes & Cores, Edição, Abrir/Salvar e Extensões são detalhadas abaixo.
Este grupo contém todas as páginas relacionadas com o componente de edição do KatePart A maioria das configurações aqui são os valores pré-definidos, que podem ser substituídos ao definir um tipo de arquivo, nas Variáveis do Documento ou através da sua alteração, durante uma sessão de edição do documento.
- Quebra de linhas dinâmica
Se esta opção estiver marcada, as linhas de texto serão quebradas na borda da visão da tela.
- Indicadores de quebra de linhas dinâmica (se aplicável)
Escolhe quando deverão ser mostrados os indicadores de quebra de linha, sendo as opções Desligado, Seguir número de linhas ou Sempre ligado.
- Alinhar a quebra de linhas dinâmica à profundidade de recuo:
Ativa o início das linhas repartidas com quebras de linha dinâmicas, de modo a ficarem alinhadas na vertical com o nível de recuo da primeira linha. Isto poderá ajudar a tornar o código e a formatação mais legíveis.
Além disso, isto permite-lhe definir uma largura máxima da tela, como porcentagem, após a qual as linhas repartidas de forma dinâmica não serão mais alinhadas na vertical. Por exemplo, a 50%, as linhas cujos níveis de recuo sejam mais profundas que 50% da largura da tela não terão qualquer alinhamento vertical aplicado às linhas repartidas subsequentes.
- Realce de espaço em branco
- Realçar as tabulações
O editor mostrará um símbolo » para indicar a presença de uma tabulação no texto.
- Realçar espaços finais
O editor mostrará pontos para indicar a presença de espaços em branco extra no fim das linhas.
- Avançado
- Mostrar linhas de recuo
Se esta opção estiver assinalada, o editor irá mostrar linhas verticais para ajudar a identificar as linhas de recuo.
- Realçar o intervalo entre os parênteses selecionados
Se esta opção estiver ativa, o intervalo entre os parênteses selecionados será realçado.
- Animar os parênteses correspondentes
Se estiver assinalado, a passagem sobre os sinais gráficos ({, [, ], },( ou )) irá animar rapidamente o sinal correspondente.
- Dobrar a primeira linha
Se estiver assinalado, a primeira linha é dobrada, se possível. Isso é útil se o arquivo começar com um comentário, como por exemplo, uma informação sobre direitos autorais.
- Bordas
- Mostrar marcadores de dobra
Se esta opção estiver assinalada, a janela atual irá mostrar marcações para dobrar ou desdobrar o código, se este estiver disponível.
- Mostrar borda de ícones
Se esta opção estiver assinalada, você verá uma borda para os ícones do lado esquerdo. A borda dos ícones mostra os sinais de favoritos, por exemplo.
- Mostrar número das linhas
Se esta opção estiver assinalada, você verá os números das linhas do lado esquerdo.
- Mostrar marcadores de modificação de linha
Se estiver assinalada, os marcadores de modificação das linhas ficarão visíveis. Para mais informações, veja em “Indicadores de modificação de linhas”.
- Mostrar marcas na barra de rolagem
Se esta opção estiver assinalada, a janela atual irá mostrar algumas marcas na barra de rolagem vertical. Essas marcas poderão mostrar, por exemplo, os favoritos.
- Mostrar minimapa na barra de rolagem
Se esta opção estiver assinalada, cada nova visão exibirá um minimapa do documento na barra de rolagem vertical.
Para obter mais informações sobre o minimapa na barra de rolagem, veja “O minimapa na barra de rolagem”
- Largura do minimapa
Ajusta a largura em pixels do minimapa na barra de rolagem.
- Ordenar menu de favoritos
- Por criação
Cada novo favorito será adicionado no fim, independentemente de onde se encontra colocado no documento.
- Por posição
Os favoritos serão ordenados pelos números de linhas onde estão colocados.
Esta seção da janela permite-lhe configurar todas as fontes e cores de qualquer esquema de cores que tiver, assim como criar esquemas novos ou remover os existentes. Cada esquema tem a configuração das cores, fontes e estilos do texto normal e selecionado.
O KatePart selecionará previamente o esquema atualmente ativo para você; se quiser trabalhar sobre um esquema diferente, comece por selecioná-lo na lista Esquema. Com os botões e você pode criar um novo esquema ou remover um existente.
No fundo da página, você poderá selecionar o Esquema padrão para o KatePart.
Por padrão, o KatePart irá basear o seu esquema de cores no esquema atual do KDE. Você poderá restaurar uma cor individual ao seu valor predefinido clicando no botão de reposição à direita do item no editor de cores, ou poderá ainda restaurar todas as cores predefinidas se usar o botão no fundo do painel.
Dica
Você poderá ajustar o esquema de cores do KDE no módulo de Cores das Configurações do Sistema.
- Cores de fundo do Editor
- Área de texto
Este é o fundo padrão para a área de edição, sendo a cor dominante da área do editor.
- Texto selecionado
Este é o fundo do texto selecionado. O valor padrão é a cor global de seleção, como está definida nas preferências de cores do KDE.
- Linha atual
Define a cor da linha atual. Se configurar esta cor um pouco diferente do fundo do Texto Normal, isto o ajudará a concentrar-se na linha atual.
- Realce da pesquisa
Define a cor do texto correspondente à sua última pesquisa.
- Realce da substituição
Define a cor do texto correspondente à sua última substituição.
- Borda do ícone
- Área de fundo
Esta cor é usada para as marcas, números de linhas e bordas das marcações de desdobramento do lado esquerdo da janela de edição, quando forem apresentados.
- Número de linhas
Esta cor é usada para desenhar os números de linha do lado esquerdo da janela, quando estiverem visíveis.
- Marcadores de quebra de linhas
Esta cor é usada para desenhar um padrão à esquerda das linhas repartidas com quebra de linha, quando estiverem alinhadas na vertical, assim como para as marcações de quebras de linha estáticas.
- Dobradura de código
Esta cor é usada para realçar a seção de código que seria dobrada quando você clica na seta de dobradura de código à esquerda de um documento Para mais informações, veja a documentação sobre a dobradura de código.
- Linhas modificadas
Esta cor é usada para realçar, à esquerda de um documento, as linhas que foram modificadas mas ainda não foram salvas. Para mais informações, veja a “Indicadores de modificação de linhas”.
- Linhas salvas
Esta cor é usada para realçar, à esquerda de um documento, as linhas que foram modificadas e salvas nesta sessão. Para mais informações, veja a “Indicadores de modificação de linhas”.
- Decorações de texto
- Linha com erros ortográficos
Esta cor é usada para indicar os erros ortográficos.
- Marcadores de tabulação e espaços
Esta cor é usada para desenhar os indicadores de espaços em branco, quando estiverem ativos.
- Linha de recuo
Esta cor é usada para desenham uma linha à esquerda dos blocos recuados, se este recurso estiver ativo.
- Realçar parênteses
Esta cor é usada para desenhar o fundo dos parênteses correspondentes.
- Cores dos marcadores
- Favoritos
Esta cor é usada para indicar os favoritos. Para mais informações, veja os “Usando os favoritos”.
- Ponto de parada ativo
Esta cor é usada pelo plugin do GDB para indicar um ponto de parada ativo. Para mais informações, veja a documentação do plugin do GDB.
- Ponto de parada alcançado
Esta cor é usada pelo plugin do GDB para indicar um ponto de parada que tenha sido atingido durante a depuração. Para mais informações, veja a documentação do plugin do GDB.
- Ponto de parada desativado
Esta cor é usada pelo plugin do GDB para indicar um ponto de parada inativo. Para mais informações, veja a documentação do plugin do GDB.
- Execução
Esta cor é usada pelo plugin do GDB para indicar a linha que está sendo executada de momento. Para mais informações, veja a documentação do plugin do GDB.
- Aviso
Esta cor é usada pelo plugin de compilação para indicar uma linha que contém um aviso do compilador. Para mais informações, veja a documentação do plugin de compilação.
- Erro
Esta cor é usada pelo plugin de compilação para indicar uma linha que contém um erro do compilador. Para mais informações, veja a documentação do plugin de compilação.
- Modelos de texto & trechos
- Plano de fundo
Esta cor é usada pelo plugin Trechos do Kate para marcar o fundo de um trecho.
- Campo editável
Esta cor é usada pelo plugin Trechos do Kate para marcar um item de substituição que você poderá clicar para editar manualmente.
- Campo editável focável
Esta cor é usada pelo plugin Trechos do Kate para marcar o item de substituição que você está editando no momento.
- Modelo de campo não editável
Esta cor é usada pelo plugin de trechos do Kate para marcar um item de substituição que não pode ser editado manualmente. Para mais informações, veja a documentação sobre os Trechos no Kate.
Se clicar neste botão irá ativar todas as cores definidas acima para corresponderem ao esquema de cores definido nas Configurações do Sistema do KDE. Para mais informações, veja a documentação do Módulo de Controle de Cores do KDE.
Se não usar o Espaço de Trabalho Plasma do KDE, este botão não fará efeito e pode não estar presente.
Aqui, o usuário poderá escolher a fonte padrão para o esquema. Você pode escolher qualquer fonte disponível no seu sistema, assim como definir um tamanho padrão e uma codificação. Um texto de exemplo aparecerá na parte inferior da janela, para que você possa ver o resultado das suas opções.
Para mais informações sobre como selecionar uma fonte, leia a seção Escolhendo as fontes na documentação dos Fundamentos do KDE.
Os estilos de texto predefinidos são herdados pelos estilos de texto realçados, permitindo ao editor apresentar o texto de forma bastante consistente. Por exemplo, o texto do comentário usa o mesmo estilo em quase todos os formatos de texto que o KatePart consegue realçar.
O nome na lista de estilos está usando o estilo configurado para o item, oferecendo-lhe uma visualização imediata ao configurar um estilo.
Cada estilo permite-lhe selecionar atributos comuns, assim como as cores do texto e de fundo. Para retirar uma cor de fundo, clique com o botão direito para usar o menu de contexto.
Aqui você poderá editar os estilos de texto usados por uma definição de realce específica. O editor seleciona previamente o realce usado pelo seu documento atual. Para funcionar com um realce diferente, selecione um na lista Realce, acima da lista de estilos.
O nome na lista de estilos está usando o estilo configurado para o item, oferecendo-lhe uma visualização imediata ao configurar um estilo.
Cada estilo permite-lhe selecionar os atributos comuns, assim como as cores de fundo e do texto. Para retirar uma cor de fundo, clique com o botão direito para usar o menu de contexto. Além disso, você poderá verificar se o estilo usado pelo item é igual ao estilo padrão e configurá-lo desta forma, caso não estiver.
Você notará que vários realces contém outros realces, representados por grupos na lista de estilos. Por exemplo, a maioria dos realces implementam o realce Alert (Alerta) e muitos formatos de código importam o realce do Doxygen. A edição das cores destes grupos só afetará os estilos se forem usados no formato de realce editado.
- Quebra de linha estática
A quebra de linha é um recurso que faz com que o editor inicie automaticamente uma nova linha de texto e mova (quebre) o cursor para o início da nova linha. O KatePart automaticamente iniciará uma nova linha de texto quando a linha atual atingir o comprimento especificado pela opção Quebrar linhas em:.
- Habilitar quebra de linha estática
Ativa ou desativa a quebra de linha estática.
- Mostrar marcador de quebra de linha estática (se aplicável)
Se esta opção estiver assinalada, será desenhada uma linha vertical na coluna da quebra de linha, como está definido na opção → na página de Edição. Lembre-se que o marcador de quebra de linha só é desenhado se você usar uma fonte monoespaçada.
- Quebrar linhas em:
Se a opção Ativar quebra de linha estática estiver selecionada esta entrada determina o comprimento (em caracteres) no qual o editor automaticamente iniciará uma nova linha.
- Modo de entrada
O modo de inserção de dados será ativado ao abrir um novo modo de exibição. Você ainda poderá ativar/desativar o modo de entrada VI, para um determinado modo de exibição através do menu .
- Parênteses automáticos
Quando o usuário digitar um sinal gráfico de abertura ([, ( ou {) o KatePart irá inserir automaticamente o sinal gráfico de fechamento (}, ) ou ]) à direita do cursor.
Quando o texto for selecionado, a digitação de um dos caracteres envolve o texto selecionado.
- Copiar e colar
- Copiar/recortar a linha atual se não existir seleção
Se esta opção estiver ativa e se a seleção de texto estiver vazia, as ações de cópia e corte são efetuadas para a linha de texto na posição atual do cursor.
- Movimento do cursor de texto
- Início e fim inteligentes
Quando estiver selecionado, pressionar na tecla Home, fará com que o cursor salte os espaços em branco e vá para o início do texto de uma linha.
- PageUp/PageDown move o cursor
Esta opção muda o comportamento do cursor quando o usuário pressiona as teclas Page Up e Page Down. Se não estiver selecionada, o cursor de texto manterá sua posição relativa dentro do texto visível no KatePart conforme o novo texto se torna visível como resultada da operação. Assim, se o cursor estiver no meio do texto visível quando a operação ocorre, ele permanecerá lá (exceto quando o início ou fim são atingidos). Com esta opção selecionada, o primeiro pressionamento de tecla fará com que o cursor se mova para cima ou para baixo do texto visível conforme uma nova página de texto é exibida.
- Centralizar cursor automaticamente:
Indica o número de linhas a manter visível acima e abaixo do cursor, sempre que possível.
- Modo de seleção de texto
- Normal
As seleções serão sobrepostas pelo texto escrito e serão perdidas com o movimento do cursor.
- Persistente
As seleções serão mantidas mesmo após o movimento do cursor ou a digitação.
- Permitir rolagem após o fim do documento
Esta opção permite-lhe deslocar além do fim do documento. Isto poderá ser usado para centrar na vertical o fundo do documento, ou para colocá-lo no topo da janela atual.
- Modo de recuo padrão:
Selecione o modo de recuo automático que desejar usar por padrão. Recomenda-se que use o
Nenhum
ou oNormal
aqui e use as configurações do tipo de arquivo para definir outros modos de recuo para os formatos de texto, como o código em C/C++ ou o XML.- Recuar usando
- Tabulações
Quando estiver ativo, o editor irá inserir caracteres de tabulação quando você clicar na tecla Tab ou usar o recuo automático.
- Espaços
Quando isto estiver ativo, o editor irá inserir um número calculado de espaços, de acordo com a posição no texto e a configuração
tab-width
, quando pressionar a tecla Tab ou usar o recuo automático.- Tabulações e espaços
Quando a opção estiver ativa, o editor irá inserir espaços, como descrito acima, quando recuar ou pressionar a tecla Tab no início de uma linha, mas irá inserir tabulações quando pressionar na tecla Tab no meio ou no fim de uma linha.
- Largura da tabulação:
Isto configura o número de espaços que são apresentados no lugar de um caractere de tabulação.
- Largura do recuo:
A largura do recuo é o número de espaços usado para recuar uma linha. Se estiver configurado para recuar com tabulações, será inserido um caractere de tabulação se o recuo for divisível pela largura da tabulação.
- Propriedades do recuo
- Manter espaços extras
Se esta opção estiver desativada, a alteração do nível de recuo alinha uma linha a um múltiplo da largura definida em Largura do recuo.
- Ajustar o recuo do texto colado da área de transferência
Se esta opção for selecionada, o texto colado da área de transferência será recuado. A execução da ação irá remover o recuo.
- Ações de recuo
- A tecla Backspace nos espaços iniciais retira o recuo
Se esta opção for selecionada, a tecla Backspace diminui o nível de recuo se o cursor estiver localizado no espaço em branco inicial de uma linha.
- Ação da tecla Tab (se não existir seleção)
Se você quiser que o Tab alinhe a linha atual no bloco de código atual, como acontece no Emacs, torne o Tab um atalho para a ação .
- Sempre avançar para a tabulação seguinte
Se esta opção for selecionada, a tecla Tab insere sempre espaços em branco até atingir a posição da tabulação seguinte. Se a opção Inserir espaços em vez de tabulações, na página Geral em Edição estiver ativa, são inseridos espaços; caso contrário, é inserida uma única tabulação.
- Sempre aumentar o nível de recuo
Se esta opção for selecionada, a tecla Tab recua sempre a linha atual de acordo com o número de posições de caracteres indicada na Largura do recuo.
- Aumentar o nível de recuo se estiver num espaço em branco inicial
Se esta opção estiver assinalada, a tecla Tab recua a linha atual ou avança para a próxima posição de tabulação. Se o ponto de inserção estiver sobre ou antes do primeiro caractere que não seja espaço na linha, ou se existir algo selecionado, a linha atual é recuada pelo número de posições de caracteres indicada em Largura do recuo. Se o ponto de inserção estiver após o primeiro caractere não-espaço e nada estiver selecionado, são inseridos espaços em branco até atingir a próxima posição de tabulação: se a opção Inserir espaços em vez de tabulações da página Geral em Edição estiver ativa, são inseridos espaços; caso contrário, é inserida uma única tabulação.
- Geral
- Ativar completamento automático
Se habilitado, aparece um campo de completação automática, mostrando uma lista com os itens de texto para completar o texto atual sob o cursor.
- Tamanho mínimo da palavra a completar
Ao digitar o texto, o completamento de palavras procura por palavras no documento iniciando com o texto já digitado. Esta opção configura a quantidade mínima de caracteres que são necessários para tornar o completamento de palavras ativo e exibir uma caixa de completamento.
- Remover o fim com a completação
Remover o fim de uma palavra anterior quando o item de completação for escolhido a partir de uma lista.
- Complementação de palavras-chave
Se estiver assinalado, a completação automática incorporada usa as palavras-chave definidas pelo realce de sintaxe.
Estas opções de configuração estão descritas na documentação do módulo do Configurações do Sistema sobre Verificação Ortográfica.
- Geral
- Permitir que os comandos do Vi substituam os atalhos do Kate
Quando selecionado, os comandos do 'Vi' irão substituir os comandos incorporados do KatePart. Por exemplo: o Ctrl+R irá refazer, substituindo a ação padrão (mostrar a janela de pesquisa e substituição).
- Mostrar números de linha relativos
Se isto estiver assinalado, a linha atual sempre se irá se referir à linha 0. As linhas acima e abaixo aumentam o número da linha de forma relativa.
- Mapeamento de teclas
A associação de teclas é usada para alterar o significado das teclas pressionadas. Isto permite-lhe mover os comandos para outras teclas ou criar sequências de teclas especiais para fazer uma determinada série de comandos.
Exemplo:
F2 ->
I--
EscIsto irá anteceder o
I--
com uma linha, ao pressionar F2.
- Formato do arquivo
- Codificação
Isto define a codificação padrão a ser usada para abrir/salvar os arquivos, se não for alterado no diálogo de abertura/gravação ou na opção da linha de comandos.
- Detecção da codificação
Selecione um item na lista, quer para desativar a detecção automática como para usar a Universal, de modo a ativar a detecção automática para todas as codificações. Contudo, como isto provavelmente só irá detectar o UTF-8/UTF-16, selecionar uma região irá usar heurísticas personalizadas para melhores resultados. Se a codificação selecionada como padrão acima, a codificação especificada na janela de abertura/salvamento de arquivos ou a codificação especificada na linha de comando corresponder ao conteúdo do arquivo, esta detecção será realizada.
- Codificação secundária
Isto define a codificação secundária a ser tentada quando abrir os arquivos, caso não funcione a codificação padrão, a indicada através da janela para abrir/salvar ou pela linha de comando, de modo a corresponder ao conteúdo do arquivo. Antes desta ser usada, a componente do Kate irá tentar deduzir a codificação, lendo um possível marcador de ordem dos 'bytes' no início do arquivo; caso se detecte algum conhecido, será escolhida a codificação correta, caso contrário será testada esta como último recurso.
- Fim da linha
Escolha o seu fim de linha preferido para o seu documento ativo. Você poderá optar pelo padrão UNIX®, DOS/Windows® ou o Macintosh.
- Detecção automática de fim de linha
Assinale isto se quiser que o editor detecte automaticamente o tipo de fim da linha. O primeiro tipo encontrado será o usado para todo o arquivo.
- Ativar o marcador da ordem de bytes
O marcador da ordem dos bytes é uma sequência especial no início dos documentos codificados em Unicode. Ajuda os editores a abrir os documentos de texto com a codificação Unicode correta. Para mais informações, veja o Marcador da Ordem de Bytes.
- Limite do tamanho da linha
Infelizmente, devido a deficiências no Qt™, o KatePart tem um desempenho ruim ao lidar com linhas extremamente longas. Por este motivo, o KatePart tentará quebrar as linhas automaticamente, quando o tamanho for maior que o número de caracteres aqui indicado. Para desativar isto, defina como
0
.
- Limpezas automáticas ao salvar
- Remover espaços finais
O editor irá eliminar automaticamente os espaços extras no fim das linhas de texto enquanto salva o arquivo. Você pode selecionar Nunca para desativar essa funcionalidade, Nas linhas modificadas para fazer apenas nas linhas que você modificou desde a última gravação do documento ou Em todo o documento para removê-las de forma incondicional do documento inteiro.
- Adicionar nova linha no fim do arquivo ao salvar
O editor irá adicionar automaticamente uma nova linha ao fim do arquivo, caso não exista, ao salvar o arquivo.
- Fazer cópia de segurança ao salvar
Criar cópia de segurança ao salvar, fará com que o KatePart copie o arquivo do disco para <prefixo><arquivo><sufixo> antes de salvar as alterações. O sufixo é, por padrão, ~ e o prefixo está em branco, por padrão.
- Arquivos locais
Assinale isto se quiser cópias de segurança dos arquivos locais ao salvar.
- Arquivos remotos
Assinale isto se quiser cópias de segurança dos arquivos remotos ao salvar.
- Prefixo
Indique o prefixo com que antecede os nomes das cópias de segurança.
- Sufixo
Indique o sufixo a ser adicionado aos nomes das cópias de segurança.
- Opções do arquivo temporário
O KatePart é capaz de recuperar (a maior parte) o que foi escrito após o último salvamento no caso de uma falta de energia. Um arquivo temporário (.swp.<nomedoarquivo>) é criado após a primeira ação de edição de um documento. Se o usuário não salvar as mudanças e o KatePart travar, o arquivo temporário permanecerá no disco. Ao abrir um arquivo, o KatePart verifica se existe um arquivo temporário para o documento e, caso exista, ele pergunta se o usuário deseja recuperar os dados perdidos ou não. O usuário também pode ver as diferenças entre o arquivo original e o recuperado. O arquivo temporário é excluído após cada salvamento ou saída normal do programa.
O KatePart sincroniza os arquivos temporários a cada 15 segundos, mas somente se eles tiverem mudado desde a última sincronização. O usuário poderá desativar a sincronização dos arquivos temporários se desejar, selecionando a opção Desativar, mas isto pode levar a mais perda de dados.
Quando estiver assinalado, os arquivos temporários são salvos na mesma pasta onde o arquivo está armazanado. Quando a Pasta alternativa for escolhida, os arquivos temporários serão criados na pasta indicada. Isso é útil para sistemas de arquivos de rede, de forma a evitar o tráfego de rede desnecessário.
Esta página permite-lhe substituir a configuração padrão dos documentos dos tipos MIME indicados. Quando o editor carregar um documento, ele verificará se o arquivo corresponde às máscaras de arquivos ou tipos MIME para cada um dos tipos definidos e, se corresponder, aplica as variáveis definidas. Se de um tipo de arquivo corresponder, será usado o que tiver maior prioridade.
- Tipo de arquivo:
O tipo de arquivo com a maior prioridade é o que será apresentado na primeira lista. Se forem encontrados mais tipos de arquivo, eles serão também listados.
- Novo
Isto é usado para criar um novo tipo de arquivo. Após clicar este botão, os campos abaixo ficam em branco, para que você possa preencher as propriedades que deseja para o novo tipo de arquivo.
- Excluir
Para remover um tipo de arquivo existente, selecione-o na lista e clique no botão Excluir.
- Propriedades do
tipo de arquivo atual
O tipo de arquivo com a maior prioridade é o que será apresentado na primeira lista. Se forem encontrados mais tipos de arquivo, eles serão também listados.
- Nome:
O nome do tipo de arquivo será o texto do item de menu correspondente. Este nome é mostrado no item →
- Seção:
O nome da seção é usado para organizar os tipos de arquivos em menus. Ele também é usado no menu → .
- Variáveis:
Este texto permite-lhe configurar as opções do KatePart para os arquivos selecionados por este tipo MIME, usando as variáveis do KatePart. Você poderá definir quase todas as opções de configuração, como o 'highlight', 'indent-mode', etc.
Pressione para ver uma lista de todas as variáveis disponíveis e suas descrições. Selecione a caixa à esquerda para ativar uma determinada variável e então defina o valor da variável à direita. Algumas variáveis fornecem uma caixa combinada para selecionar os valores possíveis enquanto outras necessitam que você insira um valor válido manualmente.
Para informações completas sobre estas variáveis, veja Configurando com variáveis de documento.
- Realce:
Se você criar um novo tipo de arquivo, esta lista permite-lhe selecionar um tipo de arquivo para o realce.
- Modo de recuo:
A lista indica o modo de recuo para os documentos novos.
- Extensões dos arquivos:
As máscaras com caracteres especiais permitem-lhe selecionar arquivos pelo nome. Uma máscara típica usa um asterisco e a extensão do arquivo, como por exemplo
*.txt; *.text
. O texto é uma lista de máscaras separada por ponto e vírgula.- Tipos MIME:
Exibe um assistente que o ajuda a escolher facilmente tipos MIME.
- Prioridade:
Escolhe a prioridade deste tipo de arquivo. Se mais de um tipo de arquivo corresponder a um arquivo, será utilizado o com a prioridade mais elevada.
Clique neste botão para transferir descrições de realce de sintaxe novas ou atualizadas na página Web do KatePart.

As 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, com a profundidade definida na profundidade de pesquisa. As variáveis de documento no .kateconfig
usam a mesma sintaxe das modelines.
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.
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 3.7. 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-center-lines [INT]
Define o número de linhas de centralização automática.
auto-insert-doxygen [BOOL]
Ativa ou desativa a inserção do asterisco inicial nos comentários do 'doxygen'. Isto não tem efeito, a menos que você use o sistema de recuo no estilo do C.
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-marker [BOOLEANO]
Ativar/desativar o marcador da ordem dos bytes ao salvar os arquivos no formato Unicode (utf8, utf16, utf32).
Desde: Kate 3.4 (KDE 4.4)
encoding [TEXTO]
Define a codificação usada para carregar ou salvar o arquivo. Como as variáveis do documento serão lidas após o carregamento, isto só terá impacto na gravação. Se o colocar em um arquivo
.kateconfig
, também afetará o carregamento.Desde: Kate 3.10 (KDE 4.10)
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
, omac
e odos
.folding-markers [BOOL]
Ativa ou desativa a visualização dos marcadores de expansão/contração do código.
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
,ruby
exml
sã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.
mixed-indent [BOOLEANO]
Ativa ou desativa o recuo misto no estilo Emacs.
Nota: Obsoleto desde o Kate 3 no KDE4. Esta variável é ignorada. Use o replace-tabs on; como alternativa no futuro.
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.
remove-trailing-space [BOOL]
Ativa ou desativa a limpeza dinâmica dos fins-de-linha.
Nota: Obsoleto desde a versão KDE 4.10. Em vez disso, use a opção remove-trailing-spaces com a escolha desejada.
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.
Desde: KDE 4.10. Esta opção substitui as opções
remove-trailing-space
ereplace-trailing-space-save
.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.
replace-trailing-space-save [BOOL]
Ativa ou desativa a limpeza dos fins-de-linha no salvamento.
Nota: Obsoleto desde a versão KDE 4.10. Em vez disso, use a opção remove-trailing-spaces com a escolha desejada.
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.
space-indent [BOOLEANO]
Ativa ou desativa o recuo com espaços.
Nota: Obsoleto desde o Kate 3 no KDE4. O recuo misto é o comportamento padrão. Use o replace-tabs on; para obter um recuo apenas com espaços.
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.

Direitos autorais do KatePart e KWrite 2001-2014 da equipe do Kate.
Baseado no KWrite original, que possui Direitos Autorais 2000 para Jochen Wilhelmy (digisnap AT cs.tu-berlin.de)
Contribuições:
Christoph Cullmann
(cullmann AT kde.org)
Michael Bartl
(michael.bartl1 AT chello.at)
Phlip
(phlip_cpp AT my-deja.com)
Anders Lund
(anders AT alweb.dk)
Matt Newell
(newellm AT proaxis.com)
Joseph Wenninger
(kde AT jowenn.at)
Jochen Wilhelmy
(digisnap AT cs.tu-berlin.de)
Michael Koch
(koch AT kde.org)
Christian Gebauer
(gebauer AT kde.org)
Simon Hausmann
(hausmann AT kde.org)
Glen Parker
(glenebob AT nwlink.com)
Scott Manson
(sdmanson AT altel.net)
John Firebaugh
(jfirebaugh AT kde.org)
A documentação do KatePart é baseada na documentação original do KWrite, modificada para ser relevante a todos os usuários do KatePart.
A documentação original do KWrite foi escrita por Thad McGinnis (ctmcginnis AT compuserve.com)
, com diversas modificações de Christian Tibirna (tibirna AT kde.org)
. Foi revista e convertida para DocBook por Lauri Watts (lauri AT kde.org)
e atualizada por Anne-Marie Mahfouf (annma AT kde.org)
e Anders Lund (anders AT alweb.dk)
A documentação atual do KatePart é mantida por T.C. Hollingsworth (tchollingsworth AT gmail.com)
. Por favor, envie seus comentários ou sugestões para a lista de discussão de desenvolvimento do KatePart em (kwrite-devel AT kde.org)
ou crie um relatório de erro no Sistema de Gerenciamento de Erros do KDE.
Tradução de Marcus Gama (marcus.gama AT gmail.com)
e André Marcelo Alvarenga (alvarenga AT kde.org)
Esta documentação é licenciada sob os termos da Licença de Documentação Livre GNU.
Este programa é licenciado sob os termos da Licença Pública Geral GNU.

O objetivo do modo VI não é ser um substituto completo para o Vim e suportar todas as funcionalidades do Vim. O objetivo é tornar o “jeito Vim” de edição de texto - e os hábitos Vim aprendidos - disponíveis para os programas que usam o editor de texto do KatePart como seu editor interno.
O modo VI busca integrar-se de maneira transparente aos programas e se afastar do comportamento do Vim onde fizer sentido. Por exemplo, :w
abrirá uma janela para salvar no modo VI do KatePart.
Para ativar o Modo de entrada VI para todas as novas visualizações, vá para → + → . Nesta página você pode definir opções para o Modo de entrada VI e definir e editar o mapeamento de teclado neste modo. O Modo de entrada VI pode também ser alternado com a configuração no menu . (O atalho de teclado padrão é Meta+Ctrl+V - onde o Meta é normalmente a tecla Windows).
Nota
Muitos comandos de teclado do modo Vi são sensíveis à caixa, diferentemente da maioria dos atalhos de teclado do KDE. Isto significa que y
e Y
são comando diferentes. Para inserir o comando y
(yank - empurrar), certifique-se de que o Caps Lock está desativado e pressione Y. Para inserir o comando Y
(empurrar para o fim da linha), Shift+Y.
Isto não se aplica aos comandos que usam a tecla Ctrl, que podem ser inseridos independentemente do modo do Caps Lock e sem pressionar o Shift. No entanto, alguns comandos necessitam do uso da combinação da tecla Ctrl seguida por outra tecla que diferencie maiúsculas e minúsculas. Por exemplo, para inserir “Ctrl+W, h
” (alternar para a visão dividida à direita) certifique-se de que o Caps Lock está desativado, pressione Ctrl+W, solte e então pressione H.
Existem algumas poucas funcionalidades do modo VI do KatePart que são incompatíveis com o Vim (sem contar as que estão faltando). Elas estão listadas abaixo juntamente com os motivos para esta incompatibilidade.
KatePart: o
U
e o Ctrl+R são o 'Refazer'.Vim: Ctrl+R é o 'refazer' normal, enquanto o U é usado para anular todas as últimas alterações numa linha.
O motivo para ter a ação U como refazer no modo VI do KatePart é que o atalho Ctrl+R por padrão é usado pela função substituir do KatePart (localizar e substituir). Por padrão, o modo VI não se sobrepõe aos atalhos do KatePart (isto pode ser configurado em → + → ), assim a ação de refazer precisa estar disponível como uma tecla “normal”. Além disso, o comportamento do comando
U
no Vim não corresponde exatamente ao sistema de refazer interno do KatePart, assim isto seria um suporte não tão trivial de qualquer maneira.KatePart:
print
mostra a janela Imprimir.Vim:
print
imprime as linhas de um determinado intervalo como seu avô, o 'ed'.Comandos como
:print
estão disponíveis não somente no modo VI para usuários que usam o KatePart “normal” também - assim, o comando:print
abre a janela de impressão - seguindo o princípio da menor surpresa ao invés de simplesmente imitar o comportamento do Vim.KatePart:
Y
copia até o fim da linha.Vim:
Y
copia toda a linha, como noy
y
.O comportamento do VI para o comando
Y
é na prática um erro. Para os comandos 'change' e 'delete',c
c
/d
d
fará esta ação na linha atual eC
/D
funcionará da coluna do cursor até o final da linha. No entanto,y
y
eY
copia a linha atual. No Modo VI do KatePart,Y
copia até o fim da linha. Isto é considerado “mais lógico” na documentação do Vim.KatePart:
O
eo
abre [tantas
] novas linhas e entra no modo de inserção.Vim:
O
eo
abre uma nova linha e insere o texto [tantas
] vezes ao deixar o modo de inserção.Isto é normalmente feito como uma consequência de se observar muitas pessoas confusas com este comportamento no canal IRC do vim (#vim no freenode).
Modo Normal permite que você insira comandos para navegar ou editar um documento, sendo o modo padrão. Você pode retornar à ele a partir de outro modo pressionando Esc.
Modo Visual permite que você selecione texto em um documento. A maioria dos comandos do Modo Normal são também válidos neste modo. Você pode entrar nele pressionando
v
para selecionar caracteres ouV
para selecionar linhas.Modo Inserção permite que você edite o documento diretamente. Você pode entrar nele pressionando
i
ou um dos vários comandos listados abaixo.O Modo Comando invoca a linha de comando do KatePart, permitindo que você execute muitos dos comandos disponíveis nas implementações do Vi bem como alguns específicos do KatePart. Para mais informações sobre estes comandos, veja “A Linha de Comando do Componente de Edição”. Para usá-lo, pressione :, insira o comando e pressione Enter.
O Modo Visual é ativado automaticamente quando o texto é selecionado com o mouse. Isto é também ativado ao usar funções do Kate que selecionam texto, como a Selecionar tudo (por meio do menu ou usando o Ctrl+A).
As marcas do Vi e os favoritos do Kate são integrados. Quando uma marca é criada no Modo Vi, um favorito correspondente no Kate é criado e aparece no menu . Do mesmo modo, quando um favorito do Kate é criado, uma marca correspondente do Vi na coluna 0 é também criada.
| Entra no Modo Inserção; adiciona após o cursor |
| Entra no Modo Inserção; adiciona após a linha |
| Entra no Modo Inserção; insere antes do cursor |
Inserir | Entra no Modo Inserção; insere antes do cursor |
| Entra no Modo Inserção; insere antes do primeiro caracter não-vazio da linha |
| Entra no Modo Inserção; insere antes do cursor, deixando o último modo de inserção |
| Entra no Modo Visual; seleciona caracteres |
| Entra no Modo Visual; seleciona linhas |
Ctrl+v | Entra no Modo Visual; seleciona blocos |
| Entra no Modo Visual; seleciona novamente a última seleção |
| Abre uma nova linha abaixo da linha atual |
| Abre uma nova linha acima da linha atual |
| Junta linhas |
| Muda: seguido de um deslocamento para excluir e entrar no Modo Inserção |
| Muda até o final da linha: Exclui até o final da linha e entre na Modo Inserção |
| Muda a linha: Exclui a linha e entre no Modo Inserção |
| Substitui caractere |
| Substitui linha |
| Excluir linha |
| Seguido de deslocamento para excluir |
| Exclui até o fim da linha |
| Exclui caractere à direita do cursor |
Excluir | Exclui caractere à direita do cursor |
| Exclui caractere à esquerda do cursor |
| Seguido com um deslocamento para transformar em minúsculas |
| Transforma a linha atual em minúsculas |
| Seguido de um deslocamento para tornar maiúsculas |
| Transforma a linha atual em maiúsculas |
| Seguido de um deslocamento para copiar (do termo em inglês “yank” |
| Copia (do termo em inglês) a linha |
| Copia (do termo em inglês) a linha |
| Colar após o cursor |
| Colar antes do cursor |
| Colar após o cursor com recuo |
| Colar antes do cursor com recuo |
| Seguido de um caractere para substituir o caractere após o cursor |
| Entra no modo Substituição |
| Entra no Modo Comando |
| Procurar |
| Desfazer |
Ctrl+R | Refazer |
| Refazer |
| Definir marcador (pode ser usado por deslocamentos mais tarde) |
| Localizar próxima |
| Localizar anterior |
| Recuar linha |
| Remover recuo da linha |
| Recuar linhas |
| Remover recuos da linhas |
Ctrl+F | Página abaixo |
Ctrl+B | Página acima |
| Imprimir o valor ASCII do caractere |
| Repetir última mudança |
| comandoAlinharLinha |
| comandoAlinharLinhas |
| Muda a caixa (maiúscula ou minúscula) do caractere atual |
Ctrl+S | Dividir visão horizontalmente |
Ctrl+V | Dividir visão verticalmente |
Ctrl+W, | Próxima divisão da janela |
Ctrl+W, Ctrl+W Esquerda | Ir para a divisão da janela à esquerda |
Ctrl+W, Ctrl+W Direita | Ir para a divisão da janela à direita |
Ctrl+W, Ctrl+W Acima | Ir para a divisão da janela acima |
Ctrl+W, Ctrl+W Abaixo | Ir para a divisão da janela abaixo |
As teclas a seguir podem ser usadas para mover-se em um documento no modo Normal ou Visual, ou em conjunção com um dos comandos acima. Elas podem ser precedidas por um número, que indica quantas vezes o referido movimento será feito.
| Esquerda |
Esquerda | Esquerda |
Backspace | Esquerda |
| Abaixo |
Abaixo | Abaixo |
| Acima |
Acima | Acima |
| Direita |
Direita | Direita |
Espaço | Direita |
| Fim da linha |
End | Fim da linha |
| Primeiro caractere da linha (Coluna 0) |
Início | Primeiro caractere da linha |
| Primeiro caractere não vazio da linha |
| Seguido pelo caractere para mover para direita do cursor |
| Seguido pelo caractere para mover para esquerda do cursor |
| Seguido pelo caractere para mover para direita do cursor, colocando o cursor no caractere antes dele |
| Seguido pelo caractere para mover para esquerda do cursor, colocando o cursor no caractere antes dele |
| Primeira linha |
| Última linha |
| Próxima palavra |
| Próxima palavra separada por espaço em branco |
| Palavra anterior |
| Palavra anterior separada por espaço em branco |
| Fim da palavra |
| Fim da palavra separada por espaço em branco |
| Fim da palavra anterior |
| Fim da palavra anterior separada por espaço em branco |
| Seguido de um número de coluna para mover para esta coluna |
| Seguido por um item para mover para este item |
| Marca |
| Marca o primeiro caractere não em branco da linha |
| Colchete de abertura anterior |
| Próximo colchete de abertura |
| Colchete de fechamento anterior |
| Próximo colchete de fechamento |
Ctrl+I | Saltar para a próxima localização |
Ctrl+O | Saltar para a localização anterior |
| Ir para a primeira linha da tela |
| Ir para a linha do meio da tela |
| Ir para a última linha da tela |
| Ir para a porcentagem especificada do documento |
| Ir para a linha visualmente acima (quando usar a quebra de linha dinâmica) |
| Ir para a linha visualmente abaixo (quando usar a quebra de linha dinâmica) |
Ctrl+Esquerda | Move para uma palavra à esquerda |
Ctrl+Direita | Move para uma palavra à direita |
Estes objetos podem ser usados para selecionar determinadas porções de um documento.
| Palavra interna: palavra incluindo espaços em branco |
| Uma palavra: palavra excluindo espaços em branco |
| Aspas duplas ( |
| Aspas duplas ( |
| Aspas simples ( |
| Aspas simples ( |
| Parênteses de abertura [ |
| Parênteses de abertura [ |
| Colchete de abertura ( |
| Colchete de abertura ( |
| Colchete de abertura ( |
| Parênteses de abertura ( |
| Divisa de abertura ( |
| Divisa de abertura ( |
| Apóstrofo anterior ( |
| Apóstrofo anterior ( |
Ctrl+D | Retirar recuo |
Ctrl+T | Recuar |
Ctrl+E | Inserir abaixo |
Ctrl+Y | Apagar palavra |
Ctrl+W | Apagar palavra |
Ctrl+U | Excluir linha |
Ctrl+J | Nova linha |
Ctrl+H | Apaga o caractere atrás |
Ctrl+Home | Move para o primeiro caractere no documento |
Ctrl+R | Inserir o conteúdo do registro n |
Ctrl+O, | Entrar no modo normal somente para um comando |
Ctrl+A | Incrementar o número atualmente selecionado |
Ctrl+X | Decrementar o número atualmente selecionado |
Este objeto está faltando no Vim. O objeto de texto vírgula torna mais fácil modificar listas de parâmetros em linguagens no estilo C e outras listas separadas por vírgula. Isto é basicamente a área entre duas vírgulas ou entre uma vírgula e um colchete. Na linha mostrada na ilustração, os três intervalos que este objeto de texto pode ter são realçados.

Índice
Este Apêndice contém uma breve mas suficiente introdução sobre o mundo das expressões regulares. Ele documenta expressões regulares na forma disponível dentro do KatePart, que não é compatível com as expressões regulares do Perl, ou de outros comandos como o grep.
As Expressões Regulares nos fornecem uma maneira de descrever alguns possíveis conteúdos de uma string de texto, de modo a ser entendido por um pedaço de software, e assim, ele pode investigar se um texto combina, e também no caso de aplicativos avançados, com o objetivo de salvar pedaços ou o texto que combina com a busca.
Um exemplo. Digamos que você deseja buscar, em um texto, por parágrafos que iniciam com um desses nomes: “Henrik” ou“Pernille ”, seguido por alguma forma do verbo “dizer”.
Com uma pesquisa normal, você iria começar a procurar pelo primeiro nome, “Henrique”, sendo talvez seguido de “di”, como o seguinte: Henrique di
e, enquanto procura por ocorrências, iria ignorar os que não se encontram no início de um parágrafo, assim como os que têm uma palavra que começa por “di” que não é “diz”, “disse” ou algo do gênero. Claro, e ainda ter que repetir isto com o próximo nome...
Com as Expressões Regulares, aquela tarefa poderia ser cumprida com uma única busca, e com um grau maior de precisão.
Para obter isto, as Expressões Regulares definem regras para expressar em detalhes uma generalização de uma string que será procurada. Podemos literalmente expressar nosso exemplo assim: “ Uma linha iniciada com ‘Henrik’ ou ‘Pernille’ (possivelmente seguido por 4 caracteres em branco ou tabs) seguido por um espaço em branco, seguido por um ‘di’ e então, um ‘iz’ ou ‘sse’”, que poderia ser colocado na seguinte expressão regular:
^[ \t]{0,4}(Henrik|Pernille) di(sse|z)
O exemplo anterior demonstra todos os quatro conceitos principais das Expressões Regulares modernas, chamados:
Padrões
Afirmações
Quantificadores
Referências para trás
O acento circunflexo (^
) no início da expressão é uma afirmação, sendo verdade somente se a string relacionada estiver no início de uma linha.
As strings [ \t]
e (Henrik|Pernille) di(sse|z)
são padrões. A primeira é uma classe de caractere que combina ou com um espaço em branco ou com um caractere de tabulação (horizontal); o outro padrão contém primeiramente um subpadrão que combina ou com Henrik
ou com Pernille
. Em seguida, vem um pedaço que corresponde exatamente com a string di
e, finalmente segue um subpadrão que combina com sse
ou com z
.
A string {0,4}
é um quantificado dizendo “qualquer número de 0 até 4 da string anterior”.
Por causa do suporte ao conceito de referência para trás das expressões regulares, é economizado uma parte inteira combinada da string, bem como os subpadrões incluídos em parênteses; fornecidos alguns tipos de acesso para aquelas referências, podemos obter nossos meios de encontrar a string inteira (ao se procurar um documento de texto em um editor com uma expressão regular, o que é marcado frequentemente) ou o nome encontrado, ou a última parte do verbo.
Toda junta, a expressão procurará o que você desejar que ela procure, e somente ali.
As seções seguintes descreverão em detalhes como construir e usar padrões, classes de caracteres, afirmações, quantificadores e referências para trás, e a seção final fornecerá alguns exemplos úteis.

Padrões consistem de strings literais e classes de caracteres, e podem conter subpadrões, que são padrões cercados por parênteses.
Em padrões, bem como em classes de caracteres, alguns caracteres possuem um significado especial. Para combinar literalmente quaisquer um destes caracteres, eles devem ser marcados ou escapados, para deixar com que o software saiba que deve interpretar tais caracteres de maneira literal.
Isto é feito anexando no início do caractere uma barra invertida (\
).
O software de expressão regular silenciosamente ignorará, escapando um caractere que não possui nenhum significado especial no contexto; assim, escapar, por exemplo, um “j” (\j
) é seguro. Se você tiver dúvidas se um caractere possui significado especial, você pode, portanto, escapá-lo seguramente.
A marcação inclui o próprio caractere de barra; por isso, para escapar uma barra, você deveria escrever \\
.
Uma classe de caractere é uma expressão que combina um dos caracteres de um conjunto definido. Em Expressões Regulares, as classes de caracteres são definidas colocando-se os caracteres legais em uma classe com colchetes ([]
), ou usando uma das classes abreviadas descritas abaixo.
Classes de caracteres simples contém um ou mais caracteres literais, como por exemplo [abc]
(combinando com uma das letras: “a”, “b” ou “c”) ou [0123456789]
(combinando com qualquer dígito).
Uma vez que as letras e os números possuem uma ordem lógica, você poderá abreviá-los, definindo para isso intervalos: [a-c]
é igual a [abc]
e [0-9]
é igual a [0123456789]
. Combinar estas opções, por exemplo [a-fynot1-38]
é perfeitamente possível (a última classe irá corresponder a um dos seguintes caracteres: “a”,“b”,“c”,“d”, “e”,“f”,“y”,“n”,“o”,“t”, “1”,“2”,“3” ou “8”).
Como as letras maiúsculas são diferentes de minúsculas em expressões, para criar uma classe de caracteres que não diferenciasse maiúsculas de minúsculas, combinando por exemplo com “a” ou “b”, em qualquer caso, você precisaria escrever [aAbB]
.
Obviamente, é possível criar uma classe “negativa” que corresponda a “tudo exceto”. Para fazer isso, coloque um acento circunflexo (^
) no início da classe:
[^abc]
combinará com qualquer caractere menos com “a”, “b” ou “c”.
Além disso, para caracteres literais, algumas abreviações são definidas, tornando a vida um pouco mais fácil:
\a
Isto combina com o caractere ASCII da campainha (BEL, 0x07).
\f
Isto combina com o caractere ASCII de nova página (FF, 0x0C).
\n
Isto combina com o caractere ASCII de nova linha (LF, 0x0A, nova linha do Unix).
\r
Isto combina com o caractere ASCII de retorno de carro (CR, 0x0D).
\t
Isto combina com o caractere ASCII de tabulação horizontal (HT, 0x09).
\v
Isto combina com o caractere ASCII de tabulação vertical (VT, 0x0B).
\xhhhh
Isto combina com o caractere Unicode correspondente ao número hexadecimal hhhh (entre 0x0000 e 0xFFFF). \0ooo (isto é, \zero ooo) combina com o caractere ASCII/Latin-1 correspondente ao número octal ooo (entre 0 e 0377).
.
(ponto)Isto combina com qualquer caractere (incluindo nova linha).
\d
Isto combina com um dígito. É igual a
[0-9]
\D
Isto combina com um caractere que não seja dígito. Igual a
[^0-9]
ou[^\d]
\s
Isto combina com um caractere em branco. Praticamente igual a
[\t\n\r]
\S
Combina com o que não seja espaço em branco. Praticamente igual a
[^\t\r\n]
, e igual a[^\s]
\w
Combina com quaisquer “caractere da palavra”, neste caso quaisquer letras ou dígitos. Note que o caractere de sublinhado (ou underscore -
_
) não combina, como é o caso com expressões regulares do Perl. Igual a[a-zA-Z0-9]
\W
Combina com qualquer caractere diferente de palavra - qualquer coisa menos letras ou números. Igual a
[^a-zA-Z0-9]
ou[^\w]
As classes abreviadas pode ser colocadas dentro de classes personalizadas, como por exemplo: para combinar um caractere de palavra, um em branco ou um ponto, você poderia escrever [\w\.]
Nota
A notação POSIX de classes, [:<nome da classe>:]
, atualmente não é suportada.
Os seguintes caracteres possuem um significado especial dentro da construção “[]” de classes de caractere, e deve ser escapado para ser literalmente incluído em uma classe:
]
Finaliza a classe. Deve ser escapado, a menos que este caractere seja o primeiro da classe (pode ser seguido por um circunflexo não-escapado)
^
(circunflexo)Denota uma classe negativa, se for o primeiro caractere. Deve ser escapado para combinar literalmente, se for o primeiro caractere da classe.
-
(hífen)Denota um intervalo lógico. Deve sempre ser escapado dentro de uma classe.
\
(barra invertida)O caractere de escape. Deve sempre ser escapado.
Se você deseja combinar um de um conjunto de padrões alternativos, pode separá-los com o caractere de barra vertical: |
Por exemplo: para encontrar a palavra “John” ou a palavra “Harry”, você usaria uma expressão do tipo John|Harry
.
Subpadrões são padrões fechados entre parênteses, e possuem vários usos no mundo das expressões regulares.
Você pode usar subpadrões para agrupar um conjunto de alternativas dentro de um padrão maior. As alternativas são separadas pelo caractere “|” (barra vertical).
Por exemplo: Para procurar uma das palavras “int”, “float” ou “double”, você poderia usar o padrão int|float|double
. Se você deseja somente encontrar delas, se for seguida por algum espaço em branco e então algumas letras, coloque as alternativas dentro de um subpadrão: (int|float|double)\s+\w+
.
Se você deseja usar uma referência anterior, use um subpadrão para ter a parte desejada do padrão lembrada.
Por exemplo: Se você deseja encontrar duas ocorrências da mesma palavra, separadas por vírgula, e possivelmente algum espaço em branco, poderia escrever: (\w+),\s*\1
. O subpadrão \w+
procuraria pelo pedaço dos caracteres da palavra, e a expressão inteira combinaria se aquelas forem separadas por uma vírgula, 0 ou mais espaços em branco, e então, um pedaço igual de caracteres da palavra (a string \1
referencia o primeiro subpadrão entre os parênteses).
Uma afirmação do tipo adiante é um subpadrão, iniciando com ?=
ou ?!
.
Por exemplo: para combinar a string literal “Bill”, mas somente seguida por “ Gates”, você poderia usar esta expressão: Bill(?! Gates)
(isto procuraria por “Bill Clinton”, bem como por “Billy the kid”, mas ele silenciosamente ignoraria as outras combinações).
Os subpadrões usados para as afirmações não são capturados.
Veja também em Afirmações
Os seguintes caracteres possuem um significado especial dentro de um padrão, e devem ser escapados, caso você deseje procurá-los literalmente:
\
(barra invertida)O caractere de escape.
^
(circunflexo)Combina com o início da string.
$
Combina com o fim da string.
()
(parênteses esquerdo e direito)Denota subpadrões.
{}
(abre e fecha chaves)Denota quantificadores numéricos.
[]
(abre e fecha colchetes)Denota classes de caracteres.
|
(barra vertical)OR lógico. Alternativas separadas.
+
(sinal de mais)Quantificador, 1 ou mais.
*
(asterisco)Quantificador, 0 ou mais.
?
(ponto de interrogação)Um caractere opcional. Pode ser interpretado como um quantificador, 0 ou 1.

Quantificadores permitem que uma expressão regular combine dentro de um número especificado ou de um intervalo de números, com um caractere, uma classe de caracteres ou um subpadrão.
Os quantificadores estão dentro de chaves ({
e }
), e possuem como forma geral: {[mínimo-ocorrências][, [máximo-ocorrências]]}
O uso é melhor explicado através do exemplo:
{1}
Exatamente 1 ocorrência
{0,1}
Zero ou 1 ocorrência
{,1}
O mesmo, mas com menos trabalho ;)
{5,10}
No mínimo 5 e no máximo 10 ocorrências.
{5,}
No mínimo 5 ocorrências, sem máximo.
Adicionalmente, existe algumas abreviações:
*
(asterisco)igual a
{0,}
, procura por quaisquer número de ocorrências.+
(sinal de mais)similar a
{1,}
, no mínimo 1 ocorrência.?
(ponto de interrogação)similar a
{0,1}
, zero ou 1 ocorrência.
Ao usar os quantificadores sem máximo, as expressões regulares padronizam a combinação para o mais próximo da string procurada possível, comumente conhecido como comportamento guloso.
O software moderno de expressões regulares fornece o chamado “desligamento” do modo 'guloso', embora em um ambiente gráfico a interface fornece a você o acesso a isto. Por exemplo, um diálogo de busca, fornecendo a busca para uma expressão regular, poderia ter uma caixa chamada “Combinação Mínima”, bem como indicar se o 'modo guloso' é o comportamento padrão.
Aqui estão alguns exemplos do uso de quantificadores
^\d{4,5}\s
Combina com os dígitos em “1234 ir” e “12345 agora,” mas não combina com “567 sete” nem com “223459 algum local”
\s+
Combina uma ou mais vezes com caracteres de espaço em branco
(bla){1,}
Combina com todos os “blablabla”, e com “bla” em “blackbird” ou “tabla”
/?>
Combina com “/>” em “<fecharitem/>” bem como com “>” em “<abriritem>”.

Afirmações permitem que uma expressão regular combine com certas condições controladas.
Uma afirmação não precisa de um caractere para combinar, e em vez disso ela investiga as adjacentes de uma possível combinação, antes de conhecê-la. Por exemplo: a afirmação limite da palavra não tenta encontrar um caractere que não seja da palavra, oposto de uma palavra em sua posição, e ao invés disso, ele certifica-se de que não existe um caractere da palavra. Isto significa que a afirmação pode combinar onde não existe caractere, isto é, no final de uma string procurada.
Algumas verificações, de fato, possuem um padrão de correspondência, mas a parte do texto que correspondeu não será uma parte do resultado da correspondência, em relação à expressão completa.
As Expressões Regulares, como documentadas aqui, suportam as seguintes afirmações:
^
(circunflexo: início de string)Combina com o início da string procurada.
A expressão
^Peter
combinará com “ Peter” na string “Peter, ei!”, mas não com “Ei, Peter!”$
(final da string)Combina com o fim da string procurada.
A expressão
você\?$
combinará com o 'você' no final da string “É isto que deseja para você?”, mas não combinará com “É isto que deseja para você, certo?”\b
(limite da palavra)Combina se existir um caractere da palavra, mas não combina com o caractere de outra.
Isto é útil para encontrar finais de palavras, como por exemplo, finais para encontrar uma expressão inteira. A expressão
\bem\b
procurará separado por “em” na string “Ele estava em prantos no embarque”, mas não combinará, por exemplo, com o “em” de “ embarque”.\B
(sem limite de palavra)Combina com tudo que “\b” não combina.
Isto significa que ele combinará com string dentro de palavras. A expressão
\Em\B
combinará com “embarque” mas não com “Ele estava em prantos”.(?=PADRÃO)
(adiante positivo)Uma afirmação adiante olha na parte da string seguinte, como uma possível combinação. O 'adiante positivo' prevenirá a string de combinação, se o texto seguinte não combina com o PADRÃO da afirmação, mas o texto combinado não será incluído no resultado.
A expressão
carta(?=\w)
combinará com “carta” em “cartada”, mas não em “O jogador deu uma cartada!”(?!PADRÃO)
(adiante negativo)O 'adiante negativo' previne que uma possível combinação seja de conhecimento, se a seguinte parte da string buscada não combina com seu PADRÃO.
A expressão
const \w+\b(?!\s*&)
combinará com “const char” na string “const char* foo ” enquanto que não combinará “const QString” em “const QString& bar”, pois o “& ” combina com o padrão de afirmação negativo.