Template:Instruction/doc

From Encyclopedia Ephemera
Revision as of 14:15, 9 April 2026 by ephemera>Unknown user

Template:Instruction documentation

Purpose

This template stores machine-readable metadata for pages in the [[Instructions:]] namespace.

The PHP backend reads this metadata through template parameter parsing in wiki_parse_json_block() and wiki_normalise_template_meta(). The most important fields for context assembly are:

  • id
  • type
  • requires
  • tags
  • status
  • priority
  • canonical
  • applies_to
  • task_type
  • include_by_default

Usage

{{Instruction
|id=example-page
|type=workflow
|applies_to=Sources
|task_type=create
|priority=high
|status=active
|canonical=true
|include_by_default=no
|requires=Instructions:World Bible,Instructions:Schema/Source Page
|tags=example,workflow
}}

Field notes

id
Stable machine-readable identifier.
type
Common values include core, workflow, schema, style, and reference.
applies_to
Common values include mixed, Encyclopedia, Sources, Talk, and Instructions.
task_type
Common values include create, edit, analyze, summarize, and system.
requires
Comma-separated list of page titles. The PHP backend splits this field on commas and uses it for dependency traversal.
tags
Comma-separated list of tags.
canonical
Use true/false or yes/no.
include_by_default
Use yes only for pages intended to be loaded into most context bundles.

Backend compatibility

  • Keep requires comma-separated.
  • Keep tags comma-separated.
  • Do not replace Instructions:Config with template-only metadata; that page still needs its JSON block.