[Author Prev][Author Next][Thread Prev][Thread Next]
[Author Index (this month)][Thread Index (this month)][Top of Archive]

Re: good examples of HTML-based command references?

Subject: Re: good examples of HTML-based command references?
From: "Peter Neilson" <neilson -at- windstream -dot- net>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Wed, 12 Jun 2013 12:21:55 -0400

If you write your command docs as Unix-style "man" pages you can use man2html:
http://linuxers.org/article/make-manpages-navigable-using-man2html

On Wed, 12 Jun 2013 11:52:34 -0400, Robert Lauriston <robert -at- lauriston -dot- com> wrote:

I need to create an HTML template for documenting a bunch of commands.
Something like:

command name
description
syntax
parameters and options
notes
examples
links to related commands etc.

For example:

http://www.perforce.com/perforce/doc.current/manuals/cmdref/
http://www.postgresql.org/docs/9.2/static/sql-commands.html
http://technet.microsoft.com/en-us/library/cc754340%28v=ws.10%29.aspx

Any better examples out there?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
New! Doc-to-Help 2013 features the industry's first HTML5 editor for authoring.

Learn more: http://bit.ly/ZeOZeQ

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-
To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com


Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwhirl.com/email-discussion-groups/ for more resources and info.

Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com

Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives

Previous by Author: Re: The ethics of tech writing; Why quit?
Next by Author: Re: Advice on rewriting translated ops manuals
Previous by Thread: TechWhirl: Technical Communication Recap for June 7, 2013
Next by Thread: Re: CrossRef vs FundRef -- does anyone understand why FundRef?

[Top of Archive] | [Author Index (this month)] | [Thread Index (this month)]

What this post helpful? Share it with friends and colleagues:

Sponsored Ads