Skip to content

docs: add Attachment Model overview to enhancements reference#188

Merged
dereuromark merged 1 commit into
masterfrom
docs/attachment-model-overview
May 20, 2026
Merged

docs: add Attachment Model overview to enhancements reference#188
dereuromark merged 1 commit into
masterfrom
docs/attachment-model-overview

Conversation

@dereuromark

Copy link
Copy Markdown
Contributor

Summary

Adds an "Attachment Model" overview to docs/reference/enhancements.md documenting where each block construct expects its attribute block. Crosslinked from docs/guide/syntax.md.

Why

djot-php has accumulated several attribute extensions (list items, definition list elements, table rows, table cells) each with its own attachment position. The individual sections document the what; this overview documents the governing principle — attributes precede their target; adjacency selects the tighter target — and the deliberate "last-content-line" exceptions for list items and <dd>.

Also documents two things readers consistently ask about:

No behavior change

Docs-only.

Related

Documents the governing principle ("attributes precede their target;
adjacency selects the tighter target where supported") and a single
table covering all djot-php attribute targets (block, inline, <li>,
<dt>, <dd>, <dl>, table row, table cell, marker-glyph not-addressable
note). Notes the start/type/reversed strip on <li>/<dd> (#187) and
the list-item last-content-line rule (#186).
@dereuromark dereuromark added the documentation Improvements or additions to documentation label May 20, 2026
@dereuromark dereuromark merged commit f31cfe4 into master May 20, 2026
4 checks passed
@dereuromark dereuromark deleted the docs/attachment-model-overview branch May 20, 2026 00:39
@codecov

codecov Bot commented May 20, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.12%. Comparing base (7cd1cff) to head (8f58401).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff            @@
##             master     #188   +/-   ##
=========================================
  Coverage     91.12%   91.12%           
  Complexity     3354     3354           
=========================================
  Files            99       99           
  Lines          8575     8575           
=========================================
  Hits           7814     7814           
  Misses          761      761           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant