magical/bbj
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

aaaaaaaaa markdown and orgtables AAAAAA

Browse Source
This commit is contained in:
Blake DeMarcy 2017-03-01 17:08:29 -06:00
parent 90d566cfbd
commit a5ef5c5b9f
1 changed files with 6 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
PROTOCOL.md → docs/protocol.md
View File

@ -42,9 +42,8 @@ varies a lot between programming languages.
Some objects will provide further arguments beyond those 3. They will Some objects will provide further arguments beyond those 3. They will
always be at the end of the array. always be at the end of the array.
|-------------|----------------------------------------------------------|
| Name | Description | | Name | Description |
|-------------|----------------------------------------------------------| |-------------+----------------------------------------------------------|
| `quote` | This is a string that refers to a previous post number. | | `quote` | This is a string that refers to a previous post number. |
| | These are formatted like >>5, which means it is a | | | These are formatted like >>5, which means it is a |
| | reference to `post_id` 5. These are not processed in | | | reference to `post_id` 5. These are not processed in |
@ -52,22 +51,21 @@ always be at the end of the array.
| | addition to the indices at i[1] and i[2], a fourth value | | | addition to the indices at i[1] and i[2], a fourth value |
| | is provided, which is an integer of the `post_id` being | | | is provided, which is an integer of the `post_id` being |
| | quoted. Note that the string indices include the >>'s. | | | quoted. Note that the string indices include the >>'s. |
|-------------|----------------------------------------------------------| |-------------+----------------------------------------------------------|
| `linequote` | This is a line of text, denoted by a newline during | | `linequote` | This is a line of text, denoted by a newline during |
| | composure, representing text that is assumed to be | | | composure, representing text that is assumed to be |
| | a quote of someone else. The indices span from the > | | | a quote of someone else. The indices span from the > |
| | until (not including) the newline. | | | until (not including) the newline. |
|-------------|----------------------------------------------------------| |-------------+----------------------------------------------------------|
| `color` | This is a block of text, denoted by [[color: body]] | | `color` | This is a block of text, denoted by [[color: body]] |
| | during composure. The body may span across newlines. | | | during composure. The body may span across newlines. |
| | A fourth item is provided in the array: it is one of the | | | A fourth item is provided in the array: it is one of the |
| | following strings representing the color. | | | following strings representing the color. |
| | `red`, `green`, `yellow`, `blue`, `magenta`, or `cyan`. | | | `red`, `green`, `yellow`, `blue`, `magenta`, or `cyan`. |
|-------------|----------------------------------------------------------| |-------------+----------------------------------------------------------|
| `bold` | Like color, except that no additional attribute is | | `bold` | Like color, except that no additional attribute is |
| `italic` | provided. it is denoted as [[directive: body]] during | | `italic` | provided. it is denoted as [[directive: body]] during |
| `underline` | composure. | | `underline` | composure. |
|-------------|----------------------------------------------------------|
Threads & Replies Threads & Replies
@ -78,7 +76,6 @@ Threads are represented the same when using `thread_index` and
present with `thread_load`. The following attributes are present with `thread_load`. The following attributes are
available on the parent object: available on the parent object:
|---------------|------------------------------------------------------|
| Name | Description | | Name | Description |
|---------------|------------------------------------------------------| |---------------|------------------------------------------------------|
| `author` | The ID string of the author. | | `author` | The ID string of the author. |
@ -109,12 +106,10 @@ available on the parent object:
| `edited` | Boolean of whether the post has been edited. | | `edited` | Boolean of whether the post has been edited. |
|---------------|------------------------------------------------------| |---------------|------------------------------------------------------|
| `created` | Unix timestamp of when the post was originally made. | | `created` | Unix timestamp of when the post was originally made. |
|---------------|------------------------------------------------------|
The following attributes are available on each reply object in `replies`: The following attributes are available on each reply object in `replies`:
|------------|---------------------------------------------------------|
| Name | Description | | Name | Description |
|------------|---------------------------------------------------------| |------------|---------------------------------------------------------|
| `post_id` | An integer of the posts ID; unlike thread and user ids, | | `post_id` | An integer of the posts ID; unlike thread and user ids, |
@ -135,7 +130,6 @@ The following attributes are available on each reply object in `replies`:
| `edited` | A boolean of whether the post was edited. | | `edited` | A boolean of whether the post was edited. |
|------------|---------------------------------------------------------| |------------|---------------------------------------------------------|
| `created` | Unix timestamp of when the reply was originally posted. | | `created` | Unix timestamp of when the reply was originally posted. |
|------------|---------------------------------------------------------|
Errors Errors
@ -149,7 +143,6 @@ the problem. `description` is intended for human consumption; in your client
code, use the error codes to handle conditions. The `presentable` column code, use the error codes to handle conditions. The `presentable` column
indicates whether the `description` should be shown to users verbatim. indicates whether the `description` should be shown to users verbatim.
|------|--------------|---------------------------------------------------|
| Code | Presentable | Documentation | | Code | Presentable | Documentation |
|------|--------------|---------------------------------------------------| |------|--------------|---------------------------------------------------|
| 0 | Never, fix | Malformed json input. `description` is the error | | 0 | Never, fix | Malformed json input. `description` is the error |
@ -188,4 +181,3 @@ indicates whether the `description` should be shown to users verbatim.
| 10 | Always | User action requires `admin` privilege. | | 10 | Always | User action requires `admin` privilege. |
|------|--------------|---------------------------------------------------| |------|--------------|---------------------------------------------------|
| 11 | Always | Invalid formatting directives in text submission. | | 11 | Always | Invalid formatting directives in text submission. |
|------|--------------|---------------------------------------------------|