wiki:FreeDocPlugin

Context Navigation

Version 3 (modified by RIck van der Zwet, 14 years ago) (diff)
--

Wiki pages FreeBSD handbook style

Description

Tweaks and tricks to have your wiki pages look like the FreeBSD handbook and articles. Included but not to limited:

Man page linking
Syntaxing of files and code snippets
Information and Warning fields

Bugs/Feature Requests

Existing bugs and feature requests for FreeDocPlugin are here.

If you have any issues, create a new ticket.

Download

Download the zipped source from [download:freedocplugin here].

Source

You can check out FreeDocPlugin from here using Subversion, or browse the source with Trac.

Installation

Download from [download:freedocplugin here]
Install plugin by uploading to your plugins directory
Enable in your trac.ini, by adding freedoc.* = enabled to your [components] section. Like this:
```
[components]
freedoc.* = enabled
```
Restart/reload your webserver if running some kind of mod_python, mod_fsgi or something like it.
Enjoy!

Example

example(1)

To link to a certain man page use syntax like sshd(8) or nc(1)

 1. After every colon at the end of the line there will be an automagic return:
   example# have your commands detected and formatted in pre
   of course you could also use the non-root variant:
   example$ echo "{{{ preserve command syntax till end of line }}}";
 1. Use a somehow more simple *bold* tag
  Note: Will alert your readers to be careful by a drawing the attention using a grey box
 1. Linking to file:README or dir:/usr/local/etc will automatically syntax it.

Important: Will draw a big fat warning altering your users of total disaster