MWX/ManPage: Difference between revisions

From Woozle Writes Code
< MWX
Jump to navigation Jump to search
(more examples, more clearly formatted)
mNo edit summary
 
(8 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<hide>
[[category:MediaWiki extension|ManPage]]
[[page type::article]]
'''2022-04-16''' Changes to the <code>man</code> command seem to have broken this extension, and I haven't had time to fix it.
[[page type::project]]
[[thing type::software]]
[[thing type::MediaWiki extension]]
[[license::open source]]
[[platform::MediaWiki]]
[[author::User:Woozle]]
</hide>
==About==
==About==
[[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.
'''Special:ManPage''' is a simple extension for [[MediaWiki]] which allows any {{l/htyp|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 <code>man</code> command's "--html" option which displays output in {{l/htyp|HTML}} instead of fixed-pitch plaintext. The page to display is requested within the URL.


Some examples:
'''Requires''': [[groff]] (see [[#Troubleshooting]], below)
* {{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.
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==
* [[/code]]
* [https://gitlab.com/woozalia/Special-ManPage Git repository]
==Troubleshooting==
If you get a blank page (no errors but no manpage either), make sure [[groff]] is installed. The <code>man</code> command uses <code>groff</code> 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

Latest revision as of 20:26, 1 May 2022

2022-04-16 Changes to the man command seem to have broken this extension, and I haven't had time to fix it.

About

Special:ManPage 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 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)

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 man 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
Retrieved from "https://wooz.dev/mw/index.php?title=MWX/ManPage&oldid=1354"