[Pmwiki-users] notes on pmwiki documentation
John Rankin
john.rankin at affinity.co.nz
Sat Mar 1 18:44:49 CST 2003
If HowTo is used, then HowToVerb... might be a convention to follow, eg
HowToSetUpPmWiki
HowToUsePmWikiGroups
HowtoInstallPmWiki
HowToUpgradeToANewVersion
HowToAdministerWikiStyles
HowToAddCustomMarkup
are a few examples. This would also help distinguish pages which are =
definitions (nouns such as WikiWord, WikiTrail, etc) from pages which are =
instructions. I think this would help both authors and readers be clear on =
what is the page's purpose. And sometimes pages are both definitions and =
instructions (WikiTrailsAndTheirUse for example).
In general, I try to avoid turning nouns into verbs (configure into =
configuration), and favour plain English over Latin or Greek (SetUp rather =
than Configure).
I am finding that putting scripts that add markup to the standard =
distribution in a directory called 'extras' has really helped me keep =
track of what's going on (but I get confused easily). Local I use for =
different colour schemes or page layouts.
As this is likely to be a moving target as page names move around before =
they settle, a [[redirect:pagename]] as the sole contents of a page may be =
worth considering.
--=20
John Rankin
--
On Saturday, 1 March 2003 10:49 AM, Patrick R. Michaud <pmichaud at sci.=
tamucc.edu> wrote:
Following up on the previous messages, I've decided to just=20
write down a list of standard pages that I think ought to be
provided with the basic PmWiki distribution, but without
displaying the group memberships. Perhaps this will make
a useful organization scheme more obvious. The [...]'s
on some items below indicate that the word might or might not
be part of the title.
WikiWord
WikiWikiWeb=20
WikiSandbox
TextFormattingRules =20
WikiGroups
WikiStyles=20
[PmWiki]WikiStylesAdmin
WikiTrails
FreeLinks
EditQuickReference (appears at bottom of Edit Page)
QuickReference
InterMap
WikiHelp
SearchWiki
HomePage
[PmWiki]Configuration[Guide] or [PmWiki]Setup[Guide]
[PmWiki]BasicConfiguration[Guide] (?)
[PmWiki]AdvancedConfiguration[Guide] (?)
[PmWiki]Installation[Guide] or [PmWiki]Install[Guide]
[PmWiki]Variables (documents variables avaible for use)
[PmWiki]Upgrades (how to do upgrades)
[PmWiki]Philosophy
[PmWiki]Passwords or [PmWiki]PasswordGuide
WikiGroupsHowTo
[PmWiki]Files or [PmWiki]FilesOrganization
[PmWiki]ReleaseNotes
[PmWiki]ChangeLog
PmWiki
[PmWiki]Scripts or [PmWiki]Modules
WikiReferences (references to other WikiWikiWeb resources)
[PmWiki]AddingCustomMarkup
One could also replace "Guide" with "HowTo" in each of the above cases
and perhaps that would be more self-explanatory (e.g.,=20
PmWikiConfigurationHowTo).
More information about the pmwiki-users
mailing list