Ascribe

Filter Basics

You can use filters to modify the markup produced by output tags. A filter is a simple method that takes a single parameter, which is always the output of the portion of the output to the left of the filter. For example, you can use the mail_to filter within an Ascribe template to turn your company's email address into a clickable link:

If your company's email address is "bids@example.com" then this would produce the HTML markup:

Filters can also be chained together. In this case, the result of each filter becomes the input of the next in line. For example, this chain of two filters will turn your email into an upper-cased clickable link:

If your company's email address is "bids@example.com" then this would produce the HTML markup:

String Filters

capitalize

Capitalizes each word in the string.

downcase

Converts all characters to lowercase.

remove

Removes all instances of specified text from the string. For example, {{ company.company_website_path | remove: "http://" }} removes the prefix from the company's web site address.

remove_first

Same as remove, but only removes the first instance of the specified text.

replace

Replaces characters in the string. For example, {{ project.street | replace: "St.", "Street" }} would spell out the abbreviation "St." if encountered in the variable. You can use regular expressions in the search and replacement.

replace_first

Same as replace, but only replaces the first instance of the specified text.

size

Returns the number of characters in the string.

truncate

By default, truncates a string to 50 characters and adds "...". You can modify these parameters by supplying arguments to the filter. For example, {{ project.title | truncate: 10, "" }} will truncate the project title to 10 characters and not add anything after it.

truncatewords

By default, truncates a string to 15 words. You can change the number of words by supplying an argument. For example, {{ project.description | truncatewords: 10 }} will retrieve the first 10 words of the project description.

upcase

Converts all characters to uppercase.

Collection Filters

first

Returns the first item in the collection.

join

Concatenates all items in a collection by putting a supplied string between them. For example, {{ projects | join, ", " }} will produce a list like this: "New Office Building, Shopping Center Remodel, Site Survey - Grand Road, Plant Addition".

last

Returns the last item in the collection.

size

Returns the number of items in the collection

sort

Sorts the collection by name. There is no way to sort by a property of the objects in the collection.

Date Filter

date

Presents a date by using a supplied format string. For example, {{ project.completed_at | date: "%m/%d/%y" }} will return a string such as "08/22/09". The table below shows the special characters that you can use in the format string.

Presentation Filters

escape

Escapes all HTML in a string, making it safe for screen output regardless of its source.

h

Same as escape.

mail_to

Converts an email address to a hyperlink.

newline_to_br

Converts all newlines to <br /> tags.

simple_format

Applies simple formatting rules to a string: converts all single newline characters to <br /> tags and all doubled newline characters to <p> tag pairs.

strip_html

Removes all HTML from a string.

strip_newlines

Removes all newlines from a string.

• Main Help Page
• Customizing Ascribe
• Using Liquid