Issue 5068 - Define translation string format

translation-string-format.md

+# Websites translation string format
+
+## Format
+
+`{{ $uid[$tag-name $tag-attribute] $contents }}`
+
+## Example
+
+```
+<section>
+  <h1>{{ 1[heading text] Example heading }}</h1>
+  <p>{{ 2[paragraph text] Example paragraph }}</p>
+  <ul>
+    <li>{{ 5[list item text] List item }}</li>
+  </ul>
+  <a title="{{ 3[link tooltip text] Example tooltip }}">{{ 4[link text] Example link }}</a>
+</section>
+```
+
+## Explination
+
+### $uid
+
+A numeric unique identifier.
+
+### $tag-name
+
+A human readable tag name.
+
+### $tag-attribute
+
+A human readable tag attribute name.
+
+### $contents
+
+String contents.
+
+### FAQ
+
+Should $uid be human readable?
+:   No, because making it human readable only complicates things.
+
+Should $tag-name be human readable?
+:   Yes, use common sense to expand abbreviations e.g. p -> paragraph and exclude irrelivant information like heading number.
+
+Should $attribute-name be human readable?
+:   Yes, use common sense to expand the meaning of the attribute e.g. title -> tooltip.
+
+What if there is no attribute?
+:   Use "text".
+
+What about naming conflicts?
+:   These should be easy to spot if we test/preview and review changes. These could also be identified by linting.
+
+What about order of numbers?
+:   It should be understood that these numbers are unique IDs; not ordered IDs (I put them out-of-order in my example on purpose).