wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Shuffle and clarify identifier grammar

Browse source 
Specifically, make it clearer that event IDs are the weird exception in this section.
This commit is contained in:
Travis Ralston 2019-06-10 14:23:04 -06:00
parent 29340c6eb8
commit ad2eefdde9
1 changed files with 14 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

22
specification/appendices/identifier_grammar.rst
View file

@ -88,14 +88,13 @@ Common Identifier Format
~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~
The Matrix protocol uses a common format to assign unique identifiers to a The Matrix protocol uses a common format to assign unique identifiers to a
number of entities, including users, events and rooms. Each identifier typically number of entities, including users, events and rooms. Each identifier takes
takes the form:: the form::
&localpart:domain &string
where ``&`` represents a 'sigil' character; ``domain`` is the `server name`_ of where ``&`` represents a 'sigil' character; ``string`` is the string which makes
the homeserver which allocated the identifier, and ``localpart`` is an up the identifier.
identifier allocated by that homeserver.
The sigil characters are as follows: The sigil characters are as follows:
@ -105,9 +104,16 @@ The sigil characters are as follows:
* ``+``: Group ID * ``+``: Group ID
* ``#``: Room alias * ``#``: Room alias
User IDs, group IDs, room IDs, room aliases, and sometimes event IDs take the form::
&localpart:domain
where ``domain`` is the `server name`_ of the homeserver which allocated the
identifier, and ``localpart`` is an identifier allocated by that homeserver.
The precise grammar defining the allowable format of an identifier depends on The precise grammar defining the allowable format of an identifier depends on
the type of identifier. For example, event IDs can be represented without a the type of identifier. For example, event IDs can sometimes be represented with
``domain`` component under some conditions - see the `Event IDs <#room-ids-and-event-ids>`_ a ``domain`` component under some conditions - see the `Event IDs <#room-ids-and-event-ids>`_
section below for more information. section below for more information.
User Identifiers User Identifiers