Step

⚠️ ARCHIVED: This module is no longer in use or maintained.

This repository is archived and kept for historical reference only. It receives no updates, bug fixes, or security patches. Do not install it on new sites.

Replacement: Use the CKEditor Templates module (ckeditor_templates) to insert the [step]…[/step] shortcode into the node body.

What it was

Step is a Drupal module that added a "Step" button to the CKEditor 5 toolbar. It was used when writing tutorial content on the OIT site.

When an editor clicked the button, the plugin inserted this shortcode placeholder at the cursor position:

[step]Step Text[/step]

The editor then replaced Step Text with the content of the tutorial step. The module only inserted the shortcode text. It did not render it. Rendering was done by the TutorialStep shortcode plugin in the tutorial module.

Technical overview

• Drupal: ^10 || ^11. Depends on core ckeditor5.
• Plugin definition: step.ckeditor5.yml registers the step_step CKEditor 5 plugin and the step toolbar item ("Add step to tutorials").
• Libraries: step.libraries.yml defines:
  • step/step: the compiled editor plugin (js/build/step.js).
  • step/admin.step: the toolbar icon styling for the text format admin form (css/step.admin.css).
• JavaScript source: js/ckeditor5_plugins/step/src/
  • step.js: plugin entry point.
  • stepediting.js: registers the insertStep command.
  • insertstepcommand.js: inserts the [step]…[/step] text.
  • stepui.js: registers the toolbar button and icon (icons/step.svg).

Building (historical)

The plugin was built with webpack against CKEditor 5 ~34.1.0:

yarn install
yarn build    # or: yarn watch

Removing it from a site

If a site still has this module enabled:

1. Remove the Step button from any text format toolbars that use it (/admin/config/content/formats). If editors still need to insert step shortcodes, set up a ckeditor_templates template for them instead.
2. Uninstall the module: drush pm:uninstall step.
3. Remove the package: composer remove oit/step.
4. Export config: drush cex.

Existing content that contains [step]…[/step] shortcodes is not changed when you remove this module. Those shortcodes still render as long as the tutorial module's shortcode handling remains in place.

License

GPL-2.0-or-later