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

Merge pull request #1139 from turt2live/travis/m.tag

Browse source 
Tag ordering is defined as a number between 0 and 1, not strings
This commit is contained in:
Richard van der Hoff 2018-03-05 18:59:40 +00:00 • committed by GitHub
commit fd27be869b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 8 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

2
changelogs/client_server.rst
View file

@ -21,6 +21,8 @@ Unreleased changes
(`#1109 <https://github.com/matrix-org/matrix-doc/pull/1109>`_). (`#1109 <https://github.com/matrix-org/matrix-doc/pull/1109>`_).
- Fix the representation of ``m.presence`` events - Fix the representation of ``m.presence`` events
(`#1137 <https://github.com/matrix-org/matrix-doc/pull/1137>`_). (`#1137 <https://github.com/matrix-org/matrix-doc/pull/1137>`_).
- Clarify that ``m.tag`` ordering is done with numbers, not strings
(`#1139 <https://github.com/matrix-org/matrix-doc/pull/1139>`_).
- Changes to the API which will be backwards-compatible for clients: - Changes to the API which will be backwards-compatible for clients:

2
event-schemas/examples/m.tag
View file

@ -2,7 +2,7 @@
"type": "m.tag", "type": "m.tag",
"content": { "content": {
"tags": { "tags": {
"work": {"order": 1} "u.work": {"order": 1}
} }
} }
} }

11
specification/modules/tags.rst
View file

@ -35,12 +35,11 @@ the tags are for.
Each tag has an associated JSON object with information about the tag, e.g how Each tag has an associated JSON object with information about the tag, e.g how
to order the rooms with a given tag. to order the rooms with a given tag.
Ordering information is given under the ``order`` key as a string. The string Ordering information is given under teh ``order`` key as a number between 0 and
are compared lexicographically by unicode codepoint to determine which should 1. The numbers are compared such that 0 is displayed first. Therefore a room
displayed first. So a room with a tag with an ``order`` key of ``"apples"`` with an ``order`` of ``0.2`` would be displayed before a room with an ``order``
would appear before a room with a tag with an ``order`` key of ``"oranges"``. of ``0.7``. If a room has a tag without an ``order`` key then it should appear
If a room has a tag without an ``order`` key then it should appear after the after the rooms with that tag that have an ``order`` key.
rooms with that tag that have an ``order`` key.
The name of a tag MUST not exceed 255 bytes. The name of a tag MUST not exceed 255 bytes.