Wiki source code of Change Displayers
Last modified by Vincent Massol on 2026/09/03 22:02
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | A displayer is the layout a list of changes is rendered with. The [[custom report form>>doc:documentation.extensions.user.release-notes.generate-report.WebHome]] offers the four below in a drop-down, and the [[displayChanges macro>>doc:documentation.extensions.dev.release-notes.displaychanges-macro.WebHome]] takes the same names in its ##displayer## parameter. A release note uses ##simple## for the changes that carry a screenshot and ##list## for the others. | ||
| 2 | |||
| 3 | == Grid == | ||
| 4 | |||
| 5 | Cards laid out in columns, each holding the change title, then its media, then its summary. A card holds a single medium: the screenshots of the change when it has any, otherwise its first video, otherwise a placeholder picture. This is the default. | ||
| 6 | |||
| 7 | {{image reference="displayer-grid.png" size="large" alt="Changes rendered as a grid of cards, each with its title above its screenshot and its summary"/}} | ||
| 8 | |||
| 9 | {{version product="Release Notes Application" before="2.5"}}The media came above the title, the cards had no border of their own, and a change referencing several videos displayed all of them.{{/version}} | ||
| 10 | |||
| 11 | == Flow == | ||
| 12 | |||
| 13 | One row per change, with the media on the left and the title and summary on the right. A row holds the same single medium as a grid card, and the two halves sit side by side from medium screens up, stacking on anything narrower. | ||
| 14 | |||
| 15 | {{image reference="displayer-flow.png" size="large" alt="Changes rendered as rows with the media on the left and the text on the right, the last change showing the placeholder picture"/}} | ||
| 16 | |||
| 17 | {{version product="Release Notes Application" before="2.6.1"}}A change with no screenshot was given an empty column, the two halves stayed side by side at every width, and the medium started lower than the title beside it.{{/version}} | ||
| 18 | |||
| 19 | == Simple == | ||
| 20 | |||
| 21 | One section per change, with the screenshots in a gallery and a link to the change page when it has a description. | ||
| 22 | |||
| 23 | {{image reference="displayer-simple.png" size="large" alt="A change rendered as a section with its title, summary and a screenshot gallery"/}} | ||
| 24 | |||
| 25 | == List == | ||
| 26 | |||
| 27 | A bullet list of titles and summaries, with no screenshots. This is the compact form used for the miscellaneous changes. | ||
| 28 | |||
| 29 | {{image reference="displayer-list.png" size="large" alt="Changes rendered as a bullet list of titles followed by their summaries"/}} |
