|
1 | 1 | <!-- markdownlint-disable MD007 MD013 MD024-->
|
2 | 2 | # tldr-pages client specification
|
3 | 3 |
|
4 |
| -**Current Specification Version:** Unreleased |
| 4 | +**Current Specification Version:** 2.3 |
5 | 5 |
|
6 | 6 | This document contains the official specification for tldr-pages clients. It is _not_ a specification of the format of the pages themselves - only a specification of how a user should be able to interface with an official client. For a list of previous versions of the specification, see the [changelog section](#changelog) below.
|
7 | 7 |
|
@@ -126,7 +126,7 @@ Although this specification is about the interface that clients must provide, it
|
126 | 126 | Things to take into account:
|
127 | 127 | - Clients MAY highlight the placeholders and MUST remove the surrounding curly braces.
|
128 | 128 | - If option placeholders are set to show only shortform or longform options, they MUST not be highlighted. This is because there is no longer user choice involved.
|
129 |
| -- Clients MUST remove the angle brackets from option placeholders when only short- or longform is shown. |
| 129 | +- Clients MUST remove the square brackets from option placeholders when only short- or longform is shown. |
130 | 130 | - Clients MUST NOT treat them as the placeholder syntax if they are escaped using `\` (i.e. `\{\{` and `\}\}`) and MUST instead display literal braces, without backslashes. Placeholder escaping applies only when both braces are escaped (e.g. in `\{` or `\{{`, backslashes MUST be displayed).
|
131 | 131 | - In cases when a command uses `{}` in its arguments (e.g. `stash@{0}`) **_the outer braces_** mark the placeholder - the braces inside MUST be displayed.
|
132 | 132 | - Clients MUST NOT break if the page format is changed within the _CommonMark_ specification.
|
@@ -254,8 +254,11 @@ the form `vX.Y`) should be done immediately AFTER merging the version bump, as
|
254 | 254 | the commit hash changes when merging with squash or rebase.
|
255 | 255 | -->
|
256 | 256 |
|
257 |
| -- Unreleased |
| 257 | +- [v2.3, March 7th 2025](https://github.com/tldr-pages/tldr/blob/v2.3/CLIENT-SPECIFICATION.md) ([#15866](https://github.com/tldr-pages/tldr/pull/15866)) |
258 | 258 | - Added longform/shortform specifications ([#15253](https://github.com/tldr-pages/tldr/pull/15253))
|
| 259 | + - Specify `common` as a supported platform option ([#15855](https://github.com/tldr-pages/tldr/pull/15855)) |
| 260 | + - Add the date of removal of the old asset website ([#15862](https://github.com/tldr-pages/tldr/pull/15862)) |
| 261 | + - Various grammar fixes |
259 | 262 |
|
260 | 263 | - [v2.2, March 20th 2024](https://github.com/tldr-pages/tldr/blob/v2.2/CLIENT-SPECIFICATION.md) ([#12452](https://github.com/tldr-pages/tldr/pull/12452))
|
261 | 264 | - Removed redirect text from the [caching section](#caching) ([#12133](https://github.com/tldr-pages/tldr/pull/12133))
|
|
0 commit comments