Merge pull request #137 from matrix-org/daniel/multipleexamples

Daniel/multipleexamples

event-schemas/check_examples.py

@@ -60,6 +60,8 @@ def check_example_dir(exampledir, schemadir):
                 continue
             examplepath = os.path.join(root, filename)
             schemapath = examplepath.replace(exampledir, schemadir)
+            if schemapath.find("#") >= 0:
+                schemapath = schemapath[:schemapath.find("#")]
             try:
                 check_example_file(examplepath, schemapath)
             except Exception as e:

event-schemas/examples/v1/m.room.member#invite_room_state

@@ -0,0 +1,30 @@
+{
+  "age": 242352,
+  "content": {
+    "membership": "join",
+    "avatar_url": "mxc://localhost/SEsfnsuifSDFSSEF#auto",
+    "displayname": "Alice Margatroid"
+  },
+  "invite_room_state": [
+    {
+      "type": "m.room.name",
+      "state_key": "",
+      "content": {
+        "name": "Forest of Magic"
+      }
+    },
+    {
+      "type": "m.room.join_rules",
+      "state_key": "",
+      "content": {
+        "join_rules": "invite"
+      }
+    }
+  ],
+  "state_key": "@alice:localhost",
+  "origin_server_ts": 1431961217939,
+  "event_id": "$WLGTSEFSEF:localhost",
+  "type": "m.room.member",
+  "room_id": "!Cuyf34gef24t:localhost",
+  "user_id": "@example:localhost"
+}

event-schemas/examples/v1/m.room.member#third_party_invite

@@ -0,0 +1,25 @@
+{
+  "age": 242352,
+  "content": {
+    "membership": "join",
+    "avatar_url": "mxc://localhost/SEsfnsuifSDFSSEF#auto",
+    "displayname": "Alice Margatroid",
+    "third_party_invite": {
+      "signed": {
+        "mxid": "@alice:localhost",
+        "signatures": {
+          "magic.forest": {
+            "ed25519:3": "fQpGIW1Snz+pwLZu6sTy2aHy/DYWWTspTJRPyNp0PKkymfIsNffysMl6ObMMFdIJhk6g6pwlIqZ54rxo8SLmAg"
+          }
+        },
+        "token": "abc123"
+      }
+    }
+  },
+  "state_key": "@alice:localhost",
+  "origin_server_ts": 1431961217939,
+  "event_id": "$WLGTSEFSEF:localhost",
+  "type": "m.room.member",
+  "room_id": "!Cuyf34gef24t:localhost",
+  "user_id": "@example:localhost"
+}

templating/matrix_templates/sections.py

@@ -35,7 +35,7 @@ class MatrixSections(Sections):
             if not filterFn(event_name):
                 continue
             sections.append(template.render(
-                example=examples[event_name], 
+                examples=examples[event_name],
                 event=schemas[event_name],
                 title_kind=subtitle_title_char
             ))
@@ -136,7 +136,7 @@ class MatrixSections(Sections):
             if not event_name.startswith("m.room.message#m."):
                 continue
             sections.append(template.render(
-                example=examples[event_name], 
+                example=examples[event_name][0],
                 event=schemas[event_name],
                 title_kind=subtitle_title_char
             ))

templating/matrix_templates/templates/events.tmpl

@@ -12,8 +12,10 @@
 {{ tables.paramtable(table.rows, [(table.title or "Content") ~ " Key", "Type", "Description"]) }}
 
 {% endfor %}
-Example:
+Example{% if examples | length > 1 %}s{% endif %}:
 
+{% for example in examples %}
 .. code:: json
 
     {{example | jsonify(4, 4)}}
+{% endfor %}

templating/matrix_templates/units.py

@@ -572,9 +572,14 @@ class MatrixUnits(Units):
             if not filename.startswith("m."):
                 continue
             with open(os.path.join(path, filename), "r") as f:
-                examples[filename] = json.loads(f.read())
-                if filename == "m.room.message#m.text":
-                    examples["m.room.message"] = examples[filename]
+                event_name = filename.split("#")[0]
+                example = json.loads(f.read())
+
+                examples[filename] = examples.get(filename, [])
+                examples[filename].append(example)
+                if filename != event_name:
+                    examples[event_name] = examples.get(event_name, [])
+                    examples[event_name].append(example)
         return examples
 
     def load_event_schemas(self):