List of whitespace rules

Manolis Kiagias sonicy at otenet.gr
Sun Jun 15 00:13:59 EEST 2008


This is the list of whitespace / formatting rules for SGML files:

- Lines break at 78 cols (with few notable exceptions)
- There should be no spaces at the end of lines
- Eight spaces ==> 1 tab (beginning of lines, exclude <screen> tags)
- Splitting <ulink> in two lines: Should happen before 'url=' and next 
line should be indented by two spaces
- Closing </para> tags should not be preceded by a space (or newline). 
If required the word before </para> should move to the next line along 
with the tag to maintain rule 1.
- Completely blank lines should only contain a newline and no extra 
spaces (these are easy to miss when checking)
- Formatting: Elements at the same level separated by newlines. Elements 
at different levels are indented.
- New files should contain a $FreeBSD$ tag

Add any more you can think of ;)




More information about the Freebsd-doc-el mailing list