From e572cc662a15e3f642bb333f4b24b1450d407462 Mon Sep 17 00:00:00 2001 From: Kegan Dougal Date: Tue, 2 Jun 2015 16:27:52 +0100 Subject: [PATCH] Restructure the first few sections. Remove unecessary sections; put presnece/profile sections on the right level. Move Living Standard warning to the top of the Introduction section. --- scripts/README | 3 ++- specification/00_basis.rst | 22 +++++++++------------- specification/10_client_server_api.rst | 4 ++-- templating/matrix_templates/sections.py | 4 ++-- 4 files changed, 15 insertions(+), 18 deletions(-) diff --git a/scripts/README b/scripts/README index bf97843a..a65b8577 100644 --- a/scripts/README +++ b/scripts/README @@ -1,5 +1,6 @@ Requirements: - - docutils (for converting RST to HTML) + - docutils (for converting RST to HTML) + - Jinja2 (for templating) To generate the complete specification along with supporting documentation, run: python gendoc.py diff --git a/specification/00_basis.rst b/specification/00_basis.rst index 4d7ea4df..10709f1d 100644 --- a/specification/00_basis.rst +++ b/specification/00_basis.rst @@ -15,24 +15,11 @@ Changelog For a full changelog, see https://github.com/matrix-org/matrix-doc/blob/master/CHANGELOG.rst -Table of Contents -================= - .. contents:: Table of Contents .. sectnum:: Introduction ============ - -Matrix is a set of open APIs for open-federated Instant Messaging (IM), Voice -over IP (VoIP) and Internet of Things (IoT) communication, designed to create -and support a new global real-time communication ecosystem. The intention is to -provide an open decentralised pubsub layer for the internet for securely -persisting and publishing/subscribing JSON objects. - -This specification is the ongoing result of standardising the APIs used by the -various components of the Matrix ecosystem to communicate with one another. - .. WARNING:: The Matrix specification is still evolving: the APIs are not yet frozen and this document is in places a work in progress or stale. We have made every @@ -43,6 +30,15 @@ various components of the Matrix ecosystem to communicate with one another. goal is to mirror WHATWG's `Living Standard `_. +Matrix is a set of open APIs for open-federated Instant Messaging (IM), Voice +over IP (VoIP) and Internet of Things (IoT) communication, designed to create +and support a new global real-time communication ecosystem. The intention is to +provide an open decentralised pubsub layer for the internet for securely +persisting and publishing/subscribing JSON objects. + +This specification is the ongoing result of standardising the APIs used by the +various components of the Matrix ecosystem to communicate with one another. + The principles that Matrix attempts to follow are: - Pragmatic Web-friendly APIs (i.e. JSON over REST) diff --git a/specification/10_client_server_api.rst b/specification/10_client_server_api.rst index 501655cb..df1bb9a6 100644 --- a/specification/10_client_server_api.rst +++ b/specification/10_client_server_api.rst @@ -1178,14 +1178,14 @@ address The textual address of the 3pid, eg. the email address Presence -~~~~~~~~ +-------- .. TODO-spec - Define how users receive presence invites, and how they accept/decline them {{presence_http_api}} Profiles -~~~~~~~~ +-------- {{profile_http_api}} diff --git a/templating/matrix_templates/sections.py b/templating/matrix_templates/sections.py index af3aec94..7bc25095 100644 --- a/templating/matrix_templates/sections.py +++ b/templating/matrix_templates/sections.py @@ -75,7 +75,7 @@ class MatrixSections(Sections): return self._render_http_api_group( "profile", sortFnOrPathList=["displayname", "avatar_url"], - title_kind="+" + title_kind="~" ) def render_sync_http_api(self): @@ -87,7 +87,7 @@ class MatrixSections(Sections): return self._render_http_api_group( "presence", sortFnOrPathList=["status"], - title_kind="+" + title_kind="~" ) def render_room_events(self):