MWX/ManPage: Difference between revisions

From Woozle Writes Code
< MWX
Jump to navigation Jump to search
(→‎About: tweaks; link to new GitHub repo)
(troubleshooting hint)
Line 20: Line 20:
* [https://github.com/woozalia/Special-ManPage GitHub repository]
* [https://github.com/woozalia/Special-ManPage GitHub repository]
* [[/code]] - may not be the latest version
* [[/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 {{l/linux/cmd|man}} command uses groff for HTML formatting.
==Future==
==Future==
Planned features:
Planned features:

Revision as of 16:53, 12 February 2015

<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.

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

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