wiki:FreeDocPlugin

Version 6 (modified by otaku42, 5 years ago) (diff)

Minor formatting fix

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 here.

Source

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

Installation

  1. Download from here and unzip it
  2. Build like a general egg, for Trac version 0.11 use:
    $ cd freedocplugin/0.11
    $ python setup.py bdist_egg
    
  3. Copy the egg in your plugins by either uploading it using the admin panel. Or copy it on the command line.
  4. Enable in your trac.ini, by adding freedoc.* = enabled to your [components] section. Like this:
    [components]
    freedoc.* = enabled
    
  5. Restart/reload your webserver if running some kind of mod_python, mod_fsgi or something like it.
  6. 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 

Rendered example output

Recent Changes

[13787] by rickvanderzwet on 2014-03-22 15:50:50
Updating dev script to match new location and make more generic
[10648] by rickvanderzwet on 2011-09-10 11:32:32
Fix formatting of unordered list.
[9271] by rickvanderzwet on 2010-10-08 12:41:39
Seems to ignore the CaSe flag in new python/trac. This hack will do

Author/Contributors

Author: rickvanderzwet
Contributors:

Attachments (1)

Download all attachments as: .zip