if has("autocmd") au BufNewFile,BufRead *.sgml,*.ent,*.xsl,*.xml call Set_SGML() au BufNewFile,BufRead *.[1-9] call ShowSpecial() endif " has(autocmd) function Set_Highlights() "match ExtraWhitespace /^\s* \s*\|\s\+$/ highlight default link OverLength ErrorMsg match OverLength /\%71v.\+/ return 0 endfunction " Set_Highlights() function ShowSpecial() setlocal list listchars=tab:>>,trail:*,eol:$ hi def link nontext ErrorMsg return 0 endfunction " ShowSpecial() function Set_SGML() setlocal number syn match sgmlSpecial "&[^;]*;" setlocal syntax=sgml setlocal filetype=xml setlocal shiftwidth=2 setlocal textwidth=70 setlocal tabstop=8 setlocal softtabstop=2 setlocal formatprg="fmt -p" setlocal autoindent setlocal smartindent " Rewrap paragraphs noremap P gqj " Replace spaces with tabs noremap T :s/ /\t/<CR> call ShowSpecial() call Set_Highlights() return 0 endfunction " Set_SGML()
Capítulo 12. Configuração do Editor
Índice
Ajustar a configuração do editor de texto pode tornar o trabalho nos arquivos da documentação mais rápido e fácil, além de ajudar os documentos a ficarem em conformidade com as diretrizes do projeto.
12.1. Vim
Instale-o a partir de editors/vim, editors/vim-console, ou editors/vim-tiny e siga as instruções de configuração em Configuração.
12.1.1. Uso
Pressione P tpara reformatar parágrafos ou texto selecionado no modo Visual. Pressione T para substituir grupos de oito espaços por um tab.
12.1.2. Configuração
Edite o ~/.vimrc, adicionando estas linhas ao final do arquivo:
12.2. Emacs
Instale-o a partir de editors/emacs ou editors/emacs-devel.
12.2.1. Validação
O modo nxml do Emacs usa esquemas NG relax compacto para validar o XML. Um esquema NG relax compacto para a extensão do FreeBSD para DocBook 5.0 está incluído no repositório de documentação. Para configurar o modo nxml para validar usando este esquema, crie ~/.emacs.d/schema/schemas.xml e adicione estas linhas ao arquivo:
locatingRules xmlns="http://thaiopensource.com/ns/locating-rules/1.0" documentElement localName="section" typeId="DocBook" documentElement localName="chapter" typeId="DocBook" documentElement localName="article" typeId="DocBook" documentElement localName="book" typeId="DocBook" typeId id="DocBook" uri="/usr/local/share/xml/docbook/5.0/rng/docbook.rnc" locatingRules
12.2.2. Revisão Automatizada com Flycheck e Igor
O pacote Flycheck está disponível no Emacs Lisp Package Archive da Milkypostman (MELPA). Se a MELPA ainda não estiver nos repositórios de pacotes do Emacs, ele pode ser adicionado executando
(add-to-list 'package-archives '("melpa" . "http://stable.melpa.org/packages/") t)
Adicione a linha ao arquivo de inicialização do Emacs (qualquer um deles, ~/.emacs, ~/.emacs.el, ou ~.emacs.d/init.el) para tornar esta alteração permanente.
Para instalar o Flycheck, execute
(package-install 'flycheck)
Crie um verificador Flycheck para textproc/igor executando
(flycheck-define-checker igor "FreeBSD Documentation Project sanity checker. See URLs https://www.freebsd.org/docproj/ and http://www.freshports.org/textproc/igor/." :command ("igor" "-X" source-inplace) :error-parser flycheck-parse-checkstyle :modes (nxml-mode) :standard-input t) (add-to-list 'flycheck-checkers 'igor 'append)
Novamente, adicione essas linhas ao arquivo de inicialização do Emacs para tornar as mudanças permanentes.
12.2.3. Configurações Específicas da Documentação do FreeBSD
Para aplicar configurações específicas para o projeto de documentação do FreeBSD, crie o arquivo .dir-locals.el no diretório raiz do repositório de documentação e adicione estas linhas ao arquivo:
;;; Directory Local Variables ;;; For more information see (info "(emacs) Directory Variables") ((nxml-mode (eval . (turn-on-auto-fill)) (fill-column . 70) (eval . (require 'flycheck)) (eval . (flycheck-mode 1)) (flycheck-checker . igor) (eval . (add-to-list 'rng-schema-locating-files "~/.emacs.d/schema/schemas.xml"))))
12.3. nano
Instale o aplicativo partir de editors/nano ou editors/nano-devel.
12.3.1. Configuração
Copie o arquivo com a amostra da regra para realce da sintaxe XML para o diretório inicial do usuário:
% cp /usr/local/share/nano/xml.nanorc ~/.nanorc
Use um editor para substituir as linhas do ~/.nanorc referentes ao bloco syntax "xml"
por estas regras:
syntax "xml" "\.([jrs]html?|xml|xslt?)$" # trailing whitespace color ,blue "[[:space:]]+$" # multiples of eight spaces at the start a line # (after zero or more tabs) should be a tab color ,blue "^([TAB]*[ ]{8})+" # tabs after spaces color ,yellow "( )+TAB" # highlight indents that have an odd number of spaces color ,red "^(([ ]{2})+|(TAB+))*[ ]{1}[^ ]{1}" # lines longer than 70 characters color ,yellow "^(.{71})|(TAB.{63})|(TAB{2}.{55})|(TAB{3}.{47}).+$"
Processe o arquivo para criar guias incorporadas:
% perl -i'' -pe 's/TAB/\t/g' ~/.nanorc
12.3.2. Uso
Especifique opções úteis adicionais ao executar o editor:
% nano -AKipwz -r 70 -T8 _index.adoc
Usuários do csh(1) podem definir um alias em ~/.cshrc para automatizar estas opções:
alias nano "nano -AKipwz -r 70 -T8"
Depois que o alias é definido, as opções serão adicionadas automaticamente:
% nano _index.adoc
Última alteração em: 6 de fevereiro de 2022 por Danilo G. Baio