Mirrors
/
synapse
mirror of https://github.com/element-hq/synapse.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

howto: Link jsfiddles correctly. Hide ugly TODOs.

This commit is contained in:
Kegan Dougal 2014-09-03 09:14:16 +01:00
parent 84430a4a8a
commit 8c793e0704
1 changed files with 22 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
docs/client-server/howto.rst
View File

@ -1,7 +1,8 @@
TODO(kegan): Room config (specifically: message history, .. TODO kegan
public rooms). /register seems super simplistic compared to /login, maybe it Room config (specifically: message history,
would be better if /register used the same technique as /login? /register should public rooms). /register seems super simplistic compared to /login, maybe it
be "user" not "user_id". would be better if /register used the same technique as /login? /register should
be "user" not "user_id".
How to use the client-server API How to use the client-server API
@ -21,7 +22,9 @@ Accounts
Before you can send and receive messages, you must **register** for an account. Before you can send and receive messages, you must **register** for an account.
If you already have an account, you must **login** into it. If you already have an account, you must **login** into it.
**Try out the fiddle: http://jsfiddle.net/4q2jyxng/** `Try out the fiddle`__
.. __: http://jsfiddle.net/4q2jyxng/
Registration Registration
------------ ------------
@ -82,7 +85,9 @@ Communicating
In order to communicate with another user, you must **create a room** with that In order to communicate with another user, you must **create a room** with that
user and **send a message** to that room. user and **send a message** to that room.
**Try out the fiddle: http://jsfiddle.net/zL3zto9g/** `Try out the fiddle`__
.. __: http://jsfiddle.net/zL3zto9g/
Creating a room Creating a room
--------------- ---------------
@ -100,7 +105,8 @@ The "room alias" is a human-readable string which can be shared with other users
so they can join a room, rather than the room ID which is a randomly generated so they can join a room, rather than the room ID which is a randomly generated
string. You can have multiple room aliases per room. string. You can have multiple room aliases per room.
TODO(kegan): How to add/remove aliases from an existing room. .. TODO(kegan)
How to add/remove aliases from an existing room.
Sending messages Sending messages
@ -129,7 +135,9 @@ these rules may specify if you require an **invitation** from someone already in
the room in order to **join the room**. In addition, you may also be able to the room in order to **join the room**. In addition, you may also be able to
join a room **via a room alias** if one was set up. join a room **via a room alias** if one was set up.
**Try out the fiddle: http://jsfiddle.net/7fhotf1b/** `Try out the fiddle`__
.. __: http://jsfiddle.net/7fhotf1b/
Inviting a user to a room Inviting a user to a room
------------------------- -------------------------
@ -173,7 +181,9 @@ An event is some interesting piece of data that a client may be interested in.
It can be a message in a room, a room invite, etc. There are many different ways It can be a message in a room, a room invite, etc. There are many different ways
of getting events, depending on what the client already knows. of getting events, depending on what the client already knows.
**Try out the fiddle: http://jsfiddle.net/vw11mg37/** `Try out the fiddle`__
.. __: http://jsfiddle.net/vw11mg37/
Getting all state Getting all state
----------------- -----------------
@ -621,4 +631,6 @@ creating and joining rooms, sending messages, getting member lists and getting
historical messages for a room. This covers most functionality of a messaging historical messages for a room. This covers most functionality of a messaging
application. application.
**Try out the fiddle: http://jsfiddle.net/uztL3yme/** `Try out the fiddle`__
.. __: http://jsfiddle.net/uztL3yme/