Version 6 (modified by 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] and unzip it
- Build like a general egg, for Trac version 0.11 use:
$ cd freedocplugin/0.11 $ python setup.py bdist_egg
- Copy the egg in your
plugins
by either uploading it using the admin panel. Or copy it on the command line. - 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 alerting your users of total disaster
Recent Changes
- 17022 by rickvanderzwet on 2018-01-17 20:14:19
-
Margin of list had wrong offset
- 15351 by rickvanderzwet on 2016-02-21 18:55:19
-
Support of csh style user prompts.
- 15264 by rjollos on 2016-02-11 04:22:34
-
Remove unnecessary svn:mime-type on py files
svn:mime-type was set to "plain" for many files.
(more)
Author/Contributors
Author: rickvanderzwet
Contributors:
Attachments (1)
-
example-freedoc.png (54.8 KB) - added by 14 years ago.
Rendered example output
Download all attachments as: .zip