Changes between Version 6 and Version 7 of ManPageRendererPlugin


Ignore:
Timestamp:
Jun 16, 2015, 8:58:49 AM (9 years ago)
Author:
figaro
Comment:

Cosmetic changes, tagged with license

Legend:

Unmodified
Added
Removed
Modified
  • ManPageRendererPlugin

    v6 v7  
    1 = Unix Manual page renderer =
     1[[PageOutline(2-5,Contents,pullout)]]
    22
    3 == Description ==
     3= Unix Manual page renderer
    44
    5 A plugin for rendering unix manual pages to HTML so they're human readable when browsing the repository.
     5== Description
    66
    7 Specifically it extends the IHTMLPreviewRenderer component of the mimeviewer to pass the nroff man page through groff which generates an HTML version of the page. I originally submitted it as a [http://trac.edgewall.org/ticket/7067 new enhancement] a while back to the main trac site but trac-hacks seems to be the place for such things now.
     7A plugin for rendering unix manual pages to HTML, so they are human readable when browsing the repository.
    88
    9 == Bugs/Feature Requests ==
     9Specifically it extends the IHTMLPreviewRenderer component of the mimeviewer to pass the nroff man page through groff, which generates an HTML version of the page.
     10
     11Originally submitted as a [http://trac.edgewall.org/ticket/7067 new enhancement to Trac], but currently hosted on trac-hacks.
     12
     13== Bugs/Feature Requests
    1014
    1115Existing bugs and feature requests for ManPageRendererPlugin are
     
    1317
    1418If you have any issues, create a
    15 [http://trac-hacks.org/newticket?component=ManPageRendererPlugin&owner=pierz new ticket].
     19[/newticket?component=ManPageRendererPlugin new ticket].
    1620
    17 == Download ==
     21[[TicketQuery(component=ManPageRendererPlugin&group=type,format=progress)]]
     22
     23== Download
    1824
    1925Download the zipped source from [download:manpagerendererplugin here].
    2026
    21 == Source ==
     27== Source
    2228
    2329You can check out ManPageRendererPlugin from [http://trac-hacks.org/svn/manpagerendererplugin here] using Subversion, or [source:manpagerendererplugin browse the source] with Trac.
    2430
    25 == Install ==
     31== Installation
    2632
    27 The simplest way to install it is using easy_install:
    28 {{{
     33The simplest way to install it is using `easy_install`:
     34{{{#!sh
    2935easy_install http://trac-hacks.org/svn/manpagerendererplugin/0.11/
    3036}}}
    31 This plugin uses groff so it needs to be installed on your machine (it usually is installed on most unixes) and if it is not in the usual place of /usr/bin/groff you can specify its location in the trac.ini file:
    32 {{{
     37
     38This plugin uses groff, so it needs to be installed on your machine, usually installed as a standard on most unixes. If it is not in the usual place of `/usr/bin/groff`, you can specify its location in your `trac.ini` file:
     39{{{#!ini
    3340groff_path = /your_path/groff
    3441}}}
    35 You will need to enable it in trac.ini:
    36 {{{
     42
     43You will need also to enable this plugin in your `trac.ini` file:
     44{{{#!ini
     45[components]
    3746manpagerenderer.* = enabled
    3847}}}
    39 It will automatically render pages ending .man but if you want it to render man pages that end in .1 (or something else) then add this to [mimeviewer] section:
    40 {{{
     48
     49It will automatically render pages ending `.man`, but if you want it to render man pages that end in `.1` (or something else), then add this to [mimeviewer] section:
     50{{{#!ini
     51[mimeviewer]
    4152mime_map = application/x-troff-man:1
    4253}}}
    43 And/or you can set svn:mime-type property to application/x-troff-man for specific files you want renderer by the plugin.
    4454
    45 == Example ==
     55You can set svn:mime-type property to application/x-troff-man for specific files you want to have rendered by the plugin.
    4656
    47 See it working on our trac site:
     57== Example
     58
     59See it working on our Trac site:
    4860http://frostie.cs.ucl.ac.uk/nets/mmedia/browser/rat/trunk/man/man1/rat.1
    4961
    50 == Recent Changes ==
     62== Recent Changes
    5163
    5264[[ChangeLog(manpagerendererplugin, 3)]]
    5365
    54 == Author/Contributors ==
     66== Author/Contributors
    5567
    5668'''Author:''' Piers O'Hanlon [[BR]]
     69'''Maintainer:''' [[Maintainer]] [[BR]]
    5770'''Contributors:'''