Guide

Fixed

• Fixed a Twig syntax error in Image components (thanks to @davidhellmann for the fix) #78
• Fixed broken links to README and CHANGELOG

Fixed

• Fixes an error that occurs when a guide query doesn’t return a guide #82

Added

• Added support for Craft 4 #70

Changed

• Updated components to use apply tags instead of filter.
  • NOTE: guides that use filter tags will need to be manually updated.

Removed

• Removed depreceated UI Element class, wbrowar\guide\fieldlayoutelements\GuideInclude.

Added

• Guides now support emoji 👀

Fixed

• Removed unused function that was causing install to fail (thanks, @internetztube) #49
• Fixed an issue where you couldn’t copy Guide export data #59
  • A new textarea includes your export data, so you can choose to copy it out of the textarea or use the button to copy it to your clipboard (when available).

Added

• Added new Changelog snippet.
  • Spiritual successor to the Changelog widget from the Communicator plugin.
• Added new Incorrect File Type snippet.
  • Find Assets in a volume that don’t match the desired file extensions.
• The current page hash is now tracked and available in guide templates as a Vue data variable, called hash.
• Individual guides can be selected when exporting guides in the Guide utility.
• A new widget option allows you to display the Guide title as the widget header.

Changed

• The Organizer has a new responsive layout—making it easier to use on smaller screen sizes.
• Low-Res Image Check and Missing Focal Points snippets now display as tables.
• Minor UI changes.

Fixed

• Fixed an issue where migrations between Guide 2 and 3 could have errored out when upgrading via the CP.

Added

• The Organizer has been rewritten so a single guide can be displayed in multiple areas around the CP.
• Guides can be placed in unique places, based on CSS selector.
• Guides can be added to a specific page in the CP, based on page URI and CSS selector.
• Guides can be placed on Global edit pages.
• A variable, guideDisplayArea, can be used to modify guides based on what area they are placed in.
• When grouped together, guides can be navigated via a menu in the top-right side of the guide display.
• A new Guide Variable setting has been for Project Name and it can be rendered using {{ craft.guide.var('projectName') }}.
• A button, labeled TL;DR, has been added to let you hide or show portions of guides.
• The guide editor groups components by tabs when using the code editor.
• Snippet components have been added to the Editor.
• Tailwind CSS-based utility classes have been added to assist in styling.
• Vue 3 variables—along with Twig helpers—have been added so that guides can make some template-based state changes.
• An on-load Vue component has been added to set Vue variables upon guide render.

Changed

• Guides no longer need to be selected for UI elements when in an environment where allowAdminChanges is enabled.
  • A Guide UI element can be placed in the field layout designer, then the guide that is populated there can be picked from within one of pages that use that field layout.
• Guides added to the Guide CP area now live together at /guide, instead of the Guide CP Section starting at the first guide’s individual page URI.
• When added to element edit pages, guides now live above or below the edit fields, instead of in the sidebar as buttons that open up modals.
• All guides are in the Twig format and the guide format setting has been removed.
  • You can use the {% filter markdown('gfm') %} filter around markdown content to render it in a guide.
• Tip Callout guide component has been replaced by Tip and Warning components that look more like native Craft info boxes.
• Guides are now rendered in Vue 3.
• Guide now welcomes you in three dimensions.

Fixed

• Guide template syntax errors are now caught in try/catch blocks and throw an error.
• Fixed times where the Guide code editor sometimes didn’t load correctly.
• Fixed some Guide 2 UI styling issues.

Removed

• See Upgrading from Guide 2 for suggestions around removed features.
• Rebrand settings have been removed.
• Per-guide user permissions have been removed.
• The <grid> tag has been removed.
  • To eventually be replaced by container query utility variants.
• Removed the craft.guide.getAllForUser() Twig variable.
• Guide no longer supports using .md templates.
• Guides no longer imports guide data and assets from an external repo.

Fixed

• Composer 2 compatibility #34

Added

• Add guides to element edit pages using a Guide IU element in the Craft 3.5 field layout designer.
• Add guides to asset edit pages.
• In situations where guides can get lost due to project config changes, a new Guide Recovery button in the Guide Utility can reset all guides to the Available Guides column of the Guide Organizer.

Changed

• Guide now requires Craft 3.5+
• Deprecated Header icon asset field and added a header icon text input in Guide Settings.
• Minor CSS changes.
• Documentation has been moved to a separate URL.

Fixed

• Fixed some style issues after upgrading to Craft 3.5.

Fixed

• Fixed an issue saving guides when using Postgres #31

Added

• A new max-width setting has been added to the main wrapper of all guide content.
• A warning is displayed when the { craft.guide.component() } Twig variable is used in the LITE edition of Guide.

Changed

• Twig image components now display a message when a valid asset or image URL has not been passed in.
• Twig image components now use the native loading attribute to lazy load images. All existing Twig image components will use native lazy loading, and the lazyLoad argument will be ignored.
• New Markdown image components will have the loading attribute added to them by default.

Fixed

• Fixed an error that occurs on some pages in the CP #27.
• Fixed an error when adding template guides in a Windows environment #29.
• Fixed an error that prevented guides templates from being imported when an Organizer hadn’t been created yet #30.

Changed

• Bumped required version of Craft to 3.4.0.

Fixed

• Fixed style bug on Guide Dashboard widgets based on a change from Craft 3.4 RC to 3.4 release.

Fixed

• Fixed style bug on Guide Dashboard widgets.

Fixed

• Fixed issue preventing plugin Javascript from loading.

Added

• Added drop targets to make it easier to drag-and-drop guides in the Organizer #25.

Changed

• Bumped minimum Craft version to ^3.4.0-RC1.
• Updated styles for Craft 3.4.
  • NOTE: This involved making some changes to Guide’s default styles and custom styles may need to be adjusted.
• Changed the label of "Unused Guides" to "Available Guides" in the Organizer #23.
• Images loaded through the Twig component are now lazy loaded via the native lazy attribute.

Fixed

• Fixed a bug that didn't display guides when creating a new category.
• Fixed path to Widget icon.

Fixed

• Fixed a bug that occurred when templates were removed from the Templates Path directory.

Fixed

• Fixed a bug where the Guide utility wasn’t available in the FREE edition.

Added

• File contents in guide templates can be moved to the Content Field in one click—making it easier to go from importing templates to editing their content in the Guide Editor.
• A Guide utility has been added to the Utilities CP section.
  • Guides can be imported from Craft Guide Templates
  • Guide data stored in the database can be exported from one environment (dev, staging, etc...) then imported into another environment.
  • The layout of guides in the Organizer are exported and imported, too.
• Guides can now be duplicated from the Guide Organizer via a new action button found on each guide (click on the gear to see guide actions).

Changed

• Importing guides from Craft Guide Templates has been moved from Settings to the Guide Utility.
  • This makes it possible to import guides on a server where allowAdminChanges is set to false.
• When saving a guide, -1 will be appended to the slug if the slug is not unique.

Added

• A new variable, craft.guide.include(), lets you include the content of one guide into another guide.
  • Using this variable renders the guide content in a Twig-based guide regardless of whether the format of the imported guide is Twig or Markdown.
• An "Include Guide" component has been added for Twig-based guides
  • If you do not see the "Include Guide" component, try visiting the Components settings page in Guide Settings, make sure "Include Guide" is enabled, then re-save the Component settings page.
• Added a Recipes, Tips, and Tricks section to the README.

Changed

• The "Markdown" component now defaults to GitHub Flavored Markdown to match Guide’s default Markdown flavor.

Fixed

• Fixed a bug that did’t allow the editor to work when devMode was set to false.
• Made the CSS selector of Guide iframe content more specific to avoid affecting Live Preview iframes.
• Gave import options unique IDs to avoid multiple selects when clicking on a checkbox label.

Please upgrade to Guide 1.4.0 before upgrading to 2.0.0. Tips for upgrading from Guide 1 can be found here.

Added

• Guides can be imported from Craft Guide Templates within Guide’s settings page
• Added Organizer
  • Drag and drop interface for creating and managing guides
• Added Ace to the guide editor for syntax highlighting in Markdown and Twig
• Added component snippets
  • Drag a component into the editor to place it's code
  • Automatically generated image components are created based on image assets in your Guide Assets Volume
  • Less-used components can be hidden from the guide editor using the Guide settings page
• External documentation can be used for the content of a guide as an iframe
  • Works great with VuePress-style docs where everything is self contained
• Guides can be added to the sidebar on categories edit pages and user edit pages
• Guides can now use Twig's include functions to pull in external templates
• Styling guide content can now be done through color fields in the CMS
• A custom logo can be uploaded to replace the Guide icon in guide headers
• A print style sheet is added to Guide pages to remove Craft’s UI and to extend the content to fill a piece of paper

Changed

• Guide widgets now pull their content from guides created in the Organizer
• Permissions for who may edit guides have been moved out of plugin settings and into individual guides
• Minimum requirement for Craft has been changed to 3.2

Removed

• Removed table-based Navigation
  • CP Navigation is now managed in the Organizer
• Removed Email Support, Welcome Widget, and Website Updates widgets
  • The functionality of these widgets can be found in a new plugin, Communicator
• Custom Variables settings have been removed
  • Use Craft’s alias() and getenv() functions to get
• Removed the updateGuideCpNav() Twig function

Added

• Added a new Edit Guide Navigation permission
• Added Guide 2.0 deprecation warnings for widget features
  • Guide 2.0 is in the works! The Email Support, Website Updates, and Welcome Widget will all be removed from Guide in 2.0, but a new plugin, called Communicator, is available for free and includes all of these widgets. You can download it in the Craft Plugin Store: https://plugins.craftcms.com/communicator

Changed

• Bumped the minimum required version of Craft to 3.1.20.1
• CP navigation management has been moved from the Guide plugin settings page to its own CP tab

Fixed

• Fixed user permissions set in the navigation not getting validated correctly

Fixed

• Fixed an issue that occurred when converting template guides to User Guides on some servers (#10)

Fixed

• Fixed an issue that caused subnav to disappear when in Guide CP section pages (#2)
• Fixed a bug that occurred when all Guide Nav items are removed (#9)

Added

• Added a new widget, Email Support, that lets clients send a custom message and basic browser and site details to a support contact
  • Support contacts can be added in Guide plugin settings
• Added options to turn off entire features from the Guide plugin settings page
  • These settings can also be multi-environment aware by adding them to config/guide.php
  • NOTE: Craft cannot globally disable widgets, so disabling a widget requires that instances of that widget are manually removed

Changed

• Updated the plugin icon
• Changed the name of "Admin‘s Log" to "Website Updates" throughout
• Cleaned up unused classes

Fixed

• Fixed a bug where the Guide CP section navigation wasn‘t scrolling upon click

Changed

• In places where the template mode is being set, the template mode is returned back to what it previously was

Fixed

• Fixed a bug that occurred when {{ guideVar() }} was called and no Custom Variables were set
• Fixed a bug that prevented User Guides from being deleted on Entry Edit pages
• Hid the "Delete" button on new User Guides

Added

• Added the ability to add, edit, and delete User Guides in the Guide CP Section
  • Existing template-based guides can continue to be edited via Twig templates, or can be "converted" over to a User Guide—stored in the database
  • Guides in the CP section can be created using Twig or Markdown
• Added a new Welcome Widget
  • Unlike the Guide Widgets that are created for individual users, this widget can be set in one place and updated across all users who have this widget installed
  • To edit Welcome Widget's content, use the "Guide > Welcome Widget" tab in the global sidebar
• Added an Admin's Log widget
  • Create a changelog for your clients and collaborators
  • Manage the log in the "Guide > Admin's Log" tab in the global sidebar
  • Logs are shown with the newest first and users can choose how many log entries they would like to see on their dashboard

Changed

• updateGuideCpNav now only sets the Guide CP Section subnav when no navigation has been created
  • Going forward, use updateGuideCpNav in your Guide CP templates to set the initial subnav links, then edit the subnav in Guide plugin settings
  • This was changed to help facilitate the ability to manage the subnav in plugin settings, as well as to help reduce unneeded re-setting of the subnav on every page load

Fixed

• Fixed a bug when looking for a Content Guide on an entry edit page when an entry wasn't enabled

Changed

• Added margin above and below hr tags

Fixed

• Fixed a bug that duplicated encrypted custom guideVars()

Added

• You can now store custom guideVar() variables by setting their keys and values in Guide Plugin Settings
  • You can store plain strings, as well as encrypted strings for displaying passwords and sensitive information in your CMS guide

Changed

• Modified the style of the Sections dropdown to show hierarchy based on element types (h1, h2, h3, and h4)

Fixed

• Fixed some wonky migration bugs
• Fixed a bug that occurred when Admin Bar wasn't installed
• Fixed guide CP section not displaying the currently selected page in the sidebar nav

Added

• Added a guide_fpo class that outlines an element in a bright pink color so you don't forget to change it
  • Added this class around the output of guideVar() variables that haven't been set in Settings
• Admin Bar Widget is now validated via PHP
• Added the ability to change guideQuery() from all to either one or count by passing in a second parameter
• Added more examples to Components page

Fixed

• Removed header styles that bled out of Admin Bar widget

Fixed

• Fixed Admin Bar widget not getting removed

Added

• Added Custom CSS preview in Guide plugin settings to make re-branding easier
• Add an Admin Bar Widget
  • If a user is on an entry that has a Content Guide it will appear in Admin Bar
• Added guideAsset() twig tag to get image assets based on their filename
• Added guideQuery() twig tag to query existing Content Guides
• Added pluginEnabled() twig tag to check to see if a plugin is installed
• Added a config.php file to override plugin settings (copy this to config/guide.php to get it to work)

Added

• Added collaborative guides to Entry edit pages
  • For each Entry Type you can set instructions that appear when clicking on a button in the sidebar
  • Users with the right permissions can edit these guides using either Markdown, Twig, or by pointing to a frontend template in the site's templates directory
• Added Twig extensions that make it easier to personalize guides that are copied from one client to another. See Settings for more information
• Added a "More info" button to the bottom of guides that appear in edit pages
  • This button can link to the Guide CP section, or anywhere else that could be useful for content editors (like Craft documentation pages)
• Added "Create Guides" and "Delete Guides" permissions
• Added CSS Custom Properties defaults above the Settings > Custom CSS field to make it easier to rebrand style containers
• Added a max-width to guides in the Guide CP Section. This can be adjusted in Setting > Custom CSS

Changed

• Changed "Sections" button in Guide CP Section over to a button that should be clicked/tapped to show section links. Clicking or tapping the button will hide the sections links
• For consistency, changed guide__code_block to guide_code_block and guide__code_inline to guide_code_inline
• Updated Schema version
  • [looks at camera and breaks the fourth wall] This is my first time creating a migration, so if it doesn't work, please let me know.

Fixed

• Fixed an issue that prevented Guide from being installed via the console
• Fixed a Javascript bug that prevented the ability to jump to sections on the Guide CP Section

Added

• Added a drop down subnavigation to jump down to a sections on a page
• Added a way to flag header elements as data-guide-section, which adds the element to the drop down subnav
• Added styles for table elements
• Added a new grid style for featuring screenshot images or other media

Changed

• Made some tweaks and added some default CSS Custom Properties to guide.css.

Added

• Added new page to preview style components.

Changed

• Made some tweaks and added some defaults to guide.css.

Fixed

• Restrict loading guide.js to CP only.
• Fixed paths to all GitHub files

Added

• Initial release