Changes between Version 6 and Version 7 of ManPageRendererPlugin
- Timestamp:
- Jun 16, 2015, 8:58:49 AM (9 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
ManPageRendererPlugin
v6 v7 1 = Unix Manual page renderer = 1 [[PageOutline(2-5,Contents,pullout)]] 2 2 3 = = Description ==3 = Unix Manual page renderer 4 4 5 A plugin for rendering unix manual pages to HTML so they're human readable when browsing the repository. 5 == Description 6 6 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. 7 A plugin for rendering unix manual pages to HTML, so they are human readable when browsing the repository. 8 8 9 == Bugs/Feature Requests == 9 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. 10 11 Originally submitted as a [http://trac.edgewall.org/ticket/7067 new enhancement to Trac], but currently hosted on trac-hacks. 12 13 == Bugs/Feature Requests 10 14 11 15 Existing bugs and feature requests for ManPageRendererPlugin are … … 13 17 14 18 If you have any issues, create a 15 [ http://trac-hacks.org/newticket?component=ManPageRendererPlugin&owner=pierznew ticket].19 [/newticket?component=ManPageRendererPlugin new ticket]. 16 20 17 == Download == 21 [[TicketQuery(component=ManPageRendererPlugin&group=type,format=progress)]] 22 23 == Download 18 24 19 25 Download the zipped source from [download:manpagerendererplugin here]. 20 26 21 == Source ==27 == Source 22 28 23 29 You can check out ManPageRendererPlugin from [http://trac-hacks.org/svn/manpagerendererplugin here] using Subversion, or [source:manpagerendererplugin browse the source] with Trac. 24 30 25 == Install ==31 == Installation 26 32 27 The simplest way to install it is using easy_install:28 {{{ 33 The simplest way to install it is using `easy_install`: 34 {{{#!sh 29 35 easy_install http://trac-hacks.org/svn/manpagerendererplugin/0.11/ 30 36 }}} 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 38 This 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 33 40 groff_path = /your_path/groff 34 41 }}} 35 You will need to enable it in trac.ini: 36 {{{ 42 43 You will need also to enable this plugin in your `trac.ini` file: 44 {{{#!ini 45 [components] 37 46 manpagerenderer.* = enabled 38 47 }}} 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 49 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: 50 {{{#!ini 51 [mimeviewer] 41 52 mime_map = application/x-troff-man:1 42 53 }}} 43 And/or you can set svn:mime-type property to application/x-troff-man for specific files you want renderer by the plugin.44 54 45 == Example == 55 You can set svn:mime-type property to application/x-troff-man for specific files you want to have rendered by the plugin. 46 56 47 See it working on our trac site: 57 == Example 58 59 See it working on our Trac site: 48 60 http://frostie.cs.ucl.ac.uk/nets/mmedia/browser/rat/trunk/man/man1/rat.1 49 61 50 == Recent Changes ==62 == Recent Changes 51 63 52 64 [[ChangeLog(manpagerendererplugin, 3)]] 53 65 54 == Author/Contributors ==66 == Author/Contributors 55 67 56 68 '''Author:''' Piers O'Hanlon [[BR]] 69 '''Maintainer:''' [[Maintainer]] [[BR]] 57 70 '''Contributors:'''