Field Types / Article field

This extension provides an "Article" field type, which is a powerful text editor for creating rich content in your Bolt websites. It can work with grids, embeds, typographic markup and media. The editor itself is developed by Imperavi, and is licensed for usage in Bolt.

The Article extension ships with Bolt by default. If you're on a custom install, it might need to be installed before you can use it in your website. If so, run the following command to install it:

composer require bolt/article

Basic Configuration:¶

To add Article fields in your ContentTypes, use type: article in contenttypes.yaml:

        content:
            type: article

Example usage in templates:¶

To print out the Article field you just need to do in your templates:

{{ record.content }}

The result will be like this:

You can configure the editor in config/extensions/bolt-article.yaml. This configuration affects all the instances of the Article field that you've configured in your ContentTypes. The default configuration looks like this:

default:
  plugins: [ blockcode, buttonlink, definedlinks, inlineformat, reorder, tags, underline ]
  source: true
  grid:
    classname: 'article-grid'
    columns: 12
    patterns:
      '4|4|4': 'col-4|col-4|col-4'
      '4|8': 'col-4|col-8'
      '6|6': 'col-6|col-6'
      '8|4': 'col-8|col-4'

plugins:
  ~

Configuring the buttons¶

Bolt's version of Article ships with all the official plugins and options. you can add or remove buttons and plugins by configuring them in the plugins: parameters. Check the official Article documentation for all available buttons. Note that some buttons might require you to enable the corresponding plugin as well. See here for a list of the available plugins.

Settings¶

Where applicable, you can add extra settings under the default: key in the bolt-article.yaml configuration. See the documentation for available settings.

Note that this documentation uses Javascript, whilst Bolt's configuration uses Yaml. For example, the documentation for 'Paste' has this example:

ArticleEditor('#entry', {
    css: '/your-article-dist-path/',
    paste: {
        autolink: false
    }
});

In bolt-Article.yaml you can add this as:

default:
  buttons: [ …]
  plugins: [ … ]
  css: '/your-article-dist-path/'
  paste:
    autolink: false

Default plugins¶

For a list of all plugins that ship with Article, check out Imperavi.

Adding custom plugins¶

If you've written your own block or plugin for Article according to the documentation for Creating Plugins or for Creating Blocks, you can add it to the editor in Bolt, by placing it in /public/assets/article/_plugins. Then, add it to the bolt-article.yaml configuration:

default:
  buttons: [ … ]
  plugins: [ … ]

plugins:
  myplugin: [ 'myplugin/myplugin.js', 'myplugin/myplugin.css' ]

Grid setup¶

Using Article, you can allow the editors to insert Grid elements, splitting up the "main column" in two or more columns, allowing them more variations for laying out content.

By default, Article has a simple grid that consists of 12 columns, and allows the editors to pick '4 + 4 + 4', '4 + 8', '6 + 6' and '8 + 4' as options. The grid will create HTML like this:

<div class="article-grid">
    <div class="col-6">
    …
    </div>
    <div class="col-6">
    …
    </div>
</div>

On the front end of the website, this needs to be styled correctly as CSS, in order to work properly. This can be done in a few ways:

1. Linking to the default styles.
2. Copy the grid.css file to your theme to customize it.
3. Manually styling the grid, using your own CSS.

You can link the grid.css that ships with Article using the following:

<link rel="stylesheet" href="{{ asset('assets/article/grid.css', 'public') }}">

If you prefer to copy the file to your own theme, you can link it using:

<link rel="stylesheet" href="{{ asset('css/article_grid.css', 'theme') }}">

Alternatively, if your theme is using Bootstrap or Bulma, you can configure Article to use the grid format from your preferred framework directly. See the documentation on using Bootstrap grid or using Bulma grid.

Input Sanitisation¶

All content in this field type will be sanitised before it gets inserted into the database. This means that only 'whitelisted' HTML like <b> and <img src="…"> is kept, while things like <embed> and <script> are scrubbed from the field before being stored. As a site-implementor you can control the whitelisted tags and attributes using the following section in config.yaml:

htmlcleaner:
    allowed_tags: [ div, span, p, br, hr, s, u, strong, em, i, b, li, ul, ol, …, … ]
    allowed_attributes: [ id, class, style, name, value, href, src, alt, title, …, … ]

To disable sanitisation for this field, you can add sanitise: false to the field config, like so:

        title:
            type: article
            sanitise: false