Module: RubyBBCode::Tags

Included in:

RubyBBCode

Defined in:

lib/tags/tags.rb

Constant Summary

@@tags =

tagname => tag, HTML open tag, HTML close tag, description, example All of these entrys are represented as @dictionary in the classes (or as the variable tags) A single item from this file (eg the :b entry) is refered to as a @definition

{
  :b => {
    :html_open => '**', :html_close => '**',
    :description => 'Make text bold',
    :example => 'This is [b]bold[/b].'},
  :i => {
    :html_open => '*', :html_close => '*',
    :description => 'Make text italic',
    :example => 'This is [i]italic[/i].'},
  :u => {
    :html_open => '', :html_close => '',
    :description => 'Underline text',
    :example => 'This is [u]underlined[/u].'},
  :center => {
    :html_open => '', :html_close => '',
    :description => 'Center a text',
    :example => '[center]This is centered[/center].'},
  :ul => {
    :html_open => '', :html_close => "\n",
    :description => 'Unordered list',
    :example => '[ul][li]List item[/li][li]Another list item[/li][/ul].',
    :only_allow => [ :li ]},
  :ol => {
    :html_open => '', :html_close => "\n",
    :description => 'Ordered list',
    :example => '[ol][li]List item[/li][li]Another list item[/li][/ol].',
    :only_allow => [ :li ]},
  :li => {
    :html_open => {
      :ul => '  - ',
      :ol => '  1. '
    },
    :html_close => "\n",
    :description => 'List item',
    :example => '[ul][li]List item[/li][li]Another list item[/li][/ul].',
    :only_in => [ :ul, :ol ]},
  :img => {
    :html_open => '%between%', :html_close => '',
    :description => 'Image',
    :example => '[img]http://www.google.com/intl/en_ALL/images/logo.gif[/img].',
    :only_allow => [],
    :require_between => true,
    :allow_tag_param => true, :allow_tag_param_between => false,
    :tag_param => /^(\d*)x(\d*)$/,
    :tag_param_tokens => [{:token => :width, :prefix => 'width="', :postfix => '" ' },
                          { :token => :height,  :prefix => 'height="', :postfix => '" ' } ],
    :tag_param_description => 'The image parameters \'%param%\' are incorrect, <width>x<height> excepted'},
  :url => {
    :html_open => '%url%', :html_close => '',
    :description => 'Link to another page',
    :example => '[url]http://www.google.com/[/url].',
    :only_allow => [],
    :require_between => true,
    :allow_tag_param => true, :allow_tag_param_between => true,
    :tag_param => /^((((http|https|ftp|irc):\/\/)|\/).+)$/, :tag_param_tokens => [{ :token => :url }],
    :tag_param_description => 'The URL should start with http:// https://, ftp:// or /, instead of \'%param%\'' },
  :quote => {
    :first_html_open => "\n", :last_html_close => "\n",
    :html_open => "*--- Begin quote from __%author%__*\n\n", :html_close => "\n\n*--- End quote*\n\n",
    :description => 'Quote another person',
    :example => '[quote]BBCode is great[/quote]',
    :allow_tag_param => true, :allow_tag_param_between => false,
    :tag_param => /(.*)/,
    :tag_param_tokens => [{:token => :author, :prefix => '', :postfix => ""}]},
  :size => {
    :html_open => '[size=%size%]', :html_close => '[/size]',
    :description => 'Change the size of the text',
    :example => '[size=32]This is 32px[/size]',
    :allow_tag_param => true, :allow_tag_param_between => false,
    :tag_param => /(\d*)/,
    :tag_param_tokens => [{:token => :size}]},
  :color => {
    :html_open => '', :html_close => '',
    :description => 'Change the color of the text',
    :example => '[color=red]This is red[/color]',
    :allow_tag_param => true, :allow_tag_param_between => false,
    :tag_param => /(([a-z]+)|(#[0-9a-f]{6}))/i,
    :tag_param_tokens => [{:token => :color}]},
  :youtube => {
    :html_open => 'http://www.youtube.com/v/%between%', :html_close => '',
    :description => 'Youtube video',
    :example => '[youtube]E4Fbk52Mk1w[/youtube]',
    :only_allow => [],
    :url_varients => ["youtube.com", "youtu.be", "y2u.be"], # NOT USED
    :url_matches => [/youtube\.com.*[v]=([^&]*)/, /youtu\.be\/([^&]*)/, /y2u\.be\/([^&]*)/],
    :require_between => true},
  :vimeo => {
    :html_open => 'http://vimeo.com/%between%', 
    :html_close => '',
    :description => 'Vimeo video',
    :example => '[vimeo]http://vimeo.com/46141955[/vimeo]',
    :only_allow => [],
    :url_matches => [/vimeo\.com\/([^&]*)/],
    :require_between => true},
  :media => {
    :multi_tag => true,
    :supported_tags => [
      :youtube,
      :vimeo
    ]
  }
}

Class Method Summary

• .tag_list ⇒ Object

Class Method Details

.tag_list ⇒ Object

# File 'lib/tags/tags.rb', line 109

def self.tag_list
  @@tags
end