From 3dafe4133ccb0a7b295815d9c56432ec6aff31e5 Mon Sep 17 00:00:00 2001
From: Kegan Dougal <kegan@matrix.org>
Date: Tue, 19 Aug 2014 16:39:30 +0100
Subject: [PATCH 01/13] Added registration/login jsfiddle, formatted so it can
 be loaded directly from jsfiddle. Requires jQuery 1.8.3

---
 jsfiddles/register_login/demo.css  |  7 +++
 jsfiddles/register_login/demo.html | 20 +++++++++
 jsfiddles/register_login/demo.js   | 69 ++++++++++++++++++++++++++++++
 3 files changed, 96 insertions(+)
 create mode 100644 jsfiddles/register_login/demo.css
 create mode 100644 jsfiddles/register_login/demo.html
 create mode 100644 jsfiddles/register_login/demo.js

diff --git a/jsfiddles/register_login/demo.css b/jsfiddles/register_login/demo.css
new file mode 100644
index 00000000..11781c25
--- /dev/null
+++ b/jsfiddles/register_login/demo.css
@@ -0,0 +1,7 @@
+.loggedin {
+    visibility: hidden;
+}
+
+p {
+    font-family: monospace;
+}
diff --git a/jsfiddles/register_login/demo.html b/jsfiddles/register_login/demo.html
new file mode 100644
index 00000000..9cdb1613
--- /dev/null
+++ b/jsfiddles/register_login/demo.html
@@ -0,0 +1,20 @@
+<div>
+    <p>This registration/login demo requires a home server to be running on http://localhost:8080</p>
+</div>
+<form class="registrationForm">
+    <input type="text" id="user" placeholder="Username"></input>
+    <input type="password" id="password" placeholder="Password"></input>
+    <input type="button" class="register" value="Register"></input>
+</form>
+<form class="loginForm">
+    <input type="text" id="userLogin" placeholder="Username"></input>
+    <input type="password" id="passwordLogin" placeholder="Password"></input>
+    <input type="button" class="login" value="Login"></input>
+</form>
+<div class="loggedin">
+    <p id="welcomeText"></p>
+    <input type="button" class="testToken" value="Test token"></input>
+    <input type="button" class="logout" value="Logout"></input>
+    <p id="imSyncText"></p>
+</div>
+    
diff --git a/jsfiddles/register_login/demo.js b/jsfiddles/register_login/demo.js
new file mode 100644
index 00000000..1644f76a
--- /dev/null
+++ b/jsfiddles/register_login/demo.js
@@ -0,0 +1,69 @@
+var accountInfo = {};
+
+var showLoggedIn = function(data) {
+    accountInfo = data;
+    $(".loggedin").css({visibility: "visible"});
+    $("#welcomeText").text("Welcome " + accountInfo.user_id+". Your access token is:  " +
+                           accountInfo.access_token);    
+};
+
+$('.register').live('click', function() {
+    var user = $("#user").val();
+    var password = $("#password").val();
+    $.ajax({
+        url: "http://localhost:8080/matrix/client/api/v1/register",
+        type: "POST",
+        contentType: "application/json; charset=utf-8",
+        data: JSON.stringify({ user_id: user, password: password }),
+        dataType: "json",
+        success: function(data) {
+            showLoggedIn(data);
+        },
+        error: function(err) {
+            alert(JSON.stringify($.parseJSON(err.responseText)));  
+        }
+    });
+});
+
+var login = function(user, password) {
+    $.ajax({
+        url: "http://localhost:8080/matrix/client/api/v1/login",
+        type: "POST",
+        contentType: "application/json; charset=utf-8",
+        data: JSON.stringify({ user: user, password: password, type: "m.login.password" }),
+        dataType: "json",
+        success: function(data) {
+            showLoggedIn(data);
+        },
+        error: function(err) {
+            alert(JSON.stringify($.parseJSON(err.responseText)));  
+        }
+    });  
+};
+
+$('.login').live('click', function() {
+    var user = $("#userLogin").val();
+    var password = $("#passwordLogin").val();
+    $.getJSON("http://localhost:8080/matrix/client/api/v1/login", function(data) {
+        if (data.type !== "m.login.password") {
+            alert("I don't know how to login with this type: " + data.type);
+            return;
+        }
+        login(user, password);
+    });
+});
+
+$('.logout').live('click', function() {
+    accountInfo = {};
+    $("#imSyncText").text("");
+    $(".loggedin").css({visibility: "hidden"});
+});
+
+$('.testToken').live('click', function() {
+    var url = "http://localhost:8080/matrix/client/api/v1/im/sync?access_token=" + accountInfo.access_token + "&from=END&to=START&limit=1";
+    $.getJSON(url, function(data) {
+         $("#imSyncText").text(JSON.stringify(data, undefined, 2));
+    }).fail(function(err) {
+        $("#imSyncText").text(JSON.stringify($.parseJSON(err.responseText)));
+    });
+});

From 8fb3367238ecd9779ca64c36a2a40b70dd47454b Mon Sep 17 00:00:00 2001
From: Kegan Dougal <kegan@matrix.org>
Date: Tue, 19 Aug 2014 17:34:31 +0100
Subject: [PATCH 02/13] More fiddles, more fun!

---
 jsfiddles/create_room_send_msg/demo.css  |  17 ++++
 jsfiddles/create_room_send_msg/demo.html |  30 +++++++
 jsfiddles/create_room_send_msg/demo.js   | 109 +++++++++++++++++++++++
 3 files changed, 156 insertions(+)
 create mode 100644 jsfiddles/create_room_send_msg/demo.css
 create mode 100644 jsfiddles/create_room_send_msg/demo.html
 create mode 100644 jsfiddles/create_room_send_msg/demo.js

diff --git a/jsfiddles/create_room_send_msg/demo.css b/jsfiddles/create_room_send_msg/demo.css
new file mode 100644
index 00000000..48a55f37
--- /dev/null
+++ b/jsfiddles/create_room_send_msg/demo.css
@@ -0,0 +1,17 @@
+.loggedin {
+    visibility: hidden;
+}
+
+p {
+    font-family: monospace;
+}
+
+table
+{
+    border-spacing:5px;
+}
+
+th,td
+{
+    padding:5px;
+}
diff --git a/jsfiddles/create_room_send_msg/demo.html b/jsfiddles/create_room_send_msg/demo.html
new file mode 100644
index 00000000..31c26c76
--- /dev/null
+++ b/jsfiddles/create_room_send_msg/demo.html
@@ -0,0 +1,30 @@
+<div>
+    <p>This room creation / message sending demo requires a home server to be running on http://localhost:8080</p>
+</div>
+<form class="loginForm">
+    <input type="text" id="userLogin" placeholder="Username"></input>
+    <input type="password" id="passwordLogin" placeholder="Password"></input>
+    <input type="button" class="login" value="Login"></input>
+</form>
+<div class="loggedin">
+    <form class="createRoomForm">
+        <input type="text" id="roomAlias" placeholder="Room alias (optional)"></input>
+        <input type="button" class="createRoom" value="Create Room"></input>
+    </form>
+    <form class="sendMessageForm">
+        <input type="text" id="roomId" placeholder="Room ID"></input>
+        <input type="text" id="messageBody" placeholder="Message body"></input>
+        <input type="button" class="sendMessage" value="Send Message"></input>
+    </form>
+    <table id="rooms">
+        <tbody>
+            <tr>
+                <th>Room ID</th>
+                <th>My state</th>
+                <th>Room Alias</th>
+                <th>Latest message</th>
+            </tr>
+        </tbody>
+    </table>
+</div>
+    
diff --git a/jsfiddles/create_room_send_msg/demo.js b/jsfiddles/create_room_send_msg/demo.js
new file mode 100644
index 00000000..c17eb26b
--- /dev/null
+++ b/jsfiddles/create_room_send_msg/demo.js
@@ -0,0 +1,109 @@
+var accountInfo = {};
+
+var showLoggedIn = function(data) {
+    accountInfo = data;
+    getCurrentRoomList();
+    $(".loggedin").css({visibility: "visible"});
+};
+
+$('.login').live('click', function() {
+    var user = $("#userLogin").val();
+    var password = $("#passwordLogin").val();
+    $.ajax({
+        url: "http://localhost:8080/matrix/client/api/v1/login",
+        type: "POST",
+        contentType: "application/json; charset=utf-8",
+        data: JSON.stringify({ user: user, password: password, type: "m.login.password" }),
+        dataType: "json",
+        success: function(data) {
+            showLoggedIn(data);
+        },
+        error: function(err) {
+            alert(JSON.stringify($.parseJSON(err.responseText)));  
+        }
+    }); 
+});
+
+var getCurrentRoomList = function() {
+    var url = "http://localhost:8080/matrix/client/api/v1/im/sync?access_token=" + accountInfo.access_token + "&from=END&to=START&limit=1";
+    $.getJSON(url, function(data) {
+        for (var i=0; i<data.length; ++i) {
+            data[i].latest_message = data[i].messages.chunk[0].content.body;
+            addRoom(data[i]);   
+        }
+    }).fail(function(err) {
+        alert(JSON.stringify($.parseJSON(err.responseText)));
+    });
+};
+
+$('.createRoom').live('click', function() {
+    var roomAlias = $("#roomAlias").val();
+    var data = {};
+    if (roomAlias.length > 0) {
+        data.room_alias_name = roomAlias;   
+    }
+    $.ajax({
+        url: "http://localhost:8080/matrix/client/api/v1/rooms?access_token="+accountInfo.access_token,
+        type: "POST",
+        contentType: "application/json; charset=utf-8",
+        data: JSON.stringify(data),
+        dataType: "json",
+        success: function(data) {
+            data.membership = "join"; // you are automatically joined into every room you make.
+            data.latest_message = "";
+            addRoom(data);
+        },
+        error: function(err) {
+            alert(JSON.stringify($.parseJSON(err.responseText)));  
+        }
+    }); 
+});
+
+var addRoom = function(data) {
+    row = "<tr>" +
+        "<td>"+data.room_id+"</td>" +
+        "<td>"+data.membership+"</td>" +
+        "<td>"+data.room_alias+"</td>" +
+        "<td>"+data.latest_message+"</td>" +
+        "</tr>";
+    $("#rooms").append(row);
+};
+
+$('.sendMessage').live('click', function() {
+    var roomId = $("#roomId").val();
+    var body = $("#messageBody").val();
+    var msgId = $.now();
+    
+    if (roomId.length === 0 || body.length === 0) {
+        return;
+    }
+    
+    var url = "http://localhost:8080/matrix/client/api/v1/rooms/$roomid/messages/$user/$msgid?access_token=$token";
+    url = url.replace("$token", accountInfo.access_token);
+    url = url.replace("$roomid", encodeURIComponent(roomId));
+    url = url.replace("$user", encodeURIComponent(accountInfo.user_id));
+    url = url.replace("$msgid", msgId);
+    
+    var data = {
+        msgtype: "m.text",
+        body: body
+    };
+    
+    $.ajax({
+        url: url,
+        type: "PUT",
+        contentType: "application/json; charset=utf-8",
+        data: JSON.stringify(data),
+        dataType: "json",
+        success: function(data) {
+            $("#messageBody").val("");
+            // wipe the table and reload it. Using the event stream would be the best
+            // solution but that is out of scope of this fiddle.
+            $("#rooms").find("tr:gt(0)").remove();
+            getCurrentRoomList();
+        },
+        error: function(err) {
+            alert(JSON.stringify($.parseJSON(err.responseText)));  
+        }
+    }); 
+});

From eee7cd7730c9eadb1f31b6d14acedbddea05e355 Mon Sep 17 00:00:00 2001
From: Kegan Dougal <kegan@matrix.org>
Date: Wed, 20 Aug 2014 13:47:20 +0100
Subject: [PATCH 03/13] Added more jsfiddles.

---
 jsfiddles/event_stream/demo.css      |  17 ++++
 jsfiddles/event_stream/demo.html     |  23 +++++
 jsfiddles/event_stream/demo.js       | 142 +++++++++++++++++++++++++++
 jsfiddles/room_memberships/demo.css  |  17 ++++
 jsfiddles/room_memberships/demo.html |  37 +++++++
 jsfiddles/room_memberships/demo.js   | 139 ++++++++++++++++++++++++++
 6 files changed, 375 insertions(+)
 create mode 100644 jsfiddles/event_stream/demo.css
 create mode 100644 jsfiddles/event_stream/demo.html
 create mode 100644 jsfiddles/event_stream/demo.js
 create mode 100644 jsfiddles/room_memberships/demo.css
 create mode 100644 jsfiddles/room_memberships/demo.html
 create mode 100644 jsfiddles/room_memberships/demo.js

diff --git a/jsfiddles/event_stream/demo.css b/jsfiddles/event_stream/demo.css
new file mode 100644
index 00000000..48a55f37
--- /dev/null
+++ b/jsfiddles/event_stream/demo.css
@@ -0,0 +1,17 @@
+.loggedin {
+    visibility: hidden;
+}
+
+p {
+    font-family: monospace;
+}
+
+table
+{
+    border-spacing:5px;
+}
+
+th,td
+{
+    padding:5px;
+}
diff --git a/jsfiddles/event_stream/demo.html b/jsfiddles/event_stream/demo.html
new file mode 100644
index 00000000..ee4fc3ea
--- /dev/null
+++ b/jsfiddles/event_stream/demo.html
@@ -0,0 +1,23 @@
+<div>
+    <p>This event stream demo requires a home server to be running on http://localhost:8080</p>
+</div>
+<form class="loginForm">
+    <input type="text" id="userLogin" placeholder="Username"></input>
+    <input type="password" id="passwordLogin" placeholder="Password"></input>
+    <input type="button" class="login" value="Login"></input>
+</form>
+<div class="loggedin">
+    <form class="sendMessageForm">
+        <input type="button" class="sendMessage" value="Send random message"></input>
+    </form>
+    <p id="streamErrorText"></p>
+    <table id="rooms">
+        <tbody>
+            <tr>
+                <th>Room ID</th>
+                <th>Latest message</th>
+            </tr>
+        </tbody>
+    </table>
+</div>
+    
diff --git a/jsfiddles/event_stream/demo.js b/jsfiddles/event_stream/demo.js
new file mode 100644
index 00000000..b657b809
--- /dev/null
+++ b/jsfiddles/event_stream/demo.js
@@ -0,0 +1,142 @@
+var accountInfo = {};
+
+var eventStreamInfo = {
+    from: "END"
+};
+
+var roomInfo = [];
+
+var longpollEventStream = function() {
+    var url = "http://localhost:8080/matrix/client/api/v1/events?access_token=$token&from=$from";
+    url = url.replace("$token", accountInfo.access_token);
+    url = url.replace("$from", eventStreamInfo.from);
+    
+    $.getJSON(url, function(data) {
+        eventStreamInfo.from = data.end;
+        
+        var hasNewLatestMessage = false;
+        for (var i=0; i<data.chunk.length; ++i) {
+            if (data.chunk[i].type === "m.room.message") {
+                for (var j=0; j<roomInfo.length; ++j) {
+                    if (roomInfo[j].room_id === data.chunk[i].room_id) {
+                        roomInfo[j].latest_message = data.chunk[i].content.body;
+                        hasNewLatestMessage = true;
+                    }
+                }
+            }
+        }
+        
+        if (hasNewLatestMessage) {
+           setRooms(roomInfo);
+        }
+        $("#streamErrorText").text("");
+        longpollEventStream();
+    }).fail(function(err) {
+        $("#streamErrorText").text("Event stream error: "+JSON.stringify($.parseJSON(err.responseText)));
+        setTimeout(longpollEventStream, 5000);
+    });
+};
+
+var showLoggedIn = function(data) {
+    accountInfo = data;
+    longpollEventStream();
+    getCurrentRoomList();
+    $(".loggedin").css({visibility: "visible"});
+};
+
+$('.login').live('click', function() {
+    var user = $("#userLogin").val();
+    var password = $("#passwordLogin").val();
+    $.ajax({
+        url: "http://localhost:8080/matrix/client/api/v1/login",
+        type: "POST",
+        contentType: "application/json; charset=utf-8",
+        data: JSON.stringify({ user: user, password: password, type: "m.login.password" }),
+        dataType: "json",
+        success: function(data) {
+            $("#rooms").find("tr:gt(0)").remove();
+            showLoggedIn(data);
+        },
+        error: function(err) {
+            alert(JSON.stringify($.parseJSON(err.responseText)));  
+        }
+    }); 
+});
+
+var getCurrentRoomList = function() {
+    $("#roomId").val("");
+    var url = "http://localhost:8080/matrix/client/api/v1/im/sync?access_token=" + accountInfo.access_token + "&from=END&to=START&limit=1";
+    $.getJSON(url, function(data) {
+        for (var i=0; i<data.length; ++i) {
+            if ("messages" in data[i]) {
+                data[i].latest_message = data[i].messages.chunk[0].content.body;   
+            }
+        }
+        roomInfo = data;
+        setRooms(roomInfo);  
+    }).fail(function(err) {
+        alert(JSON.stringify($.parseJSON(err.responseText)));
+    });
+};
+
+$('.sendMessage').live('click', function() {
+    if (roomInfo.length === 0) {
+        alert("There is no room to send a message to!");
+        return;
+    }
+    
+    var index = Math.floor(Math.random() * roomInfo.length);
+    
+    sendMessage(roomInfo[index].room_id);
+});
+
+var sendMessage = function(roomId) {
+    var body = "jsfiddle message @" + $.now();
+    var msgId = $.now();
+    
+    if (roomId.length === 0) {
+        return;
+    }
+    
+    var url = "http://localhost:8080/matrix/client/api/v1/rooms/$roomid/messages/$user/$msgid?access_token=$token";
+    url = url.replace("$token", accountInfo.access_token);
+    url = url.replace("$roomid", encodeURIComponent(roomId));
+    url = url.replace("$user", encodeURIComponent(accountInfo.user_id));
+    url = url.replace("$msgid", msgId);
+    
+    var data = {
+        msgtype: "m.text",
+        body: body
+    };
+    
+    $.ajax({
+        url: url,
+        type: "PUT",
+        contentType: "application/json; charset=utf-8",
+        data: JSON.stringify(data),
+        dataType: "json",
+        success: function(data) {
+            $("#messageBody").val("");
+        },
+        error: function(err) {
+            alert(JSON.stringify($.parseJSON(err.responseText)));  
+        }
+    }); 
+};
+
+var setRooms = function(roomList) {
+    // wipe existing entries
+    $("#rooms").find("tr:gt(0)").remove();
+    
+    var rows = "";
+    for (var i=0; i<roomList.length; ++i) {
+        row = "<tr>" +
+            "<td>"+roomList[i].room_id+"</td>" +
+            "<td>"+roomList[i].latest_message+"</td>" +
+            "</tr>";  
+        rows += row;
+    }
+    
+    $("#rooms").append(rows);
+};
+
diff --git a/jsfiddles/room_memberships/demo.css b/jsfiddles/room_memberships/demo.css
new file mode 100644
index 00000000..48a55f37
--- /dev/null
+++ b/jsfiddles/room_memberships/demo.css
@@ -0,0 +1,17 @@
+.loggedin {
+    visibility: hidden;
+}
+
+p {
+    font-family: monospace;
+}
+
+table
+{
+    border-spacing:5px;
+}
+
+th,td
+{
+    padding:5px;
+}
diff --git a/jsfiddles/room_memberships/demo.html b/jsfiddles/room_memberships/demo.html
new file mode 100644
index 00000000..96232e82
--- /dev/null
+++ b/jsfiddles/room_memberships/demo.html
@@ -0,0 +1,37 @@
+<div>
+    <p>This room membership demo requires a home server to be running on http://localhost:8080</p>
+</div>
+<form class="loginForm">
+    <input type="text" id="userLogin" placeholder="Username"></input>
+    <input type="password" id="passwordLogin" placeholder="Password"></input>
+    <input type="button" class="login" value="Login"></input>
+</form>
+<div class="loggedin">
+    <form class="createRoomForm">
+        <input type="button" class="createRoom" value="Create Room"></input>
+    </form>
+    <form class="changeMembershipForm">
+        <input type="text" id="roomId" placeholder="Room ID"></input>
+        <input type="text" id="targetUser" placeholder="Target User ID"></input>
+        <select id="membership">
+            <option value="invite">Invite</option>
+            <option value="join">Join</option>
+            <option value="leave">Leave</option>
+        </select>
+        <input type="button" class="changeMembership" value="Change Membership"></input>
+    </form>
+    <form class="joinAliasForm">
+        <input type="text" id="roomAlias" placeholder="Room Alias (#name:domain)"></input>
+        <input type="button" class="joinAlias" value="Join via Alias"></input>
+    </form>
+    <table id="rooms">
+        <tbody>
+            <tr>
+                <th>Room ID</th>
+                <th>My state</th>
+                <th>Room Alias</th>
+            </tr>
+        </tbody>
+    </table>
+</div>
+    
diff --git a/jsfiddles/room_memberships/demo.js b/jsfiddles/room_memberships/demo.js
new file mode 100644
index 00000000..b3ce0f0e
--- /dev/null
+++ b/jsfiddles/room_memberships/demo.js
@@ -0,0 +1,139 @@
+var accountInfo = {};
+
+var showLoggedIn = function(data) {
+    accountInfo = data;
+    getCurrentRoomList();
+    $(".loggedin").css({visibility: "visible"});
+};
+
+$('.login').live('click', function() {
+    var user = $("#userLogin").val();
+    var password = $("#passwordLogin").val();
+    $.ajax({
+        url: "http://localhost:8080/matrix/client/api/v1/login",
+        type: "POST",
+        contentType: "application/json; charset=utf-8",
+        data: JSON.stringify({ user: user, password: password, type: "m.login.password" }),
+        dataType: "json",
+        success: function(data) {
+            $("#rooms").find("tr:gt(0)").remove();
+            showLoggedIn(data);
+        },
+        error: function(err) {
+            alert(JSON.stringify($.parseJSON(err.responseText)));  
+        }
+    }); 
+});
+
+var getCurrentRoomList = function() {
+    $("#roomId").val("");
+    // wipe the table and reload it. Using the event stream would be the best
+    // solution but that is out of scope of this fiddle.
+    $("#rooms").find("tr:gt(0)").remove();
+    
+    var url = "http://localhost:8080/matrix/client/api/v1/im/sync?access_token=" + accountInfo.access_token + "&from=END&to=START&limit=1";
+    $.getJSON(url, function(data) {
+        for (var i=0; i<data.length; ++i) {
+            addRoom(data[i]);   
+        }
+    }).fail(function(err) {
+        alert(JSON.stringify($.parseJSON(err.responseText)));
+    });
+};
+
+$('.createRoom').live('click', function() {
+    var data = {};
+    $.ajax({
+        url: "http://localhost:8080/matrix/client/api/v1/rooms?access_token="+accountInfo.access_token,
+        type: "POST",
+        contentType: "application/json; charset=utf-8",
+        data: JSON.stringify(data),
+        dataType: "json",
+        success: function(data) {
+            data.membership = "join"; // you are automatically joined into every room you make.
+            data.latest_message = "";
+            addRoom(data);
+        },
+        error: function(err) {
+            alert(JSON.stringify($.parseJSON(err.responseText)));  
+        }
+    }); 
+});
+
+var addRoom = function(data) {
+    row = "<tr>" +
+        "<td>"+data.room_id+"</td>" +
+        "<td>"+data.membership+"</td>" +
+        "<td>"+data.room_alias+"</td>" +
+        "</tr>";
+    $("#rooms").append(row);
+};
+
+$('.changeMembership').live('click', function() {
+    var roomId = $("#roomId").val();
+    var member = $("#targetUser").val();
+    var membership = $("#membership").val();
+    
+    if (roomId.length === 0) {
+        return;
+    }
+    
+    var url = "http://localhost:8080/matrix/client/api/v1/rooms/$roomid/members/$user/state?access_token=$token";
+    url = url.replace("$token", accountInfo.access_token);
+    url = url.replace("$roomid", encodeURIComponent(roomId));
+    url = url.replace("$user", encodeURIComponent(member));
+    
+    if (membership === "leave") {
+        $.ajax({
+            url: url,
+            type: "DELETE",
+            contentType: "application/json; charset=utf-8",
+            dataType: "json",
+            success: function(data) {
+                getCurrentRoomList();
+            },
+            error: function(err) {
+                alert(JSON.stringify($.parseJSON(err.responseText)));  
+            }
+        });
+    }
+    else {
+        var data = {
+            membership: membership
+        };
+        
+        $.ajax({
+            url: url,
+            type: "PUT",
+            contentType: "application/json; charset=utf-8",
+            data: JSON.stringify(data),
+            dataType: "json",
+            success: function(data) {
+                getCurrentRoomList();
+            },
+            error: function(err) {
+                alert(JSON.stringify($.parseJSON(err.responseText)));  
+            }
+        }); 
+    }
+});
+
+$('.joinAlias').live('click', function() {
+    var roomAlias = $("#roomAlias").val();
+    var url = "http://localhost:8080/matrix/client/api/v1/join/$roomalias?access_token=$token";
+    url = url.replace("$token", accountInfo.access_token);
+    url = url.replace("$roomalias", encodeURIComponent(roomAlias));
+    $.ajax({
+        url: url,
+        type: "PUT",
+        contentType: "application/json; charset=utf-8",
+        data: JSON.stringify({}),
+        dataType: "json",
+        success: function(data) {
+            getCurrentRoomList();
+        },
+        error: function(err) {
+            alert(JSON.stringify($.parseJSON(err.responseText)));  
+        }
+    }); 
+});

From d5da30422ce56a6c777e2f7b9f14c23e4474805e Mon Sep 17 00:00:00 2001
From: Kegan Dougal <kegan@matrix.org>
Date: Wed, 20 Aug 2014 16:45:59 +0100
Subject: [PATCH 04/13] Added final jsfiddle: an example app demonstrating most
 of the c2s api.

---
 jsfiddles/example_app/demo.css  |  43 +++++
 jsfiddles/example_app/demo.html |  56 ++++++
 jsfiddles/example_app/demo.js   | 303 ++++++++++++++++++++++++++++++++
 3 files changed, 402 insertions(+)
 create mode 100644 jsfiddles/example_app/demo.css
 create mode 100644 jsfiddles/example_app/demo.html
 create mode 100644 jsfiddles/example_app/demo.js

diff --git a/jsfiddles/example_app/demo.css b/jsfiddles/example_app/demo.css
new file mode 100644
index 00000000..4c1e157c
--- /dev/null
+++ b/jsfiddles/example_app/demo.css
@@ -0,0 +1,43 @@
+.roomListDashboard, .roomContents, .sendMessageForm {
+    visibility: hidden;
+}
+
+.roomList {
+    background-color: #909090;
+}
+
+.messageWrapper {
+    background-color: #EEEEEE;
+    height: 400px;
+    overflow: scroll;
+}
+
+.membersWrapper {
+    background-color: #EEEEEE;
+    height: 200px;
+    width: 50%;
+    overflow: scroll;
+}
+
+.textEntry {
+    width: 100%
+}
+
+p {
+    font-family: monospace;
+}
+
+table
+{
+    border-spacing:5px;
+}
+
+th,td
+{
+    padding:5px;
+}
+
+.roomList tr:not(:first-child):hover {
+    background-color: orange;
+    cursor: pointer;
+}
diff --git a/jsfiddles/example_app/demo.html b/jsfiddles/example_app/demo.html
new file mode 100644
index 00000000..0af946f6
--- /dev/null
+++ b/jsfiddles/example_app/demo.html
@@ -0,0 +1,56 @@
+<div class="signUp">
+    <p>Matrix example application: Requires a local home server running at http://localhost:8080</p>
+    <form class="registrationForm">
+        <p>No account? Register:</p>
+        <input type="text" id="userReg" placeholder="Username"></input>
+        <input type="password" id="passwordReg" placeholder="Password"></input>
+        <input type="button" class="register" value="Register"></input>
+    </form>
+    <form class="loginForm">
+        <p>Got an account? Login:</p>
+        <input type="text" id="userLogin" placeholder="Username"></input>
+        <input type="password" id="passwordLogin" placeholder="Password"></input>
+        <input type="button" class="login" value="Login"></input>
+    </form>
+</div>
+
+<div class="roomListDashboard">
+    <form class="createRoomForm">
+        <input type="text" id="roomAlias" placeholder="Room alias"></input>
+        <input type="button" class="createRoom" value="Create Room"></input>
+    </form>
+    <table id="rooms" class="roomList">
+        <tbody>
+            <tr>
+                <th>Room</th>
+                <th>My state</th>
+                <th>Latest message</th>
+            </tr>
+        </tbody>
+    </table>
+</div>
+
+<div class="roomContents">
+    <p id="roomName">Select a room</p>
+    <div class="messageWrapper">
+        <table id="messages">
+            <tbody>
+            </tbody>
+        </table>
+    </div>
+    <form class="sendMessageForm">
+        <input type="text" class="textEntry" id="body" placeholder="Enter text here..." onkeydown="javascript:if (event.keyCode == 13) document.getElementById('sendMsg').focus()"></input>
+        <input type="button" class="sendMessage" id="sendMsg" value="Send"></input>
+    </form>
+</div>
+
+<div>
+    <p>Member list:</p>
+    <div class="membersWrapper">
+        <table id="members">
+            <tbody>
+            </tbody>
+        </table>
+    </div>
+</div>
+    
diff --git a/jsfiddles/example_app/demo.js b/jsfiddles/example_app/demo.js
new file mode 100644
index 00000000..295597f0
--- /dev/null
+++ b/jsfiddles/example_app/demo.js
@@ -0,0 +1,303 @@
+var accountInfo = {};
+
+var eventStreamInfo = {
+    from: "END"
+};
+
+var roomInfo = [];
+var memberInfo = [];
+var viewingRoomId;
+
+// ************** Event Streaming **************
+var longpollEventStream = function() {
+    var url = "http://localhost:8080/matrix/client/api/v1/events?access_token=$token&from=$from";
+    url = url.replace("$token", accountInfo.access_token);
+    url = url.replace("$from", eventStreamInfo.from);
+
+    $.getJSON(url, function(data) {
+        eventStreamInfo.from = data.end;
+        
+        var hasNewLatestMessage = false;
+        var updatedMemberList = false;
+        var i=0;
+        var j=0;
+        for (i=0; i<data.chunk.length; ++i) {
+            if (data.chunk[i].type === "m.room.message") {
+                console.log("Got new message: " + JSON.stringify(data.chunk[i]));
+                if (viewingRoomId === data.chunk[i].room_id) {
+                    addMessage(data.chunk[i]);
+                }
+                
+                for (j=0; j<roomInfo.length; ++j) {
+                    if (roomInfo[j].room_id === data.chunk[i].room_id) {
+                        roomInfo[j].latest_message = data.chunk[i].content.body;
+                        hasNewLatestMessage = true;
+                    }
+                }
+            }
+            else if (data.chunk[i].type === "m.room.member") {
+                if (viewingRoomId === data.chunk[i].room_id) {
+                    console.log("Got new member: " + JSON.stringify(data.chunk[i]));
+                    for (j=0; j<memberInfo.length; ++j) {
+                        if (memberInfo[j].target_user_id === data.chunk[i].target_user_id) {
+                            memberInfo[j] = data.chunk[i];
+                            updatedMemberList = true;
+                            break;
+                        }
+                    }
+                    if (!updatedMemberList) {
+                        memberInfo.push(data.chunk[i]);  
+                        updatedMemberList = true;
+                    }
+                }
+                if (data.chunk[i].target_user_id === accountInfo.user_id) {
+                    getCurrentRoomList(); // update our join/invite list
+                }
+            }
+            else {
+                console.log("Discarding: " + JSON.stringify(data.chunk[i]));
+            }
+        }
+        
+        if (hasNewLatestMessage) {
+           setRooms(roomInfo);
+        }
+        if (updatedMemberList) {
+            $("#members").empty();
+            for (i=0; i<memberInfo.length; ++i) { 
+                addMember(memberInfo[i]);
+            }
+        }
+        longpollEventStream();
+    }).fail(function(err) {
+        setTimeout(longpollEventStream, 5000);
+    });
+};
+
+// ************** Registration and Login **************
+var onLoggedIn = function(data) {
+    accountInfo = data;
+    longpollEventStream();
+    getCurrentRoomList();
+    $(".roomListDashboard").css({visibility: "visible"});
+    $(".roomContents").css({visibility: "visible"});
+    $(".signUp").css({display: "none"});
+};
+
+$('.login').live('click', function() {
+    var user = $("#userLogin").val();
+    var password = $("#passwordLogin").val();
+    $.ajax({
+        url: "http://localhost:8080/matrix/client/api/v1/login",
+        type: "POST",
+        contentType: "application/json; charset=utf-8",
+        data: JSON.stringify({ user: user, password: password, type: "m.login.password" }),
+        dataType: "json",
+        success: function(data) {
+            onLoggedIn(data);
+        },
+        error: function(err) {
+            alert("Unable to login: is the home server running?");  
+        }
+    }); 
+});
+
+$('.register').live('click', function() {
+    var user = $("#userReg").val();
+    var password = $("#passwordReg").val();
+    $.ajax({
+        url: "http://localhost:8080/matrix/client/api/v1/register",
+        type: "POST",
+        contentType: "application/json; charset=utf-8",
+        data: JSON.stringify({ user_id: user, password: password }),
+        dataType: "json",
+        success: function(data) {
+            onLoggedIn(data);
+        },
+        error: function(err) {
+            var msg = "Is the home server running?";
+            var errJson = $.parseJSON(err.responseText);
+            if (errJson !== null) {
+                msg = errJson.error;   
+            }
+            alert("Unable to register: "+msg);  
+        }
+    });
+});
+
+// ************** Creating a room ******************
+$('.createRoom').live('click', function() {
+    var roomAlias = $("#roomAlias").val();
+    var data = {};
+    if (roomAlias.length > 0) {
+        data.room_alias_name = roomAlias;   
+    }
+    $.ajax({
+        url: "http://localhost:8080/matrix/client/api/v1/rooms?access_token="+accountInfo.access_token,
+        type: "POST",
+        contentType: "application/json; charset=utf-8",
+        data: JSON.stringify(data),
+        dataType: "json",
+        success: function(response) {
+            $("#roomAlias").val("");
+            response.membership = "join"; // you are automatically joined into every room you make.
+            response.latest_message = "";
+            
+            roomInfo.push(response);
+            setRooms(roomInfo);
+        },
+        error: function(err) {
+            alert(JSON.stringify($.parseJSON(err.responseText)));  
+        }
+    }); 
+});
+
+// ************** Getting current state **************
+var getCurrentRoomList = function() {
+    var url = "http://localhost:8080/matrix/client/api/v1/im/sync?access_token=" + accountInfo.access_token + "&from=END&to=START&limit=1";
+    $.getJSON(url, function(data) {
+        for (var i=0; i<data.length; ++i) {
+            if ("messages" in data[i]) {
+                data[i].latest_message = data[i].messages.chunk[0].content.body;   
+            }
+        }
+        roomInfo = data;
+        setRooms(roomInfo);  
+    }).fail(function(err) {
+        alert(JSON.stringify($.parseJSON(err.responseText)));
+    });
+};
+
+var loadRoomContent = function(roomId) {
+    console.log("loadRoomContent " + roomId);
+    viewingRoomId = roomId;
+    $("#roomName").text("Room: "+roomId);
+    $(".sendMessageForm").css({visibility: "visible"});
+    getMessages(roomId);
+    getMemberList(roomId);
+};
+
+var getMessages = function(roomId) {
+    $("#messages").empty();
+    var url = "http://localhost:8080/matrix/client/api/v1/rooms/" + roomId + "/messages/list?access_token=" + accountInfo.access_token + "&from=END&to=START&limit=10";
+    $.getJSON(url, function(data) {
+        for (var i=data.chunk.length-1; i>=0; --i) {
+            addMessage(data.chunk[i]);   
+        }
+    });
+};
+
+var getMemberList = function(roomId) {
+    $("#members").empty();
+    memberInfo = [];
+    var url = "http://localhost:8080/matrix/client/api/v1/rooms/" + roomId + "/members/list?access_token=" + accountInfo.access_token;
+    $.getJSON(url, function(data) {
+        for (var i=0; i<data.chunk.length; ++i) {
+            memberInfo.push(data.chunk[i]);
+            addMember(data.chunk[i]);   
+        }
+    });
+};
+
+// ************** Sending messages **************
+$('.sendMessage').live('click', function() {
+    if (viewingRoomId === undefined) {
+        alert("There is no room to send a message to!");
+        return;
+    }
+    var body = $("#body").val();
+    sendMessage(viewingRoomId, body);
+});
+
+var sendMessage = function(roomId, body) {
+    var msgId = $.now();
+    
+    var url = "http://localhost:8080/matrix/client/api/v1/rooms/$roomid/messages/$user/$msgid?access_token=$token";
+    url = url.replace("$token", accountInfo.access_token);
+    url = url.replace("$roomid", encodeURIComponent(roomId));
+    url = url.replace("$user", encodeURIComponent(accountInfo.user_id));
+    url = url.replace("$msgid", msgId);
+    
+    var data = {
+        msgtype: "m.text",
+        body: body
+    };
+    
+    $.ajax({
+        url: url,
+        type: "PUT",
+        contentType: "application/json; charset=utf-8",
+        data: JSON.stringify(data),
+        dataType: "json",
+        success: function(data) {
+            $("#body").val("");
+        },
+        error: function(err) {
+            alert(JSON.stringify($.parseJSON(err.responseText)));  
+        }
+    });
+};
+
+// ************** Navigation and DOM manipulation **************
+var setRooms = function(roomList) {
+    // wipe existing entries
+    $("#rooms").find("tr:gt(0)").remove();
+    
+    var rows = "";
+    for (var i=0; i<roomList.length; ++i) {
+        row = "<tr>" +
+              "<td>"+roomList[i].room_id+"</td>" +
+              "<td>"+roomList[i].membership+"</td>" +
+              "<td>"+roomList[i].latest_message+"</td>" +
+              "</tr>";  
+        rows += row;
+    }
+    
+    $("#rooms").append(rows);
+    
+    $('#rooms').find("tr").click(function(){
+        var roomId = $(this).find('td:eq(0)').text();
+        var membership = $(this).find('td:eq(1)').text();
+        if (membership !== "join") {
+            console.log("Joining room " + roomId); 
+            var url = "http://localhost:8080/matrix/client/api/v1/rooms/$roomid/members/$user/state?access_token=$token";
+            url = url.replace("$token", accountInfo.access_token);
+            url = url.replace("$roomid", encodeURIComponent(roomId));
+            url = url.replace("$user", encodeURIComponent(accountInfo.user_id));
+            $.ajax({
+                url: url,
+                type: "PUT",
+                contentType: "application/json; charset=utf-8",
+                data: JSON.stringify({membership: "join"}),
+                dataType: "json",
+                success: function(data) {
+                    loadRoomContent(roomId);
+                    getCurrentRoomList();
+                },
+                error: function(err) {
+                    alert(JSON.stringify($.parseJSON(err.responseText)));  
+                }
+            });
+        }
+        else {
+            loadRoomContent(roomId);
+        }
+    });
+};
+
+var addMessage = function(data) {
+    var row = "<tr>" +
+              "<td>"+data.user_id+"</td>" +
+              "<td>"+data.content.body+"</td>" +
+              "</tr>"; 
+    $("#messages").append(row);
+};
+
+var addMember = function(data) {
+    var row = "<tr>" +
+              "<td>"+data.target_user_id+"</td>" +
+              "<td>"+data.content.membership+"</td>" +
+              "</tr>"; 
+    $("#members").append(row);
+};
+

From 1f3811b1b8f4742c07cb07f0bc56038ce15a8231 Mon Sep 17 00:00:00 2001
From: Kegan Dougal <kegan@matrix.org>
Date: Fri, 29 Aug 2014 15:01:46 +0100
Subject: [PATCH 05/13] Fix JSFiddles to work with the new C-S API.

---
 jsfiddles/create_room_send_msg/demo.js | 17 +++---
 jsfiddles/event_stream/demo.js         | 18 +++----
 jsfiddles/example_app/demo.js          | 56 +++++++++++++-------
 jsfiddles/register_login/demo.js       |  4 +-
 jsfiddles/room_memberships/demo.html   |  6 +--
 jsfiddles/room_memberships/demo.js     | 73 ++++++++++++--------------
 6 files changed, 93 insertions(+), 81 deletions(-)

diff --git a/jsfiddles/create_room_send_msg/demo.js b/jsfiddles/create_room_send_msg/demo.js
index c17eb26b..db2ae2d6 100644
--- a/jsfiddles/create_room_send_msg/demo.js
+++ b/jsfiddles/create_room_send_msg/demo.js
@@ -25,11 +25,12 @@ $('.login').live('click', function() {
 });
 
 var getCurrentRoomList = function() {
-    var url = "http://localhost:8080/matrix/client/api/v1/im/sync?access_token=" + accountInfo.access_token + "&from=END&to=START&limit=1";
+    var url = "http://localhost:8080/matrix/client/api/v1/initialSync?access_token=" + accountInfo.access_token + "&limit=1";
     $.getJSON(url, function(data) {
-        for (var i=0; i<data.length; ++i) {
-            data[i].latest_message = data[i].messages.chunk[0].content.body;
-            addRoom(data[i]);   
+        var rooms = data.rooms;
+        for (var i=0; i<rooms.length; ++i) {
+            rooms[i].latest_message = rooms[i].messages.chunk[0].content.body;
+            addRoom(rooms[i]);   
         }
     }).fail(function(err) {
         alert(JSON.stringify($.parseJSON(err.responseText)));
@@ -43,7 +44,7 @@ $('.createRoom').live('click', function() {
         data.room_alias_name = roomAlias;   
     }
     $.ajax({
-        url: "http://localhost:8080/matrix/client/api/v1/rooms?access_token="+accountInfo.access_token,
+        url: "http://localhost:8080/matrix/client/api/v1/createRoom?access_token="+accountInfo.access_token,
         type: "POST",
         contentType: "application/json; charset=utf-8",
         data: JSON.stringify(data),
@@ -78,11 +79,9 @@ $('.sendMessage').live('click', function() {
         return;
     }
     
-    var url = "http://localhost:8080/matrix/client/api/v1/rooms/$roomid/messages/$user/$msgid?access_token=$token";
+    var url = "http://localhost:8080/matrix/client/api/v1/rooms/$roomid/send/m.room.message?access_token=$token";
     url = url.replace("$token", accountInfo.access_token);
     url = url.replace("$roomid", encodeURIComponent(roomId));
-    url = url.replace("$user", encodeURIComponent(accountInfo.user_id));
-    url = url.replace("$msgid", msgId);
     
     var data = {
         msgtype: "m.text",
@@ -91,7 +90,7 @@ $('.sendMessage').live('click', function() {
     
     $.ajax({
         url: url,
-        type: "PUT",
+        type: "POST",
         contentType: "application/json; charset=utf-8",
         data: JSON.stringify(data),
         dataType: "json",
diff --git a/jsfiddles/event_stream/demo.js b/jsfiddles/event_stream/demo.js
index b657b809..3f132cd9 100644
--- a/jsfiddles/event_stream/demo.js
+++ b/jsfiddles/event_stream/demo.js
@@ -65,14 +65,15 @@ $('.login').live('click', function() {
 
 var getCurrentRoomList = function() {
     $("#roomId").val("");
-    var url = "http://localhost:8080/matrix/client/api/v1/im/sync?access_token=" + accountInfo.access_token + "&from=END&to=START&limit=1";
+    var url = "http://localhost:8080/matrix/client/api/v1/initialSync?access_token=" + accountInfo.access_token + "&limit=1";
     $.getJSON(url, function(data) {
-        for (var i=0; i<data.length; ++i) {
-            if ("messages" in data[i]) {
-                data[i].latest_message = data[i].messages.chunk[0].content.body;   
+        var rooms = data.rooms;
+        for (var i=0; i<rooms.length; ++i) {
+            if ("messages" in rooms[i]) {
+                rooms[i].latest_message = rooms[i].messages.chunk[0].content.body;   
             }
         }
-        roomInfo = data;
+        roomInfo = rooms;
         setRooms(roomInfo);  
     }).fail(function(err) {
         alert(JSON.stringify($.parseJSON(err.responseText)));
@@ -92,17 +93,14 @@ $('.sendMessage').live('click', function() {
 
 var sendMessage = function(roomId) {
     var body = "jsfiddle message @" + $.now();
-    var msgId = $.now();
     
     if (roomId.length === 0) {
         return;
     }
     
-    var url = "http://localhost:8080/matrix/client/api/v1/rooms/$roomid/messages/$user/$msgid?access_token=$token";
+    var url = "http://localhost:8080/matrix/client/api/v1/rooms/$roomid/send/m.room.message?access_token=$token";
     url = url.replace("$token", accountInfo.access_token);
     url = url.replace("$roomid", encodeURIComponent(roomId));
-    url = url.replace("$user", encodeURIComponent(accountInfo.user_id));
-    url = url.replace("$msgid", msgId);
     
     var data = {
         msgtype: "m.text",
@@ -111,7 +109,7 @@ var sendMessage = function(roomId) {
     
     $.ajax({
         url: url,
-        type: "PUT",
+        type: "POST",
         contentType: "application/json; charset=utf-8",
         data: JSON.stringify(data),
         dataType: "json",
diff --git a/jsfiddles/example_app/demo.js b/jsfiddles/example_app/demo.js
index 295597f0..f5e08b32 100644
--- a/jsfiddles/example_app/demo.js
+++ b/jsfiddles/example_app/demo.js
@@ -38,8 +38,9 @@ var longpollEventStream = function() {
             else if (data.chunk[i].type === "m.room.member") {
                 if (viewingRoomId === data.chunk[i].room_id) {
                     console.log("Got new member: " + JSON.stringify(data.chunk[i]));
+                    addMessage(data.chunk[i]);
                     for (j=0; j<memberInfo.length; ++j) {
-                        if (memberInfo[j].target_user_id === data.chunk[i].target_user_id) {
+                        if (memberInfo[j].state_key === data.chunk[i].state_key) {
                             memberInfo[j] = data.chunk[i];
                             updatedMemberList = true;
                             break;
@@ -50,7 +51,7 @@ var longpollEventStream = function() {
                         updatedMemberList = true;
                     }
                 }
-                if (data.chunk[i].target_user_id === accountInfo.user_id) {
+                if (data.chunk[i].state_key === accountInfo.user_id) {
                     getCurrentRoomList(); // update our join/invite list
                 }
             }
@@ -133,7 +134,7 @@ $('.createRoom').live('click', function() {
         data.room_alias_name = roomAlias;   
     }
     $.ajax({
-        url: "http://localhost:8080/matrix/client/api/v1/rooms?access_token="+accountInfo.access_token,
+        url: "http://localhost:8080/matrix/client/api/v1/createRoom?access_token="+accountInfo.access_token,
         type: "POST",
         contentType: "application/json; charset=utf-8",
         data: JSON.stringify(data),
@@ -154,14 +155,15 @@ $('.createRoom').live('click', function() {
 
 // ************** Getting current state **************
 var getCurrentRoomList = function() {
-    var url = "http://localhost:8080/matrix/client/api/v1/im/sync?access_token=" + accountInfo.access_token + "&from=END&to=START&limit=1";
+    var url = "http://localhost:8080/matrix/client/api/v1/initialSync?access_token=" + accountInfo.access_token + "&limit=1";
     $.getJSON(url, function(data) {
-        for (var i=0; i<data.length; ++i) {
-            if ("messages" in data[i]) {
-                data[i].latest_message = data[i].messages.chunk[0].content.body;   
+        var rooms = data.rooms;
+        for (var i=0; i<rooms.length; ++i) {
+            if ("messages" in rooms[i]) {
+                rooms[i].latest_message = rooms[i].messages.chunk[0].content.body;   
             }
         }
-        roomInfo = data;
+        roomInfo = rooms;
         setRooms(roomInfo);  
     }).fail(function(err) {
         alert(JSON.stringify($.parseJSON(err.responseText)));
@@ -179,7 +181,8 @@ var loadRoomContent = function(roomId) {
 
 var getMessages = function(roomId) {
     $("#messages").empty();
-    var url = "http://localhost:8080/matrix/client/api/v1/rooms/" + roomId + "/messages/list?access_token=" + accountInfo.access_token + "&from=END&to=START&limit=10";
+    var url = "http://localhost:8080/matrix/client/api/v1/rooms/" + 
+              encodeURIComponent(roomId) + "/messages?access_token=" + accountInfo.access_token + "&from=END&dir=b&limit=10";
     $.getJSON(url, function(data) {
         for (var i=data.chunk.length-1; i>=0; --i) {
             addMessage(data.chunk[i]);   
@@ -190,7 +193,8 @@ var getMessages = function(roomId) {
 var getMemberList = function(roomId) {
     $("#members").empty();
     memberInfo = [];
-    var url = "http://localhost:8080/matrix/client/api/v1/rooms/" + roomId + "/members/list?access_token=" + accountInfo.access_token;
+    var url = "http://localhost:8080/matrix/client/api/v1/rooms/" + 
+              encodeURIComponent(roomId) + "/members?access_token=" + accountInfo.access_token;
     $.getJSON(url, function(data) {
         for (var i=0; i<data.chunk.length; ++i) {
             memberInfo.push(data.chunk[i]);
@@ -212,11 +216,9 @@ $('.sendMessage').live('click', function() {
 var sendMessage = function(roomId, body) {
     var msgId = $.now();
     
-    var url = "http://localhost:8080/matrix/client/api/v1/rooms/$roomid/messages/$user/$msgid?access_token=$token";
+    var url = "http://localhost:8080/matrix/client/api/v1/rooms/$roomid/send/m.room.message?access_token=$token";
     url = url.replace("$token", accountInfo.access_token);
     url = url.replace("$roomid", encodeURIComponent(roomId));
-    url = url.replace("$user", encodeURIComponent(accountInfo.user_id));
-    url = url.replace("$msgid", msgId);
     
     var data = {
         msgtype: "m.text",
@@ -225,7 +227,7 @@ var sendMessage = function(roomId, body) {
     
     $.ajax({
         url: url,
-        type: "PUT",
+        type: "POST",
         contentType: "application/json; charset=utf-8",
         data: JSON.stringify(data),
         dataType: "json",
@@ -260,13 +262,12 @@ var setRooms = function(roomList) {
         var membership = $(this).find('td:eq(1)').text();
         if (membership !== "join") {
             console.log("Joining room " + roomId); 
-            var url = "http://localhost:8080/matrix/client/api/v1/rooms/$roomid/members/$user/state?access_token=$token";
+            var url = "http://localhost:8080/matrix/client/api/v1/rooms/$roomid/join?access_token=$token";
             url = url.replace("$token", accountInfo.access_token);
             url = url.replace("$roomid", encodeURIComponent(roomId));
-            url = url.replace("$user", encodeURIComponent(accountInfo.user_id));
             $.ajax({
                 url: url,
-                type: "PUT",
+                type: "POST",
                 contentType: "application/json; charset=utf-8",
                 data: JSON.stringify({membership: "join"}),
                 dataType: "json",
@@ -286,16 +287,33 @@ var setRooms = function(roomList) {
 };
 
 var addMessage = function(data) {
+
+    var msg = data.content.body;
+    if (data.type === "m.room.member") {
+        if (data.content.membership === "invite") {
+            msg = "<em>invited " + data.state_key + " to the room</em>";
+        }
+        else if (data.content.membership === "join") {
+            msg = "<em>joined the room</em>";
+        }
+        else if (data.content.membership === "leave") {
+            msg = "<em>left the room</em>";
+        }
+        else {
+            msg = "<em>" + data.content.membership + "</em>";
+        }
+    }
+
     var row = "<tr>" +
               "<td>"+data.user_id+"</td>" +
-              "<td>"+data.content.body+"</td>" +
+              "<td>"+msg+"</td>" +
               "</tr>"; 
     $("#messages").append(row);
 };
 
 var addMember = function(data) {
     var row = "<tr>" +
-              "<td>"+data.target_user_id+"</td>" +
+              "<td>"+data.state_key+"</td>" +
               "<td>"+data.content.membership+"</td>" +
               "</tr>"; 
     $("#members").append(row);
diff --git a/jsfiddles/register_login/demo.js b/jsfiddles/register_login/demo.js
index 1644f76a..270a9678 100644
--- a/jsfiddles/register_login/demo.js
+++ b/jsfiddles/register_login/demo.js
@@ -45,7 +45,7 @@ $('.login').live('click', function() {
     var user = $("#userLogin").val();
     var password = $("#passwordLogin").val();
     $.getJSON("http://localhost:8080/matrix/client/api/v1/login", function(data) {
-        if (data.type !== "m.login.password") {
+        if (data.flows[0].type !== "m.login.password") {
             alert("I don't know how to login with this type: " + data.type);
             return;
         }
@@ -60,7 +60,7 @@ $('.logout').live('click', function() {
 });
 
 $('.testToken').live('click', function() {
-    var url = "http://localhost:8080/matrix/client/api/v1/im/sync?access_token=" + accountInfo.access_token + "&from=END&to=START&limit=1";
+    var url = "http://localhost:8080/matrix/client/api/v1/initialSync?access_token=" + accountInfo.access_token + "&limit=1";
     $.getJSON(url, function(data) {
          $("#imSyncText").text(JSON.stringify(data, undefined, 2));
     }).fail(function(err) {
diff --git a/jsfiddles/room_memberships/demo.html b/jsfiddles/room_memberships/demo.html
index 96232e82..4c1bf6b4 100644
--- a/jsfiddles/room_memberships/demo.html
+++ b/jsfiddles/room_memberships/demo.html
@@ -14,9 +14,9 @@
         <input type="text" id="roomId" placeholder="Room ID"></input>
         <input type="text" id="targetUser" placeholder="Target User ID"></input>
         <select id="membership">
-            <option value="invite">Invite</option>
-            <option value="join">Join</option>
-            <option value="leave">Leave</option>
+            <option value="invite">invite</option>
+            <option value="join">join</option>
+            <option value="leave">leave</option>
         </select>
         <input type="button" class="changeMembership" value="Change Membership"></input>
     </form>
diff --git a/jsfiddles/room_memberships/demo.js b/jsfiddles/room_memberships/demo.js
index b3ce0f0e..91cc96ab 100644
--- a/jsfiddles/room_memberships/demo.js
+++ b/jsfiddles/room_memberships/demo.js
@@ -4,6 +4,14 @@ var showLoggedIn = function(data) {
     accountInfo = data;
     getCurrentRoomList();
     $(".loggedin").css({visibility: "visible"});
+    $("#membership").change(function() {
+    if ($("#membership").val() === "invite") {
+        $("#targetUser").css({visibility: "visible"});
+    }
+    else {
+        $("#targetUser").css({visibility: "hidden"});
+    }
+});
 };
 
 $('.login').live('click', function() {
@@ -31,10 +39,11 @@ var getCurrentRoomList = function() {
     // solution but that is out of scope of this fiddle.
     $("#rooms").find("tr:gt(0)").remove();
     
-    var url = "http://localhost:8080/matrix/client/api/v1/im/sync?access_token=" + accountInfo.access_token + "&from=END&to=START&limit=1";
+    var url = "http://localhost:8080/matrix/client/api/v1/initialSync?access_token=" + accountInfo.access_token + "&limit=1";
     $.getJSON(url, function(data) {
-        for (var i=0; i<data.length; ++i) {
-            addRoom(data[i]);   
+        var rooms = data.rooms;
+        for (var i=0; i<rooms.length; ++i) {
+            addRoom(rooms[i]);   
         }
     }).fail(function(err) {
         alert(JSON.stringify($.parseJSON(err.responseText)));
@@ -44,7 +53,7 @@ var getCurrentRoomList = function() {
 $('.createRoom').live('click', function() {
     var data = {};
     $.ajax({
-        url: "http://localhost:8080/matrix/client/api/v1/rooms?access_token="+accountInfo.access_token,
+        url: "http://localhost:8080/matrix/client/api/v1/createRoom?access_token="+accountInfo.access_token,
         type: "POST",
         contentType: "application/json; charset=utf-8",
         data: JSON.stringify(data),
@@ -78,44 +87,32 @@ $('.changeMembership').live('click', function() {
         return;
     }
     
-    var url = "http://localhost:8080/matrix/client/api/v1/rooms/$roomid/members/$user/state?access_token=$token";
+    var url = "http://localhost:8080/matrix/client/api/v1/rooms/$roomid/$membership?access_token=$token";
     url = url.replace("$token", accountInfo.access_token);
     url = url.replace("$roomid", encodeURIComponent(roomId));
-    url = url.replace("$user", encodeURIComponent(member));
+    url = url.replace("$membership", membership);
     
-    if (membership === "leave") {
-        $.ajax({
-            url: url,
-            type: "DELETE",
-            contentType: "application/json; charset=utf-8",
-            dataType: "json",
-            success: function(data) {
-                getCurrentRoomList();
-            },
-            error: function(err) {
-                alert(JSON.stringify($.parseJSON(err.responseText)));  
-            }
-        });
-    }
-    else {
-        var data = {
-            membership: membership
+    var data = {};
+    
+    if (membership === "invite") {
+        data = {
+            user_id: member
         };
-        
-        $.ajax({
-            url: url,
-            type: "PUT",
-            contentType: "application/json; charset=utf-8",
-            data: JSON.stringify(data),
-            dataType: "json",
-            success: function(data) {
-                getCurrentRoomList();
-            },
-            error: function(err) {
-                alert(JSON.stringify($.parseJSON(err.responseText)));  
-            }
-        }); 
     }
+
+    $.ajax({
+        url: url,
+        type: "POST",
+        contentType: "application/json; charset=utf-8",
+        data: JSON.stringify(data),
+        dataType: "json",
+        success: function(data) {
+            getCurrentRoomList();
+        },
+        error: function(err) {
+            alert(JSON.stringify($.parseJSON(err.responseText)));  
+        }
+    }); 
 });
 
 $('.joinAlias').live('click', function() {
@@ -125,7 +122,7 @@ $('.joinAlias').live('click', function() {
     url = url.replace("$roomalias", encodeURIComponent(roomAlias));
     $.ajax({
         url: url,
-        type: "PUT",
+        type: "POST",
         contentType: "application/json; charset=utf-8",
         data: JSON.stringify({}),
         dataType: "json",

From ca0a642e668b621d867d3eb233cf0ecd00666fe7 Mon Sep 17 00:00:00 2001
From: Matthew Hodgson <matthew@matrix.org>
Date: Sun, 31 Aug 2014 14:51:37 +0100
Subject: [PATCH 06/13] change the world: make the default matrix API URL
 prefix /_matrix rather than /matrix to make it easier for existing websites
 to mount a HS in their namespace without collisions.

perl -pi -e 's#/matrix#/_matrix#g' ./cmdclient/console.py ./docs/client-server/howto.rst ./docs/client-server/specification.rst ./docs/client-server/swagger_matrix/directory ./docs/client-server/swagger_matrix/events ./docs/client-server/swagger_matrix/login ./docs/client-server/swagger_matrix/presence ./docs/client-server/swagger_matrix/profile ./docs/client-server/swagger_matrix/registration ./docs/client-server/swagger_matrix/rooms ./docs/server-server/specification.rst ./graph/graph.py ./jsfiddles/create_room_send_msg/demo.js ./jsfiddles/event_stream/demo.js ./jsfiddles/example_app/demo.js ./jsfiddles/register_login/demo.js ./jsfiddles/room_memberships/demo.js ./synapse/api/urls.py ./tests/federation/test_federation.py ./tests/handlers/test_presence.py ./tests/handlers/test_typing.py ./tests/rest/test_events.py ./tests/rest/test_presence.py ./tests/rest/test_profile.py ./tests/rest/test_rooms.py ./webclient/components/fileUpload/file-upload-service.js ./webclient/components/matrix/matrix-service.js
---
 jsfiddles/create_room_send_msg/demo.js |  8 ++++----
 jsfiddles/event_stream/demo.js         |  8 ++++----
 jsfiddles/example_app/demo.js          | 18 +++++++++---------
 jsfiddles/register_login/demo.js       |  8 ++++----
 jsfiddles/room_memberships/demo.js     | 10 +++++-----
 5 files changed, 26 insertions(+), 26 deletions(-)

diff --git a/jsfiddles/create_room_send_msg/demo.js b/jsfiddles/create_room_send_msg/demo.js
index db2ae2d6..61044da7 100644
--- a/jsfiddles/create_room_send_msg/demo.js
+++ b/jsfiddles/create_room_send_msg/demo.js
@@ -10,7 +10,7 @@ $('.login').live('click', function() {
     var user = $("#userLogin").val();
     var password = $("#passwordLogin").val();
     $.ajax({
-        url: "http://localhost:8080/matrix/client/api/v1/login",
+        url: "http://localhost:8080/_matrix/client/api/v1/login",
         type: "POST",
         contentType: "application/json; charset=utf-8",
         data: JSON.stringify({ user: user, password: password, type: "m.login.password" }),
@@ -25,7 +25,7 @@ $('.login').live('click', function() {
 });
 
 var getCurrentRoomList = function() {
-    var url = "http://localhost:8080/matrix/client/api/v1/initialSync?access_token=" + accountInfo.access_token + "&limit=1";
+    var url = "http://localhost:8080/_matrix/client/api/v1/initialSync?access_token=" + accountInfo.access_token + "&limit=1";
     $.getJSON(url, function(data) {
         var rooms = data.rooms;
         for (var i=0; i<rooms.length; ++i) {
@@ -44,7 +44,7 @@ $('.createRoom').live('click', function() {
         data.room_alias_name = roomAlias;   
     }
     $.ajax({
-        url: "http://localhost:8080/matrix/client/api/v1/createRoom?access_token="+accountInfo.access_token,
+        url: "http://localhost:8080/_matrix/client/api/v1/createRoom?access_token="+accountInfo.access_token,
         type: "POST",
         contentType: "application/json; charset=utf-8",
         data: JSON.stringify(data),
@@ -79,7 +79,7 @@ $('.sendMessage').live('click', function() {
         return;
     }
     
-    var url = "http://localhost:8080/matrix/client/api/v1/rooms/$roomid/send/m.room.message?access_token=$token";
+    var url = "http://localhost:8080/_matrix/client/api/v1/rooms/$roomid/send/m.room.message?access_token=$token";
     url = url.replace("$token", accountInfo.access_token);
     url = url.replace("$roomid", encodeURIComponent(roomId));
     
diff --git a/jsfiddles/event_stream/demo.js b/jsfiddles/event_stream/demo.js
index 3f132cd9..997d1a22 100644
--- a/jsfiddles/event_stream/demo.js
+++ b/jsfiddles/event_stream/demo.js
@@ -7,7 +7,7 @@ var eventStreamInfo = {
 var roomInfo = [];
 
 var longpollEventStream = function() {
-    var url = "http://localhost:8080/matrix/client/api/v1/events?access_token=$token&from=$from";
+    var url = "http://localhost:8080/_matrix/client/api/v1/events?access_token=$token&from=$from";
     url = url.replace("$token", accountInfo.access_token);
     url = url.replace("$from", eventStreamInfo.from);
     
@@ -48,7 +48,7 @@ $('.login').live('click', function() {
     var user = $("#userLogin").val();
     var password = $("#passwordLogin").val();
     $.ajax({
-        url: "http://localhost:8080/matrix/client/api/v1/login",
+        url: "http://localhost:8080/_matrix/client/api/v1/login",
         type: "POST",
         contentType: "application/json; charset=utf-8",
         data: JSON.stringify({ user: user, password: password, type: "m.login.password" }),
@@ -65,7 +65,7 @@ $('.login').live('click', function() {
 
 var getCurrentRoomList = function() {
     $("#roomId").val("");
-    var url = "http://localhost:8080/matrix/client/api/v1/initialSync?access_token=" + accountInfo.access_token + "&limit=1";
+    var url = "http://localhost:8080/_matrix/client/api/v1/initialSync?access_token=" + accountInfo.access_token + "&limit=1";
     $.getJSON(url, function(data) {
         var rooms = data.rooms;
         for (var i=0; i<rooms.length; ++i) {
@@ -98,7 +98,7 @@ var sendMessage = function(roomId) {
         return;
     }
     
-    var url = "http://localhost:8080/matrix/client/api/v1/rooms/$roomid/send/m.room.message?access_token=$token";
+    var url = "http://localhost:8080/_matrix/client/api/v1/rooms/$roomid/send/m.room.message?access_token=$token";
     url = url.replace("$token", accountInfo.access_token);
     url = url.replace("$roomid", encodeURIComponent(roomId));
     
diff --git a/jsfiddles/example_app/demo.js b/jsfiddles/example_app/demo.js
index f5e08b32..95823204 100644
--- a/jsfiddles/example_app/demo.js
+++ b/jsfiddles/example_app/demo.js
@@ -10,7 +10,7 @@ var viewingRoomId;
 
 // ************** Event Streaming **************
 var longpollEventStream = function() {
-    var url = "http://localhost:8080/matrix/client/api/v1/events?access_token=$token&from=$from";
+    var url = "http://localhost:8080/_matrix/client/api/v1/events?access_token=$token&from=$from";
     url = url.replace("$token", accountInfo.access_token);
     url = url.replace("$from", eventStreamInfo.from);
 
@@ -89,7 +89,7 @@ $('.login').live('click', function() {
     var user = $("#userLogin").val();
     var password = $("#passwordLogin").val();
     $.ajax({
-        url: "http://localhost:8080/matrix/client/api/v1/login",
+        url: "http://localhost:8080/_matrix/client/api/v1/login",
         type: "POST",
         contentType: "application/json; charset=utf-8",
         data: JSON.stringify({ user: user, password: password, type: "m.login.password" }),
@@ -107,7 +107,7 @@ $('.register').live('click', function() {
     var user = $("#userReg").val();
     var password = $("#passwordReg").val();
     $.ajax({
-        url: "http://localhost:8080/matrix/client/api/v1/register",
+        url: "http://localhost:8080/_matrix/client/api/v1/register",
         type: "POST",
         contentType: "application/json; charset=utf-8",
         data: JSON.stringify({ user_id: user, password: password }),
@@ -134,7 +134,7 @@ $('.createRoom').live('click', function() {
         data.room_alias_name = roomAlias;   
     }
     $.ajax({
-        url: "http://localhost:8080/matrix/client/api/v1/createRoom?access_token="+accountInfo.access_token,
+        url: "http://localhost:8080/_matrix/client/api/v1/createRoom?access_token="+accountInfo.access_token,
         type: "POST",
         contentType: "application/json; charset=utf-8",
         data: JSON.stringify(data),
@@ -155,7 +155,7 @@ $('.createRoom').live('click', function() {
 
 // ************** Getting current state **************
 var getCurrentRoomList = function() {
-    var url = "http://localhost:8080/matrix/client/api/v1/initialSync?access_token=" + accountInfo.access_token + "&limit=1";
+    var url = "http://localhost:8080/_matrix/client/api/v1/initialSync?access_token=" + accountInfo.access_token + "&limit=1";
     $.getJSON(url, function(data) {
         var rooms = data.rooms;
         for (var i=0; i<rooms.length; ++i) {
@@ -181,7 +181,7 @@ var loadRoomContent = function(roomId) {
 
 var getMessages = function(roomId) {
     $("#messages").empty();
-    var url = "http://localhost:8080/matrix/client/api/v1/rooms/" + 
+    var url = "http://localhost:8080/_matrix/client/api/v1/rooms/" + 
               encodeURIComponent(roomId) + "/messages?access_token=" + accountInfo.access_token + "&from=END&dir=b&limit=10";
     $.getJSON(url, function(data) {
         for (var i=data.chunk.length-1; i>=0; --i) {
@@ -193,7 +193,7 @@ var getMessages = function(roomId) {
 var getMemberList = function(roomId) {
     $("#members").empty();
     memberInfo = [];
-    var url = "http://localhost:8080/matrix/client/api/v1/rooms/" + 
+    var url = "http://localhost:8080/_matrix/client/api/v1/rooms/" + 
               encodeURIComponent(roomId) + "/members?access_token=" + accountInfo.access_token;
     $.getJSON(url, function(data) {
         for (var i=0; i<data.chunk.length; ++i) {
@@ -216,7 +216,7 @@ $('.sendMessage').live('click', function() {
 var sendMessage = function(roomId, body) {
     var msgId = $.now();
     
-    var url = "http://localhost:8080/matrix/client/api/v1/rooms/$roomid/send/m.room.message?access_token=$token";
+    var url = "http://localhost:8080/_matrix/client/api/v1/rooms/$roomid/send/m.room.message?access_token=$token";
     url = url.replace("$token", accountInfo.access_token);
     url = url.replace("$roomid", encodeURIComponent(roomId));
     
@@ -262,7 +262,7 @@ var setRooms = function(roomList) {
         var membership = $(this).find('td:eq(1)').text();
         if (membership !== "join") {
             console.log("Joining room " + roomId); 
-            var url = "http://localhost:8080/matrix/client/api/v1/rooms/$roomid/join?access_token=$token";
+            var url = "http://localhost:8080/_matrix/client/api/v1/rooms/$roomid/join?access_token=$token";
             url = url.replace("$token", accountInfo.access_token);
             url = url.replace("$roomid", encodeURIComponent(roomId));
             $.ajax({
diff --git a/jsfiddles/register_login/demo.js b/jsfiddles/register_login/demo.js
index 270a9678..1e68cb91 100644
--- a/jsfiddles/register_login/demo.js
+++ b/jsfiddles/register_login/demo.js
@@ -11,7 +11,7 @@ $('.register').live('click', function() {
     var user = $("#user").val();
     var password = $("#password").val();
     $.ajax({
-        url: "http://localhost:8080/matrix/client/api/v1/register",
+        url: "http://localhost:8080/_matrix/client/api/v1/register",
         type: "POST",
         contentType: "application/json; charset=utf-8",
         data: JSON.stringify({ user_id: user, password: password }),
@@ -27,7 +27,7 @@ $('.register').live('click', function() {
 
 var login = function(user, password) {
     $.ajax({
-        url: "http://localhost:8080/matrix/client/api/v1/login",
+        url: "http://localhost:8080/_matrix/client/api/v1/login",
         type: "POST",
         contentType: "application/json; charset=utf-8",
         data: JSON.stringify({ user: user, password: password, type: "m.login.password" }),
@@ -44,7 +44,7 @@ var login = function(user, password) {
 $('.login').live('click', function() {
     var user = $("#userLogin").val();
     var password = $("#passwordLogin").val();
-    $.getJSON("http://localhost:8080/matrix/client/api/v1/login", function(data) {
+    $.getJSON("http://localhost:8080/_matrix/client/api/v1/login", function(data) {
         if (data.flows[0].type !== "m.login.password") {
             alert("I don't know how to login with this type: " + data.type);
             return;
@@ -60,7 +60,7 @@ $('.logout').live('click', function() {
 });
 
 $('.testToken').live('click', function() {
-    var url = "http://localhost:8080/matrix/client/api/v1/initialSync?access_token=" + accountInfo.access_token + "&limit=1";
+    var url = "http://localhost:8080/_matrix/client/api/v1/initialSync?access_token=" + accountInfo.access_token + "&limit=1";
     $.getJSON(url, function(data) {
          $("#imSyncText").text(JSON.stringify(data, undefined, 2));
     }).fail(function(err) {
diff --git a/jsfiddles/room_memberships/demo.js b/jsfiddles/room_memberships/demo.js
index 91cc96ab..7e499049 100644
--- a/jsfiddles/room_memberships/demo.js
+++ b/jsfiddles/room_memberships/demo.js
@@ -18,7 +18,7 @@ $('.login').live('click', function() {
     var user = $("#userLogin").val();
     var password = $("#passwordLogin").val();
     $.ajax({
-        url: "http://localhost:8080/matrix/client/api/v1/login",
+        url: "http://localhost:8080/_matrix/client/api/v1/login",
         type: "POST",
         contentType: "application/json; charset=utf-8",
         data: JSON.stringify({ user: user, password: password, type: "m.login.password" }),
@@ -39,7 +39,7 @@ var getCurrentRoomList = function() {
     // solution but that is out of scope of this fiddle.
     $("#rooms").find("tr:gt(0)").remove();
     
-    var url = "http://localhost:8080/matrix/client/api/v1/initialSync?access_token=" + accountInfo.access_token + "&limit=1";
+    var url = "http://localhost:8080/_matrix/client/api/v1/initialSync?access_token=" + accountInfo.access_token + "&limit=1";
     $.getJSON(url, function(data) {
         var rooms = data.rooms;
         for (var i=0; i<rooms.length; ++i) {
@@ -53,7 +53,7 @@ var getCurrentRoomList = function() {
 $('.createRoom').live('click', function() {
     var data = {};
     $.ajax({
-        url: "http://localhost:8080/matrix/client/api/v1/createRoom?access_token="+accountInfo.access_token,
+        url: "http://localhost:8080/_matrix/client/api/v1/createRoom?access_token="+accountInfo.access_token,
         type: "POST",
         contentType: "application/json; charset=utf-8",
         data: JSON.stringify(data),
@@ -87,7 +87,7 @@ $('.changeMembership').live('click', function() {
         return;
     }
     
-    var url = "http://localhost:8080/matrix/client/api/v1/rooms/$roomid/$membership?access_token=$token";
+    var url = "http://localhost:8080/_matrix/client/api/v1/rooms/$roomid/$membership?access_token=$token";
     url = url.replace("$token", accountInfo.access_token);
     url = url.replace("$roomid", encodeURIComponent(roomId));
     url = url.replace("$membership", membership);
@@ -117,7 +117,7 @@ $('.changeMembership').live('click', function() {
 
 $('.joinAlias').live('click', function() {
     var roomAlias = $("#roomAlias").val();
-    var url = "http://localhost:8080/matrix/client/api/v1/join/$roomalias?access_token=$token";
+    var url = "http://localhost:8080/_matrix/client/api/v1/join/$roomalias?access_token=$token";
     url = url.replace("$token", accountInfo.access_token);
     url = url.replace("$roomalias", encodeURIComponent(roomAlias));
     $.ajax({

From 5614f7051bffb82036f43800118d573e3f69c28d Mon Sep 17 00:00:00 2001
From: Kegan Dougal <kegan@matrix.org>
Date: Tue, 2 Sep 2014 15:29:38 +0100
Subject: [PATCH 07/13] Updated howto.rst to use the new APIs. Updated
 JSFiddles to use 8008. Linked new fiddles with howto.rst. Added more
 explanations.

---
 jsfiddles/create_room_send_msg/demo.html |  2 +-
 jsfiddles/create_room_send_msg/demo.js   |  8 +++----
 jsfiddles/event_stream/demo.html         |  2 +-
 jsfiddles/event_stream/demo.js           |  8 +++----
 jsfiddles/example_app/demo.html          |  2 +-
 jsfiddles/example_app/demo.js            | 28 ++++++++++++++----------
 jsfiddles/register_login/demo.html       |  2 +-
 jsfiddles/register_login/demo.js         |  8 +++----
 jsfiddles/room_memberships/demo.html     |  2 +-
 jsfiddles/room_memberships/demo.js       | 10 ++++-----
 10 files changed, 39 insertions(+), 33 deletions(-)

diff --git a/jsfiddles/create_room_send_msg/demo.html b/jsfiddles/create_room_send_msg/demo.html
index 31c26c76..088ff7ac 100644
--- a/jsfiddles/create_room_send_msg/demo.html
+++ b/jsfiddles/create_room_send_msg/demo.html
@@ -1,5 +1,5 @@
 <div>
-    <p>This room creation / message sending demo requires a home server to be running on http://localhost:8080</p>
+    <p>This room creation / message sending demo requires a home server to be running on http://localhost:8008</p>
 </div>
 <form class="loginForm">
     <input type="text" id="userLogin" placeholder="Username"></input>
diff --git a/jsfiddles/create_room_send_msg/demo.js b/jsfiddles/create_room_send_msg/demo.js
index 61044da7..3dc72638 100644
--- a/jsfiddles/create_room_send_msg/demo.js
+++ b/jsfiddles/create_room_send_msg/demo.js
@@ -10,7 +10,7 @@ $('.login').live('click', function() {
     var user = $("#userLogin").val();
     var password = $("#passwordLogin").val();
     $.ajax({
-        url: "http://localhost:8080/_matrix/client/api/v1/login",
+        url: "http://localhost:8008/_matrix/client/api/v1/login",
         type: "POST",
         contentType: "application/json; charset=utf-8",
         data: JSON.stringify({ user: user, password: password, type: "m.login.password" }),
@@ -25,7 +25,7 @@ $('.login').live('click', function() {
 });
 
 var getCurrentRoomList = function() {
-    var url = "http://localhost:8080/_matrix/client/api/v1/initialSync?access_token=" + accountInfo.access_token + "&limit=1";
+    var url = "http://localhost:8008/_matrix/client/api/v1/initialSync?access_token=" + accountInfo.access_token + "&limit=1";
     $.getJSON(url, function(data) {
         var rooms = data.rooms;
         for (var i=0; i<rooms.length; ++i) {
@@ -44,7 +44,7 @@ $('.createRoom').live('click', function() {
         data.room_alias_name = roomAlias;   
     }
     $.ajax({
-        url: "http://localhost:8080/_matrix/client/api/v1/createRoom?access_token="+accountInfo.access_token,
+        url: "http://localhost:8008/_matrix/client/api/v1/createRoom?access_token="+accountInfo.access_token,
         type: "POST",
         contentType: "application/json; charset=utf-8",
         data: JSON.stringify(data),
@@ -79,7 +79,7 @@ $('.sendMessage').live('click', function() {
         return;
     }
     
-    var url = "http://localhost:8080/_matrix/client/api/v1/rooms/$roomid/send/m.room.message?access_token=$token";
+    var url = "http://localhost:8008/_matrix/client/api/v1/rooms/$roomid/send/m.room.message?access_token=$token";
     url = url.replace("$token", accountInfo.access_token);
     url = url.replace("$roomid", encodeURIComponent(roomId));
     
diff --git a/jsfiddles/event_stream/demo.html b/jsfiddles/event_stream/demo.html
index ee4fc3ea..7657780d 100644
--- a/jsfiddles/event_stream/demo.html
+++ b/jsfiddles/event_stream/demo.html
@@ -1,5 +1,5 @@
 <div>
-    <p>This event stream demo requires a home server to be running on http://localhost:8080</p>
+    <p>This event stream demo requires a home server to be running on http://localhost:8008</p>
 </div>
 <form class="loginForm">
     <input type="text" id="userLogin" placeholder="Username"></input>
diff --git a/jsfiddles/event_stream/demo.js b/jsfiddles/event_stream/demo.js
index 997d1a22..5c81e08c 100644
--- a/jsfiddles/event_stream/demo.js
+++ b/jsfiddles/event_stream/demo.js
@@ -7,7 +7,7 @@ var eventStreamInfo = {
 var roomInfo = [];
 
 var longpollEventStream = function() {
-    var url = "http://localhost:8080/_matrix/client/api/v1/events?access_token=$token&from=$from";
+    var url = "http://localhost:8008/_matrix/client/api/v1/events?access_token=$token&from=$from";
     url = url.replace("$token", accountInfo.access_token);
     url = url.replace("$from", eventStreamInfo.from);
     
@@ -48,7 +48,7 @@ $('.login').live('click', function() {
     var user = $("#userLogin").val();
     var password = $("#passwordLogin").val();
     $.ajax({
-        url: "http://localhost:8080/_matrix/client/api/v1/login",
+        url: "http://localhost:8008/_matrix/client/api/v1/login",
         type: "POST",
         contentType: "application/json; charset=utf-8",
         data: JSON.stringify({ user: user, password: password, type: "m.login.password" }),
@@ -65,7 +65,7 @@ $('.login').live('click', function() {
 
 var getCurrentRoomList = function() {
     $("#roomId").val("");
-    var url = "http://localhost:8080/_matrix/client/api/v1/initialSync?access_token=" + accountInfo.access_token + "&limit=1";
+    var url = "http://localhost:8008/_matrix/client/api/v1/initialSync?access_token=" + accountInfo.access_token + "&limit=1";
     $.getJSON(url, function(data) {
         var rooms = data.rooms;
         for (var i=0; i<rooms.length; ++i) {
@@ -98,7 +98,7 @@ var sendMessage = function(roomId) {
         return;
     }
     
-    var url = "http://localhost:8080/_matrix/client/api/v1/rooms/$roomid/send/m.room.message?access_token=$token";
+    var url = "http://localhost:8008/_matrix/client/api/v1/rooms/$roomid/send/m.room.message?access_token=$token";
     url = url.replace("$token", accountInfo.access_token);
     url = url.replace("$roomid", encodeURIComponent(roomId));
     
diff --git a/jsfiddles/example_app/demo.html b/jsfiddles/example_app/demo.html
index 0af946f6..7a9dffdd 100644
--- a/jsfiddles/example_app/demo.html
+++ b/jsfiddles/example_app/demo.html
@@ -1,5 +1,5 @@
 <div class="signUp">
-    <p>Matrix example application: Requires a local home server running at http://localhost:8080</p>
+    <p>Matrix example application: Requires a local home server running at http://localhost:8008</p>
     <form class="registrationForm">
         <p>No account? Register:</p>
         <input type="text" id="userReg" placeholder="Username"></input>
diff --git a/jsfiddles/example_app/demo.js b/jsfiddles/example_app/demo.js
index 95823204..ad79fcca 100644
--- a/jsfiddles/example_app/demo.js
+++ b/jsfiddles/example_app/demo.js
@@ -10,7 +10,7 @@ var viewingRoomId;
 
 // ************** Event Streaming **************
 var longpollEventStream = function() {
-    var url = "http://localhost:8080/_matrix/client/api/v1/events?access_token=$token&from=$from";
+    var url = "http://localhost:8008/_matrix/client/api/v1/events?access_token=$token&from=$from";
     url = url.replace("$token", accountInfo.access_token);
     url = url.replace("$from", eventStreamInfo.from);
 
@@ -89,7 +89,7 @@ $('.login').live('click', function() {
     var user = $("#userLogin").val();
     var password = $("#passwordLogin").val();
     $.ajax({
-        url: "http://localhost:8080/_matrix/client/api/v1/login",
+        url: "http://localhost:8008/_matrix/client/api/v1/login",
         type: "POST",
         contentType: "application/json; charset=utf-8",
         data: JSON.stringify({ user: user, password: password, type: "m.login.password" }),
@@ -107,7 +107,7 @@ $('.register').live('click', function() {
     var user = $("#userReg").val();
     var password = $("#passwordReg").val();
     $.ajax({
-        url: "http://localhost:8080/_matrix/client/api/v1/register",
+        url: "http://localhost:8008/_matrix/client/api/v1/register",
         type: "POST",
         contentType: "application/json; charset=utf-8",
         data: JSON.stringify({ user_id: user, password: password }),
@@ -134,7 +134,7 @@ $('.createRoom').live('click', function() {
         data.room_alias_name = roomAlias;   
     }
     $.ajax({
-        url: "http://localhost:8080/_matrix/client/api/v1/createRoom?access_token="+accountInfo.access_token,
+        url: "http://localhost:8008/_matrix/client/api/v1/createRoom?access_token="+accountInfo.access_token,
         type: "POST",
         contentType: "application/json; charset=utf-8",
         data: JSON.stringify(data),
@@ -155,7 +155,7 @@ $('.createRoom').live('click', function() {
 
 // ************** Getting current state **************
 var getCurrentRoomList = function() {
-    var url = "http://localhost:8080/_matrix/client/api/v1/initialSync?access_token=" + accountInfo.access_token + "&limit=1";
+    var url = "http://localhost:8008/_matrix/client/api/v1/initialSync?access_token=" + accountInfo.access_token + "&limit=1";
     $.getJSON(url, function(data) {
         var rooms = data.rooms;
         for (var i=0; i<rooms.length; ++i) {
@@ -181,7 +181,7 @@ var loadRoomContent = function(roomId) {
 
 var getMessages = function(roomId) {
     $("#messages").empty();
-    var url = "http://localhost:8080/_matrix/client/api/v1/rooms/" + 
+    var url = "http://localhost:8008/_matrix/client/api/v1/rooms/" + 
               encodeURIComponent(roomId) + "/messages?access_token=" + accountInfo.access_token + "&from=END&dir=b&limit=10";
     $.getJSON(url, function(data) {
         for (var i=data.chunk.length-1; i>=0; --i) {
@@ -193,7 +193,7 @@ var getMessages = function(roomId) {
 var getMemberList = function(roomId) {
     $("#members").empty();
     memberInfo = [];
-    var url = "http://localhost:8080/_matrix/client/api/v1/rooms/" + 
+    var url = "http://localhost:8008/_matrix/client/api/v1/rooms/" + 
               encodeURIComponent(roomId) + "/members?access_token=" + accountInfo.access_token;
     $.getJSON(url, function(data) {
         for (var i=0; i<data.chunk.length; ++i) {
@@ -216,7 +216,7 @@ $('.sendMessage').live('click', function() {
 var sendMessage = function(roomId, body) {
     var msgId = $.now();
     
-    var url = "http://localhost:8080/_matrix/client/api/v1/rooms/$roomid/send/m.room.message?access_token=$token";
+    var url = "http://localhost:8008/_matrix/client/api/v1/rooms/$roomid/send/m.room.message?access_token=$token";
     url = url.replace("$token", accountInfo.access_token);
     url = url.replace("$roomid", encodeURIComponent(roomId));
     
@@ -262,7 +262,7 @@ var setRooms = function(roomList) {
         var membership = $(this).find('td:eq(1)').text();
         if (membership !== "join") {
             console.log("Joining room " + roomId); 
-            var url = "http://localhost:8080/_matrix/client/api/v1/rooms/$roomid/join?access_token=$token";
+            var url = "http://localhost:8008/_matrix/client/api/v1/rooms/$roomid/join?access_token=$token";
             url = url.replace("$token", accountInfo.access_token);
             url = url.replace("$roomid", encodeURIComponent(roomId));
             $.ajax({
@@ -290,6 +290,9 @@ var addMessage = function(data) {
 
     var msg = data.content.body;
     if (data.type === "m.room.member") {
+        if (data.content.membership === undefined) {
+            return;
+        }
         if (data.content.membership === "invite") {
             msg = "<em>invited " + data.state_key + " to the room</em>";
         }
@@ -299,10 +302,13 @@ var addMessage = function(data) {
         else if (data.content.membership === "leave") {
             msg = "<em>left the room</em>";
         }
-        else {
-            msg = "<em>" + data.content.membership + "</em>";
+        else if (data.content.membership === "ban") {
+            msg = "<em>was banned from the room</em>";
         }
     }
+    if (msg === undefined) {
+        return;
+    }
 
     var row = "<tr>" +
               "<td>"+data.user_id+"</td>" +
diff --git a/jsfiddles/register_login/demo.html b/jsfiddles/register_login/demo.html
index 9cdb1613..fcac453a 100644
--- a/jsfiddles/register_login/demo.html
+++ b/jsfiddles/register_login/demo.html
@@ -1,5 +1,5 @@
 <div>
-    <p>This registration/login demo requires a home server to be running on http://localhost:8080</p>
+    <p>This registration/login demo requires a home server to be running on http://localhost:8008</p>
 </div>
 <form class="registrationForm">
     <input type="text" id="user" placeholder="Username"></input>
diff --git a/jsfiddles/register_login/demo.js b/jsfiddles/register_login/demo.js
index 1e68cb91..95950391 100644
--- a/jsfiddles/register_login/demo.js
+++ b/jsfiddles/register_login/demo.js
@@ -11,7 +11,7 @@ $('.register').live('click', function() {
     var user = $("#user").val();
     var password = $("#password").val();
     $.ajax({
-        url: "http://localhost:8080/_matrix/client/api/v1/register",
+        url: "http://localhost:8008/_matrix/client/api/v1/register",
         type: "POST",
         contentType: "application/json; charset=utf-8",
         data: JSON.stringify({ user_id: user, password: password }),
@@ -27,7 +27,7 @@ $('.register').live('click', function() {
 
 var login = function(user, password) {
     $.ajax({
-        url: "http://localhost:8080/_matrix/client/api/v1/login",
+        url: "http://localhost:8008/_matrix/client/api/v1/login",
         type: "POST",
         contentType: "application/json; charset=utf-8",
         data: JSON.stringify({ user: user, password: password, type: "m.login.password" }),
@@ -44,7 +44,7 @@ var login = function(user, password) {
 $('.login').live('click', function() {
     var user = $("#userLogin").val();
     var password = $("#passwordLogin").val();
-    $.getJSON("http://localhost:8080/_matrix/client/api/v1/login", function(data) {
+    $.getJSON("http://localhost:8008/_matrix/client/api/v1/login", function(data) {
         if (data.flows[0].type !== "m.login.password") {
             alert("I don't know how to login with this type: " + data.type);
             return;
@@ -60,7 +60,7 @@ $('.logout').live('click', function() {
 });
 
 $('.testToken').live('click', function() {
-    var url = "http://localhost:8080/_matrix/client/api/v1/initialSync?access_token=" + accountInfo.access_token + "&limit=1";
+    var url = "http://localhost:8008/_matrix/client/api/v1/initialSync?access_token=" + accountInfo.access_token + "&limit=1";
     $.getJSON(url, function(data) {
          $("#imSyncText").text(JSON.stringify(data, undefined, 2));
     }).fail(function(err) {
diff --git a/jsfiddles/room_memberships/demo.html b/jsfiddles/room_memberships/demo.html
index 4c1bf6b4..e6f39df5 100644
--- a/jsfiddles/room_memberships/demo.html
+++ b/jsfiddles/room_memberships/demo.html
@@ -1,5 +1,5 @@
 <div>
-    <p>This room membership demo requires a home server to be running on http://localhost:8080</p>
+    <p>This room membership demo requires a home server to be running on http://localhost:8008</p>
 </div>
 <form class="loginForm">
     <input type="text" id="userLogin" placeholder="Username"></input>
diff --git a/jsfiddles/room_memberships/demo.js b/jsfiddles/room_memberships/demo.js
index 7e499049..64ba7671 100644
--- a/jsfiddles/room_memberships/demo.js
+++ b/jsfiddles/room_memberships/demo.js
@@ -18,7 +18,7 @@ $('.login').live('click', function() {
     var user = $("#userLogin").val();
     var password = $("#passwordLogin").val();
     $.ajax({
-        url: "http://localhost:8080/_matrix/client/api/v1/login",
+        url: "http://localhost:8008/_matrix/client/api/v1/login",
         type: "POST",
         contentType: "application/json; charset=utf-8",
         data: JSON.stringify({ user: user, password: password, type: "m.login.password" }),
@@ -39,7 +39,7 @@ var getCurrentRoomList = function() {
     // solution but that is out of scope of this fiddle.
     $("#rooms").find("tr:gt(0)").remove();
     
-    var url = "http://localhost:8080/_matrix/client/api/v1/initialSync?access_token=" + accountInfo.access_token + "&limit=1";
+    var url = "http://localhost:8008/_matrix/client/api/v1/initialSync?access_token=" + accountInfo.access_token + "&limit=1";
     $.getJSON(url, function(data) {
         var rooms = data.rooms;
         for (var i=0; i<rooms.length; ++i) {
@@ -53,7 +53,7 @@ var getCurrentRoomList = function() {
 $('.createRoom').live('click', function() {
     var data = {};
     $.ajax({
-        url: "http://localhost:8080/_matrix/client/api/v1/createRoom?access_token="+accountInfo.access_token,
+        url: "http://localhost:8008/_matrix/client/api/v1/createRoom?access_token="+accountInfo.access_token,
         type: "POST",
         contentType: "application/json; charset=utf-8",
         data: JSON.stringify(data),
@@ -87,7 +87,7 @@ $('.changeMembership').live('click', function() {
         return;
     }
     
-    var url = "http://localhost:8080/_matrix/client/api/v1/rooms/$roomid/$membership?access_token=$token";
+    var url = "http://localhost:8008/_matrix/client/api/v1/rooms/$roomid/$membership?access_token=$token";
     url = url.replace("$token", accountInfo.access_token);
     url = url.replace("$roomid", encodeURIComponent(roomId));
     url = url.replace("$membership", membership);
@@ -117,7 +117,7 @@ $('.changeMembership').live('click', function() {
 
 $('.joinAlias').live('click', function() {
     var roomAlias = $("#roomAlias").val();
-    var url = "http://localhost:8080/_matrix/client/api/v1/join/$roomalias?access_token=$token";
+    var url = "http://localhost:8008/_matrix/client/api/v1/join/$roomalias?access_token=$token";
     url = url.replace("$token", accountInfo.access_token);
     url = url.replace("$roomalias", encodeURIComponent(roomAlias));
     $.ajax({

From 07399b096606b9f841262bf65933f046cf78f822 Mon Sep 17 00:00:00 2001
From: Kegan Dougal <kegan@matrix.org>
Date: Mon, 8 Sep 2014 14:24:28 -0700
Subject: [PATCH 08/13] Added demo.details

---
 jsfiddles/example_app/demo.details | 7 +++++++
 1 file changed, 7 insertions(+)
 create mode 100644 jsfiddles/example_app/demo.details

diff --git a/jsfiddles/example_app/demo.details b/jsfiddles/example_app/demo.details
new file mode 100644
index 00000000..3f96d3e7
--- /dev/null
+++ b/jsfiddles/example_app/demo.details
@@ -0,0 +1,7 @@
+ name: Example Matrix Client
+ description: Includes login, live event streaming, creating rooms, sending messages and viewing member lists.
+ authors:
+   - matrix.org
+ resources:
+   - http://matrix.org
+ normalize_css: no
\ No newline at end of file

From c19bced03d86058ab3d28631328cc28d20d84c5f Mon Sep 17 00:00:00 2001
From: Kegan Dougal <kegan@matrix.org>
Date: Mon, 8 Sep 2014 14:53:58 -0700
Subject: [PATCH 09/13] Update jsfiddles to have more helpful error messages
 when there is no connection when logging in.

---
 jsfiddles/create_room_send_msg/demo.js |  7 ++++++-
 jsfiddles/event_stream/demo.js         |  7 ++++++-
 jsfiddles/register_login/demo.js       | 14 ++++++++++++--
 jsfiddles/room_memberships/demo.js     |  7 ++++++-
 4 files changed, 30 insertions(+), 5 deletions(-)

diff --git a/jsfiddles/create_room_send_msg/demo.js b/jsfiddles/create_room_send_msg/demo.js
index 3dc72638..9c346e2f 100644
--- a/jsfiddles/create_room_send_msg/demo.js
+++ b/jsfiddles/create_room_send_msg/demo.js
@@ -19,7 +19,12 @@ $('.login').live('click', function() {
             showLoggedIn(data);
         },
         error: function(err) {
-            alert(JSON.stringify($.parseJSON(err.responseText)));  
+            var errMsg = "To try this, you need a home server running!";
+            var errJson = $.parseJSON(err.responseText);
+            if (errJson) {
+                errMsg = JSON.stringify(errJson);   
+            }
+            alert(errMsg);  
         }
     }); 
 });
diff --git a/jsfiddles/event_stream/demo.js b/jsfiddles/event_stream/demo.js
index 5c81e08c..acba8391 100644
--- a/jsfiddles/event_stream/demo.js
+++ b/jsfiddles/event_stream/demo.js
@@ -58,7 +58,12 @@ $('.login').live('click', function() {
             showLoggedIn(data);
         },
         error: function(err) {
-            alert(JSON.stringify($.parseJSON(err.responseText)));  
+            var errMsg = "To try this, you need a home server running!";
+            var errJson = $.parseJSON(err.responseText);
+            if (errJson) {
+                errMsg = JSON.stringify(errJson);   
+            }
+            alert(errMsg);  
         }
     }); 
 });
diff --git a/jsfiddles/register_login/demo.js b/jsfiddles/register_login/demo.js
index 95950391..fffa9e05 100644
--- a/jsfiddles/register_login/demo.js
+++ b/jsfiddles/register_login/demo.js
@@ -20,7 +20,12 @@ $('.register').live('click', function() {
             showLoggedIn(data);
         },
         error: function(err) {
-            alert(JSON.stringify($.parseJSON(err.responseText)));  
+            var errMsg = "To try this, you need a home server running!";
+            var errJson = $.parseJSON(err.responseText);
+            if (errJson) {
+                errMsg = JSON.stringify(errJson);   
+            }
+            alert(errMsg);   
         }
     });
 });
@@ -36,7 +41,12 @@ var login = function(user, password) {
             showLoggedIn(data);
         },
         error: function(err) {
-            alert(JSON.stringify($.parseJSON(err.responseText)));  
+            var errMsg = "To try this, you need a home server running!";
+            var errJson = $.parseJSON(err.responseText);
+            if (errJson) {
+                errMsg = JSON.stringify(errJson);   
+            }
+            alert(errMsg);  
         }
     });  
 };
diff --git a/jsfiddles/room_memberships/demo.js b/jsfiddles/room_memberships/demo.js
index 64ba7671..8a7b1aa8 100644
--- a/jsfiddles/room_memberships/demo.js
+++ b/jsfiddles/room_memberships/demo.js
@@ -28,7 +28,12 @@ $('.login').live('click', function() {
             showLoggedIn(data);
         },
         error: function(err) {
-            alert(JSON.stringify($.parseJSON(err.responseText)));  
+            var errMsg = "To try this, you need a home server running!";
+            var errJson = $.parseJSON(err.responseText);
+            if (errJson) {
+                errMsg = JSON.stringify(errJson);   
+            }
+            alert(errMsg); 
         }
     }); 
 });

From b01e8165d0aed5b447b012a71774f3ff113b7e3f Mon Sep 17 00:00:00 2001
From: Kegan Dougal <kegan@matrix.org>
Date: Mon, 6 Oct 2014 14:52:46 +0100
Subject: [PATCH 10/13] Update JSFiddles/how-to to support the new registration
 format.

---
 jsfiddles/example_app/demo.js    | 2 +-
 jsfiddles/register_login/demo.js | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/jsfiddles/example_app/demo.js b/jsfiddles/example_app/demo.js
index ad79fcca..13c9c2b3 100644
--- a/jsfiddles/example_app/demo.js
+++ b/jsfiddles/example_app/demo.js
@@ -110,7 +110,7 @@ $('.register').live('click', function() {
         url: "http://localhost:8008/_matrix/client/api/v1/register",
         type: "POST",
         contentType: "application/json; charset=utf-8",
-        data: JSON.stringify({ user_id: user, password: password }),
+        data: JSON.stringify({ user: user, password: password, type: "m.login.password" }),
         dataType: "json",
         success: function(data) {
             onLoggedIn(data);
diff --git a/jsfiddles/register_login/demo.js b/jsfiddles/register_login/demo.js
index fffa9e05..2e6957b6 100644
--- a/jsfiddles/register_login/demo.js
+++ b/jsfiddles/register_login/demo.js
@@ -14,7 +14,7 @@ $('.register').live('click', function() {
         url: "http://localhost:8008/_matrix/client/api/v1/register",
         type: "POST",
         contentType: "application/json; charset=utf-8",
-        data: JSON.stringify({ user_id: user, password: password }),
+        data: JSON.stringify({ user: user, password: password, type: "m.login.password" }),
         dataType: "json",
         success: function(data) {
             showLoggedIn(data);

From 3b696878f5ec36e297d5bd01d0d3b32ffec04e52 Mon Sep 17 00:00:00 2001
From: Kegan Dougal <kegan@matrix.org>
Date: Fri, 6 Feb 2015 12:59:08 +0000
Subject: [PATCH 11/13] Fix a bunch of rst syntax errors.

---
 drafts/general_api.rst                     |   11 +-
 drafts/model/profiles.rst                  |    3 +-
 drafts/model/protocol_examples.rst         |   12 +-
 drafts/model/rooms.rst                     |   24 +-
 drafts/old-client-server-specification.rst | 1281 --------------------
 5 files changed, 28 insertions(+), 1303 deletions(-)
 delete mode 100644 drafts/old-client-server-specification.rst

diff --git a/drafts/general_api.rst b/drafts/general_api.rst
index 5a027d15..2b42b8b0 100644
--- a/drafts/general_api.rst
+++ b/drafts/general_api.rst
@@ -111,6 +111,7 @@ Global initial sync API ``[Draft]``
       - The invite event
       - Other state info (e.g. room name, topic, join_rules to know if pubilc)
       - # members?
+
     so clients know more information about the room other than the user_id of the
     inviter, timestamp and the room ID.
 
@@ -637,7 +638,7 @@ A client may wish to send multiple actions in parallel. The send event APIs
 support sending multiple events in a batch.
  
 Inviting a user ``[ONGOING]``
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 .. NOTE::
   - Clients need to know *why* they are being invited (e.g. a ``reason`` key,
     just like for kicks/bans). However, this opens up a spam vector where any
@@ -1028,8 +1029,8 @@ relate to other events are referred to as "Child Events". The event being
 related to is referred to as "Parent Events". Child events cannot stand alone as
 a separate entity; they require the parent event in order to make sense.
 
-Bundling
-++++++++
+Bundling updates
+++++++++++++++++
 Events that relate to another event should come down inside that event. That is,
 the top-level event should come down with all the child events at the same time.
 This is called a "bundle" and it is represented as an array of events inside the
@@ -1081,8 +1082,8 @@ not update the event itself*, and are *not required* in order to display the
 parent event. Crucially, the child events can be paginated, whereas ``updates`` 
 child events cannot be paginated.
 
-Bundling
-++++++++
+Bundling relations
+++++++++++++++++++
 Child events can be optionally bundled with the parent event, depending on your 
 display mechanism. The number of child events which can be bundled should be 
 limited to prevent events becoming too large. This limit should be set by the 
diff --git a/drafts/model/profiles.rst b/drafts/model/profiles.rst
index f7d6bd56..15f65feb 100644
--- a/drafts/model/profiles.rst
+++ b/drafts/model/profiles.rst
@@ -198,12 +198,11 @@ Requests that a client can make to its Home Server
 
  * get another user's Display Name / Avatar / metadata fields
 
-[[TODO(paul): At some later stage we should consider the API for:
+TODO(paul): At some later stage we should consider the API for:
 
  * get/set ACL permissions on my metadata fields
 
  * manage my ACL tokens
-]]
 
 Server-Server
 -------------
diff --git a/drafts/model/protocol_examples.rst b/drafts/model/protocol_examples.rst
index 61a599b4..f1d31f34 100644
--- a/drafts/model/protocol_examples.rst
+++ b/drafts/model/protocol_examples.rst
@@ -3,7 +3,9 @@ Host: ...
 Content-Length: ...
 Content-Type: application/json
 
-{
+.. code :: javascript
+
+  {
     "origin": "localhost:5000",
     "pdus": [
         {
@@ -27,7 +29,7 @@ Content-Type: application/json
         "1404381396852"
     ],
     "ts": 1404381427823
-}
+  }
 
 HTTP/1.1 200 OK
 ...
@@ -42,7 +44,9 @@ HTTP/1.1 200 OK
 Content-Length: ...
 Content-Type: application/json
 
-{
+.. code :: javascript
+
+  {
     origin: ...,
     prev_ids: ...,
     data: [
@@ -59,6 +63,6 @@ Content-Type: application/json
         },
         ...,
     ]
-}
+  }
 
 
diff --git a/drafts/model/rooms.rst b/drafts/model/rooms.rst
index 0007e48e..07c5e71f 100644
--- a/drafts/model/rooms.rst
+++ b/drafts/model/rooms.rst
@@ -125,13 +125,14 @@ m.invite_level
 m.join_rules
   Encodes the rules on how non-members can join the room. Has the following
   possibilities:
-    "public" - a non-member can join the room directly
-    "knock" - a non-member cannot join the room, but can post a single "knock"
-        message requesting access, which existing members may approve or deny
-    "invite" - non-members cannot join the room without an invite from an
-        existing member
-    "private" - nobody who is not in the 'may_join' list or already a member
-        may join by any mechanism
+
+    - "public" - a non-member can join the room directly
+    - "knock" - a non-member cannot join the room, but can post a single "knock"
+      message requesting access, which existing members may approve or deny
+    - "invite" - non-members cannot join the room without an invite from an
+      existing member
+    - "private" - nobody who is not in the 'may_join' list or already a member
+      may join by any mechanism
 
   In any of the first three modes, existing members with sufficient permission
   can send invites to non-members if allowed by the "m.invite_level" key. A
@@ -263,10 +264,11 @@ resolve this:
    that duplicate requests can be suppressed. On receipt of a room creation
    request that the HS thinks there already exists a room for, the invitation to
    join can be rejected if:
-      a) the HS believes the sending user is already a member of the room (and
-         maybe their HS has forgotten this fact), or
-      b) the proposed room has a lexicographically-higher ID than the existing
-         room (to resolve true race condition conflicts)
+
+      - a) the HS believes the sending user is already a member of the room (and
+        maybe their HS has forgotten this fact), or
+      - b) the proposed room has a lexicographically-higher ID than the existing
+        room (to resolve true race condition conflicts)
       
  * The room ID for a private 1:1 chat has a special form, determined by
    concatenting the User IDs of both members in a deterministic order, such that
diff --git a/drafts/old-client-server-specification.rst b/drafts/old-client-server-specification.rst
deleted file mode 100644
index e06bd676..00000000
--- a/drafts/old-client-server-specification.rst
+++ /dev/null
@@ -1,1281 +0,0 @@
-========================
-Matrix Client-Server API
-========================
-
-
-
-.. WARNING::
-  This specification is quite old and obsolete, but not all of the bits which 
-  are still relevant have been merged into matrix-doc/specification.
-  As such this is still quite a useful trove of info.
-  This needs to happen asap.
-
-
-
-
-
-The following specification outlines how a client can send and receive data from 
-a home server.
-
-[[TODO(kegan): 4/7/14 Grilling
-- Mechanism for getting historical state changes (e.g. topic updates) - add 
-  query param flag?
-- Generic mechanism for linking first class events (e.g. feedback) with other s
-  first class events (e.g. messages)?
-- Generic mechanism for updating 'stuff about the room' (e.g. favourite coffee) 
-  AND specifying clobbering rules (clobber/add to list/etc)?
-- How to ensure a consistent view for clients paginating through room lists? 
-  They aren't really ordered in any way, and if you're paginating
-  through them, how can you show them a consistent result set? Temporary 'room 
-  list versions' akin to event version? How does that work?
-]]
-
-[[TODO(kegan):
-Outstanding problems / missing spec:
-- Push
-- Typing notifications
-]]
-
-Terminology
------------
-Stream Tokens: 
-An opaque token used to make further streaming requests. When using any 
-pagination streaming API, responses will contain a start and end stream token. 
-When reconnecting to the stream, these tokens can be used to tell the server 
-where the client got up to in the stream.
-
-Event ID:
-Every event that comes down the event stream or that is returned from the REST
-API has an associated event ID (event_id). This ID will be the same between the 
-REST API and the event stream, so any duplicate events can be clobbered 
-correctly without knowing anything else about the event.
-
-Message ID:
-The ID of a message sent by a client in a room. Clients send IMs to each other 
-in rooms. Each IM sent by a client must have a unique message ID which is unique
-for that particular client.
-
-User ID:
-The @username:host style ID of the client. When registering for an account, the 
-client specifies their username. The user_id is this username along with the 
-home server's unique hostname. When federating between home servers, the user_id
-is used to uniquely identify users across multiple home servers.
-
-Room ID:
-The room_id@host style ID for the room. When rooms are created, the client either
-specifies or is allocated a room ID. This room ID must be used to send messages 
-in that room. Like with clients, there may be multiple rooms with the same ID 
-across multiple home servers. The room_id is used to uniquely identify a room 
-when federating.
-
-Global message ID:
-The globally unique ID for a message. This ID is formed from the msg_id, the 
-client's user_id and the room_id. This uniquely identifies any 
-message. It is represented with '-' as the delimeter between IDs. The 
-global_msg_id is of the form: room_id-user_id-msg_id
-
-
-REST API and the Event Stream
------------------------------
-Clients send data to the server via a RESTful API. They can receive data via 
-this API or from an event stream. An event stream is a special path which 
-streams all events the client may be interested in. This makes it easy to 
-immediately receive updates from the REST API. All data is represented as JSON.
-
-Pagination streaming API
-========================
-Clients are often interested in very large datasets. The data itself could
-be 1000s of messages in a given room, 1000s of rooms in a public room list, or
-1000s of events (presence, typing, messages, etc) in the system. It is not
-practical to send vast quantities of data to the client every time they
-request a list of public rooms for example. There needs to be a way to show a
-subset of this data, and apply various filters to it. This is what the pagination
-streaming API is. This API defines standard request/response parameters which 
-can be used when navigating this stream of data.
-
-Pagination Request Query Parameters
------------------------------------
-Clients may wish to paginate results from the event stream, or other sources of 
-information where the amount of information may be a problem,
-e.g. in a room with 10,000s messages. The pagination query parameters provide a 
-way to navigate a 'window' around a large set of data. These
-parameters are only valid for GET requests.
-       
-        S e r v e r - s i d e   d a t a
- |-------------------------------------------------|
-START      ^               ^                      END
-           |_______________|
-                   |
-            Client-extraction
-
-'START' and 'END' are magic token values which specify the start and end of the 
-dataset respectively.
-
-Query parameters:
-  from : $streamtoken - The opaque token to start streaming from.
-  to : $streamtoken - The opaque token to end streaming at. Typically,
-       clients will not know the item of data to end at, so this will usually be 
-       START or END.
-  limit : integer - An integer representing the maximum number of items to 
-          return.
-
-For example, the event stream has events E1 -> E15. The client wants the last 5 
-events and doesn't know any previous events:
-
-S                                                    E
-|-E1-E2-E3-E4-E5-E6-E7-E8-E9-E10-E11-E12-E13-E14-E15-|
-|                               |                    |
-|                          _____|                    |
-|__________________       |       ___________________|
-                   |      |      |
- GET /events?to=START&limit=5&from=END
- Returns:
-   E15,E14,E13,E12,E11
-
-
-Another example: a public room list has rooms R1 -> R17. The client is showing 5 
-rooms at a time on screen, and is on page 2. They want to
-now show page 3 (rooms R11 -> 15):
-
-S                                                           E
-|  0  1  2  3  4  5  6  7  8  9  10  11  12  13  14  15  16 | stream token
-|-R1-R2-R3-R4-R5-R6-R7-R8-R9-R10-R11-R12-R13-R14-R15-R16-R17| room
-                  |____________| |________________|
-                        |                |
-                    Currently            |
-                    viewing              |
-                                         |
-                         GET /rooms/list?from=9&to=END&limit=5
-                         Returns: R11,R12,R13,R14,R15
-                         
-Note that tokens are treated in an *exclusive*, not inclusive, manner. The end 
-token from the intial request was '9' which corresponded to R10. When the 2nd
-request was made, R10 did not appear again, even though from=9 was specified. If
-you know the token, you already have the data.
-
-Pagination Response
--------------------
-Responses to pagination requests MUST follow the format:
-{
-  "chunk": [ ... , Responses , ... ],
-  "start" : $streamtoken,
-  "end" : $streamtoken
-}
-Where $streamtoken is an opaque token which can be used in another query to
-get the next set of results. The "start" and "end" keys can only be omitted if
-the complete dataset is provided in "chunk".
-
-If the client wants earlier results, they should use from=$start_streamtoken,
-to=START. Likewise, if the client wants later results, they should use
-from=$end_streamtoken, to=END.
-
-Unless specified, the default pagination parameters are from=START, to=END, 
-without a limit set. This allows you to hit an API like
-/events without any query parameters to get everything.
-
-The Event Stream
-----------------
-The event stream returns events using the pagination streaming API. When the 
-client disconnects for a while and wants to reconnect to the event stream, they 
-should specify from=$end_streamtoken. This lets the server know where in the 
-event stream the client is. These tokens are completely opaque, and the client 
-cannot infer anything from them.
-
-  GET /events?from=$LAST_STREAM_TOKEN
-  REST Path: /events
-  Returns (success): A JSON array of Event Data.
-  Returns (failure): An Error Response
-
-LAST_STREAM_TOKEN is the last stream token obtained from the event stream. If the 
-client is connecting for the first time and does not know any stream tokens,
-they can use "START" to request all events from the start. For more information 
-on this, see "Pagination Request Query Parameters".
-
-The event stream supports shortpoll and longpoll with the "timeout" query
-parameter. This parameter specifies the number of milliseconds the server should
-hold onto the connection waiting for incoming events. If no events occur in this
-period, the connection will be closed and an empty chunk will be returned. To
-use shortpoll, specify "timeout=0".
-
-Event Data
-----------
-This is a JSON object which looks like:
-{
-  "event_id" : $EVENT_ID,
-  "type" : $EVENT_TYPE,
-  $URL_ARGS,
-  "content" : {
-    $EVENT_CONTENT
-  }
-}
-
-EVENT_ID
-  An ID identifying this event. This is so duplicate events can be suppressed on
-  the client.
-
-EVENT_TYPE
-  The namespaced event type (m.*)
-
-URL_ARGS
-  Path specific data from the REST API.
-
-EVENT_CONTENT
-  The event content, matching the REST content PUT previously.
-
-Events are differentiated via the event type "type" key. This is the type of 
-event being received. This can be expanded upon by using different namespaces. 
-Every event MUST have a 'type' key.
-
-Most events will have a corresponding REST URL. This URL will generally have 
-data in it to represent the resource being modified,
-e.g. /rooms/$room_id. The event data will contain extra top-level keys to expose 
-this information to clients listening on an event
-stream. The event content maps directly to the contents submitted via the REST 
-API.
-
-For example:
-  Event Type: m.example.room.members
-  REST Path: /examples/room/$room_id/members/$user_id
-  REST Content: { "membership" : "invited" }
-  
-is represented in the event stream as:
-
-{
-  "event_id" : "e_some_event_id",
-  "type" : "m.example.room.members",
-  "room_id" : $room_id,
-  "user_id" : $user_id,
-  "content" : {
-    "membership" : "invited"
-  }
-}
-
-As convention, the URL variable "$varname" will map directly onto the name 
-of the JSON key "varname".
-
-Error Responses
----------------
-If the client sends an invalid request, the server MAY respond with an error 
-response. This is of the form:
-{
-  "error" : "string",
-  "errcode" : "string"
-}
-The 'error' string will be a human-readable error message, usually a sentence
-explaining what went wrong. 
-
-The 'errcode' string will be a unique string which can be used to handle an 
-error message e.g. "M_FORBIDDEN". These error codes should have their namespace 
-first in ALL CAPS, followed by a single _. For example, if there was a custom
-namespace com.mydomain.here, and a "FORBIDDEN" code, the error code should look
-like "COM.MYDOMAIN.HERE_FORBIDDEN". There may be additional keys depending on 
-the error, but the keys 'error' and 'errcode' will always be present. 
-
-Some standard error codes are below:
-
-M_FORBIDDEN:
-Forbidden access, e.g. joining a room without permission, failed login.
-
-M_UNKNOWN_TOKEN:
-The access token specified was not recognised.
-
-M_BAD_JSON:
-Request contained valid JSON, but it was malformed in some way, e.g. missing
-required keys, invalid values for keys.
-
-M_NOT_JSON:
-Request did not contain valid JSON.
-
-M_NOT_FOUND:
-No resource was found for this request.
-
-Some requests have unique error codes:
-
-M_USER_IN_USE:
-Encountered when trying to register a user ID which has been taken.
-
-M_ROOM_IN_USE:
-Encountered when trying to create a room which has been taken.
-
-M_BAD_PAGINATION:
-Encountered when specifying bad pagination values to a Pagination Streaming API.
-
-
-========
-REST API
-========
-
-All content must be application/json. Some keys are required, while others are 
-optional. Unless otherwise specified,
-all HTTP PUT/POST/DELETEs will return a 200 OK with an empty response body on 
-success, and a 4xx/5xx with an optional Error Response on failure. When sending 
-data, if there are no keys to send, an empty JSON object should be sent.
-
-All POST/PUT/GET/DELETE requests MUST have an 'access_token' query parameter to 
-allow the server to authenticate the client. All
-POST requests MUST be submitted as application/json. 
-
-All paths MUST be namespaced by the version of the API being used. This should
-be:
-
-/_matrix/client/api/v1
-
-All REST paths in this section MUST be prefixed with this. E.g.
-  REST Path: /rooms/$room_id
-  Absolute Path: /_matrix/client/api/v1/rooms/$room_id
-
-Registration
-============
-Clients must register with the server in order to use the service. After 
-registering, the client will be given an
-access token which must be used in ALL requests as a query parameter 
-'access_token'.
-
-Registering for an account
---------------------------
-  POST /register
-  With: A JSON object containing the key "user_id" which contains the desired 
-        user_id, or an empty JSON object to have the server allocate a user_id 
-        automatically.
-  Returns (success): 200 OK with a JSON object:
-                     {
-                       "user_id" : "string [user_id]",
-                       "access_token" : "string"
-                     }
-  Returns (failure): An Error Response. M_USER_IN_USE if the user ID is taken.
-                     
-
-Unregistering an account
-------------------------
-  POST /unregister
-  With query parameters: access_token=$ACCESS_TOKEN
-  Returns (success): 200 OK
-  Returns (failure): An Error Response.
-  
-  
-Logging in to an existing account
-=================================
-If the client has already registered, they need to be able to login to their
-account. The home server may provide many different ways of logging in, such
-as user/password auth, login via a social network (OAuth), login by confirming 
-a token sent to their email address, etc. This section does NOT define how home 
-servers should authorise their users who want to login to their existing 
-accounts. This section defines the standard interface which implementations 
-should follow so that ANY client can login to ANY home server.
-
-The login process breaks down into the following:
-  1: Get login process info.
-  2: Submit the login stage credentials.
-  3: Get access token or be told the next stage in the login process and repeat 
-     step 2.
-     
-Getting login process info:
-  GET /login
-  Returns (success): 200 OK with LoginInfo.
-  Returns (failure): An Error Response.
-  
-Submitting the login stage credentials:
-  POST /login
-  With: LoginSubmission
-  Returns (success): 200 OK with LoginResult
-  Returns (failure): An Error Response
-  
-Where LoginInfo is a JSON object which MUST have a "type" key which denotes the 
-login type. If there are multiple login stages, this object MUST also contain a 
-"stages" key, which has a JSON array of login types denoting all the steps in 
-order to login, including the first stage which is in "type". This allows the 
-client to make an informed decision as to whether or not they can natively
-handle the entire login process, or whether they should fallback (see below).
-
-Where LoginSubmission is a JSON object which MUST have a "type" key.
-
-Where LoginResult is a JSON object which MUST have either a "next" key OR an
-"access_token" key, depending if the login process is over or not. This object
-MUST have a "session" key if multiple POSTs need to be sent to /login.
-
-Fallback
---------
-If the client does NOT know how to handle the given type, they should:
-  GET /login/fallback
-This MUST return an HTML page which can perform the entire login process.
-
-Password-based
---------------
-Type: "m.login.password"
-LoginSubmission:
-{
-  "type": "m.login.password",
-  "user": <user_id>,
-  "password": <password>
-}
-
-Example:
-Assume you are @bob:matrix.org and you wish to login on another mobile device.
-First, you GET /login which returns:
-{
-  "type": "m.login.password"
-}
-Your client knows how to handle this, so your client prompts the user to enter
-their username and password. This is then submitted:
-{
-  "type": "m.login.password",
-  "user": "@bob:matrix.org",
-  "password": "monkey"
-}
-The server checks this, finds it is valid, and returns:
-{
-  "access_token": "abcdef0123456789"
-}
-The server may optionally return "user_id" to confirm or change the user's ID.
-This is particularly useful if the home server wishes to support localpart entry
-of usernames (e.g. "bob" rather than "@bob:matrix.org").
-
-OAuth2-based
-------------
-Type: "m.login.oauth2"
-This is a multi-stage login.
-
-LoginSubmission:
-{
-  "type": "m.login.oauth2",
-  "user": <user_id>
-}
-Returns:
-{
-  "uri": <Authorization Request uri OR service selection uri>
-}
-
-The home server acts as a 'confidential' Client for the purposes of OAuth2.
-
-If the uri is a "sevice selection uri", it is a simple page which prompts the 
-user to choose which service to authorize with. On selection of a service, they
-link through to Authorization Request URIs. If there is only 1 service which the
-home server accepts when logging in, this indirection can be skipped and the
-"uri" key can be the Authorization Request URI. 
-
-The client visits the Authorization Request URI, which then shows the OAuth2 
-Allow/Deny prompt. Hitting 'Allow' returns the redirect URI with the auth code. 
-Home servers can choose any path for the redirect URI. The client should visit 
-the redirect URI, which will then finish the OAuth2 login process, granting the 
-home server an access token for the chosen service. When the home server gets 
-this access token, it knows that the cilent has authed with the 3rd party, and 
-so can return a LoginResult.
-
-The OAuth redirect URI (with auth code) MUST return a LoginResult.
-    
-Example:
-Assume you are @bob:matrix.org and you wish to login on another mobile device.
-First, you GET /login which returns:
-{
-  "type": "m.login.oauth2"
-}
-Your client knows how to handle this, so your client prompts the user to enter
-their username. This is then submitted:
-{
-  "type": "m.login.oauth2",
-  "user": "@bob:matrix.org"
-}
-The server only accepts auth from Google, so returns the Authorization Request
-URI for Google:
-{
-  "uri": "https://accounts.google.com/o/oauth2/auth?response_type=code&
-  client_id=CLIENT_ID&redirect_uri=REDIRECT_URI&scope=photos"
-}
-The client then visits this URI and authorizes the home server. The client then
-visits the REDIRECT_URI with the auth code= query parameter which returns:
-{
-  "access_token": "0123456789abcdef"
-}
-
-Email-based (code)
-------------------
-Type: "m.login.email.code"
-This is a multi-stage login.
-
-First LoginSubmission:
-{
-  "type": "m.login.email.code",
-  "user": <user_id>
-  "email": <email address>
-}
-Returns:
-{
-  "session": <session id>
-}
-
-The email contains a code which must be sent in the next LoginSubmission:
-{
-  "type": "m.login.email.code",
-  "session": <session id>,
-  "code": <code in email sent>
-}
-Returns:
-{
-  "access_token": <access token>
-}
-
-Example:
-Assume you are @bob:matrix.org and you wish to login on another mobile device.
-First, you GET /login which returns:
-{
-  "type": "m.login.email.code"
-}
-Your client knows how to handle this, so your client prompts the user to enter
-their email address. This is then submitted:
-{
-  "type": "m.login.email.code",
-  "user": "@bob:matrix.org",
-  "email": "bob@mydomain.com"
-}
-The server confirms that bob@mydomain.com is linked to @bob:matrix.org, then 
-sends an email to this address and returns:
-{
-  "session": "ewuigf7462"
-}
-The client's screen changes to a code submission page. The email arrives and it 
-says something to the effect of "please enter 2348623 into the app". This is
-the submitted along with the session:
-{
-  "type": "m.login.email.code",
-  "session": "ewuigf7462",
-  "code": "2348623"
-}
-The server accepts this and returns:
-{
-  "access_token": "abcdef0123456789"
-}
-
-Email-based (url)
------------------
-Type: "m.login.email.url"
-This is a multi-stage login.
-
-First LoginSubmission:
-{
-  "type": "m.login.email.url",
-  "user": <user_id>
-  "email": <email address>
-}
-Returns:
-{
-  "session": <session id>
-}
-
-The email contains a URL which must be clicked. After it has been clicked, the
-client should perform a request:
-{
-  "type": "m.login.email.code",
-  "session": <session id>
-}
-Returns:
-{
-  "access_token": <access token>
-}
-
-Example:
-Assume you are @bob:matrix.org and you wish to login on another mobile device.
-First, you GET /login which returns:
-{
-  "type": "m.login.email.url"
-}
-Your client knows how to handle this, so your client prompts the user to enter
-their email address. This is then submitted:
-{
-  "type": "m.login.email.url",
-  "user": "@bob:matrix.org",
-  "email": "bob@mydomain.com"
-}
-The server confirms that bob@mydomain.com is linked to @bob:matrix.org, then 
-sends an email to this address and returns:
-{
-  "session": "ewuigf7462"
-}
-The client then starts polling the server with the following:
-{
-  "type": "m.login.email.url",
-  "session": "ewuigf7462"
-}
-(Alternatively, the server could send the device a push notification when the
-email has been validated). The email arrives and it contains a URL to click on.
-The user clicks on the which completes the login process with the server. The
-next time the client polls, it returns:
-{
-  "access_token": "abcdef0123456789"
-}
-
-N-Factor auth
--------------
-Multiple login stages can be combined with the "next" key in the LoginResult.
-
-Example:
-A server demands an email.code then password auth before logging in. First, the
-client performs a GET /login which returns:
-{
-  "type": "m.login.email.code",
-  "stages": ["m.login.email.code", "m.login.password"]
-}
-The client performs the email login (See "Email-based (code)"), but instead of
-returning an access_token, it returns:
-{
-  "next": "m.login.password"
-}
-The client then presents a user/password screen and the login continues until
-this is complete (See "Password-based"), which then returns the "access_token".
-
-Rooms
-=====
-A room is a conceptual place where users can send and receive messages. Rooms 
-can be created, joined and left. Messages are sent
-to a room, and all participants in that room will receive the message. Rooms are 
-uniquely identified via the room_id.
-
-Creating a room (with a room ID)
---------------------------------
-  Event Type: m.room.create [TODO(kegan): Do we generate events for this?]
-  REST Path: /rooms/$room_id
-  Valid methods: PUT
-  Required keys: None.
-  Optional keys:
-    visibility : [public|private] - Set whether this room shows up in the public 
-    room list.
-  Returns:
-    On Failure: MAY return a suggested alternative room ID if this room ID is 
-    taken.
-    {
-      suggested_room_id : $new_room_id
-      error : "Room already in use."
-      errcode : "M_ROOM_IN_USE"
-    }
-    
-
-Creating a room (without a room ID)
------------------------------------
-  Event Type: m.room.create [TODO(kegan): Do we generate events for this?]
-  REST Path: /rooms
-  Valid methods: POST
-  Required keys: None.
-  Optional keys:
-    visibility : [public|private] - Set whether this room shows up in the public 
-    room list.
-  Returns:
-    On Success: The allocated room ID. Additional information about the room
-    such as the visibility MAY be included as extra keys in this response.
-    {
-      room_id : $room_id
-    }
-
-Setting the topic for a room
-----------------------------
-  Event Type: m.room.topic
-  REST Path: /rooms/$room_id/topic
-  Valid methods: GET/PUT
-  Required keys: 
-    topic : $topicname - Set the topic to $topicname in room $room_id.
-
-
-See a list of public rooms
---------------------------
-  REST Path: /public/rooms?pagination_query_parameters
-  Valid methods: GET
-  This API can use pagination query parameters.
-  Returns:
-    {
-      "chunk" : JSON array of RoomInfo JSON objects - Required.
-      "start" : "string (start token)" - See Pagination Response.
-      "end" : "string (end token)" - See Pagination Response.
-      "total" : integer - Optional. The total number of rooms.
-    }
-
-RoomInfo: Information about a single room.
-  Servers MUST send the key: room_id
-  Servers MAY send the keys: topic, num_members
-  {
-    "room_id" : "string",
-    "topic" : "string",
-    "num_members" : integer
-  }
-
-Room Members
-============
-
-Invite/Joining/Leaving a room
------------------------------
-  Event Type: m.room.member
-  REST Path: /rooms/$room_id/members/$user_id/state
-  Valid methods: PUT/GET/DELETE
-  Required keys:
-    membership : [join|invite] - The membership state of $user_id in room 
-                                 $room_id.
-  Optional keys:
-    displayname,
-    avatar_url : String fields from the member user's profile
-    state,
-    status_msg,
-    mtime_age : Presence information
-
-  These optional keys provide extra information that the client is likely to
-  be interested in so it doesn't have to perform an additional profile or
-  presence information fetch.
-
-Where:
-  join - Indicate you ($user_id) are joining the room $room_id.
-  invite - Indicate that $user_id has been invited to room $room_id.
-
-User $user_id can leave room $room_id by DELETEing this path.
-
-Checking the user list of a room
---------------------------------
-  REST Path: /rooms/$room_id/members/list
-  This API can use pagination query parameters.
-  Valid methods: GET
-  Returns:
-    A pagination response with chunk data as m.room.member events.
-
-Messages
-========
-Users send messages to other users in rooms. These messages may be text, images, 
-video, etc. Clients may also want to acknowledge messages by sending feedback, 
-in the form of delivery/read receipts.
-
-Server-attached keys
---------------------
-The server MAY attach additional keys to messages and feedback. If a client 
-submits keys with the same name, they will be clobbered by
-the server.
-
-Required keys:
-from : "string [user_id]"
-  The user_id of the user who sent the message/feedback.
-
-Optional keys:
-hsob_ts : integer
-  A timestamp (ms resolution) representing when the message/feedback got to the 
-  sender's home server ("home server outbound timestamp").
-
-hsib_ts : integer
-  A timestamp (ms resolution) representing when the 
-  message/feedback got to the receiver's home server ("home server inbound 
-  timestamp"). This may be the same as hsob_ts if the sender/receiver are on the 
-  same home server.
-
-Sending messages
-----------------
-  Event Type: m.room.message
-  REST Path: /rooms/$room_id/messages/$from/$msg_id
-  Valid methods: GET/PUT
-  URL parameters:
-    $from : user_id - The sender's user_id. This value will be clobbered by the 
-    server before sending.
-  Required keys: 
-    msgtype: [m.text|m.emote|m.image|m.audio|m.video|m.location|m.file] - 
-             The type of message. Not to be confused with the Event 'type'.
-  Optional keys:
-    sender_ts : integer - A timestamp (ms resolution) representing the 
-                wall-clock time when the message was sent from the client.
-  Reserved keys:
-    body : "string" - The human readable string for compatibility with clients 
-           which cannot process a given msgtype. This key is optional, but
-           if it is included, it MUST be human readable text 
-           describing the message. See individual msgtypes for more 
-           info on what this means in practice.
-
-Each msgtype may have required fields of their own.
-
-msgtype: m.text
-----------------
-Required keys:
-  body : "string" - The body of the message.
-Optional keys:
-  None.
-
-msgtype: m.emote
------------------
-Required keys:
-  body : "string" - *tries to come up with a witty explanation*.
-Optional keys:
-  None.
-
-msgtype: m.image
------------------
-Required keys:
-  url : "string" - The URL to the image.
-Optional keys:
-  body : "string" - info : JSON object (ImageInfo) - The image info for image 
-         referred to in 'url'.
-  thumbnail_url : "string" - The URL to the thumbnail.
-  thumbnail_info : JSON object (ImageInfo) - The image info for the image 
-                   referred to in 'thumbnail_url'.
-
-ImageInfo: Information about an image.
-{
-  "size" : integer (size of image in bytes),
-  "w" : integer (width of image in pixels),
-  "h" : integer (height of image in pixels),
-  "mimetype" : "string (e.g. image/jpeg)"
-}
-
-Interpretation of 'body' key: The alt text of the image, or some kind of content 
-description for accessibility e.g. "image attachment".
-
-msgtype: m.audio
------------------
-Required keys:
-  url : "string" - The URL to the audio.
-Optional keys:
-  info : JSON object (AudioInfo) - The audio info for the audio referred to in 
-         'url'.
-
-AudioInfo: Information about a piece of audio. 
-{
-  "mimetype" : "string (e.g. audio/aac)",
-  "size" : integer (size of audio in bytes),
-  "duration" : integer (duration of audio in milliseconds)
-}
-
-Interpretation of 'body' key: A description of the audio e.g. "Bee Gees - 
-Stayin' Alive", or some kind of content description for accessibility e.g. 
-"audio attachment".
-
-msgtype: m.video
------------------
-Required keys:
-  url : "string" - The URL to the video.
-Optional keys:
-  info : JSON object (VideoInfo) - The video info for the video referred to in 
-         'url'.
-
-VideoInfo: Information about a video.
-{
-  "mimetype" : "string (e.g. video/mp4)",
-  "size" : integer (size of video in bytes),
-  "duration" : integer (duration of video in milliseconds),
-  "w" : integer (width of video in pixels),
-  "h" : integer (height of video in pixels),
-  "thumbnail_url" : "string (URL to image)",
-  "thumbanil_info" : JSON object (ImageInfo)
-}
-
-Interpretation of 'body' key: A description of the video e.g. "Gangnam style", 
-or some kind of content description for accessibility e.g. "video attachment".
-
-msgtype: m.location
---------------------
-Required keys:
-  geo_uri : "string" - The geo URI representing the location.
-Optional keys:
-  thumbnail_url : "string" - The URL to a thumnail of the location being 
-                  represented.
-  thumbnail_info : JSON object (ImageInfo) - The image info for the image 
-                   referred to in 'thumbnail_url'.
-
-Interpretation of 'body' key: A description of the location e.g. "Big Ben, 
-London, UK", or some kind of content description for accessibility e.g. 
-"location attachment".
-
-
-Sending feedback
-----------------
-When you receive a message, you may want to send delivery receipt to let the 
-sender know that the message arrived. You may also want to send a read receipt 
-when the user has read the message. These receipts are collectively known as 
-'feedback'.
-
-  Event Type: m.room.message.feedback
-  REST Path: /rooms/$room_id/messages/$msgfrom/$msg_id/feedback/$from/$feedback
-  Valid methods: GET/PUT
-  URL parameters:
-    $msgfrom - The sender of the message's user_id.
-    $from : user_id - The sender of the feedback's user_id. This value will be 
-    clobbered by the server before sending.
-    $feedback : [d|r] - Specify if this is a [d]elivery or [r]ead receipt.
-  Required keys:
-    None.
-  Optional keys:
-    sender_ts : integer - A timestamp (ms resolution) representing the 
-    wall-clock time when the receipt was sent from the client.
-
-Receiving messages (bulk/pagination)
-------------------------------------
-  Event Type: m.room.message
-  REST Path: /rooms/$room_id/messages/list
-  Valid methods: GET
-  Query Parameters:
-    feedback : [true|false] - Specify if feedback should be bundled with each 
-    message.
-  This API can use pagination query parameters.
-  Returns:
-    A JSON array of Event Data in "chunk" (see Pagination Response). If the 
-    "feedback" parameter was set, the Event Data will also contain a "feedback" 
-    key which contains a JSON array of feedback, with each element as Event Data 
-    with compressed feedback for this message.
-
-Event Data with compressed feedback is a special type of feedback with 
-contextual keys removed. It is designed to limit the amount of redundant data 
-being sent for feedback. This removes the type, event_id, room ID, 
-message sender ID and message ID keys.
-
-     ORIGINAL (via event streaming)
-{
-  "event_id":"e1247632487",
-  "type":"m.room.message.feedback",
-  "from":"string [user_id]",
-  "feedback":"string [d|r]",
-  "room_id":"$room_id",
-  "msg_id":"$msg_id",
-  "msgfrom":"$msgfromid",
-  "content":{
-    "sender_ts":139880943
-  }
-}
-
-     COMPRESSED (via /messages/list)
-{
-  "from":"string [user_id]",
-  "feedback":"string [d|r]",
-  "content":{
-    "sender_ts":139880943
-  }
-}
-
-When you join a room $room_id, you may want the last 10 messages with feedback. 
-This is represented as:
-  GET 
-  /rooms/$room_id/messages/list?from=END&to=START&limit=10&feedback=true
-
-You may want to get 10 messages even earlier than that without feedback. If the 
-start stream token from the previous request was stok_019173, this request would 
-be:
-  GET 
-  /rooms/$room_id/messages/list?from=stok_019173&to=START&limit=10&
-                               feedback=false
-  
-NOTE: Care must be taken when using this API in conjunction with event 
-      streaming. It is possible that this will return a message which will
-      then come down the event stream, resulting in a duplicate message. Clients 
-      should clobber based on the global message ID, or event ID.
-
-
-Get current state for all rooms (aka IM Initial Sync API)
--------------------------------
-  REST Path: /im/sync
-  Valid methods: GET
-  This API can use pagination query parameters. Pagination is applied on a per
-  *room* basis. E.g. limit=1 means "get 1 message for each room" and not "get 1
-  room's messages". If there is no limit, all messages for all rooms will be
-  returned.
-  If you want 1 room's messages, see "Receiving messages (bulk/pagination)".
-  Additional query parameters: 
-    feedback: [true] - Bundles feedback with messages.
-  Returns:
-    An array of RoomStateInfo.
-
-RoomStateInfo: A snapshot of information about a single room.
-  {
-    "room_id" : "string",
-    "membership" : "string [join|invite]",
-    "messages" : {
-      "start": "string",
-      "end": "string",
-      "chunk":
-      m.room.message pagination stream events (with feedback if specified),
-      this is the same as "Receiving messages (bulk/pagination)".
-    }
-  }
-The "membership" key is the calling user's membership state in the given 
-"room_id". The "messages" key may be omitted if the "membership" value is 
-"invite". Additional keys may be added to the top-level object, such as:
-  "topic" : "string" - The topic for the room in question.
-  "room_image_url" : "string" - The URL of the room image if specified.
-  "num_members" : integer - The number of members in the room.
-
-
-Profiles
-========
-
-Getting/Setting your own displayname
-------------------------------------
-  REST Path: /profile/$user_id/displayname
-  Valid methods: GET/PUT
-  Required keys:
-    displayname : The displayname text
-
-Getting/Setting your own avatar image URL
------------------------------------------
-The homeserver does not currently store the avatar image itself, but offers
-storage for the user to specify a web URL that points at the required image,
-leaving it up to clients to fetch it themselves.
-  REST Path: /profile/$user_id/avatar_url
-  Valid methods: GET/PUT
-  Required keys:
-    avatar_url : The URL path to the required image
-
-Getting other user's profile information
-----------------------------------------
-Either of the above REST methods may be used to fetch other user's profile
-information by the client, either on other local users on the same homeserver or
-for users from other servers entirely.
-
-
-Presence
-========
-
-In the following messages, the presence state is a presence string as described in
-the main specification document.
-
-Getting/Setting your own presence state
----------------------------------------
-  REST Path: /presence/$user_id/status
-  Valid methods: GET/PUT
-  Required keys:
-    presence : <string> - The user's new presence state
-  Optional keys:
-    status_msg : text string provided by the user to explain their status
-
-Fetching your presence list
----------------------------
-  REST Path: /presence_list/$user_id
-  Valid methods: GET/(post)
-  Returns:
-    An array of presence list entries. Each entry is an object with the
-    following keys:
-      {
-        "user_id" : string giving the observed user's ID
-        "presence" : int giving their status
-        "status_msg" : optional text string
-        "displayname" : optional text string from the user's profile
-        "avatar_url" : optional text string from the user's profile
-      }
-
-Maintaining your presence list
-------------------------------
-  REST Path: /presence_list/$user_id
-  Valid methods: POST/(get)
-  With: A JSON object optionally containing either of the following keys:
-    "invite" : a list of strings giving user IDs to invite for presence
-      subscription
-    "drop" : a list of strings giving user IDs to remove from your presence
-      list
-
-Receiving presence update events
---------------------------------
-  Event Type: m.presence
-  Keys of the event's content are the same as those returned by the presence
-    list.
-
-Examples
-========
-
-The following example is the story of "bob", who signs up at "sy.org" and joins 
-the public room "room_beta@sy.org". They get the 2 most recent
-messages (with feedback) in that room and then send a message in that room. 
-
-For context, here is the complete chat log for room_beta@sy.org:
-
-Room: "Hello world" (room_beta@sy.org)
-Members: (2) alice@randomhost.org, friend_of_alice@randomhost.org
-Messages:
-  alice@randomhost.org : hi friend!                     
-  [friend_of_alice@randomhost.org DELIVERED]
-  alice@randomhost.org : you're my only friend          
-  [friend_of_alice@randomhost.org DELIVERED]
-  alice@randomhost.org : afk                            
-  [friend_of_alice@randomhost.org DELIVERED]
-  [ bob@sy.org joins ]
-  bob@sy.org : Hi everyone
-  [ alice@randomhost.org changes the topic to "FRIENDS ONLY" ]
-  alice@randomhost.org : Hello!!!!
-  alice@randomhost.org : Let's go to another room
-  alice@randomhost.org : You're not my friend
-  [ alice@randomhost.org invites bob@sy.org to the room 
-  commoners@randomhost.org]
-
-
-REGISTER FOR AN ACCOUNT
-POST: /register
-Content: {}
-Returns: { "user_id" : "bob@sy.org" , "access_token" : "abcdef0123456789" }
-
-GET PUBLIC ROOM LIST
-GET: /rooms/list?access_token=abcdef0123456789
-Returns: 
-{ 
-  "total":3,
-  "chunk":
-  [
-    { "room_id":"room_alpha@sy.org", "topic":"I am a fish" },
-    { "room_id":"room_beta@sy.org", "topic":"Hello world" },
-    { "room_id":"room_xyz@sy.org", "topic":"Goodbye cruel world" }
-  ]
-}
-
-JOIN ROOM room_beta@sy.org
-PUT 
-/rooms/room_beta%40sy.org/members/bob%40sy.org/state?
-                                    access_token=abcdef0123456789
-Content: { "membership" : "join" }
-Returns: 200 OK
-
-GET LATEST 2 MESSAGES WITH FEEDBACK
-GET 
-/rooms/room_beta%40sy.org/messages/list?from=END&to=START&limit=2&
-                                    feedback=true&access_token=abcdef0123456789
-Returns:
-{
-  "chunk":
-    [
-      { 
-        "event_id":"01948374", 
-        "type":"m.room.message",
-        "room_id":"room_beta@sy.org",
-        "msg_id":"avefifu",
-        "from":"alice@randomhost.org",
-        "hs_ts":139985736,
-        "content":{
-          "msgtype":"m.text",
-          "body":"afk"
-        }
-        "feedback": [
-          {
-            "from":"friend_of_alice@randomhost.org",
-            "feedback":"d",
-            "hs_ts":139985850,
-            "content":{
-              "sender_ts":139985843
-            }
-          }
-        ]
-      },
-      { 
-        "event_id":"028dfe8373", 
-        "type":"m.room.message",
-        "room_id":"room_beta@sy.org",
-        "msg_id":"afhgfff",
-        "from":"alice@randomhost.org",
-        "hs_ts":139970006,
-        "content":{
-          "msgtype":"m.text",
-          "body":"you're my only friend"
-        }
-        "feedback": [
-          {
-            "from":"friend_of_alice@randomhost.org",
-            "feedback":"d",
-            "hs_ts":139970144,
-            "content":{
-              "sender_ts":139970122
-            }
-          }
-        ]
-      },
-    ],
-  "start": "stok_04823947",
-  "end": "etok_1426425"
-}
-
-SEND MESSAGE IN ROOM
-PUT 
-/rooms/room_beta%40sy.org/messages/bob%40sy.org/m0001?
-                            access_token=abcdef0123456789
-Content: { "msgtype" : "text" , "body" : "Hi everyone" }
-Returns: 200 OK
-
-
-Checking the event stream for this user:
-GET: /events?from=START&access_token=abcdef0123456789
-Returns:
-{
-  "chunk": 
-    [
-      { 
-        "event_id":"e10f3d2b", 
-        "type":"m.room.member",
-        "room_id":"room_beta@sy.org",
-        "user_id":"bob@sy.org",
-        "content":{
-          "membership":"join"
-        }
-      },
-      { 
-        "event_id":"1b352d32", 
-        "type":"m.room.message",
-        "room_id":"room_beta@sy.org",
-        "msg_id":"m0001",
-        "from":"bob@sy.org",
-        "hs_ts":140193857,
-        "content":{
-          "msgtype":"m.text",
-          "body":"Hi everyone"
-        }
-      }
-    ],
-  "start": "stok_9348635",
-  "end": "etok_1984723"
-}
-
-Client disconnects for a while and the topic is updated in this room, 3 new 
-messages arrive whilst offline, and bob is invited to another room.
-
-GET /events?from=etok_1984723&access_token=abcdef0123456789
-Returns:
-{
-  "chunk": 
-    [
-      { 
-        "event_id":"feee0294", 
-        "type":"m.room.topic",
-        "room_id":"room_beta@sy.org",
-        "from":"alice@randomhost.org",
-        "content":{
-          "topic":"FRIENDS ONLY",
-        }
-      },
-      { 
-        "event_id":"a028bd9e", 
-        "type":"m.room.message",
-        "room_id":"room_beta@sy.org",
-        "msg_id":"z839409",
-        "from":"alice@randomhost.org",
-        "hs_ts":140195000,
-        "content":{
-          "msgtype":"m.text",
-          "body":"Hello!!!"
-        }
-      },
-      { 
-        "event_id":"49372d9e", 
-        "type":"m.room.message",
-        "room_id":"room_beta@sy.org",
-        "msg_id":"z839410",
-        "from":"alice@randomhost.org",
-        "hs_ts":140196000,
-        "content":{
-          "msgtype":"m.text",
-          "body":"Let's go to another room"
-        }
-      },
-      { 
-        "event_id":"10abdd01", 
-        "type":"m.room.message",
-        "room_id":"room_beta@sy.org",
-        "msg_id":"z839411",
-        "from":"alice@randomhost.org",
-        "hs_ts":140197000,
-        "content":{
-          "msgtype":"m.text",
-          "body":"You're not my friend"
-        }
-      },
-      { 
-        "event_id":"0018453d", 
-        "type":"m.room.member",
-        "room_id":"commoners@randomhost.org",
-        "from":"alice@randomhost.org",
-        "user_id":"bob@sy.org",
-        "content":{
-          "membership":"invite"
-        }
-      },
-    ],
-  "start": "stok_0184288",
-  "end": "etok_1348723"
-}

From 047355b5c9d69b34bfe09e44800c1d41d12c2185 Mon Sep 17 00:00:00 2001
From: Kegan Dougal <kegan@matrix.org>
Date: Fri, 6 Feb 2015 13:05:28 +0000
Subject: [PATCH 12/13] More syntax fixes

---
 drafts/typing_notifications.rst |  2 +-
 drafts/use_cases.rst            | 17 ++++++++++-------
 2 files changed, 11 insertions(+), 8 deletions(-)

diff --git a/drafts/typing_notifications.rst b/drafts/typing_notifications.rst
index 3d3d23e0..048eba98 100644
--- a/drafts/typing_notifications.rst
+++ b/drafts/typing_notifications.rst
@@ -7,7 +7,7 @@ Client APIs
 To set "I am typing for the next N msec"::
   PUT .../rooms/:room_id/typing/:user_id
   Content:  { "typing": true, "timeout": N }
-    # timeout is in msec; I suggest no more than 20 or 30 seconds
+  # timeout is in msec; I suggest no more than 20 or 30 seconds
 
 This should be re-sent by the client to continue informing the server the user
 is still typing; I suggest a safety margin of 5 seconds before the expected
diff --git a/drafts/use_cases.rst b/drafts/use_cases.rst
index 955db4b3..09172d49 100644
--- a/drafts/use_cases.rst
+++ b/drafts/use_cases.rst
@@ -268,6 +268,7 @@ Chat Screen
  What's visible:
   - Enough scrollback to fill a "screen full" of content.
   - Threads:
+
     - Initially will only display the timestamp and user ID of the *first*
       message. But can expand to show the entire tree.
     - Tree of messages indicating which message is a reply to which.
@@ -280,6 +281,7 @@ Chat Screen
   - Desktop/Push Notifications for messages
  What you can do:
   - Send a message in reply to another message:
+
     - Immediate local echo, may cause messages to re-order
     - Messages that haven't reached the server are queued.
     - Thread is displayed where it should be in the thread order once the
@@ -296,13 +298,14 @@ Chat Screen
     The columns start and end as threads split and rejoin the main conversation
     The messages for each thread are ordered by how recent they are::
 
-    Room #1        Room # 2           Room # 2
-    +------------+ +----------------+ Side thread.
-    | * Message1 | | * Root         | +--------------+
-    | * Message2 | | * A1 -> Root   | | * B1 -> Root |
-    +------------+ | * A2 -> A1     | | * B2 -> B1   |
-                   | * M -> A2, B2  | +--------------+
-                   +----------------+
+      Room #1        Room # 2           Room # 2
+      +------------+ +----------------+ Side thread.
+      | * Message1 | | * Root         | +--------------+
+      | * Message2 | | * A1 -> Root   | | * B1 -> Root |
+      +------------+ | * A2 -> A1     | | * B2 -> B1   |
+                     | * M -> A2, B2  | +--------------+
+                     +----------------+
+
   - Typing notifications. Displayed within the correct thread/column.
 
  What you can do:

From 6c21f499e80dc1b72fefbcc1ebd0ca2c20118bb6 Mon Sep 17 00:00:00 2001
From: Kegan Dougal <kegan@matrix.org>
Date: Fri, 6 Feb 2015 13:08:12 +0000
Subject: [PATCH 13/13] Final syntax fixes

---
 drafts/state_resolution.rst | 1 +
 1 file changed, 1 insertion(+)

diff --git a/drafts/state_resolution.rst b/drafts/state_resolution.rst
index fec290dd..3c570b8e 100644
--- a/drafts/state_resolution.rst
+++ b/drafts/state_resolution.rst
@@ -27,6 +27,7 @@ all state events eventually.
 Algorithm requirements
 ----------------------
 We want the algorithm to have the following properties:
+
 - Since we aren't guaranteed what order we receive state events in, except that
   we see parents before children, the state resolution algorithm must not depend
   on the order and must always come to the same result.