Changes between Version 17 and Version 18 of ShellExampleMacro


Ignore:
Timestamp:
Jan 17, 2016, 7:12:56 AM (8 years ago)
Author:
figaro
Comment:

Cosmetic changes, tagged with pypi

Legend:

Unmodified
Added
Removed
Modified
  • ShellExampleMacro

    v17 v18  
    55== Description
    66
    7 Wiki Formatter for command line shell examples.
     7This is a wiki processor to display command line shell examples in Trac wiki pages.
    88
    9 This plugin has only been tested on Trac 0.12, but may work with earlier versions.
     9This plugin has only been tested on Trac 0.12, and may work for later versions.
    1010
    1111== Example
    1212
    13 Additional examples are available [http://svn.umtri.umich.edu/trac/bio/wiki/useful/ShellExample/readme here].
     13A typical example might look like this:
     14
    1415{{{
    1516{{{
     
    3435}}}
    3536
    36 Produces output like this: [[BR]]
     37Produces output like this:
    3738
    3839[[Image(ShellExample-example.png)]]
    3940
     41Additional examples are available [http://svn.umtri.umich.edu/trac/bio/wiki/useful/ShellExample/readme here].
     42
    4043== More Details
    4144
    42 This is a [wiki:WikiProcessors WikiProcessor] so it is used with the standard #! notation. This processor injects css code into Trac, so you should get formatted output by default. Any tagged code is inside a span element, and the following classes are used:
     45This is a [wiki:WikiProcessors WikiProcessor] so it is used with the standard `#!` notation. This processor injects css code into Trac, so you should get formatted output by default. Any tagged code is inside a span element, and the following classes are used:
    4346 * se-input
    4447 * se-input-userreplacement
     
    6871
    6972results in something like the following (expanded for easier reading):
    70 {{{
    71 #!xml
     73
     74{{{#!xml
    7275<div class="code">
    7376  <pre>
     
    104107You can check out ShellExampleMacro from [/svn/shellexamplemacro/0.12/trunk/ here] using Subversion, or [source:shellexamplemacro browse the source] with Trac.
    105108
     109There is also a version on [pypi:TracShellExampleMacro PyPi].
     110
     111== Installation
     112
     113You can install this software as a normal Trac plugin.
     114
     115 1. Uninstall ShellExample wiki processor if you have installed before.
     116 1. Change to the directory containing `setup.py`.
     117 1. If you want to install this plugin globally, that will install this plugin to the Python path:
     118 {{{#!python
     119python setup.py install
     120}}}
     121 1. If you want to install this plugin to Trac instance only:
     122 {{{#!python
     123python setup.py bdist_egg
     124copy the generated egg file to the trac instance's plugin directory
     125cp dist/*.egg /srv/trac/env/plugins
     126}}}
     127 1. Configure your `trac.ini` file:
     128 {{{#!ini
     129[components]
     130shellexample.* = enabled
     131}}}
     132
    106133== Recent Changes
    107134