MWX/ManPage: Difference between revisions
(future - planned features) |
(more examples, more clearly formatted) |
||
| Line 9: | Line 9: | ||
</hide> | </hide> | ||
==About== | ==About== | ||
[[SpecialManPage]] is a simple extension for [[MediaWiki]] which allows [[manpage]]s to be displayed within the wiki as a Special page. It makes use of the "man" command's "--html" option which displays output in [[HTML]] instead of fixed-pitch [[plaintext]]. The page to display is requested within the URL | [[SpecialManPage]] is a simple extension for [[MediaWiki]] which allows [[manpage]]s to be displayed within the wiki as a Special page, which is often more readable than the standard terminal-based display. It makes use of the "{{l/manpage|man}}" command's "--html" option which displays output in [[HTML]] instead of fixed-pitch [[plaintext]]. The page to display is requested within the URL. | ||
Some examples: | |||
* {{l/manpage|cat}} | |||
* {{l/manpage|ssh}} | |||
* {{l/manpage|telnet}} | |||
Manpage contents can also be transcluded, but this may not be particularly useful until some features are added for extracting partial content of manpages rather than returning the entire thing. | |||
* [[/code]] | * [[/code]] | ||
| Line 17: | Line 24: | ||
* search manpages by topic or content | * search manpages by topic or content | ||
* list available manpages | * list available manpages | ||
* support for crosslinks to other manpages (not sure this is possible) | |||
* [[texinfo]] support | |||
Revision as of 01:18, 22 July 2013
<hide> page type::article page type::project thing type::software thing type::MediaWiki extension license::open source platform::MediaWiki author::User:Woozle </hide>
About
SpecialManPage is a simple extension for MediaWiki which allows manpages to be displayed within the wiki as a Special page, which is often more readable than the standard terminal-based display. It makes use of the "Template:L/manpage" command's "--html" option which displays output in HTML instead of fixed-pitch plaintext. The page to display is requested within the URL.
Some examples:
Manpage contents can also be transcluded, but this may not be particularly useful until some features are added for extracting partial content of manpages rather than returning the entire thing.
Future
Planned features:
- return just a summary
- search manpages by topic or content
- list available manpages
- support for crosslinks to other manpages (not sure this is possible)
- texinfo support