Editing Guides

A guide can be written in the built-in code editor, imported as a template, or embedded as an iframe. All guides are created and configured in the Guide Editor.

Guide Editor

To create a new guide, go to the Organizer tab in the Guide CP section and click on the + New Guide button.

When setting up a guide, you’ll set the following options under the Settings tab:

OptionsDescription
TitleThe title of the guide as it appears throughout the CMS.
SlugThe slug of the guide used in its URI. This slug is used when including guide content into another.
Content SourceDetermine if the guide’s content should come from the code editor, a Twig template in your Guide Templates directory, or an external URL.
SummaryA short summary of the guide displayed on the guide in the Organizer.

Components

Guide Component

When using the code editor to create a guide you’ll see a row of tabs in the top-left of the editor. Each tab contains a list of components that can be added to your guide. Some components are simple shorthand for HTML markup where other components provide examples of things you can do within your guides. To see what a component does, and what arguments are available to it, click on the component’s Documentation button.

Components are based on a Guide variable and they look this:

{{ craft.guide.component('image', { url: 'REPLACE_URL' }) }}

The first thing passed into the component variable is the handle for the component. In this case, its image. The second argument is an object of variables. This is an example of an image component that pulls an image file in from an external URL, so the url variable is used to set the image source.

Under the hood, the Twig component is transforming the image to optimize its file size at both 1x and 2x resolutions and lazy loading is added so the image doesn’t load until the reader scrolls down to it.

The above example is based on the Image component, however, when you drag an asset component from the Images tab into the editor field you'll notice that the same image handle is used but different variables are passed in:

{{ craft.guide.component('image', { asset: craft.assets.filename('my-image.jpg').volume('guide').one() }) }}

In this case, we're passing in a full image asset and the URL of the image will get extracted out within the component. You could use this same asset variable when looping through several image assets at a time.

{% set assets = craft.assets.volume('guide').all() %}

{% for asset in assets %}
  {{ craft.guide.component('image', { asset: asset }) }}
{% endfor %}

Snippets

The components in the Snippets tab are chunks of Twig code that can provide dynamically updated information to project authors. For example, you could create a widget using the Low-Res Image Check snippet—making it easy for editors to spot images that don't meet the minimum resolution needed for images in a specific asset volume.

{# Set the asset volume you would like to check for images in. #}
{% set volume = 'REPLACE_VOLUME' %}
{# Set the width to the smallest size that an image should be uploaded. #}
{% set width = 300 %}

{# Find all images within the targeted asset volume that are not wider than the "width" value. #}
{% set assets = craft.assets.volume(volume).width('< ' ~ width).kind('image').all() %}

{# Display a list of invalid images and instruct authors on what size is recommended. #}
{% if assets|length %}
  <h2>Images that are too small (less than {{ width }}px wide)</h2>
  <p>These images should be replaced with a .jpg that is at least {{ width }}px wide.</p>
  
  <div class="g-space-y-2">
    {% for asset in assets %}
      <div class="g-grid g-grid-cols-[var(--grid-cols)] g-gap-2" style="--grid-cols: 300px 1fr;">
        <img loading="lazy" src="{{ asset.url }}" width="300" />
        <div>
          {{ craft.guide.component('button', { attrs: { class: ['submit'] }, label: 'Edit Image', url: asset.cpEditUrl }) }}
          <p><strong>Title</strong><br>{{ asset.title }}</p>
          <p><strong>File name</strong><br>{{ asset.filename }}</p>
          <p><strong>Width</strong><br>{{ asset.width }}px</p>
        </div>
      </div>
    {% endfor %}
  </div>
{% endif %}

Snippets can be modified or even used as starters to create more complicated guides. Some snippets include variables set at the top of the snippet to make it easy to customize the code within.

If nothing else, snippets can be used as inspiration to help solve common AX issues!

Twig Variables

In addition to components, Guide provides a set of Twig variables:

VariableExample/Description
componentExample: {{ craft.guide.component('audio', { url: 'my-song.mp3' }) }}
Renders a Guide component based on the handle set in the first argument and a configuration object in the second argument.
getAllExample: {{ craft.guide.getAll() }}
Performs a search of all guides that fit the criteria passed in. This will return an array of guide objects.
getOneExample: {{ craft.guide.getOne({ id: 10 }) }}
Returns a single guide object based on the criteria passed in.
includeExample: {{ craft.guide.include({ slug: 'assets' }) }}
Finds a matching guide and renders its content in place.
varExample: {{ craft.guide.var('clientName') }}
Returns variables set in Guide Settings.

Context-Aware Guides

When using guides on element edit pages and in UI elements, context variables are available that represents the specific piece of content you are editing.

VariableDescription
elementFound on Asset, Category, and Entry edit pages. Represents the current element you are updating.
userFound on User edit pages. Represents the current user you are updating.

Because guides can be moved around the CP, it’s a good idea to check for the variable before it is used in a guide. For example, if you want to show the title of the current entry in your guide, you could write something like this:

{% if element ?? false %}
  <p><strong>Element title:</strong> {{ element.title }}</p>
{% else %}
  <p>This guide was not added to an entry edit page.</p>
{% endif %}

Guide Templates

You may use templates to create your CMS guide in a way that's easily portable from one Craft site to another. To add a template to your CMS guide, follow these instructions:

  1. Create your guide template and save it using .twig or .html as its file extension.
  2. Place your file into the directory set as the Template Path setting in the Guide setting page. The default is set to _guide, so in that case your file would need to go into ./templates/_guide/.
  3. Go to the Organizer tab in the Guide CP section and click on the + New Guide button to create a new guide.
  4. Set Content Source to Page Template.
  5. Select your new template in the Template field in the Editor tab.
  6. Click the Save button.
  7. Use the Organizer to add your guide to the Craft CP or click on the View button to visit the guide’s page within the CP.

Guides in your Template Path can be included and imported by using the path guide_template_path in your Twig tags.

For example, a Twig file at the location ./templates/_guide/header.twig would be can be included using: {% include 'guide_template_path/header.twig' %}.

This will allow you to move the Template Path to a different location without breaking your includes and imports.

External Documentation

Selecting External Page from the Content Source guide option will let you display an external page in an iframe.

The Craft Docs in an iframe

Some websites don’t allow for their pages to appear in iframes. The owner of a website may be able to confgure their server to allow for their content to appear in an iframe, however, this is usually set up this way for security reasons.

Edit this page on GitHub Updated at Wed, Aug 25, 2021