Editor Instruction Block
Add editor-only guidance notes to pages. These blocks are visible during editing but stripped from published output.
The Editor Instruction block embeds guidance notes directly into a page. These notes are visible to content authors in the editor but are automatically stripped during publishing, so they never appear on the live site.
When to Use
Block Properties
| Property | Required | Description |
|---|---|---|
| Message | Yes | The instruction text shown to the content author. Supports plain text. |
Visual Appearance
In the editor, the block renders as a dashed amber card with a sticky-note icon and an "Editor only" badge. This distinctive styling makes instructions stand out clearly from real content blocks.
| Element | Style |
|---|---|
| Border | Dashed, amber colour |
| Background | Light amber tint |
| Icon | Sticky note (amber) |
| Badge | "Editor only" label |
| Text | Placeholder: "Enter instruction for content authors..." |
Example: Template Page with Instructions
A typical template page might use editor-instruction blocks to guide authors on what content to add at each position.
How It Works
Best Practices
| Practice | Description |
|---|---|
| Be specific | Write clear, actionable instructions. "Add a component diagram" is better than "Add a diagram" |
| Position precisely | Place the instruction block exactly where the content should go |
| Include context | Mention style requirements, block types to use, or specific details to include |
| Use in templates | Editor instructions are most valuable in template pages that prescribe a standard structure |
| Remove when done | Once the guided content has been added, delete the instruction block to keep the page clean |