Help:Style Guidelines

From FreeBSDwiki
Jump to: navigation, search

The KISS principle

FreeBSD administration is a huge and overarching topic. But the goal of this wiki is to make it accessible, and accessibility means taking it in short and sweet bites - so wherever possible, try to keep your articles short; no more than one or two screen-pages. If that seems impossible, consider breaking your article down into sub-articles - for example, if you're writing an article about securing a server in an internet context, don't go into how to set up an IPFW firewall inside that article, instead link to an IPFW how-to when you get to that point.

Use Section markup tools for complex topics

In some cases - for example, an article on how to set up a Samba server from scratch - it's impossible to keep the overall article length down to a mere screen or two of text. There's just too much to cover, and it really doesn't lend itself well to multiple articles. When you have this type of content to cover, and multiple articles don't make sense, use Section markup! Not only will they automatically make your section titles nice and bold, any article with more than three Sections will also automatically get a hyperlinked table of contents at the head of the article itself. To use Sections, simply type a single line beginning and ending with ==, like this:

==This is an example of a Section line.==

This is how the article you're reading right now is formatted.

Text highlighting guidelines

When showing an interactive console session, please use a leading space in front of every line (to put the session in a little "box" in the article when it renders) and use the triple-singlequote (''') wikitag to bold user-entered text. For example:

ph34r# this is what a console session should look like on the BSDwiki.
this: Command not found.

The leading space can also be used for code from console output, and file contents.

exec xorg</nowiki>
#This text is commented out

Here are templates for adding clarity to text. Templates need <nowiki> tags to properly display special characters.

  • For commandline text within paragraphs use {{cmd|kldstat -v}} to produce kldstat -v.
  • For code console output or file contents use {{code|:Command not found.}} for :Command not found..
  • Displaying files and directories use the same code, but end directory descriptions in "/". {{file|/usr/local/etc/}} produces /usr/local/etc/ for directories. {{file|/etc/rc.conf}} produces /etc/rc.conf for files.
  • {{port|ftp/curl|BSD}} produces ftp/curl BSD for ports in ports-tree, and optionally it's licence. It links to the port's page on, if it exists.
  • {{man|kldstat|8}} produces kldstat(8). {{man|kldstat}} produces kldstat().
  • For yellow highlighting of types of text not mentioned here, use {{yhl|look at this!}} for look at this!.
Personal tools