MWX/ManPage: Difference between revisions
(troubleshooting hint) |
(broken) |
||
| Line 10: | Line 10: | ||
==About== | ==About== | ||
[[SpecialManPage]] is a simple extension for [[MediaWiki]] which allows any [[manpage]] (of those installed on the web site's server) 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. | [[SpecialManPage]] is a simple extension for [[MediaWiki]] which allows any [[manpage]] (of those installed on the web site's server) 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. | ||
'''''Note''': This extension is broken for newer versions of "man" until I can figure out how to get it to generate HTML output. The option which used to work for this is no longer working. [[User:Woozle|Woozle]] ([[User talk:Woozle|talk]]) 16:57, 21 November 2017 (EST)'' | |||
Some examples: | Some examples: | ||
Revision as of 21:57, 21 November 2017
<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 any manpage (of those installed on the web site's server) 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.
Note: This extension is broken for newer versions of "man" until I can figure out how to get it to generate HTML output. The option which used to work for this is no longer working. Woozle (talk) 16:57, 21 November 2017 (EST)
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.
Links
- GitHub repository
- /code - may not be the latest version
Troubleshooting
If you get a blank page (no errors but no manpage either), make sure groff is installed. The Template:L/linux/cmd command uses groff for HTML formatting.
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