search

pirave / postmarkup

Automatically exported from code.google.com/p/postmarkup
0 stars 0 forks source link

Complete bbcode usage document #4

Closed GoogleCodeExporter closed 8 years ago

GoogleCodeExporter commented 8 years ago 
Would it be possible to provide a bit of documentation that could serve as
a BBCode usage guide or primer?  There are two cases for doing this:
 1.) Giving developers a list of all of the tags that are implemented and
their semantics
 2.) Give something for end users to learn BBCode from (e.g. on a site that
uses Postmarkup, the developer could link to the document to instruct users
on how Postmarkup's BBCode works)

The only way I could see exactly which tags were implemented was to inspect
postmarkup.create().tags or look at the source code.  Using a general
purpose BBCode guide (like
http://www.phpbb.com/community/faq.php?mode=bbcode) isn't a good option
because it lists some tags which are not implemented in postmarkup or may
have different options / meanings.

I've attached a little script that generates such a page (pardon the
hackiness) as well as the output.  When new features / tags are implemented
you can easily add a new example or section to the doc generator.

Original issue reported on code.google.com by skryskalla on 29 Aug 2007 at 8:22

Attachments:

GoogleCodeExporter commented 8 years ago 
Good idea.

I think ultimately I should put some meta data in the tag classes so the bbcode 
doc
could be generated automatically from a Postmarkup object. That way it can be
customized if the tags aren't the default.

In the meantime, I'll put your html file in the downloads section. Thanks.

Original comment by willmcgugan on 7 Sep 2007 at 1:56