• View
• Edit
• History
• Print

DocumentationToDo

Sections:

• Missing Pages
• Pages To Review
• Pages To Improve
• Pages To Rename
• Pages To Delete
• Pages To Add To The Distribution
• General Site Fixes

Missing Pages

List

When listing a page here, do provide a brief description of the page's purpose/problem.

Do

Either list the page here for others to create, or create a good starting stub.

Don't

Create a place-holder page with no real content on it, it will get overlooked and frustrate people who come upon it.

Stubs

Good stubs provide enough information to be useful to someone landing on the page. If you feel the stub needs a review, move it to the Pages To Review list below.

Pages To Review

List

List any page here for which you would like someone else to review.

• Directives - says it still needs to be cleaned up for 2.0
• PmWiki.BlockMarkup
• PmWiki.CharacterMarkup
• PmWiki.EditGettingStarted
• PmWiki.LineMarkup
• Cookbook.EditTitle
• Search

Reviews

If you find the page nice and complete, simply remove it from this list.

Improvements

If you feel the page still needs a lot of work, move it to the Pages To Improve list below.

Pages To Improve

• WikiStyleExamples: Are references such as "...continues to use...", and version 2.0 truly accurate? I suggest rewrite/reword accordingly ---JohnHerbert

Pages To Rename

• Textformatering? This page is not in English. Not sure which (Scandinavian?) language set it belongs with
  • It's in Swedish -- A Dane

Pages To Delete

Deleting

If it seems obvious that this page needs to be deleted, go ahead, delete it. If you are not sure, ask on the mailing list or add your opinion here to help build a consensus.

Pages to add to the Distribution

• PmWiki.CharacterMarkup
• Search

Not all pages in the PmWiki group are bundled with the software. These are pages that are destinations of broken links in the distributed documentation.

PmWiki.WikiFarmTerminology

Referenced by PmWiki.Glossary and PmWiki.WikiFarms. Probably should be added.

PmWiki.WikiFarmsAdvanced

Referenced by PmWiki.WikiFarms. Probably should be converted to a recipe.

General Site Fixes

Definitive definitions

• Duplicate definitions on many pages for example ...
  • An admirable undertaking on streamlining the documentation.
    Has there been consideration for dealing with the many pages that exist duplicating definitions for functions, markups etc.? I sometimes find it almost impossible to search reliably for a defintion I know is in here, but can't find, or find info that I'm sure has been superceded on another page I've consulted previously.
    Perhaps there could be a common category created that could be applied to such pages, where they could be grouped for review and deletion of the duplicate/obsolete content as required.
    Ideally, there should ultimately only be one current, valid definition for each function/variable/markup etc. in a common location.
    Not an overnight task, but an ongoing one for those who are interested. --Des May 11, 2006, at 07:02 PM
    • Part of the problem lies with identifying the scope and purpose of the documentation. Documentation can be along the lines of dictionary and reference material or tutorials and how-to. Much of the documentation on PmWiki strives to serve the needs of a tutorial, but ends up having to carry the burden of also providing definitions along the way. My preference would be to separate the two by creating a separate body of reference material documenting every markup and function and freeing up the tutorial style documentation to provide examples and refer to the reference material for the (changing) definitions.
• Aside from the issue of duplicate definitions is the fact that there are functions and markups that have been added and identified (in ChangeLog) but are not defined in the distributed documentation. Those need to be added as well. Examples include (add to this list)
  • (:markup:)

See Also:

• CookbookToDo
• PITS.00957

addition and update of documentation