Project

bbgun

0.0
No commit activity in last 3 years
No release in over 3 years
Provides BBCode for Ruby.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

>= 0

Runtime

 Project Readme
rule bold
  ('[b]'/'[B]')
  (!'[/b]' !'[/B]'
  (tag <RbbCode::TagNode> / .))+
  ('[/b]' / '[/B]')
end

BBGun¶ ↑

Homepage

Rails Gem for BBCode. This gem is fundamentally limited because it uses regex to parse the code, which means it really screws the pooch on nested tags. If you’re alright with not having nested tags, then this gem may be for you.

Install¶ ↑

Add:

gem "bbgun"

to your Gemfile and then install the gem using:

bundle install

Usage¶ ↑

The easiest way to use tbbc is with the string method provided, for example

>> "[b]Bold[/b]".tbbc
=> "<strong>Bold</strong>"

Configuration¶ ↑

On the fly¶ ↑

If you want to quickly change something, e.g. disable a tag for a specific .tbbc call then you can configure it in the call:

>> "[b]Bold[/b] [i]Italic[/i]".tbbc(:strong_enabled => false)
=> "[b]Bold[/b] <i>Italic</i>"

Whilst this method works its not the cleanest way of doing it. Its fine for simple things like disabling a single tag (e.g. tables in signatures) but when defining custom tags or the coderay css its better to use the other config method

Globaly¶ ↑

This is done using config/initializers/tbbc.rb, this file needs to look like this:

BBGun.configure do |c|
    c.strong_enabled = false

end

That would produce the same output as the on the fly config but would work when ever you used .tbbc in the project.