Elite Dangerous Field Manual:Page section resolution: Difference between revisions
Document centralized article eyebrow section resolution |
Document linked primary secondary content-type eyebrow resolver |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{Article header|section=Operations|deck=How EDFM resolves article header eyebrows from page context instead of page-title duplication.}} | {{Article header|section=Operations|deck=How EDFM resolves article header eyebrows from page context instead of page-title duplication.}} | ||
EDFM article pages use a centralized | EDFM article pages use a centralized context resolver so the eyebrow above the page title answers '''where in EDFM the reader is''', while the H1 answers '''what page the reader is reading'''. | ||
The resolver tracks three related but separate concepts: | |||
* '''primary section''' — the broad EDFM area, such as '''Engineering''', '''Mining''', or '''Ships & Equipment'''; | |||
* '''secondary context''' — a narrower collection when EDFM has a meaningful one, such as '''Ships''', '''Modules''', '''Weapons''', or '''Engineers'''; | |||
* '''content type''' — the format or purpose of the page, currently '''Field Procedures'''. | |||
The visible eyebrow stays compact and normally renders at most two contextual segments after the plain-text <code>EDFM //</code> label: | |||
<pre> | <pre> | ||
EDFM // Ships & Equipment | EDFM // Ships & Equipment / Modules | ||
Frame Shift Drive | Frame Shift Drive | ||
</pre> | </pre> | ||
For pages with a meaningful content type, the content type takes display priority over the ordinary secondary context: | |||
<pre> | |||
EDFM // Engineering / Field Procedures | |||
Unlocking Broo Tarquin | |||
</pre> | |||
Internally, <code>Unlocking Broo Tarquin</code> still resolves to secondary context '''Engineers'''; the eyebrow simply displays '''Field Procedures''' instead because content type is the more useful second visible segment. | |||
== Normal author workflow == | == Normal author workflow == | ||
| Line 20: | Line 33: | ||
</pre> | </pre> | ||
Do not normally set an eyebrow manually. The header calls [[Module:PageContext]], which resolves | Field Procedure pages should normally use: | ||
<pre> | |||
{{Field procedure|summary=Short task summary.}} | |||
</pre> | |||
Do not normally set an eyebrow manually. The header calls [[Module:PageContext]], which resolves primary section, secondary context, and optional content type from structured data and central rules. Visible primary/secondary/type segments are rendered as ordinary MediaWiki internal links when [[Module:Data/PageSections]] defines a verified canonical destination. <code>EDFM //</code> itself remains plain text. | |||
== | == Display priority == | ||
# Render the primary section if known; otherwise render fallback '''Reference'''. | |||
# For the second visible segment, render meaningful '''content type''' first. | |||
# If there is no content type, render meaningful '''secondary context'''. | |||
# If neither exists, render no second segment. | |||
# '''Explicit override''' — <code>{{Article header|section=Combat}}</code> | The eyebrow is contextual navigation, not a complete breadcrumb trail. Do not expand it into long chains such as <code>EDFM // Engineering / Engineers / Field Procedures</code>. | ||
# ''' | |||
# '''Structured page/content type''' — existing canonical data/index pages, including Engineers, ship modules, | == Primary section resolution order == | ||
# ''' | |||
# ''' | # '''Explicit override''' — <code>{{Article header|section=Combat}}</code> or <code>topic=</code>. | ||
# '''Structured procedure metadata''' — for example mining procedure records carry a topic such as <code>Mining</code>. | |||
# '''Structured unlock target metadata''' — <code>Unlocking Name</code> resolves through the canonical Engineer data for <code>Name</code>. | |||
# '''Structured page/content type''' — existing canonical data/index pages, including Engineers, ships, ship modules, ship weapons, and mining datasets. | |||
# '''Exact central hub mappings''' — section and hub pages such as [[Engineering]], [[Mining]], [[Powerplay]], and [[Ships and Equipment]]. | |||
# '''Conservative topic-family rules''' — Guardian, Thargoid/Xeno, and AX naming rules. | |||
# '''Small exceptional override map''' — currently empty. | |||
# '''Fallback''' — unknown pages resolve to <code>Reference</code>. | # '''Fallback''' — unknown pages resolve to <code>Reference</code>. | ||
== | == Secondary context resolution order == | ||
# '''Explicit override''' — <code>{{Article header|context=Engineers}}</code> or <code>secondaryContext=</code>. | |||
# '''Exact central hub mappings''' — for hub/index pages and ordinary pages such as [[Engineer Unlock Guide]]. | |||
# '''Structured unlock target metadata''' — <code>Unlocking Name</code> retains secondary context '''Engineers''' when <code>Name</code> is an Engineer. | |||
# '''Structured page/content type''' — mapped page types such as <code>ship</code>, <code>ship_module</code>, <code>ship_weapon</code>, and <code>engineer</code>. | |||
# '''Small exceptional override map''' — currently empty. | |||
# '''None''' — ordinary topical pages do not receive a manufactured second segment. | |||
== Content type resolution order == | |||
# '''Explicit override''' — <code>{{Article header|type=Field Procedures}}</code>. | |||
# '''Structured/shared content-type signal''' — mining procedure data or Engineer-unlock procedure target data. | |||
# '''Centralized content-type family rule''' — conservative <code>How to ...</code> and <code>Unlocking ...</code> rules, after structured checks. | |||
# '''Small exceptional override map''' — currently empty. | |||
# '''None''' — normal articles do not receive a content-type segment. | |||
If a content type exists but the primary section falls all the way back to <code>Reference</code>, [[Template:Article header]] suppresses the suffix unless a primary section was explicitly provided. This avoids noisy output such as <code>EDFM // Reference / Field Procedures</code> for unresolved procedure pages. | |||
== Canonical destinations == | |||
Canonical linked destinations are centralized in [[Module:Data/PageSections]]: | |||
* '''Reference''' → [[Game Reference]] | |||
* '''Ships & Equipment''' → [[Ships and Equipment]] | |||
* '''Ships''' → [[Ships]] | |||
* '''Modules''' → [[Ship Modules]] | |||
* '''Engineering''' → [[Engineering]] | |||
* '''Engineers''' → [[Engineers]] | |||
* '''Mining''' → [[Mining]] | |||
* '''Field Procedures''' → [[Field Procedures]] | |||
A context may intentionally have no linked destination. For example, '''Weapons''' is recognized as a secondary context, but there is currently no suitable live weapons hub page; until one exists, the label renders as plain text. | |||
The renderer suppresses self-links by comparing normalized MediaWiki titles, so the [[Ships]] page can show <code>EDFM // Ships & Equipment / Ships</code> while only linking the primary section. | |||
== Structured integrations == | |||
Current integrations include: | |||
Use | * Ship pages from <code>Module:Data/Ships/index</code>, generated from the canonical [[Ships]] directory table → '''Ships & Equipment / Ships''' | ||
* Engineer pages from <code>Module:Data/Engineers/index</code> → '''Engineering / Engineers''' | |||
* Engineer unlock procedure pages such as <code>Unlocking Broo Tarquin</code> → primary topic from the target Engineer record, secondary context '''Engineers''', content type '''Field Procedures''' | |||
* Ship module pages from <code>Module:Data/ShipModules/index</code> and <code>Module:Data/Modules/index</code> → '''Ships & Equipment / Modules''' | |||
* Ship weapon pages identified through <code>Module:Data/Modules/index</code> records with subcategory <code>Weapon</code> → '''Ships & Equipment / Weapons''' | |||
* Guardian module pages identified through the module index and Guardian naming → '''Guardian Technology''' | |||
* Thargoid/Xeno/AX module pages identified through the module index and xeno naming → '''Thargoids''' | |||
* Mining method/equipment/location/commodity datasets → '''Mining''' | |||
* Mining procedure records in <code>Module:Data/Procedures/Mining</code> → primary topic from the record, content type '''Field Procedures''' | |||
If EDFM adds a new canonical dataset, add a lightweight detector in [[Module:PageContext]] and map the resulting type in [[Module:Data/PageSections]]. Do not duplicate every individual page into a hand-maintained lookup table. | |||
== Manual overrides == | |||
Use overrides only when a page is intentionally cross-topic or cannot be identified cleanly from data/rules: | |||
<pre> | <pre> | ||
{{Article header | {{Article header | ||
|section= | |section=Engineering | ||
|context=Engineers | |||
|type=Field Procedures | |||
|deck=Optional one-line summary. | |deck=Optional one-line summary. | ||
}} | }} | ||
| Line 69: | Line 127: | ||
If many pages require overrides, improve the structured data or page-family rules instead. | If many pages require overrides, improve the structured data or page-family rules instead. | ||
== Public Lua interface == | == Public Lua interface == | ||
[[Module:PageContext]] exposes: | [[Module:PageContext]] exposes semantic interfaces: | ||
* <code> | * <code>getPrimarySection</code> — returns a plain section name such as <code>Engineering</code>. | ||
* <code> | * <code>getSecondaryContext</code> — returns a plain context name such as <code>Engineers</code>, or blank. | ||
* <code> | * <code>getContentType</code> — returns a type such as <code>Field Procedures</code>, or blank for normal articles. | ||
* <code>getContext</code> — returns encoded context with <code>primarySection</code>, optional <code>secondaryContext</code>, and optional <code>contentType</code> objects. | |||
* <code>getPageType</code> — returns an internal page type such as <code>engineer</code>, <code>ship</code>, <code>ship_module</code>, <code>ship_weapon</code>, or <code>field_procedure</code> where known. | |||
* <code>eyebrow</code> — returns complete plain presentation text for compatibility/testing. | |||
* <code>renderEyebrowBody</code> — used by [[Template:Article header]] to render linked primary/display context segments after plain <code>EDFM //</code>. | |||
== Testing == | == Testing == | ||
| Line 90: | Line 145: | ||
<pre> | <pre> | ||
{{#invoke:PageContext| | {{#invoke:PageContext|getPrimarySection|page=Frame Shift Drive}} | ||
{{#invoke:PageContext| | {{#invoke:PageContext|getSecondaryContext|page=Frame Shift Drive}} | ||
{{#invoke:PageContext| | {{#invoke:PageContext|getPrimarySection|page=Felicity Farseer}} | ||
{{#invoke:PageContext| | {{#invoke:PageContext|getSecondaryContext|page=Felicity Farseer}} | ||
{{#invoke:PageContext| | {{#invoke:PageContext|getPrimarySection|page=Unlocking Broo Tarquin}} | ||
{{#invoke:PageContext|getSecondaryContext|page=Unlocking Broo Tarquin}} | |||
{{#invoke:PageContext|getContentType|page=Unlocking Broo Tarquin}} | |||
{{#invoke:PageContext|getContext|page=Unlocking Broo Tarquin}} | |||
{{#invoke:PageContext|eyebrow|page=Resolver Sandbox Unknown}} | |||
{{#invoke:PageContext|eyebrow|page=Frame Shift Drive|section=Combat|context=Modules|type=Field Procedures}} | |||
</pre> | </pre> | ||
Latest revision as of 22:04, 24 August 2026
EDFM // Operations
How EDFM resolves article header eyebrows from page context instead of page-title duplication.
EDFM article pages use a centralized context resolver so the eyebrow above the page title answers where in EDFM the reader is, while the H1 answers what page the reader is reading.
The resolver tracks three related but separate concepts:
- primary section — the broad EDFM area, such as Engineering, Mining, or Ships & Equipment;
- secondary context — a narrower collection when EDFM has a meaningful one, such as Ships, Modules, Weapons, or Engineers;
- content type — the format or purpose of the page, currently Field Procedures.
The visible eyebrow stays compact and normally renders at most two contextual segments after the plain-text EDFM // label:
EDFM // Ships & Equipment / Modules Frame Shift Drive
For pages with a meaningful content type, the content type takes display priority over the ordinary secondary context:
EDFM // Engineering / Field Procedures Unlocking Broo Tarquin
Internally, Unlocking Broo Tarquin still resolves to secondary context Engineers; the eyebrow simply displays Field Procedures instead because content type is the more useful second visible segment.
Normal author workflow
Most pages should use:
{{Article header|deck=Optional one-line page summary.}}
Field Procedure pages should normally use:
{{Field procedure|summary=Short task summary.}}
Do not normally set an eyebrow manually. The header calls Module:PageContext, which resolves primary section, secondary context, and optional content type from structured data and central rules. Visible primary/secondary/type segments are rendered as ordinary MediaWiki internal links when Module:Data/PageSections defines a verified canonical destination. EDFM // itself remains plain text.
Display priority
- Render the primary section if known; otherwise render fallback Reference.
- For the second visible segment, render meaningful content type first.
- If there is no content type, render meaningful secondary context.
- If neither exists, render no second segment.
The eyebrow is contextual navigation, not a complete breadcrumb trail. Do not expand it into long chains such as EDFM // Engineering / Engineers / Field Procedures.
Primary section resolution order
- Explicit override —
orEDFM // Combat
topic=. - Structured procedure metadata — for example mining procedure records carry a topic such as
Mining. - Structured unlock target metadata —
Unlocking Nameresolves through the canonical Engineer data forName. - Structured page/content type — existing canonical data/index pages, including Engineers, ships, ship modules, ship weapons, and mining datasets.
- Exact central hub mappings — section and hub pages such as Engineering, Mining, Powerplay, and Ships and Equipment.
- Conservative topic-family rules — Guardian, Thargoid/Xeno, and AX naming rules.
- Small exceptional override map — currently empty.
- Fallback — unknown pages resolve to
Reference.
Secondary context resolution order
- Explicit override —
orsecondaryContext=. - Exact central hub mappings — for hub/index pages and ordinary pages such as Engineer Unlock Guide.
- Structured unlock target metadata —
Unlocking Nameretains secondary context Engineers whenNameis an Engineer. - Structured page/content type — mapped page types such as
ship,ship_module,ship_weapon, andengineer. - Small exceptional override map — currently empty.
- None — ordinary topical pages do not receive a manufactured second segment.
Content type resolution order
- Explicit override —
.EDFM // Reference
- Structured/shared content-type signal — mining procedure data or Engineer-unlock procedure target data.
- Centralized content-type family rule — conservative
How to ...andUnlocking ...rules, after structured checks. - Small exceptional override map — currently empty.
- None — normal articles do not receive a content-type segment.
If a content type exists but the primary section falls all the way back to Reference, Template:Article header suppresses the suffix unless a primary section was explicitly provided. This avoids noisy output such as EDFM // Reference / Field Procedures for unresolved procedure pages.
Canonical destinations
Canonical linked destinations are centralized in Module:Data/PageSections:
- Reference → Game Reference
- Ships & Equipment → Ships and Equipment
- Ships → Ships
- Modules → Ship Modules
- Engineering → Engineering
- Engineers → Engineers
- Mining → Mining
- Field Procedures → Field Procedures
A context may intentionally have no linked destination. For example, Weapons is recognized as a secondary context, but there is currently no suitable live weapons hub page; until one exists, the label renders as plain text.
The renderer suppresses self-links by comparing normalized MediaWiki titles, so the Ships page can show EDFM // Ships & Equipment / Ships while only linking the primary section.
Structured integrations
Current integrations include:
- Ship pages from
Module:Data/Ships/index, generated from the canonical Ships directory table → Ships & Equipment / Ships - Engineer pages from
Module:Data/Engineers/index→ Engineering / Engineers - Engineer unlock procedure pages such as
Unlocking Broo Tarquin→ primary topic from the target Engineer record, secondary context Engineers, content type Field Procedures - Ship module pages from
Module:Data/ShipModules/indexandModule:Data/Modules/index→ Ships & Equipment / Modules - Ship weapon pages identified through
Module:Data/Modules/indexrecords with subcategoryWeapon→ Ships & Equipment / Weapons - Guardian module pages identified through the module index and Guardian naming → Guardian Technology
- Thargoid/Xeno/AX module pages identified through the module index and xeno naming → Thargoids
- Mining method/equipment/location/commodity datasets → Mining
- Mining procedure records in
Module:Data/Procedures/Mining→ primary topic from the record, content type Field Procedures
If EDFM adds a new canonical dataset, add a lightweight detector in Module:PageContext and map the resulting type in Module:Data/PageSections. Do not duplicate every individual page into a hand-maintained lookup table.
Manual overrides
Use overrides only when a page is intentionally cross-topic or cannot be identified cleanly from data/rules:
{{Article header
|section=Engineering
|context=Engineers
|type=Field Procedures
|deck=Optional one-line summary.
}}
If many pages require overrides, improve the structured data or page-family rules instead.
Public Lua interface
Module:PageContext exposes semantic interfaces:
getPrimarySection— returns a plain section name such asEngineering.getSecondaryContext— returns a plain context name such asEngineers, or blank.getContentType— returns a type such asField Procedures, or blank for normal articles.getContext— returns encoded context withprimarySection, optionalsecondaryContext, and optionalcontentTypeobjects.getPageType— returns an internal page type such asengineer,ship,ship_module,ship_weapon, orfield_procedurewhere known.eyebrow— returns complete plain presentation text for compatibility/testing.renderEyebrowBody— used by Template:Article header to render linked primary/display context segments after plainEDFM //.
Testing
Representative parser tests:
{{#invoke:PageContext|getPrimarySection|page=Frame Shift Drive}}
{{#invoke:PageContext|getSecondaryContext|page=Frame Shift Drive}}
{{#invoke:PageContext|getPrimarySection|page=Felicity Farseer}}
{{#invoke:PageContext|getSecondaryContext|page=Felicity Farseer}}
{{#invoke:PageContext|getPrimarySection|page=Unlocking Broo Tarquin}}
{{#invoke:PageContext|getSecondaryContext|page=Unlocking Broo Tarquin}}
{{#invoke:PageContext|getContentType|page=Unlocking Broo Tarquin}}
{{#invoke:PageContext|getContext|page=Unlocking Broo Tarquin}}
{{#invoke:PageContext|eyebrow|page=Resolver Sandbox Unknown}}
{{#invoke:PageContext|eyebrow|page=Frame Shift Drive|section=Combat|context=Modules|type=Field Procedures}}
Then verify rendered pages include exactly one visible eyebrow, retain the semantic H1, and do not show Lua/script errors.