Nanoc3::Helpers::Text contains several useful text-related helper functions.

Public Visibility

Public Instance Method Summary

#excerptize(string, params = {})	Returns an excerpt for the given string.
#strip_html(string)	Strips all HTML tags out of the given string.

Public Instance Method Details

excerptize

public excerptize(string, params = {})

Returns an excerpt for the given string. HTML tags are ignored, so if you don’t want them to turn up, they should be stripped from the string before passing it to the excerpt function.

params is a hash where the following keys can be set:

`length`:	The maximum number of characters this excerpt can contain, including the omission. Defaults to 25.
`omission`:	The string to append to the excerpt when the excerpt is shorter than the original string. Defaults to ’…’ (but in HTML, you may want to use something more fancy, like ’…’).

[View source]

    
21
22
23
24
25
26
27
28
29
30
        
          # File 'lib/nanoc3/helpers/text.rb', line 21

def excerptize(string, params={})
  # Initialize params
  params[:length]   ||= 25
  params[:omission] ||= '...'

  # Get excerpt
  length = params[:length] - params[:omission].length
  length = 0 if length < 0
  (string.length > params[:length] ? string[0...length] + params[:omission] : string)
end

strip_html

public strip_html(string)

Strips all HTML tags out of the given string.