[drupal-docs] XHTML in our documentation - Textile, Markdown, ...

Boris Mann borismann at gmail.com
Thu Mar 17 05:40:00 UTC 2005


On Wed, 16 Mar 2005 23:51:15 -0500, Moshe Weitzman <weitzman at tejasa.com> wrote:
> So how can we assure that
> documentation authors produce work that has this characteristic? I
> propose that these markup languages are the best way. I'm open to other
> suggestions, or to debate on whether clean HTML is even a worthwhile
> goal.

I think we can do it by using Filtered HTML plus (if needed) an
HTMLTidy-like function. For S5, you might actually have to run an
S5-filter, or design a Filtered HTML set of tags that S5 can handle.

Richard said (and I tend to agree) that the folks that do
documentation will have a certain level of competence around creating
HTML. So hX tags aren't too much of a stretch. And if they don't
create them...no big deal, it's just paragraphs of text: knowledge
gardeners will come by and refactor the documentation and/or fix
formatting issues. E.g. every time (sorry Kieran) Kieran posts
something to the wiki, Richard re-factors it correctly to make it look
nice. Kieran can't be bothered (and shouldn't have to) to figure out
yet-another-wiki-syntax, and it takes only moments of Richard's time
to "fix" this.

Basically, I don't want to force (and I certainly don't want to) learn
yeat-another-syntax. If we can offer a markup language AND HTML
support...I would be fine with this.

--
Boris Mann
http://www.bryght.com



More information about the drupal-docs mailing list