Skip to content

docs: document image/figure float and alignment#510

Merged
linawolf merged 2 commits intoTYPO3-Documentation:mainfrom
CybotTM:docs/image-float-alignment
Mar 1, 2026
Merged

docs: document image/figure float and alignment#510
linawolf merged 2 commits intoTYPO3-Documentation:mainfrom
CybotTM:docs/image-float-alignment

Conversation

@CybotTM
Copy link
Contributor

@CybotTM CybotTM commented Feb 12, 2026

Important

Depends on TYPO3-Documentation/render-guides#1174 — this PR documents features that require render-guides 0.37.0.

Summary

  • Document the image/figure float and alignment feature from render-guides#1174
  • Split the monolithic Images.rst into three focused pages:
    • Images.rst — basics, parameters, Examples 1–2
    • ImageZoom.rst — zoom modes, options, accessibility, Examples 3–7
    • ImageAlignment.rst — float/align, clearing floats, responsive behavior, Examples 8–10
  • Add :class: and :align: to the optional parameters list with cross-references
  • Add best practices for floating

Context

The render-guides 0.37.0 release will add CSS float/alignment support for images and figures. This PR adds the corresponding user documentation.

Test plan

  • Verify RST renders correctly (examples display floated images with wrapping text)
  • Check cross-references (:ref:image-zoom, :ref:image-float-alignment) resolve correctly across the split files
  • Confirm navigation sidebar shows: Images → Zoom and lightbox → Float and alignment → PlantUML diagrams
  • Confirm example numbering continues correctly (1–2, 3–7, 8–10)

@CybotTM CybotTM force-pushed the docs/image-float-alignment branch from 5752e02 to d9f27c3 Compare February 12, 2026 21:16
Add documentation for the new CSS float and alignment support for images
and figures introduced in render-guides 0.37.0. Split the monolithic
Images.rst into three focused pages:

- Images.rst: basics, parameters, Examples 1-2
- ImageZoom.rst: zoom modes, options, accessibility, Examples 3-7
- ImageAlignment.rst: float/align, clearing, responsive, Examples 8-10

Depends on: TYPO3-Documentation/render-guides#1174
@CybotTM CybotTM force-pushed the docs/image-float-alignment branch from d9f27c3 to 8c4d0e2 Compare February 14, 2026 14:22
When ImageZoom.rst and ImageAlignment.rst were extracted from Images.rst
into their own pages, heading underline characters were not promoted to
match the new document hierarchy. Sections that were h3/h4 in the parent
document need to become h2/h3 as standalone pages.

TYPO3 heading convention:
- h1: = above and below (page title)
- h2: = below only (sections)
- h3: - below only (subsections)
- h4: ~ below only (sub-subsections)

Signed-off-by: Sebastian Mendel <info@sebastianmendel.de>
CybotTM added a commit to netresearch/typo3-docs-skill that referenced this pull request Feb 28, 2026
…s.sh

Two issues fixed:

1. **Bug fix**: `((WARNINGS++))` and `((ERRORS++))` with `set -e` causes
   the script to exit prematurely when the counter is 0, because bash
   treats `((0))` as falsy (exit code 1). Replaced with
   `WARNINGS=$((WARNINGS + 1))` which always succeeds.

2. **New check**: Added TYPO3 heading hierarchy validation that detects:
   - First section heading not using `=` (h2) — catches the common issue
     where sections extracted from a parent page retain their old heading
     levels (e.g. `-` for h3 instead of `=` for h2)
   - Non-standard underline characters (e.g. `^` instead of `=/-/~`)
   - Skipped heading levels (e.g. h2 directly to h4 without h3)

   The check follows TYPO3 heading convention:
   - h1: `=` above and below (page title)
   - h2: `=` below only (sections)
   - h3: `-` below only (subsections)
   - h4: `~` below only (sub-subsections)

This would have caught the heading issues reported in
TYPO3-Documentation/TYPO3CMS-Guide-HowToDocument#510.

Signed-off-by: Sebastian Mendel <info@sebastianmendel.de>
@linawolf linawolf merged commit d20b953 into TYPO3-Documentation:main Mar 1, 2026
1 check 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