[pmwiki-users] BasicEditing - TextFormattingRules - MarkupMasterIndex refactoring
pmwiki at solidgone.com
Tue Feb 17 11:57:30 CST 2009
Oliver Betz wrote:
> Hello All,
> BasicEditing, TextFormattingRules and MarkupMasterIndex contain a lot
> of redundant material and I'm looking for a clear(er) separation.
> What would you say is the role of these pages?
> In my opinion, MarkupMasterIndex is a fine "quick reference". No long
> explanations, just examples. I'm tempted to change the introductory
> text accordingly.
Agree. Also think a title change makes sense.
> BasicEditing is the starting point for the beginner, right?
It should include the most common markups, with some samples and
explanations. headers, bullets, italics, bold, attachment, and images.
> TextFormattingRules claims to be a "more complete list". Should it
> * repeat the contents of BasicEditing,
> * or refer to them?
How about *including* and referring to the basic?
> If TextFormattingRules repeated the basics (my preference), should it
> be done using the same style? Currently the documentation style of
> TextFormattingRules differs noticeable from BasicEditing.
I'd say yes -- keep things consistent.
> With a uniform style, we could share a lot of text between both pages.
> With TextFormattingRules as master document, BasicEditing could
> (:include:) sections from TextFormattingRules.
That's a good benefit.
More information about the pmwiki-users