craft-plugin guide

wbrowar/guide

A CMS Guide for Craft CMS.

Guide is an author’s notebook and a developer’s best friend., _(*1)

Content authors can create and manage their own CMS Guide, create pages in Craft CMS’s Control Panel, and manage their own content shown in widgets and slideout panels on entry edit pages., _(*2)

Developers can use Guide instead of writing custom modules and site-specific plugins that provide reports, content-editing warnings, and tools that customize the author-experience around Craft CMS’s Control Panel., _(*3)

Guide makes it easy to share helpful information all around the Craft CMS Control panel, so content authors don‘t need to go far to get the answers they need., _(*4)

Guide content, AKA guides, can be written in Markdown or Twig using the built-in text editor. When using Twig you can use anything available in Craft CMS’s Twig tags, methods, and filters—and you can even use Twig code provided by other plugins., _(*5)

The Guide Organizer shows you all of the guides in your CMS and makes it easy to add them around the Craft CMS Control Panel. Guides can appear on their own standalone pages, in slideouts, as widgets, and amongst editing fields in UI Elements. With a little CSS know-how you can even use Guide to add HTML elements to the Control Panel UI., _(*6)

Guide 5 for Craft CMS 5+

Requirements

• This plugin requires Craft CMS 5.3 or later.

Editions

The PRO edition of Guide includes the Guide Organizer and a code editor with Twig components that make it easy to create guides and distribute them throughout the Craft CMS Control Panel (edit page slideouts, standalone CP pages, widgets, UI elements, and any CP URL you specify)., _(*7)

The LITE edition is offered for developers who prefer to write their own guide Twig templates in their favorite code editor and to display them on the CMS Guide page., _(*8)

[!TIP] Guide’s edition can be upgraded to PRO at any time., _(*9)

Guide PRO can be purchased in the Craft Plugin Store., _(*10)

This documentation includes the features available in the LITE edition, but it is written based on all of the features found in the PRO edition., _(*11)

Installation

To install the plugin, you can find it in the Craft Plugin Store, or follow these instructions., _(*12)

1. Open your terminal and go to your Craft project:, _(*13)

   cd /path/to/project
   

2. Then tell Composer to load the plugin:, _(*14)

   composer require wbrowar/guide
   

3. In the Control Panel, go to Settings → Plugins and click the “Install” button for Guide., _(*15)

Setup

1. Visit the Guide Settings page to configure a couple of setup options. The Template Path setting is required for guides to be displayed from Twig files in your project’s /templates directory. The Asset Volume setting is recommended when screenshots and other images are used in your guide content.
2. Create your guides using the built-in editor or by selecting templates added to your Template Path directory.
3. Use the Guide Organizer to place your guides around the Craft CMS Control Panel.

Documentation

The documentation for Guide features can be found in your Craft CMS project (look for blue buttons on Guide CP pages) or in the following Markdown files:, _(*16)

• Guide Settings
• Guides
• Guide Editor
• Guide Editor CSS
• Guide Editor JavaScript
• Guide Organizer

Releases

Release notes can be found at CHANGELOG.md, _(*17)

Supported Versions

Here is a general goal for adding and supporting features for Guide going forward:, _(*18)

• New features for the plugin will be added to the current major plugin version that targets the current released version of Craft CMS.
• The latest major plugin version that targets the previous released major version of Craft CMS will be supported with bug fixes introduced in updates to that version of Craft CMS.
• Previous major plugin versions will only get security-related updates—when necessary.

Brought to you by Will Browar, _(*19)