Skip to content

Commit

Permalink
Update docs, restaple
Browse files Browse the repository at this point in the history
  • Loading branch information
Shinmera committed Aug 14, 2018
1 parent c0d2a4f commit 0c40d25
Show file tree
Hide file tree
Showing 4 changed files with 714 additions and 582 deletions.
1 change: 1 addition & 0 deletions .gitattributes
@@ -0,0 +1 @@
doc/ linguist-vendored
515 changes: 0 additions & 515 deletions about.html

This file was deleted.

557 changes: 557 additions & 0 deletions doc/index.html

Large diffs are not rendered by default.

223 changes: 156 additions & 67 deletions documentation.lisp
Expand Up @@ -218,7 +218,8 @@ This is according to §2.2.1 and §2.4.4.")
"Returns true if the given name is a valid name for users. "Returns true if the given name is a valid name for users.
That is to say, the name must be a string in [1,32] of length That is to say, the name must be a string in [1,32] of length
and each character must be in the allowed unicode regions. and each character must be in the allowed unicode regions. The
name must also not begin or end with a space.
See VALID-NAME-CHAR-P") See VALID-NAME-CHAR-P")


Expand All @@ -230,7 +231,7 @@ See USERNAME-P")
(function channelname-p (function channelname-p
"Returns true if the given name is a valid name for channels. "Returns true if the given name is a valid name for channels.
That is to say, the name must be a string in [1,32] of length.") See USERNAME-P")


(type channelname (type channelname
"Type that is satisfied for all channelname strings. "Type that is satisfied for all channelname strings.
Expand Down Expand Up @@ -421,12 +422,12 @@ This update must be the first thing sent by the client upon
connection establishment. connection establishment.
Possible responses: Possible responses:
CONNECT See CONNECT
BAD-NAME See BAD-NAME
INVALID-PASSWORD See INVALID-PASSWORD
USERNAME-TAKEN See USERNAME-TAKEN
NO-SUCH-PROFILE See NO-SUCH-PROFILE
INCOMPATIBLE-VERSION See INCOMPATIBLE-VERSION
See PASSWORD See PASSWORD
See VERSION See VERSION
Expand All @@ -441,19 +442,20 @@ See CONNECT")
"Update to represent a disconnection request. "Update to represent a disconnection request.
Possible responses: Possible responses:
DISCONNECT See DISCONNECT
USERNAME-MISMATCH See USERNAME-MISMATCH
See UPDATE") See UPDATE")


(type register (type register
"Update to represent a registration request. "Update to represent a registration request.
Possible responses: Possible responses:
REGISTER See REGISTRATION-REJECTED
BAD-NAME See REGISTER
USERNAME-MISMATCH See BAD-NAME
INSUFFICIENT-PERMISSIONS See USERNAME-MISMATCH
See INSUFFICIENT-PERMISSIONS
See UPDATE") See UPDATE")


Expand Down Expand Up @@ -494,25 +496,25 @@ See TEXT-UPDATE")
"Update to represent a channel join request. "Update to represent a channel join request.
Possible responses: Possible responses:
JOIN See JOIN
BAD-NAME See BAD-NAME
USERNAME-MISMATCH See USERNAME-MISMATCH
ALREADY-IN-CHANNEL See ALREADY-IN-CHANNEL
NO-SUCH-CHANNEL See NO-SUCH-CHANNEL
INSUFFICIENT-PERMISSIONS See INSUFFICIENT-PERMISSIONS
See CHANNEL-UDPATE") See CHANNEL-UDPATE")


(type leave (type leave
"Update to represent a channel leave request. "Update to represent a channel leave request.
Possible responses: Possible responses:
LEAVE See LEAVE
BAD-NAME See BAD-NAME
USERNAME-MISMATCH See USERNAME-MISMATCH
NOT-IN-CHANNEL See NOT-IN-CHANNEL
NO-SUCH-CHANNEL See NO-SUCH-CHANNEL
INSUFFICIENT-PERMISSIONS See INSUFFICIENT-PERMISSIONS
See CHANNEL-UDPATE") See CHANNEL-UDPATE")


Expand All @@ -524,26 +526,26 @@ is constructed. You can obtain the name of the anonymous
channel by reading it out of the JOIN response. channel by reading it out of the JOIN response.
Possible responses: Possible responses:
JOIN See JOIN
BAD-NAME See BAD-NAME
USERNAME-MISMATCH See USERNAME-MISMATCH
CHANNELNAME-TAKEN See CHANNELNAME-TAKEN
BAD-NAME See BAD-NAME
INSUFFICIENT-PERMISSIONS See INSUFFICIENT-PERMISSIONS
See CHANNEL-UPDATE") See CHANNEL-UPDATE")


(type kick (type kick
"Update to represent a user kick request. "Update to represent a user kick request.
Possible responses: Possible responses:
KICK See KICK
BAD-NAME See BAD-NAME
USERNAME-MISMATCH See USERNAME-MISMATCH
NOT-IN-CHANNEL See NOT-IN-CHANNEL
NO-SUCH-USER See NO-SUCH-USER
NO-SUCH-CHANNEL See NO-SUCH-CHANNEL
INSUFFICIENT-PERMISSIONS See INSUFFICIENT-PERMISSIONS
See TARGET-UPDATE See TARGET-UPDATE
See CHANNEL-UPDATE") See CHANNEL-UPDATE")
Expand All @@ -554,13 +556,13 @@ See CHANNEL-UPDATE")
The user will be automatically joined to the channel. The user will be automatically joined to the channel.
Possible responses: Possible responses:
JOIN See JOIN
BAD-NAME See BAD-NAME
USERNAME-MISMATCH See USERNAME-MISMATCH
ALREADY-IN-CHANNEL See ALREADY-IN-CHANNEL
NO-SUCH-USER See NO-SUCH-USER
NO-SUCH-CHANNEL See NO-SUCH-CHANNEL
INSUFFICIENT-PERMISSIONS See INSUFFICIENT-PERMISSIONS
See TARGET-UPDATE See TARGET-UPDATE
See CHANNEL-UPDATE") See CHANNEL-UPDATE")
Expand All @@ -571,11 +573,11 @@ See CHANNEL-UPDATE")
If PERMISSIONS is NIL, the permissions are not changed. If PERMISSIONS is NIL, the permissions are not changed.
Possible responses: Possible responses:
PERMISSIONS See PERMISSIONS
BAD-NAME See BAD-NAME
USERNAME-MISMATCH See USERNAME-MISMATCH
NO-SUCH-CHANNEL See NO-SUCH-CHANNEL
INSUFFICIENT-PERMISSIONS See INSUFFICIENT-PERMISSIONS
See PERMISSIONS See PERMISSIONS
See CHANNEL-UPDATE") See CHANNEL-UPDATE")
Expand All @@ -584,11 +586,11 @@ See CHANNEL-UPDATE")
"Update to represent a channel message request. "Update to represent a channel message request.
Possible responses: Possible responses:
MESSAGE See MESSAGE
BAD-NAME See BAD-NAME
USERNAME-MISMATCH See USERNAME-MISMATCH
NO-SUCH-CHANNEL See NO-SUCH-CHANNEL
INSUFFICIENT-PERMISSIONS See INSUFFICIENT-PERMISSIONS
See CHANNEL-UPDATE See CHANNEL-UPDATE
See TEXT-UPDATE") See TEXT-UPDATE")
Expand All @@ -610,9 +612,9 @@ See USERS")
"Update to represent a channels listing request. "Update to represent a channels listing request.
Possible responses: Possible responses:
CHANNELS See CHANNELS
BAD-NAME See BAD-NAME
USERNAME-MISMATCH See USERNAME-MISMATCH
See CHANNELS See CHANNELS
See UPDATE") See UPDATE")
Expand All @@ -621,10 +623,10 @@ See UPDATE")
"Update to represent a user information request. "Update to represent a user information request.
Possible responses: Possible responses:
USER-INFO See USER-INFO
BAD-NAME See BAD-NAME
USERNAME-MISMATCH See USERNAME-MISMATCH
NO-SUCH-USER See NO-SUCH-USER
See REGISTERED See REGISTERED
See CONNECTIONS See CONNECTIONS
Expand All @@ -635,6 +637,67 @@ See TARGET-UPDATE")
See USER-INFO") See USER-INFO")


(type backfill
"Update to represent a backfill request.
Possible responses:
See NOT-IN-CHANNEL
See CHANNEL-UPDATE")

(type data
"Update to represent a raw data message.
Possible responses:
See NOT-IN-CHANNEL
See BAD-CONTENT-TYPE
See DATA
See CONTENT-TYPE
See FILENAME
See PAYLOAD
See CHANNEL-UPDATE")

(function content-type
"Returns the content-type of the encoded data payload.
See DATA")

(function filename
"Returns the file name of the file sent by the data payload.
See DATA")

(function payload
"Returns a base64 encoded data payload.
See DATA
See EMOTE")

(type emotes
"Update to represent an emote listing request.
Possible responses:
See EMOTE
See UPDATE
See NAMES")

(type emote
"Update to represent an emote entity.
This should only be sent by the server.
See CONTENT-TYPE
See NAME
See PAYLOAD
See UPDATE")

(type edit
"Update to represent a change to an existing message.
See MESSAGE")

(type failure (type failure
"Superclass for all failure response updates. "Superclass for all failure response updates.
Expand All @@ -643,6 +706,11 @@ See TEXT-UDPATE")
(type malformed-update (type malformed-update
"Update in response to a malformed update. "Update in response to a malformed update.
See FAILURE")

(type update-too-long
"Update in response to an update that contained too many characters.
See FAILURE") See FAILURE")


(type connection-unstable (type connection-unstable
Expand All @@ -658,7 +726,8 @@ See FAILURE")
(type update-failure (type update-failure
"Update in response to an update request that failed. "Update in response to an update request that failed.
See UPDATE-ID") See UPDATE-ID
See FAILURE")


(function update-id (function update-id
"Accessor to the ID of the update that failed to be completed. "Accessor to the ID of the update that failed to be completed.
Expand Down Expand Up @@ -704,6 +773,11 @@ See UPDATE-FAILURE")
(type no-such-channel (type no-such-channel
"Update in response to a CHANNEL-UPDATE for a channel that does not exist. "Update in response to a CHANNEL-UPDATE for a channel that does not exist.
See UPDATE-FAILURE")

(type registration-rejected
"Update in response to a REGISTER request that the server rejected.
See UPDATE-FAILURE") See UPDATE-FAILURE")


(type already-in-channel (type already-in-channel
Expand All @@ -712,10 +786,14 @@ See UPDATE-FAILURE")
See UPDATE-FAILURE") See UPDATE-FAILURE")


(type not-in-channel (type not-in-channel
"Update in response to a LEAVE/KICK request for a user that is not in the specified channel.") "Update in response to a LEAVE/KICK request for a user that is not in the specified channel.
See UPDATE-FAILURE")


(type channelname-taken (type channelname-taken
"Update in response to a CREATE request for a channel that already exists.") "Update in response to a CREATE request for a channel that already exists.
See UPDATE-FAILURE")


(type bad-name (type bad-name
"Update in response to any named request with a name that is not valid. "Update in response to any named request with a name that is not valid.
Expand Down Expand Up @@ -745,7 +823,18 @@ See UPDATE-FAILURE")
When this update is sent, any number of future updates When this update is sent, any number of future updates
that are received may be dropped instead. that are received may be dropped instead.
See UPDATE-FAILURE")) See UPDATE-FAILURE")

(type bad-content-type
"Update in response to a DATA update with a content-type the server does not support.
See UPDATE-FAILURE
See ALLOWED-CONTENT-TYPES")

(function allowed-content-types
"Returns a list of allowed content-type identifiers that the server supports.
See BAD-CONTENT-TYPE"))


;; reader.lisp ;; reader.lisp
(docs:define-docs (docs:define-docs
Expand Down

0 comments on commit 0c40d25

Please sign in to comment.