Changes between Version 10 and Version 11 of FreeDocPlugin


Ignore:
Timestamp:
Dec 12, 2016, 9:10:26 PM (4 years ago)
Author:
figaro
Comment:

Moved example to functional description

Legend:

Unmodified
Added
Removed
Modified
  • FreeDocPlugin

    v10 v11  
    1111 * Syntaxing of files and code snippets
    1212 * Information and Warning fields
     13
     14For example, suppose the following markup is added to your wiki page:
     15
     16= Example(1)
     17
     18{{{
     19To link to a certain man page use syntax like sshd(8) or nc(1)
     20
     21 1. After every colon at the end of the line there will be an automagic return:
     22   example# have your commands detected and formatted in pre
     23   of course you could also use the non-root variant:
     24   example$ echo "{{{ preserve command syntax till end of line }}}";
     25 1. Use a somehow more simple *bold* tag
     26  Note: Will alert your readers to be careful by a drawing the attention using a grey box
     27 1. Linking to file:README or dir:/usr/local/etc will automatically syntax it.
     28
     29Important: Will draw a big fat warning alerting your users of total disaster
     30}}}
     31
     32This will be displayed as follows with this plugin:
     33
     34[[Image(example-freedoc.png)]]
    1335
    1436== Bugs/Feature Requests
     
    3961}}}
    4062 1. Copy the egg in your {{{plugins}}} by either uploading it using the admin panel. Or copy it on the command line.
    41  1. Enable this plugin in your `trac.ini` file by adding {{{freedoc.* = enabled}}} to your {{{[components]}}} section:
     63 1. Enable this plugin in your `trac.ini` file as follows:
    4264    {{{#!ini
    4365[components]
     
    4567}}}
    4668 1. Restart/reload your webserver if running mod_python, mod_fsgi or something similar.
    47 
    48 == Example
    49 
    50 = Example(1)
    51 
    52 {{{
    53 To link to a certain man page use syntax like sshd(8) or nc(1)
    54 
    55  1. After every colon at the end of the line there will be an automagic return:
    56    example# have your commands detected and formatted in pre
    57    of course you could also use the non-root variant:
    58    example$ echo "{{{ preserve command syntax till end of line }}}";
    59  1. Use a somehow more simple *bold* tag
    60   Note: Will alert your readers to be careful by a drawing the attention using a grey box
    61  1. Linking to file:README or dir:/usr/local/etc will automatically syntax it.
    62 
    63 Important: Will draw a big fat warning alerting your users of total disaster
    64 }}}
    65 
    66 [[Image(example-freedoc.png)]]
    6769
    6870== Recent Changes