[[PageOutline(2-5,Contents,pullout)]] = Wiki pages FreeBSD handbook style == Description This page offers a series of tweaks and tricks to have your wiki pages look like the [https://www.freebsd.org/doc/handbook/ FreeBSD handbook and articles]. Key features: * Man page linking * Syntaxing of files and code snippets * Information and Warning fields For example, suppose the following markup is added to your wiki page: = 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 alerting your users of total disaster }}} This will be displayed as follows with this plugin: [[Image(example-freedoc.png)]] == Bugs/Feature Requests Existing bugs and feature requests for FreeDocPlugin are [report:9?COMPONENT=FreeDocPlugin here]. If you have any issues, create a [/newticket?component=FreeDocPlugin new ticket]. [[TicketQuery(component=FreeDocPlugin&group=type,format=progress)]] == Download Download the zipped source from [export:freedocplugin here]. == Source You can check out FreeDocPlugin from [/svn/freedocplugin here] using Subversion, or [source:freedocplugin browse the source] with Trac. == Installation 1. Download from [export:freedocplugin here] and unzip it. 1. Build like a general egg, for Trac version 0.11 use: {{{#!sh $ cd freedocplugin/0.11 $ python setup.py bdist_egg }}} 1. Copy the egg in your {{{plugins}}} by either uploading it using the admin panel. Or copy it on the command line. 1. Enable this plugin in your `trac.ini` file as follows: {{{#!ini [components] freedoc.* = enabled }}} 1. Restart/reload your webserver if running mod_python, mod_fsgi or something similar. == Recent Changes [[ChangeLog(freedocplugin, 3)]] == Author/Contributors '''Author:''' [wiki:rickvanderzwet] [[BR]] '''Maintainer:''' [[Maintainer]] [[BR]] '''Contributors:'''