Add initial metadata registry

_data/metadata_registry.yml

@@ -0,0 +1,30 @@
+# User Metadata
+- name: User Metadata
+  values:
+    - key: avatar
+      description: Avatar that graphical clients can show alongside the user's name
+      format: URL with an optional `{size}` substitution denoting the size to load in pixels
+      examples: https://example.com/avatar/{size}/asdf.jpg
+    - key: bot-url
+      description: >-
+        Lets bot runners provide a URL for more info on a bot user so they can be
+        identified as such in UI
+      format: Valid URL
+      examples: |-
+        https://example.com/bot-info.html
+    - key: display-name
+      description: >-
+        Alternative name to use instead of a nick for display purposes. Useful for gateways
+        to chat services that allow spaces and other characters in nicks. A nick is
+        required for standard protocol level stuff but can be less prominent in the UI
+      format: Any string
+      examples: |-
+        James Wheare
+        Posiden🦑
+        ダニエル
+        Борис
+    - key: status
+      description: Status text that can be shown for users without making them 'away'
+      format: Any string
+      examples: |-
+        Working from home

_data/validation/metadata_registry.meta.yaml

@@ -0,0 +1,19 @@
+root:
+  type: listofdicts
+  kids:
+    name:
+      type: string
+    values:
+      type: listofdicts
+      kids:
+        key:
+          type: string
+        format:
+          type: string
+        description:
+          type: string
+        examples:
+          type: string
+        specs:
+          type: listofstrings
+          required: false

css/style.sass

@@ -278,6 +278,9 @@ table
         margin-top: 0
     &:last-child
         margin-top: 0
+    code.examples
+        margin-top: 0.4em
+        display: block
 th
     font-weight: 500
     text-align: left

registry.md

@@ -12,6 +12,9 @@ This page lists the tags, capabilities, commands, batches and metadata keys that
 {% for type in site.data.registry %}
 <a href="#{{ type.name | slugify }}">{{ type.name }}</a>
 {% endfor %}
+{% for type in site.data.metadata_registry %}
+<a href="#{{ type.name | slugify }}">{{ type.name }}</a>
+{% endfor %}
 {% for type in site.data.standard_replies_registry %}
 <a href="#{{ type.name | slugify }}">{{ type.name }}</a>
 {% endfor %}
@@ -56,6 +59,43 @@ This page lists the tags, capabilities, commands, batches and metadata keys that
 </table>
 {% endfor %}
 
+{% for type in site.data.metadata_registry %}
+<h2 id="{{ type.name | slugify }}">{{ type.name }}</h2>
+<table class="fullwidth">
+  <thead>
+    <tr>
+      <th style="text-align: center">Key</th>
+      <th>Format</th>
+      <th>Description</th>
+    </tr>
+  </thead>
+  <tbody>
+    {% for val in type.values %}
+    <tr>
+      <td style="min-width: 5rem; white-space: nowrap">
+        <code>{{ val.key }}</code>
+      </td>
+      <td style="min-width: 10rem">
+        {% if val.format-mono %}<code>{{ val.format }}</code>{% else %}{{ val.format | markdownify | replace:"<p>","" | replace:"</p>","" }}{% endif %}
+        <br>
+        {% if val.examples %}
+        <code class="examples">{{ val.examples | newline_to_br }}</code>
+        {% endif %}
+      </td>
+      <td>
+        {{ val.description | markdownify | replace:"<p>","" | replace:"</p>","" }}
+        {% assign i = 1 %}
+        {% for link in val.links %}
+          <sup><a href="{{ site.baseurl }}{{ link }}">({{i}})</a></sup>
+          {% assign i = i | plus: 1 %}
+        {% endfor %}
+      </td>
+    </tr>
+    {% endfor %}
+  </tbody>
+</table>
+{% endfor %}
+
 {% for type in site.data.standard_replies_registry %}
 <h2 id="{{ type.name | slugify }}">{{ type.name }}</h2>
 <table class="fullwidth">