[MacPorts] Notification: howto/writeAHowTo added

MacPorts noreply at macports.org
Fri May 16 03:26:11 PDT 2008


Added page "howto/writeAHowTo" by rhwood at macports.org from 68.100.94.21*
Page URL: <http://trac.macports.org/wiki/howto/writeAHowTo>
Comment: Initial notes on how to documents
Content:

[wiki:howto <- Back to the HOWTO section]

= How to write a '''How To''' document =

 * Audience: All
 * Requires: None

== Introduction ==

This is some notes on writing a how to document.

== Notes ==

 * The title of the how to document should be in the form: ''How to action object'' where'''action''' is an action taken against '''object.''' For example:
  How To Install an Older Version of a Port
 * The url of the document should be the same as the title minus '''How to,''' with articles and (possibly) adjectives removed and in CamelCase (so that it can be referred to in wiki syntax). For example:
  InstallOlderVersion
 * Use the HowToTemplate if it will fit your how to.
 * When I get enough notes I will organize them into a proper how to.

[wiki:howto <- Back to the HOWTO section]


* The IP shown here might not mean anything if the user is behind a proxy.

-- 
MacPorts </>
Ports system for Mac OS


More information about the macports-changes mailing list