What this covers

A walkthrough of every region of the editor chrome and what each one does. Read this once after the first login; you will not need to come back. The rest of the User Guide assumes you know which sidebar item to click for what.

Walkthrough

The sidebar (left)

The sidebar lists modules with display_type sidebar. Out of the box that is three rows:

Sidebar item What it does
Pages Browse, create, edit, reorder, and delete pages. The module you spend most of your time in.
Settings Site-wide configuration: title, language, timezone, theme, a handful of operational knobs.
Plugins Read-only browser of the plugins Composer installed. Shows name, version, status.

Plugins can contribute their own sidebar items through the Plugin API; they appear here in the same list. The Installed plugins topic covers how to recognise plugin-contributed sidebar items.

Each item is a link to its module's home, for example Pages opens /editor/pages/. The current module is highlighted.

The top bar (right)

The top-right corner is the profile menu with two items:

Top-bar item What it does
Profile Change your own email and password. Each editor account has its own profile.
Logout End the current session and return to the login form.

The top bar is the same on every page of the editor.

The Dashboard (no module selected)

/editor/ with no module slug shows the Dashboard: an empty page with the message "Pick a module from the sidebar to start editing." This is the default landing after login and intentionally minimal, and makes no decisions for you about what to do next.

Inside Pages: the page tree

/editor/pages/ opens the page tree on the left and the form for the page you are editing on the right. The tree shows every page in your site as a nested list, with the page slug and a published / unpublished marker.

Clicking a row loads that page into the form on the right. Clicking the + button next to a row creates a child page. Drag-drop reorders pages within the same parent or moves them to a different parent. The Reorder, move, and delete pages topic covers reordering in detail.

Inside Pages: the form

The form has nine fields. The Create and edit pages topic walks them in detail; in summary order:

  • Name: the page's display name.
  • Menu Title: what navigation menus show instead of the Name.
  • Slug: the URL segment.
  • Content: the body, written in markdown.
  • Images: the FilePond uploader, covered in Files and images.
  • Parent Page: where the page lives in the tree.
  • Page template: which theme template renders the page.
  • Position: the order within the parent (drag handle in the tree).
  • Published (checkbox): whether visitors can see the page. Unchecked = unpublished; the editor still sees it.

A Save button at the bottom commits the form.

The preview overlay

The page form also has a Preview action that opens an overlay with the markdown content rendered to HTML, so you can check formatting without saving. The overlay shows the body HTML only; it does not wrap the result in the active theme. For the full theme-rendered look, save the page and visit it in a separate browser tab. The Drafts and preview topic covers when each is the right tool.

Inside Settings

/editor/settings/ is a read-only landing page that points at the two config files where Scriptor's settings actually live: data/settings/scriptor-config.php (defaults shipped with Scriptor) and data/settings/custom.scriptor-config.php (operator overrides). There is no in-editor form for site settings; changes happen by editing those files.

The Site settings and theme switch topic covers what each setting does and how to change it.

Inside Plugins

/editor/plugins/ is a read-only list of every Scriptor plugin Composer installed. Each row shows:

  • Name: the vendor/package identifier.
  • Version: the installed version string.
  • Status: whether the plugin is enabled or has been disabled via plugins.disabled in your custom config.

There is no install or remove action in the UI; plugin install happens through Composer (or the Docker build arg). The Installed plugins topic covers what to do when you need to add or remove a plugin.

What to check after

You should be able to point at every region without looking:

  • The three sidebar items (Pages, Settings, Plugins) and what each one opens.
  • The two top-bar items (Profile, Logout).
  • The three regions of the Pages module (tree on the left, form on the right, preview overlay on demand).
  • Where to find the active theme name (theme_path in data/settings/scriptor-config.php, mentioned on the Settings landing).
  • Where to find the installed plugin list (Plugins).

Troubleshooting

A sidebar item I expected is missing

Two common causes:

  1. The module was deactivated. Look at the modules block in data/settings/scriptor-config.php (or your custom override). An entry with 'active' => false is hidden from the sidebar without being uninstalled.
  2. The plugin that contributes it is disabled. A plugin listed under plugins.disabled in your config does not run its register() hook, so its registerEditorModule() and addEditorMenuItem() calls never happen.

Clicking a sidebar item shows a 404 with "Module not available"

The module's slug is registered in the sidebar but no module is mounted at it. This usually means a custom-config tweak (adding a sidebar item to a slug that no plugin owns) or a partially removed plugin (the menu item was hard-coded into config but the plugin no longer registers). Remove the orphan entry from the sidebar config or restore the plugin.

See also