Skip to content

Latest commit

 

History

History
120 lines (86 loc) · 3.65 KB

README.rdoc

File metadata and controls

120 lines (86 loc) · 3.65 KB
Raw

BBRuby ↑

DESCRIPTION: ↑

BBRuby is a BBCode (www.bbcode.org) implementation for Ruby. It will convert strings with BBCode markup to their HTML equivalent.

INSTALL: ↑

To install as a gem:

sudo gem install bb-ruby

To install as a plugin:

./script/plugin install git://github.com/cpjolicoeur/bb-ruby.git

USAGE: ↑

require 'bb-ruby' # (only needed if installed as a gem)

BBRuby has been included directly into the String class for use on any string object:

text = "[b]Here is some bold text[/b] followed by some [u]underlined text[/u]"
output = text.bbcode_to_html
text.bbcode_to_html!

BBRuby will auto-escape HTML tags. To prevent this just pass false as the second param:

output = text.bbcode_to_html({}, false)

Only allow certain tags:

output = text.bbcode_to_html({}, true, :enable, :image, :bold, :quote)

Disable certain tags:

output = text.bbcode_to_html({}, true, :disable, :image, :bold, :quote)

Alternative Direct usage:

output = BBRuby.to_html(bbcode_markup)

Define your own translation, in order to be more flexible:

my_blockquote = {
  'Quote' => [
    /\[quote(:.*)?=(.*?)\](.*?)\[\/quote\1?\]/mi,
    '<div class="quote"><p><cite>\2</cite></p><blockquote>\3</blockquote></div>',
    'Quote with citation',
    '[quote=mike]please quote me[/quote]',
    :quote
  ],      
}

text.bbcode_to_html(my_blockquote)

You can also use the simple_format method of ActionPack by using the *_with_formatting methods:

output = text.bbcode_to_html_with_formatting
output = text.bbcode_to_html_with_formatting!

TAGS PROCESSED: ↑

The following is the list of BBCode tags processed by BBRuby and their associated symbol for enabling/disabling them

  • b

    :bold

  • i

    :italics

  • u

    :underline

  • s

    :strikeout

  • del

    :delete

  • ins

    :insert

  • code

    :code

  • size

    :size

  • color

    :color

  • ol

    :orderedlist

  • ul

    :unorderedlist

  • li

    :listitem

  • *

    :listitem

  • list

    :listitem

  • list=1

    :listitem

  • list=a

    :listitem

  • dl

    :definelist

  • dt

    :defineterm

  • dd

    :definition

  • quote

    :quote

  • quote=source

    :quote

  • url=link

    :link

  • url

    :link

  • img size=

    :image

  • img=

    :image

  • img

    :image

  • youtube

    :video

  • gvideo

    :video

  • vimeo

    :video

  • email

    :email

LICENSE: ↑

Copyright © 2008 Craig P Jolicoeur, Fernando Blat

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.