wiki:FreeDocPlugin

Wiki pages FreeBSD handbook style

Description

This page offers a series of tweaks and tricks to have your wiki pages look like the FreeBSD handbook and articles.

Key features:

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

enhancement

0 / 1

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 this plugin in your trac.ini file by adding freedoc.* = enabled to your [components] section:
    [components]
    freedoc.* = enabled
    
  5. Restart/reload your webserver if running mod_python, mod_fsgi or something similar.

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

15351 by rickvanderzwet on 2016-02-21 19:55:19
Support of csh style user prompts.
15264 by rjollos on 2016-02-11 05:22:34
Remove unnecessary svn:mime-type on py files

svn:mime-type was set to "plain" for many files.

13787 by rickvanderzwet on 2014-03-22 15:50:50
Updating dev script to match new location and make more generic
(more)

Author/Contributors

Author: rickvanderzwet
Maintainer: RIck van der Zwet
Contributors:

Last modified 13 months ago Last modified on Nov 24, 2015, 10:15:53 AM

Attachments (1)

Download all attachments as: .zip