| 1 | = Wiki pages FreeBSD handbook style = |
| 2 | |
| 3 | == Description == |
| 4 | |
| 5 | Tweaks and tricks to have your wiki pages look like the FreeBSD handbook and articles. Included but not to limited: |
| 6 | * Man page linking |
| 7 | * Syntaxing of files and code snippets |
| 8 | * Information and Warning fields |
| 9 | |
| 10 | |
| 11 | |
| 12 | == Bugs/Feature Requests == |
| 13 | |
| 14 | Existing bugs and feature requests for FreeDocPlugin are |
| 15 | [report:9?COMPONENT=FreeDocPlugin here]. |
| 16 | |
| 17 | If you have any issues, create a |
| 18 | [http://trac-hacks.org/newticket?component=FreeDocPlugin&owner=rickvanderzwet new ticket]. |
| 19 | |
| 20 | == Download == |
| 21 | |
| 22 | Download the zipped source from [download:freedocplugin here]. |
| 23 | |
| 24 | == Source == |
| 25 | |
| 26 | You can check out FreeDocPlugin from [http://trac-hacks.org/svn/freedocplugin here] using Subversion, or [source:freedocplugin browse the source] with Trac. |
| 27 | |
| 28 | == Example == |
| 29 | |
| 30 | = example(1) = |
| 31 | |
| 32 | {{{ |
| 33 | To link to a certain man page use syntax like sshd(8) or nc(1) |
| 34 | |
| 35 | 1. After every colon at the end of the line there will be an automagic return: |
| 36 | example# have your commands detected and formatted in pre |
| 37 | of course you could also use the non-root variant: |
| 38 | example$ echo "{{{ preserve command syntax till end of line }}}" |
| 39 | 1. Use a somehow more simple *bold* tag |
| 40 | Note: Will alert your readers to be careful by a drawing the attention using a grey box |
| 41 | 1. Linking to file:README or dir:/usr/local/etc will automatically syntax it. |
| 42 | |
| 43 | Important: Will draw a big fat warning altering your users of total disaster |
| 44 | }}} |
| 45 | |
| 46 | == Recent Changes == |
| 47 | |
| 48 | [[ChangeLog(freedocplugin, 3)]] |
| 49 | |
| 50 | == Author/Contributors == |
| 51 | |
| 52 | '''Author:''' [wiki:rickvanderzwet] [[BR]] |
| 53 | '''Contributors:''' |