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

Oliver Betz list_ob at gmx.net
Thu Feb 12 03:47:55 CST 2009

John Rankin wrote:

>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.

please don't quote distorting. If you quote "therefore", you should
also quote what I refered to (granularity of Creole docs), especially
since your posting method doesn't support threading.

BTW: Do you consider to switch your posting method so it preserves
message references? Each time you reply, a new thread starts. It makes
it much harder to follow longer discussions. Gmane is great. Separate
mails will do it also.

At least you shouldn't add my name to the subject.

>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.

What is the benefit?

>>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

QuickReference is IMO different from BasicEditing and
TextFormattingRules. Of course it has to be done, but that's trivial
compared to the other pages.

Maybe I didn't get right the intention of BasicEditing and
TextFormattingRules, but as I understand, TextFormattingRules should
be the next step after reading BasicEditing. Apart from that, they are
similar in structure.

>we need both TextFormattingRules and BasicEditing to cover just
>the Creole functionality.

What should be the difference between BasicEditing and
TextFormattingRules if both cover the same subset?

>Let us create 
>  PmWikiCreole.TextFormattingRules, 
>  maybe PmWikiCreole.BasicEditing,
>  and perhaps PmWikiCreole.EditQuickReference 

well, do so and I might understand better.

>using "the Creole functionality, the whole Creole functionality, 
>and nothing but the Creole functionality" in the order shown on

this page is a bad example. It lacks two elements (as I already

And BasicEditing should not only explain the markup rules. In the
current BasicEditing page is more important content a beginner needs
to know.


More information about the pmwiki-users mailing list