MWX/ManPage: Difference between revisions
(broken) |
(updates) |
||
| Line 11: | Line 11: | ||
[[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. | ||
''' | '''Requires''': [[groff]] (see [[#Troubleshooting]], below) | ||
Some examples: | Some examples: | ||
| Line 21: | Line 21: | ||
==Links== | ==Links== | ||
* [https://github.com/woozalia/Special-ManPage GitHub repository] | * [https://github.com/woozalia/Special-ManPage GitHub repository] | ||
==Troubleshooting== | ==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. | 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: | ||
* return just a summary | * option to return just a summary | ||
* 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) | * support for crosslinks to other manpages (not sure this is possible) | ||
* [[texinfo]] support | * [[texinfo]] support | ||
Revision as of 11:08, 13 March 2018
<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.
Requires: groff (see #Troubleshooting, below)
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:
- option to 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