README.md in bbcoder-0.1.5 vs README.md in bbcoder-0.1.6
- old
+ new
@@ -4,13 +4,13 @@
* Non-regex based (except for the split)
* Handles deep nesting of tags
* Generates good html even from bad input
* Easy configuration to add new tags
-* Tags supported:
+* Tags supported by default:
-p, b, i, u, s, del, ins, ol, ul, li, dl, dt, dd, quote, code, spoiler, url, img
+p, b, i, u, s, del, ins, ol, ul, li, dl, dt, dd, quote, code, spoiler, url, img, youtube, sub, sup
Usage
--------
BBCoder.new(text).to_html
@@ -21,16 +21,24 @@
-------
gem install bbcoder
-Configuration
+Configuration Examples
-----------------------
BBCoder.configure do
tag :b, :as => :strong
+ tag :sub, :singular => true do
+ %(<sub>#{singular? ? meta : content}</sub>)
+ end
+
+ tag :sup, :singular => true do
+ %(<sup>#{singular? ? meta : content}</sup>)
+ end
+
tag :ul
tag :ol
tag :li, :parents => [:ol, :ul]
tag :img, :match => /^.*(png|bmp|jpg|gif)$/ do
@@ -58,15 +66,17 @@
Options for #tag
* :as (symbol) -> use this as the html element ([b] becomes strong)
* :match (regex) -> convert this tag and its content to html only if the content matches the regex
* :parents ([symbol]) -> ignore this tag if there is no open tag that matches its parents
+* :singular (true|false) -> use this if the tag does not require an ending tag
When you pass a block to #tag it is expecting you to return a string. You have two variables available to your block:
* meta -> Everything after the '=' in the opening tag (with [quote="Legendary"] meta returns '"Legendary"' and with [quote] meta returns nil)
* content -> Everything between the two tags (with [b]strong arm[/b] content returns 'strong arm')
+* singular? -> Tells you if this tag is being parsed in singular form or if it had an ending tag (affects if content has any data)
Author
------