Fossil SCM
Chat docs: minor typos and additions.
Commit
10085418fe8d4838dcfe1b1725f3e219b11b21d4908ac00057a1ac671a337e37
Parent
8363e7b8e6ddf9e…
1 file changed
+24
-13
+24
-13
| --- www/chat.md | ||
| +++ www/chat.md | ||
| @@ -24,11 +24,11 @@ | ||
| 24 | 24 | of the system. |
| 25 | 25 | |
| 26 | 26 | Fossil chat is designed for use by insiders - people with check-in |
| 27 | 27 | privileges or higher. It is not intended as a general-purpose gathering |
| 28 | 28 | place for random passers-by on the internet. |
| 29 | -Fossil chat is seeks to provide a communication venue for discussion | |
| 29 | +Fossil chat seeks to provide a communication venue for discussion | |
| 30 | 30 | that does *not* become part of the permanent record for the project. |
| 31 | 31 | For persist and durable discussion, use the [Forum](./forum.wiki). |
| 32 | 32 | Because the conversation is intended to be ephemeral, the chat messages |
| 33 | 33 | are local to a single repository. Chat content does not sync. |
| 34 | 34 | |
| @@ -66,11 +66,11 @@ | ||
| 66 | 66 | |
| 67 | 67 | * Any word that begins with "http://" or "https://" is assumed |
| 68 | 68 | to be a hyperlink and is tagged. |
| 69 | 69 | |
| 70 | 70 | * Text within `[...]` is parsed and it if is a valid hyperlink |
| 71 | - target (according to the way that [Fossil Wik](/wiki_rules) or | |
| 71 | + target (according to the way that [Fossil Wiki](/wiki_rules) or | |
| 72 | 72 | [Markdown](/md_rules) understand hyperlinks) then that text |
| 73 | 73 | is tagged. |
| 74 | 74 | |
| 75 | 75 | Apart from adding hyperlink anchor tags to bits of text that look |
| 76 | 76 | like hyperlinks, no changes are made to the input text. |
| @@ -88,11 +88,11 @@ | ||
| 88 | 88 | |
| 89 | 89 | This command will bring up a chat window in your default web-browser |
| 90 | 90 | (similar to the way the "[fossil ui](/help?cmd=ui)" does). The |
| 91 | 91 | chat will be for the remote repository, the repository whose URL shows |
| 92 | 92 | when you type the "[fossil remote](/help?cmd=remote)" command. In |
| 93 | -addition to bring up the chat window, this command will also | |
| 93 | +addition to bringing up the chat window, this command will also | |
| 94 | 94 | send a single "bel" character (U+0007) to standard error of the terminal |
| 95 | 95 | whenever new messages arrive in the chat window. On most systems, |
| 96 | 96 | the terminal windows will emit an "beep" whenever they receive the U+0007 |
| 97 | 97 | character. This works out-of-the-box for Mac and Windows, but on some |
| 98 | 98 | flavors of Linux, you might need to enable terminal beeps in your system |
| @@ -110,15 +110,15 @@ | ||
| 110 | 110 | |
| 111 | 111 | *You do not need to understand how Fossil chat works in order to use it. |
| 112 | 112 | But many developers prefer to know how their tools work. |
| 113 | 113 | This section is provided for the benefit of those curious developers.* |
| 114 | 114 | |
| 115 | -The [/chat](/help?cmd=/chat) webpage downloads a small amount of | |
| 116 | -HTML and a few KB of javascript to run the chat session. The | |
| 117 | -javascript uses XMLHttpRequest (XHR) to download chat content, | |
| 118 | -post new content, or delete historical messages. The following | |
| 119 | -web interfaces are used by the XHR: | |
| 115 | +The [/chat](/help?cmd=/chat) webpage downloads a small amount of HTML | |
| 116 | +and a small amount of javascript to run the chat session. The | |
| 117 | +javascript uses XMLHttpRequest (XHR) to download chat content, post | |
| 118 | +new content, or delete historical messages. The following web | |
| 119 | +interfaces are used by the XHR: | |
| 120 | 120 | |
| 121 | 121 | * **/chat-poll** → |
| 122 | 122 | Download chat content as JSON. |
| 123 | 123 | Chat messages are number sequentially. |
| 124 | 124 | The client tells the server the largest chat message it currently |
| @@ -145,10 +145,17 @@ | ||
| 145 | 145 | which are the usual mechanisms for setting up a Fossil server. |
| 146 | 146 | More advanced notification techniques such as |
| 147 | 147 | [Server-sent events](wikipedia:/wiki/Server-sent_events) and especially |
| 148 | 148 | [WebSockets](wikipedia:/wiki/WebSocket) might seem more appropriate for |
| 149 | 149 | a chat system, but those technologies are not compatible with CGI. |
| 150 | + | |
| 151 | +Downloading of posted files and images uses a separate, non-XHR interface: | |
| 152 | + | |
| 153 | + * **/chat-download** → | |
| 154 | + Fetches the file content associated with a post (one file per | |
| 155 | + post, maximum). In the UI, this is accessed via links to uploaded | |
| 156 | + files and via inlined image tags. | |
| 150 | 157 | |
| 151 | 158 | Chat messages are stored on the server-side in the CHAT table of |
| 152 | 159 | the repository. |
| 153 | 160 | |
| 154 | 161 | ~~~ |
| @@ -168,10 +175,14 @@ | ||
| 168 | 175 | schema. An administrator can "DELETE TABLE chat;" at any time, without |
| 169 | 176 | harm (apart from deleting all chat history, of course). The CHAT table |
| 170 | 177 | is dropped when running [fossil scrub --verily](/help?cmd=scrub). |
| 171 | 178 | |
| 172 | 179 | On the server-side, message text is stored exactly as entered by the |
| 173 | -users. The /chat-poll page queries the CHAT table and constructs | |
| 174 | -a JSON reply described in the [/chat-poll documentation](/help?cmd=/chat-poll). | |
| 175 | -The message text is translated into HTML prior to being converted into | |
| 176 | -JSON so that the text can be safely added to the display using | |
| 177 | -innerHTML. | |
| 180 | +users. The /chat-poll page queries the CHAT table and constructs a | |
| 181 | +JSON reply described in the [/chat-poll | |
| 182 | +documentation](/help?cmd=/chat-poll). The message text is translated | |
| 183 | +into HTML prior to being converted into JSON so that the text can be | |
| 184 | +safely added to the display using assignment to `innerHTML`. Though | |
| 185 | +`innerHTML` assignment is generally considered unsafe, it is only so | |
| 186 | +with untrusted content from untrusted sources. The chat content goes | |
| 187 | +through sanitation steps which eliminate any potential security | |
| 188 | +vulnerabilities of assigning that content to `innerHTML`. | |
| 178 | 189 |
| --- www/chat.md | |
| +++ www/chat.md | |
| @@ -24,11 +24,11 @@ | |
| 24 | of the system. |
| 25 | |
| 26 | Fossil chat is designed for use by insiders - people with check-in |
| 27 | privileges or higher. It is not intended as a general-purpose gathering |
| 28 | place for random passers-by on the internet. |
| 29 | Fossil chat is seeks to provide a communication venue for discussion |
| 30 | that does *not* become part of the permanent record for the project. |
| 31 | For persist and durable discussion, use the [Forum](./forum.wiki). |
| 32 | Because the conversation is intended to be ephemeral, the chat messages |
| 33 | are local to a single repository. Chat content does not sync. |
| 34 | |
| @@ -66,11 +66,11 @@ | |
| 66 | |
| 67 | * Any word that begins with "http://" or "https://" is assumed |
| 68 | to be a hyperlink and is tagged. |
| 69 | |
| 70 | * Text within `[...]` is parsed and it if is a valid hyperlink |
| 71 | target (according to the way that [Fossil Wik](/wiki_rules) or |
| 72 | [Markdown](/md_rules) understand hyperlinks) then that text |
| 73 | is tagged. |
| 74 | |
| 75 | Apart from adding hyperlink anchor tags to bits of text that look |
| 76 | like hyperlinks, no changes are made to the input text. |
| @@ -88,11 +88,11 @@ | |
| 88 | |
| 89 | This command will bring up a chat window in your default web-browser |
| 90 | (similar to the way the "[fossil ui](/help?cmd=ui)" does). The |
| 91 | chat will be for the remote repository, the repository whose URL shows |
| 92 | when you type the "[fossil remote](/help?cmd=remote)" command. In |
| 93 | addition to bring up the chat window, this command will also |
| 94 | send a single "bel" character (U+0007) to standard error of the terminal |
| 95 | whenever new messages arrive in the chat window. On most systems, |
| 96 | the terminal windows will emit an "beep" whenever they receive the U+0007 |
| 97 | character. This works out-of-the-box for Mac and Windows, but on some |
| 98 | flavors of Linux, you might need to enable terminal beeps in your system |
| @@ -110,15 +110,15 @@ | |
| 110 | |
| 111 | *You do not need to understand how Fossil chat works in order to use it. |
| 112 | But many developers prefer to know how their tools work. |
| 113 | This section is provided for the benefit of those curious developers.* |
| 114 | |
| 115 | The [/chat](/help?cmd=/chat) webpage downloads a small amount of |
| 116 | HTML and a few KB of javascript to run the chat session. The |
| 117 | javascript uses XMLHttpRequest (XHR) to download chat content, |
| 118 | post new content, or delete historical messages. The following |
| 119 | web interfaces are used by the XHR: |
| 120 | |
| 121 | * **/chat-poll** → |
| 122 | Download chat content as JSON. |
| 123 | Chat messages are number sequentially. |
| 124 | The client tells the server the largest chat message it currently |
| @@ -145,10 +145,17 @@ | |
| 145 | which are the usual mechanisms for setting up a Fossil server. |
| 146 | More advanced notification techniques such as |
| 147 | [Server-sent events](wikipedia:/wiki/Server-sent_events) and especially |
| 148 | [WebSockets](wikipedia:/wiki/WebSocket) might seem more appropriate for |
| 149 | a chat system, but those technologies are not compatible with CGI. |
| 150 | |
| 151 | Chat messages are stored on the server-side in the CHAT table of |
| 152 | the repository. |
| 153 | |
| 154 | ~~~ |
| @@ -168,10 +175,14 @@ | |
| 168 | schema. An administrator can "DELETE TABLE chat;" at any time, without |
| 169 | harm (apart from deleting all chat history, of course). The CHAT table |
| 170 | is dropped when running [fossil scrub --verily](/help?cmd=scrub). |
| 171 | |
| 172 | On the server-side, message text is stored exactly as entered by the |
| 173 | users. The /chat-poll page queries the CHAT table and constructs |
| 174 | a JSON reply described in the [/chat-poll documentation](/help?cmd=/chat-poll). |
| 175 | The message text is translated into HTML prior to being converted into |
| 176 | JSON so that the text can be safely added to the display using |
| 177 | innerHTML. |
| 178 |
| --- www/chat.md | |
| +++ www/chat.md | |
| @@ -24,11 +24,11 @@ | |
| 24 | of the system. |
| 25 | |
| 26 | Fossil chat is designed for use by insiders - people with check-in |
| 27 | privileges or higher. It is not intended as a general-purpose gathering |
| 28 | place for random passers-by on the internet. |
| 29 | Fossil chat seeks to provide a communication venue for discussion |
| 30 | that does *not* become part of the permanent record for the project. |
| 31 | For persist and durable discussion, use the [Forum](./forum.wiki). |
| 32 | Because the conversation is intended to be ephemeral, the chat messages |
| 33 | are local to a single repository. Chat content does not sync. |
| 34 | |
| @@ -66,11 +66,11 @@ | |
| 66 | |
| 67 | * Any word that begins with "http://" or "https://" is assumed |
| 68 | to be a hyperlink and is tagged. |
| 69 | |
| 70 | * Text within `[...]` is parsed and it if is a valid hyperlink |
| 71 | target (according to the way that [Fossil Wiki](/wiki_rules) or |
| 72 | [Markdown](/md_rules) understand hyperlinks) then that text |
| 73 | is tagged. |
| 74 | |
| 75 | Apart from adding hyperlink anchor tags to bits of text that look |
| 76 | like hyperlinks, no changes are made to the input text. |
| @@ -88,11 +88,11 @@ | |
| 88 | |
| 89 | This command will bring up a chat window in your default web-browser |
| 90 | (similar to the way the "[fossil ui](/help?cmd=ui)" does). The |
| 91 | chat will be for the remote repository, the repository whose URL shows |
| 92 | when you type the "[fossil remote](/help?cmd=remote)" command. In |
| 93 | addition to bringing up the chat window, this command will also |
| 94 | send a single "bel" character (U+0007) to standard error of the terminal |
| 95 | whenever new messages arrive in the chat window. On most systems, |
| 96 | the terminal windows will emit an "beep" whenever they receive the U+0007 |
| 97 | character. This works out-of-the-box for Mac and Windows, but on some |
| 98 | flavors of Linux, you might need to enable terminal beeps in your system |
| @@ -110,15 +110,15 @@ | |
| 110 | |
| 111 | *You do not need to understand how Fossil chat works in order to use it. |
| 112 | But many developers prefer to know how their tools work. |
| 113 | This section is provided for the benefit of those curious developers.* |
| 114 | |
| 115 | The [/chat](/help?cmd=/chat) webpage downloads a small amount of HTML |
| 116 | and a small amount of javascript to run the chat session. The |
| 117 | javascript uses XMLHttpRequest (XHR) to download chat content, post |
| 118 | new content, or delete historical messages. The following web |
| 119 | interfaces are used by the XHR: |
| 120 | |
| 121 | * **/chat-poll** → |
| 122 | Download chat content as JSON. |
| 123 | Chat messages are number sequentially. |
| 124 | The client tells the server the largest chat message it currently |
| @@ -145,10 +145,17 @@ | |
| 145 | which are the usual mechanisms for setting up a Fossil server. |
| 146 | More advanced notification techniques such as |
| 147 | [Server-sent events](wikipedia:/wiki/Server-sent_events) and especially |
| 148 | [WebSockets](wikipedia:/wiki/WebSocket) might seem more appropriate for |
| 149 | a chat system, but those technologies are not compatible with CGI. |
| 150 | |
| 151 | Downloading of posted files and images uses a separate, non-XHR interface: |
| 152 | |
| 153 | * **/chat-download** → |
| 154 | Fetches the file content associated with a post (one file per |
| 155 | post, maximum). In the UI, this is accessed via links to uploaded |
| 156 | files and via inlined image tags. |
| 157 | |
| 158 | Chat messages are stored on the server-side in the CHAT table of |
| 159 | the repository. |
| 160 | |
| 161 | ~~~ |
| @@ -168,10 +175,14 @@ | |
| 175 | schema. An administrator can "DELETE TABLE chat;" at any time, without |
| 176 | harm (apart from deleting all chat history, of course). The CHAT table |
| 177 | is dropped when running [fossil scrub --verily](/help?cmd=scrub). |
| 178 | |
| 179 | On the server-side, message text is stored exactly as entered by the |
| 180 | users. The /chat-poll page queries the CHAT table and constructs a |
| 181 | JSON reply described in the [/chat-poll |
| 182 | documentation](/help?cmd=/chat-poll). The message text is translated |
| 183 | into HTML prior to being converted into JSON so that the text can be |
| 184 | safely added to the display using assignment to `innerHTML`. Though |
| 185 | `innerHTML` assignment is generally considered unsafe, it is only so |
| 186 | with untrusted content from untrusted sources. The chat content goes |
| 187 | through sanitation steps which eliminate any potential security |
| 188 | vulnerabilities of assigning that content to `innerHTML`. |
| 189 |