Skip to content

Complete README and clean up extension - #5

Merged
davidsteeb merged 5 commits into
masterfrom
task/readme-and-cleanup
Jul 30, 2026
Merged

Complete README and clean up extension#5
davidsteeb merged 5 commits into
masterfrom
task/readme-and-cleanup

Conversation

@davidsteeb

Copy link
Copy Markdown
Contributor

Summary

Comprehensive review and clean-up of EXT:headertypes plus a full README rewrite in b13 style (aligned with container / picture).

Changes

  • [FEATURE] Add p (7) and span (8) as header type options for header and subheader — for headings that must be styled but stay out of the document outline (accessibility/SEO). The matching language labels already existed and are now used.
  • [DOCS] Rewrite the README: features, rationale, installation, field reference and a Fluid rendering example. Makes explicit that the extension is backend-only and needs a template override to render.
  • [TASK] Clean up the XLIFF file (invalid +13:13 date, standard attributes, consistent indentation/order).
  • [TASK] Add composer metadata (php requirement, authors, support links, keywords, package sorting) and a .gitattributes for the distribution archive.
  • [TASK] Add a lightweight GitHub Actions CI workflow (composer validate, PHP 8.1–8.3 lint, XLIFF lint) so the README badge reflects a real pipeline.

Notes / open points

  • The relabeling of the Core header_layout field relies on an exact str_replace of the Core showitem string. Stable across v12–v14 today, but a potential breaking point on future Core changes — left as-is for now.
  • The p/span addition is a feature; a 1.3.0 release would be appropriate when merging.

Locally verified: php -l, composer validate --strict, xmllint all pass.

Editors sometimes need a header that is visually styled but must not
appear in the document heading outline, for example a large intro line
that should stay a plain paragraph for accessibility and SEO.

Adds the values 7 (p) and 8 (span) to both the header type and the
subheader type field. The matching labels already existed in the
language file and are now actually used.
Fixes the invalid file date (an impossible "+13:13" timezone offset),
adds the standard XLIFF file attributes and aligns the indentation and
ordering of the trans-units.
The README only contained a credits note and did not explain what the
extension does or that it is backend-only: without a template override
in the site package nothing is rendered in the frontend.

Rewrites it following the structure of our other b13 extension READMEs
(container, picture) with features, rationale, installation, a field
reference and a Fluid rendering example.
Adds the PHP requirement, authors, support links, keywords and package
sorting to composer.json and excludes development files from the
distribution archive via .gitattributes.
Adds a lightweight CI pipeline that validates composer.json, lints all
PHP files against PHP 8.1 to 8.3 and validates the XLIFF files, so the
status badge in the README reflects a real workflow.
@davidsteeb
davidsteeb merged commit 4059c58 into master Jul 30, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants