From aa103066f22f71c1afffdb91139f1cb09875d5df Mon Sep 17 00:00:00 2001
From: Lena <126529524+acuteenvy@users.noreply.github.com>
Date: Sun, 17 Sep 2023 15:32:08 +0200
Subject: [PATCH 1/3] CLIENT-SPECIFICATION: add a way to escape the placeholder
syntax
---
CLIENT-SPECIFICATION.md | 7 ++++++-
1 file changed, 6 insertions(+), 1 deletion(-)
diff --git a/CLIENT-SPECIFICATION.md b/CLIENT-SPECIFICATION.md
index ff1765b58924e3..fa95b880ad01b5 100644
--- a/CLIENT-SPECIFICATION.md
+++ b/CLIENT-SPECIFICATION.md
@@ -116,7 +116,12 @@ The structure inside these translation folders is identical to that of the main
## Page structure
-Although this specification is about the interface that clients must provide, it is also worth noting that pages are written in standard [CommonMark](https://commonmark.org/), which the exception of the non-standard `{{` and `}}` syntax, which surrounds values in an example that users may edit. Clients MUST NOT break if the page format is changed within the _CommonMark_ specification.
+Although this specification is about the interface that clients must provide, it is also worth noting that pages are written in standard [CommonMark](https://commonmark.org/), with the exception of the non-standard `{{` and `}}` placeholder syntax, which surrounds values in an example that users may edit. Clients MAY highlight the placeholders and MUST remove the surrounding curly braces. Clients MUST display the `{{` and `}}` if escaped using `\` (i.e. `\{\{` and `\}\}`). Clients MUST NOT break if the page format is changed within the _CommonMark_ specification.
+
+### Examples
+
+- `ping {{example.com}}` MUST be rendered as "ping example.com"
+- `docker inspect --format '\{\{range.NetworkSettings.Networks\}\}\{\{.IPAddress\}\}\{\{end\}\}' {{container}}` MUST be rendered as "docker inspect --format '{{range.NetworkSettings.Networks}}{{.IPAddress}}{{end}}' container"
## Page resolution
From 24ac759ed729374ea5be5e3fb1a4504070a2ff90 Mon Sep 17 00:00:00 2001
From: "K.B.Dharun Krishna" <kbdharunkrishna@gmail.com>
Date: Thu, 16 Nov 2023 14:22:36 +0530
Subject: [PATCH 2/3] Update CLIENT-SPECIFICATION.md
Co-authored-by: Lena <126529524+acuteenvy@users.noreply.github.com>
---
CLIENT-SPECIFICATION.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/CLIENT-SPECIFICATION.md b/CLIENT-SPECIFICATION.md
index 5db421fcdea540..7a71ae2874fd0c 100644
--- a/CLIENT-SPECIFICATION.md
+++ b/CLIENT-SPECIFICATION.md
@@ -116,7 +116,7 @@ The structure inside these translation folders is identical to that of the main
## Page structure
-Although this specification is about the interface that clients must provide, it is also worth noting that pages are written in standard [CommonMark](https://commonmark.org/), with the exception of the non-standard `{{` and `}}` placeholder syntax, which surrounds values in an example that users may edit. Clients MAY highlight the placeholders and MUST remove the surrounding curly braces. Clients MUST display the `{{` and `}}` if escaped using `\` (i.e. `\{\{` and `\}\}`). Clients MUST NOT break if the page format is changed within the _CommonMark_ specification.
+Although this specification is about the interface that clients must provide, it is also worth noting that pages are written in standard [CommonMark](https://commonmark.org/), with the exception of the non-standard `{{` and `}}` placeholder syntax, which surrounds values in an example that users may edit. Clients MAY highlight the placeholders and MUST remove the surrounding curly braces. 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. Clients MUST NOT break if the page format is changed within the _CommonMark_ specification.
### Examples
From 6db1d0d6c78b50b527b0d7df0e55a47fb252cf1f Mon Sep 17 00:00:00 2001
From: "K.B.Dharun Krishna" <kbdharunkrishna@gmail.com>
Date: Thu, 16 Nov 2023 22:46:18 +0530
Subject: [PATCH 3/3] CLIENT-SPECIFICATION: update page structure section
Co-authored-by: Lena <126529524+acuteenvy@users.noreply.github.com>
---
CLIENT-SPECIFICATION.md | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/CLIENT-SPECIFICATION.md b/CLIENT-SPECIFICATION.md
index 7a71ae2874fd0c..d50b638eca5af1 100644
--- a/CLIENT-SPECIFICATION.md
+++ b/CLIENT-SPECIFICATION.md
@@ -116,12 +116,13 @@ The structure inside these translation folders is identical to that of the main
## Page structure
-Although this specification is about the interface that clients must provide, it is also worth noting that pages are written in standard [CommonMark](https://commonmark.org/), with the exception of the non-standard `{{` and `}}` placeholder syntax, which surrounds values in an example that users may edit. Clients MAY highlight the placeholders and MUST remove the surrounding curly braces. 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. Clients MUST NOT break if the page format is changed within the _CommonMark_ specification.
+Although this specification is about the interface that clients must provide, it is also worth noting that pages are written in standard [CommonMark](https://commonmark.org/), with the exception of the non-standard `{{` and `}}` placeholder syntax, which surrounds values in an example that users may edit. Clients MAY highlight the placeholders and MUST remove the surrounding curly braces. 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). Clients MUST NOT break if the page format is changed within the _CommonMark_ specification.
### Examples
- `ping {{example.com}}` MUST be rendered as "ping example.com"
- `docker inspect --format '\{\{range.NetworkSettings.Networks\}\}\{\{.IPAddress\}\}\{\{end\}\}' {{container}}` MUST be rendered as "docker inspect --format '{{range.NetworkSettings.Networks}}{{.IPAddress}}{{end}}' container"
+- `mount \\{{computer_name}}\{{share_name}} Z:` MUST be rendered as "mount \\computer_name\share_name Z:"
## Page resolution