[pmwiki-users] Re-thinking Intro to markup pages (Oliver Betz)

John Rankin john.rankin at affinity.co.nz
Wed Feb 11 17:04:25 CST 2009

On Thursday, 12 February 2009 7:00 AM, pmwiki-users-request at pmichaud.com wrote:
>From: Oliver Betz <list_ob at gmx.net>
>"Patrick R. Michaud" wrote:
>>As a general comment to this thread, I'm in general agreement with
>>using the Creole approach as a general guideline for our own
>>markup documentation.
>Therefore I vote for one page containing all the information about
>basic markup and editing.

I support this proposal. The page would show markup and its output.

A case can also be made that this and other "core markup" pages 
should use *only* functionality defined in Creole. All markup on 
the page should be an illustration of a Creole function. This is a 
radical suggestion; it means (:markup:) ... (:markupend:) is not 
allowed on core markup documentation pages.
>Likely a good (efficient) start will be to sort and update the
>contents of BasicEditing and TextFormattingRules.

I support this in principle. However, we could also start with
TextFormattingRules and EditQuickReference. I am not sure whether
we need both TextFormattingRules and BasicEditing to cover just
the Creole functionality.

Let us create 
  maybe PmWikiCreole.BasicEditing,
  and perhaps PmWikiCreole.EditQuickReference 
using "the Creole functionality, the whole Creole functionality, 
and nothing but the Creole functionality" in the order shown on

John Rankin
Affinity Limited
T 64 4 495 3737
F 64 4 473 7991
john.rankin at affinity.co.nz

More information about the pmwiki-users mailing list