The translation is temporarily closed for contributions due to maintenance, please come back later.

Source string Read only

(itstool) path: sect2/programlisting
Context English State
things that apply to user space, not the kernel
web server
Editor Configuration
Adjusting text editor configuration can make working on document files quicker and easier, and help documents conform to <acronym>FDP</acronym> guidelines.
Install from <package>editors/vim</package>, <package>editors/vim-console</package>, or <package>editors/vim-tiny</package> then follow the configuration instructions in <xref linkend="editor-config-vim-config"/>.
Press <keycap>P</keycap> to reformat paragraphs or text that has been selected in Visual mode. Press <keycap>T</keycap> to replace groups of eight spaces with a tab.
Edit <filename>~/.vimrc</filename>, adding these lines to the end of the file:
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:&gt;&gt;,trail:*,eol:$
hi def link nontext ErrorMsg
return 0
endfunction " ShowSpecial()

function Set_SGML()
setlocal number
syn match sgmlSpecial "&amp;[^;]*;"
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/&lt;CR&gt;
call ShowSpecial()
call Set_Highlights()
return 0
endfunction " Set_SGML()
Install from <package>editors/emacs</package> or <package>editors/emacs-devel</package>.
Emacs's nxml-mode uses compact relax NG schemas for validating XML. A compact relax NG schema for FreeBSD's extension to DocBook 5.0 is included in the documentation repository. To configure nxml-mode to validate using this schema, create <filename>~/.emacs.d/schema/schemas.xml</filename> and add these lines to the file:
<tag class="starttag">locatingRules xmlns=""</tag>
<tag class="starttag">documentElement localName="section" typeId="DocBook"</tag>
<tag class="starttag">documentElement localName="chapter" typeId="DocBook"</tag>
<tag class="starttag">documentElement localName="article" typeId="DocBook"</tag>
<tag class="starttag">documentElement localName="book" typeId="DocBook"</tag>
<tag class="starttag">typeId id="DocBook" uri="/usr/local/share/xml/docbook/5.0/rng/docbook.rnc"</tag>
<tag class="endtag">locatingRules</tag>
Automated Proofreading with Flycheck and Igor
The Flycheck package is available from Milkypostman's Emacs Lisp Package Archive (<acronym>MELPA</acronym>). If <acronym>MELPA</acronym> is not already in Emacs's packages-archives, it can be added by evaluating
(add-to-list 'package-archives '("melpa" . "") t)
Add the line to Emacs's initialization file (one of <filename>~/.emacs</filename>, <filename>~/.emacs.el</filename>, or <filename>~.emacs.d/init.el</filename>) to make this change permanent.
To install Flycheck, evaluate
(package-install 'flycheck)
Create a Flycheck checker for <package>textproc/igor</package> by evaluating
(flycheck-define-checker igor
"FreeBSD Documentation Project sanity checker.

See URLs and"
:command ("igor" "-X" source-inplace)
:error-parser flycheck-parse-checkstyle
:modes (nxml-mode)
:standard-input t)

(add-to-list 'flycheck-checkers 'igor 'append)
Again, add these lines to Emacs's initialization file to make the changes permanent.
FreeBSD Documentation Specific Settings
To apply settings specific to the FreeBSD documentation project, create <filename>.dir-locals.el</filename> in the root directory of the documentation repository and add these lines to the file:
;;; Directory Local Variables
;;; For more information see (info "(emacs) Directory Variables")

(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"))))
Install from <package>editors/nano</package> or <package>editors/nano-devel</package>.
Copy the sample <acronym>XML</acronym> syntax highlight file to the user's home directory:


No matching activity found.

Browse all component changes

Source information

Source string comment
(itstool) path: sect2/programlisting
no-wrap, read-only
Source string location
String age
a year ago
Source string age
a year ago
Translation file
books/fdp-primer.pot, string 1707