Skip to content

Commit 638527b

Browse files
committed
fix: correct heading underline characters for TYPO3 convention
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>
1 parent 8c4d0e2 commit 638527b

2 files changed

Lines changed: 21 additions & 21 deletions

File tree

Documentation/Reference/ReStructuredText/Graphics/ImageAlignment.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ preference.
3030
.. _image-float-css-classes:
3131

3232
Float with CSS classes
33-
----------------------
33+
======================
3434

3535
Add ``float-left`` or ``float-right`` to the ``:class:`` option. You can combine
3636
these with other classes such as ``with-shadow`` or ``with-border``:
@@ -48,7 +48,7 @@ these with other classes such as ``with-shadow`` or ``with-border``:
4848
.. _image-float-align-option:
4949

5050
Align option
51-
------------
51+
============
5252

5353
The ``:align:`` option on ``.. figure::`` directives supports ``left``, ``right``,
5454
and ``center``. Values ``left`` and ``right`` produce the same floating behavior
@@ -69,7 +69,7 @@ Using ``:align: center`` centers the figure without any text wrapping.
6969
.. _image-float-clearing:
7070

7171
Clearing floats
72-
---------------
72+
===============
7373

7474
After a floated image, you may want subsequent content to appear below the
7575
image rather than wrapping around it. Use the ``clear-both`` class to clear
@@ -95,7 +95,7 @@ property to the next element, forcing it below any floated content.
9595
.. _image-float-responsive:
9696

9797
Responsive behavior
98-
-------------------
98+
===================
9999

100100
Floated images automatically switch to full-width block display on small
101101
screens (below 576px). This ensures readable text on mobile devices
@@ -104,7 +104,7 @@ without horizontal scrolling.
104104
.. _image-float-example-8:
105105

106106
Example 8: Figure floated left
107-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
107+
------------------------------
108108

109109
.. figure:: /_Images/a4.jpg
110110
:alt: Example figure floated left
@@ -137,7 +137,7 @@ Typesetting requires one or more fonts.
137137
.. _image-float-example-9:
138138

139139
Example 9: Figure aligned right
140-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
140+
--------------------------------
141141

142142
.. figure:: /_Images/a4.jpg
143143
:alt: Example figure aligned right
@@ -170,7 +170,7 @@ Typesetting requires one or more fonts.
170170
.. _image-float-example-10:
171171

172172
Example 10: Image floated left with shadow
173-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
173+
-------------------------------------------
174174

175175
.. image:: /_Images/a4.jpg
176176
:alt: Example image floated left
@@ -199,7 +199,7 @@ Typesetting requires one or more fonts.
199199
.. _image-float-best-practices:
200200

201201
Best practices for floating
202-
----------------------------
202+
============================
203203

204204
* Always use ``.. rst-class:: clear-both`` after floated content to prevent
205205
layout issues with subsequent sections

Documentation/Reference/ReStructuredText/Graphics/ImageZoom.rst

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ the documentation page.
1818
.. _image-zoom-modes:
1919

2020
Available zoom modes
21-
--------------------
21+
====================
2222

2323
The zoom functionality is controlled by the `:zoom:` option on figure
2424
and image directives. The following zoom modes are available:
@@ -59,7 +59,7 @@ and image directives. The following zoom modes are available:
5959
.. _image-zoom-options:
6060

6161
Directive options
62-
-----------------
62+
=================
6363

6464
The following options are available for the figure and image directives:
6565

@@ -83,12 +83,12 @@ The following options are available for the figure and image directives:
8383
.. _image-zoom-examples:
8484

8585
Usage examples
86-
--------------
86+
==============
8787

8888
.. _image-zoom-example-3:
8989

9090
Example 3: Lightbox zoom
91-
~~~~~~~~~~~~~~~~~~~~~~~~~
91+
-------------------------
9292

9393
.. figure:: /_Images/a4.jpg
9494
:alt: Example screenshot
@@ -109,7 +109,7 @@ Example 3: Lightbox zoom
109109
.. _image-zoom-example-4:
110110

111111
Example 4: Gallery mode with grouped images
112-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
112+
--------------------------------------------
113113

114114
.. code-block:: rst
115115
@@ -130,7 +130,7 @@ Example 4: Gallery mode with grouped images
130130
.. _image-zoom-example-5:
131131

132132
Example 5: Inline scroll-wheel zoom
133-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
133+
------------------------------------
134134

135135
.. code-block:: rst
136136
@@ -143,7 +143,7 @@ Example 5: Inline scroll-wheel zoom
143143
.. _image-zoom-example-6:
144144

145145
Example 6: Magnifier lens
146-
~~~~~~~~~~~~~~~~~~~~~~~~~~
146+
--------------------------
147147

148148
.. code-block:: rst
149149
@@ -156,7 +156,7 @@ Example 6: Magnifier lens
156156
.. _image-zoom-example-7:
157157

158158
Example 7: Hidden zoom indicator
159-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
159+
---------------------------------
160160

161161
.. code-block:: rst
162162
@@ -170,14 +170,14 @@ Example 7: Hidden zoom indicator
170170
.. _image-zoom-accessibility:
171171

172172
Accessibility considerations
173-
-----------------------------
173+
=============================
174174

175175
All zoom modes are designed with accessibility in mind:
176176

177177
.. _image-zoom-keyboard:
178178

179179
Keyboard navigation
180-
~~~~~~~~~~~~~~~~~~~
180+
-------------------
181181

182182
* **Lightbox and Gallery modes**: Full keyboard support
183183

@@ -204,7 +204,7 @@ Keyboard navigation
204204
.. _image-zoom-screen-reader:
205205

206206
Screen reader support
207-
~~~~~~~~~~~~~~~~~~~~~~
207+
---------------------
208208

209209
All zoom modes maintain proper ARIA attributes and provide descriptive
210210
labels for assistive technologies. Always use the `:alt:` option to
@@ -213,15 +213,15 @@ provide descriptive alternative text for images.
213213
.. _image-zoom-reduced-motion:
214214

215215
Reduced motion support
216-
~~~~~~~~~~~~~~~~~~~~~~~
216+
----------------------
217217

218218
The zoom functionality respects the `prefers-reduced-motion` media query.
219219
When reduced motion is preferred, transitions and animations are disabled.
220220

221221
.. _image-zoom-best-practices:
222222

223223
Best practices
224-
--------------
224+
==============
225225

226226
* Always include descriptive `:alt:` text for accessibility
227227
* Use `lightbox` as the default for most images

0 commit comments

Comments
 (0)