[fpc-devel] fpdoc content syntax suggestion

Marco van de Voort marcov at stack.nl
Fri Jul 9 11:46:16 CEST 2010


In our previous episode, Michael Van Canneyt said:
> > If the time it takes to learn the new syntax is less than the time saved 
> > modifying and writing documentation then it's worthwhile ;-).
> 
> I considered that. There is no gain. You'll have to check the asciidoc syntax 
> just like you must check XML/HTML syntax. 
> Just look at the formatting errors in the wiki pages, with their supposedly
> 'simple syntax'...
> 
> And if there was a WYSIWYG editor, the whole point would be moot...

Won't WYSIWYG with multiple backend (and thus renderers) become a mess? Most
of them have the habit of producing quite dirty code (with empty and very
nested tags), and not all backends would react the same on this.

Despite my dislike of the limitations of wiki, the solution they have (edit
with tags, have an example rendering in a memo below) is easier and more
practical I think.



More information about the fpc-devel mailing list