cadmium-im/cadmium-docs-legacy
1
0
Fork 0
mirror of https://github.com/cadmium-im/cadmium-docs-legacy.git synced 2024-11-22 02:12:21 +00:00
Code Issues Projects Releases Wiki Activity

Add new section "Message type identifiers" in Cadmium Extension Document Format

Browse Source
This commit is contained in:
ChronosX88 2019-12-15 20:02:57 +04:00
parent 45d05b572e
commit 6b6e1cd101
Signed by: ChronosXYZ
GPG Key ID: 085A69A82C8C511A
1 changed files with 4 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
protocol-spec/cadmium-extension-document-format.md
View File

@ -2,6 +2,9 @@
## Introduction ## Introduction
The introduction to a CE document should contain description of the extension and example of problems which this extension can solve. The introduction to a CE document should contain description of the extension and example of problems which this extension can solve.
## Message type identifiers
In this section, specify the identifiers of the new types of protocol messages (which are introduced by the extension)
## Glossary ## Glossary
If your CE document uses terms that may not be familiar to the reader, please define them in this section. If your CE document uses terms that may not be familiar to the reader, please define them in this section.
@ -50,15 +53,8 @@ Most CE documents end with a section thanking non-authors who have made signific
# Cadmium Extension Styleguide # Cadmium Extension Styleguide
CE document are written in English. It is not expected that you will be a fine prose writer, but try to write in a clear, easily-understood fashion. CE document are written in English. It is not expected that you will be a fine prose writer, but try to write in a clear, easily-understood fashion.
## Attributes
When talking about an attribute by name, refer to it in single quotes. Example: the 'to' attribute.
When talking about the value of an attribute, refer to it in double quotes. Example: the value of the 'subscription' attribute is "both".
Elements possess attributes and contain character data and/or child elements; do not confuse these terms.
## Code Examples ## Code Examples
To show the hierarchy of JSON Objects, indent two spaces for every level. To show the hierarchy of JSON objects, indent two spaces for every level.
If an element possesses a large number of attributes, include a line break before each attribute and indent them so that they are vertically aligned for readability. If an element possesses a large number of attributes, include a line break before each attribute and indent them so that they are vertically aligned for readability.