diff options
| author | Douglas Barbosa Alexandre <dbalexandre@gmail.com> | 2016-01-12 20:24:17 -0200 |
|---|---|---|
| committer | Douglas Barbosa Alexandre <dbalexandre@gmail.com> | 2016-01-14 12:09:31 -0200 |
| commit | ac2c86055eb189690bf67cf97cc6eb5ec9c2be7b (patch) | |
| tree | e025cb5f06ed566c5ccb875a07617f01f27d150f /lib/banzai | |
| parent | a8c836c371cb253d5e611a1080cd54f9cf4698e9 (diff) | |
| download | gitlab-ce-ac2c86055eb189690bf67cf97cc6eb5ec9c2be7b.tar.gz | |
Update documentation on Banzai::Filter::GollumTagsFilter
Diffstat (limited to 'lib/banzai')
| -rw-r--r-- | lib/banzai/filter/gollum_tags_filter.rb | 40 |
1 files changed, 38 insertions, 2 deletions
diff --git a/lib/banzai/filter/gollum_tags_filter.rb b/lib/banzai/filter/gollum_tags_filter.rb index e4a73030597..fe01dae4850 100644 --- a/lib/banzai/filter/gollum_tags_filter.rb +++ b/lib/banzai/filter/gollum_tags_filter.rb @@ -3,7 +3,28 @@ require 'html/pipeline/filter' module Banzai module Filter - # HTML Filter for parsing Gollum's tags in HTML. + # HTML Filter for parsing Gollum's tags in HTML. It's only parses the + # following tags: + # + # - Link to internal pages: + # + # * [[Bug Reports]] + # * [[How to Contribute|Contributing]] + # + # - Link to external resources: + # + # * [[http://en.wikipedia.org/wiki/Git_(software)]] + # * [[Git|http://en.wikipedia.org/wiki/Git_(software)]] + # + # - Link internal images, the special attributes will be ignored: + # + # * [[images/logo.png]] + # * [[images/logo.png|alt=Logo]] + # + # - Link external images, the special attributes will be ignored: + # + # * [[http://example.com/images/logo.png]] + # * [[http://example.com/images/logo.png|alt=Logo]] # # Based on Gollum::Filter::Tags # @@ -13,7 +34,22 @@ module Banzai class GollumTagsFilter < HTML::Pipeline::Filter include ActionView::Helpers::TagHelper - # Pattern to match tag contents. + # Pattern to match tags content that should be parsed in HTML. + # + # Gollum's tags have been made to resemble the tags of other markups, + # especially MediaWiki. The basic syntax is: + # + # [[tag]] + # + # Some tags will accept attributes which are separated by pipe + # symbols.Some attributes must precede the tag and some must follow it: + # + # [[prefix-attribute|tag]] + # [[tag|suffix-attribute]] + # + # See https://github.com/gollum/gollum/wiki + # + # Rubular: http://rubular.com/r/7dQnE5CUCH TAGS_PATTERN = %r{\[\[(.+?)\]\]} # Pattern to match allowed image extensions |