Proposal for Content of Documentation Pages.#
Some ideas for consistent documentation content.
See also Proposal for Naming of Documentation Pages.
For short technical features (Plugins, Tags, ...).
Here is an incomplete example page (yellow background) for Wiki.Plugin.Index:
Wiki - Plugin
Index Plugin#
Displays all of the pages in this Wiki in alphabetical order.Contributed by AlainRavet.
Parameters#
| name | default | used for |
|---|---|---|
| itemsPerLine | ? | break every 'n' items on line. |
| include | * | |
| . . . | . . . | . . . |
Restrictions#
???Known Bugs#
noneExample#
[{INSERT IndexPlugin include='Wiki.*'}]
produces output like this:
W
Wiki, Wiki.About, Wiki.About.Attachments, Wiki.Admin.Default URL Constructor, Wiki.Admin.Multiple Wikis, Wiki.Admin.Security, Wiki.Admin.Short Url Constructor, Wiki.Admin.Short View URL Constructor, Wiki.Admin.URL Constructors, Wiki.Admin.Windows Install, Wiki.CorePages, Wiki.Developer.Page Repository, Wiki.Developer.RPC Interface, Wiki.Developer.Templates, Wiki.DocumentationMap, Wiki.Forms, Wiki.How To.Create Forms, Wiki.How To.Create Forms Example, Wiki.How To.Create Headers, Wiki.How To.Create Pages, Wiki.How To.Getting Started, Wiki.How To.Use FormClose, Wiki.How To.Use FormInput, Wiki.How To.Use FormOpen, Wiki.How To.Use FormOutput, Wiki.How To.Use FormSelect, Wiki.How To.Use FormSet, Wiki.How To.Use Forms BugReportHandler, Wiki.How To.Use Variables, Wiki.How To.Use Wiki Names, Wiki.How To.Write Pages, Wiki.HowTo, Wiki.HowTo.CenterText, Wiki.HowTo.ColorText, Wiki.HowTo.CreateCollapsableBoxes, Wiki.HowTo.CreateCollapsableLists, Wiki.HowTo.CreateCommentBoxes, Wiki.HowTo.CreateGraphBars, Wiki.HowTo.CreateLists, Wiki.HowTo.CreateSortableTables, Wiki.HowTo.CreateTabbedSections, Wiki.HowTo.CreateTables, Wiki.HowTo.CreateZebraTables, Wiki.HowTo.FormatText, Wiki.HowTo.InsertPages, Wiki.HowTo.InsertPagesTestSection, Wiki.Markup, Wiki.Plugin.Index.Discussion, WikiEditors, WikiFilters, WikiGroups, WikiMarkup, WikiModules, WikiPages, WikiPermissions, WikiPlugins, WikiWiki
See also#
Used in Wiki.Info.Index.Suggestions and Discussions#
Should go here: Wiki.Plugin.Index.DiscussionFor pages like installation instructions.
Most pages won't fit exactly into this scheme but at
least some concepts should useful.
Some Documentation#
Short descriptionTable of Contents
- Proposal for Content of Documentation Pages.
- Index Plugin
- Parameters
- Restrictions
- Known Bugs
- Example
- See also
- Suggestions and Discussions
- Some Documentation
- Introduction
- Some Heading
- Some Heading
- Frequently asked Querstions
- Subject xxx
- Subject yyy
- Restrictions
- Known Bugs
- See also
- Suggestions and Discussions
Introduction#
Some Heading#
Example:
[{INSERT IndexPlugin include='Wiki.*'}]
produces output like this:
W
Wiki, Wiki.About, Wiki.About.Attachments, Wiki.Admin.Default URL Constructor, Wiki.Admin.Multiple Wikis, Wiki.Admin.Security, Wiki.Admin.Short Url Constructor, Wiki.Admin.Short View URL Constructor, Wiki.Admin.URL Constructors, Wiki.Admin.Windows Install, Wiki.CorePages, Wiki.Developer.Page Repository, Wiki.Developer.RPC Interface, Wiki.Developer.Templates, Wiki.DocumentationMap, Wiki.Forms, Wiki.How To.Create Forms, Wiki.How To.Create Forms Example, Wiki.How To.Create Headers, Wiki.How To.Create Pages, Wiki.How To.Getting Started, Wiki.How To.Use FormClose, Wiki.How To.Use FormInput, Wiki.How To.Use FormOpen, Wiki.How To.Use FormOutput, Wiki.How To.Use FormSelect, Wiki.How To.Use FormSet, Wiki.How To.Use Forms BugReportHandler, Wiki.How To.Use Variables, Wiki.How To.Use Wiki Names, Wiki.How To.Write Pages, Wiki.HowTo, Wiki.HowTo.CenterText, Wiki.HowTo.ColorText, Wiki.HowTo.CreateCollapsableBoxes, Wiki.HowTo.CreateCollapsableLists, Wiki.HowTo.CreateCommentBoxes, Wiki.HowTo.CreateGraphBars, Wiki.HowTo.CreateLists, Wiki.HowTo.CreateSortableTables, Wiki.HowTo.CreateTabbedSections, Wiki.HowTo.CreateTables, Wiki.HowTo.CreateZebraTables, Wiki.HowTo.FormatText, Wiki.HowTo.InsertPages, Wiki.HowTo.InsertPagesTestSection, Wiki.Markup, Wiki.Plugin.Index.Discussion, WikiEditors, WikiFilters, WikiGroups, WikiMarkup, WikiModules, WikiPages, WikiPermissions, WikiPlugins, WikiWiki
Some Heading#
Frequently asked Querstions#
Subject xxx#
Q: Why?
A: Therefore.
Q: Why?
A: Therefore.
Subject yyy#
Q: Why?
A: Therefore.
Q: Why?
A: Therefore.
Restrictions#
???Known Bugs#
noneSee also#
WikiBlaBla.Suggestions and Discussions#
Should go here: Wiki.SomeDoc.Discussion- [Wiki] - [Plugin|Wiki.Plugin]: i have not tested
NamespacePlugin
but
links to upper hierarchies seem to make sense.
Even better: 'NamespaceTag' (to be written) that replaces <wiki:PageName /> in Header.jsp and writes
Wiki.Plugin.Index
(one link for Wiki, one link for Wiki.Plugin; plain text for Wiki.Plugin.Index as this is the actual page) - !!!Index Plugin: a big heading for each page seems to be better than relying on page names (at least for internationalized pages)
- Parameters with their default values should be listed in a table
(clear and compact; names for table headings are copied from
http://www.jspwiki.org/wiki/WikiMap
)
- Example output should be displayed with some background color so that the reader sees it at one glance.
- Suggestions and Discussions: should stand on a separate page ending with '.Discussion'. A documentation page should describe the actual function of the software and old bugs or further ideas should be placed elsewhere.
-- Frank_Fischer
- You can't mean that all documentation pages should look like this, can you? This is appropriate for a reference (say, to a particular plugin), but I think there are many topics that need a more conversational style. DanF
- This skeleton could be usable for documentaion of most plugins and tags, forms, aliases, URLProviders etc.
Many of the current pages fall into this scheme.
- For more conversational style some features should remain, some have to be added and some are not applicable. I have added an unfinished proposal above.
- There will still be some pages that need a different approach.
How about my Proposal for Documentation of Wiki Syntax ?
(uses tabbedSection; incomplete, German language)
-- Frank_Fischer