[[ Bug 15924 ]] Add docs for HTML5 URL syntax.

livecodemichael · livecodemichael · commit 4dcd9dd876a2 · 2017-08-10T14:55:07.000+01:00
diff --git a/docs/dictionary/command/delete-URL.lcdoc b/docs/dictionary/command/delete-URL.lcdoc
@@ -14,7 +14,7 @@ Associations: internet library
 
 Introduced: 1.1
 
-OS: mac, windows, linux, ios, android
+OS: mac, windows, linux, ios, android, html5
 
 Platforms: desktop, server, mobile
 
@@ -85,6 +85,14 @@ password to use the <delete URL> <command>.
 > <standalone application>. If included, the <Internet library> 
 > implementation will be used instead of the engine implementation.
 
+> *Cross-platform note:* The HTML5 engine only supports HTTP and HTTPs
+> protocols.
+
+> *Cross-platform note:* URLs fetched by the HTML5 engine from a domain
+> other than that of the hosting the page may be blocked by web browsers,
+> unless the server hosting the URL sets the "Access-Control-Origin" header
+> appropriately.
+
 References: libURLSetFTPStopTime (command), post (command),
 delete file (command), delete folder (command),
 function (control structure), result (function),
diff --git a/docs/dictionary/command/libURLDownloadToFile.lcdoc b/docs/dictionary/command/libURLDownloadToFile.lcdoc
@@ -12,7 +12,7 @@ Associations: internet library
 
 Introduced: 2.0
 
-OS: mac, windows, linux, ios, android
+OS: mac, windows, linux, ios, android, html5
 
 Platforms: desktop, server, mobile
 
diff --git a/docs/dictionary/command/libURLFollowHttpRedirects.lcdoc b/docs/dictionary/command/libURLFollowHttpRedirects.lcdoc
@@ -10,7 +10,7 @@ redirects and GET the page that it is redirected to.
 
 Introduced: 1.1.1
 
-OS: mac, windows, linux
+OS: mac, windows, linux,html5
 
 Platforms: desktop, server
 
@@ -33,6 +33,8 @@ Description:
 attempted to GET 301 and 302 redirects whatever the original request
 method, but didn't handle other responses.)
 
+> *Cross-platform note:* The HTML5 engine will always follow redirects.
+
 References: libURLDownloadToFile (command),
 libURLLastHTTPHeaders (function)
 
diff --git a/docs/dictionary/command/libURLSetCustomHTTPHeaders.lcdoc b/docs/dictionary/command/libURLSetCustomHTTPHeaders.lcdoc
@@ -11,7 +11,7 @@ Associations: internet library
 
 Introduced: 1.1.1
 
-OS: mac, windows, linux
+OS: mac, windows, linux, html5
 
 Platforms: desktop, server
 
diff --git a/docs/dictionary/command/libURLSetLogField.lcdoc b/docs/dictionary/command/libURLSetLogField.lcdoc
@@ -13,7 +13,7 @@ Associations: internet library
 
 Introduced: 1.1.1
 
-OS: mac, windows, linux
+OS: mac, windows, linux, html5
 
 Platforms: desktop, server
 
diff --git a/docs/dictionary/command/libURLSetStatusCallback.lcdoc b/docs/dictionary/command/libURLSetStatusCallback.lcdoc
@@ -12,7 +12,7 @@ Associations: internet library
 
 Introduced: 2.0
 
-OS: mac, windows, linux
+OS: mac, windows, linux, html5
 
 Platforms: desktop, server
 
diff --git a/docs/dictionary/command/libUrlSetDriver.lcdoc b/docs/dictionary/command/libUrlSetDriver.lcdoc
@@ -12,7 +12,7 @@ Associations: internet library
 
 Introduced: 8.1
 
-OS: mac, windows, linux, ios, android
+OS: mac, windows, linux, ios, android, html5
 
 Platforms: desktop, server, mobile
 
diff --git a/docs/dictionary/command/libUrlSetSSLVerification.lcdoc b/docs/dictionary/command/libUrlSetSSLVerification.lcdoc
@@ -44,6 +44,9 @@ connection is accepted.
 > <standalone application>. If included, the <Internet library> 
 > implementation will be used instead of the engine implementation.
 
+> *Cross-platform note:* The HTML5 engine will always verify server
+> credentials.
+
 References: main stack (glossary), handler (glossary),
 Standalone Application Settings (glossary), message (glossary),
 group (glossary), standalone application (glossary), keyword (glossary),
diff --git a/docs/dictionary/command/load.lcdoc b/docs/dictionary/command/load.lcdoc
@@ -93,19 +93,19 @@ remove it from the <cache>.
 > included, the <Internet library> implementation will be used instead of
 > the engine implementation.
 
-> *Note:* The current HTML5 support for 'load url' is experimental, and
-> will be replaced by a libUrl-like API in a subsequent DP ensuring it has
-> parity with other platforms when 'Internet Library' is used.
-
 > *Note:* When specifying URLs for iOS or Android, you must use the
 > appropriate form that conforms to [RFC
 > 1738](https://tools.ietf.org/html/rfc1738). Ensure that you
 > <URLEncode> any username and password fields appropriately for FTP
 > URLs.
 
-> *Note:* The HTML5 engine only supports HTTP and HTTPs protocols.
-> Also, only URLs from the domain hosting the web page running the HTML5
-> engine can be fetched.
+> *Cross-platform note:* The HTML5 engine only supports HTTP and HTTPs
+> protocols.
+
+> *Cross-platform note:* URLs fetched by the HTML5 engine from a domain
+> other than that of the hosting the page may be blocked by web browsers,
+> unless the server hosting the URL sets the "Access-Control-Origin" header
+> appropriately.
 
 References: unload (command), libURLftpUpload (command),
 libURLDownloadToFile (command), get (command), load (command),
diff --git a/docs/dictionary/command/post.lcdoc b/docs/dictionary/command/post.lcdoc
@@ -11,7 +11,7 @@ Associations: internet library
 
 Introduced: 1.0
 
-OS: mac, windows, linux, ios, android
+OS: mac, windows, linux, ios, android, html5
 
 Platforms: desktop, server, mobile
 
@@ -105,6 +105,14 @@ password "pass", use the following <statement> :
 > <URLEncode> any username and password fields appropriately for FTP
 > URLs.
 
+> *Cross-platform note:* The HTML5 engine only supports HTTP and HTTPs
+> protocols.
+
+> *Cross-platform note:* URLs fetched by the HTML5 engine from a domain
+> other than that of the hosting the page may be blocked by web browsers,
+> unless the server hosting the URL sets the "Access-Control-Origin" header
+> appropriately.
+
 References: post (command), write to socket (command),
 delete URL (command), read from socket (command), put (command),
 libURLSetExpect100 (command), libURLSetLogField (command),
diff --git a/docs/dictionary/command/put.lcdoc b/docs/dictionary/command/put.lcdoc
@@ -11,7 +11,7 @@ Places a <value> into a <container>.
 
 Introduced: 1.0
 
-OS: mac, windows, linux, ios, android
+OS: mac, windows, linux, ios, android, html5
 
 Platforms: desktop, server, mobile
 
@@ -153,6 +153,14 @@ create the <resource fork>.
 > <URLEncode> any username and password fields appropriately for FTP
 > URLs.
 
+> *Cross-platform note:* The HTML5 engine only supports HTTP and HTTPs
+> protocols.
+
+> *Cross-platform note:* URLs fetched by the HTML5 engine from a domain
+> other than that of the hosting the page may be blocked by web browsers,
+> unless the server hosting the URL sets the "Access-Control-Origin" header
+> appropriately.
+
 References: delete URL (command),
 put (command), local (command),
 post (command), libURLftpUpload (command),
diff --git a/docs/dictionary/command/unload.lcdoc b/docs/dictionary/command/unload.lcdoc
@@ -10,7 +10,7 @@ Removes a <file> that was placed in the local <cache> by the <load>
 
 Introduced: 1.0
 
-OS: mac, windows, linux
+OS: mac, windows, linux, html5
 
 Platforms: desktop, server
 
diff --git a/docs/dictionary/function/URLStatus.lcdoc b/docs/dictionary/function/URLStatus.lcdoc
@@ -15,7 +15,7 @@ Associations: internet library
 
 Introduced: 1.0
 
-OS: mac, windows, linux
+OS: mac, windows, linux, html5
 
 Platforms: desktop, server
 
diff --git a/docs/dictionary/function/cachedURLs.lcdoc b/docs/dictionary/function/cachedURLs.lcdoc
@@ -17,7 +17,7 @@ Associations: internet library
 
 Introduced: 1.0
 
-OS: mac, windows, linux
+OS: mac, windows, linux, html5
 
 Platforms: desktop, server
 
diff --git a/docs/dictionary/function/libURLErrorData.lcdoc b/docs/dictionary/function/libURLErrorData.lcdoc
@@ -12,7 +12,7 @@ Associations: internet library
 
 Introduced: 1.1.1
 
-OS: mac, windows, linux
+OS: mac, windows, linux, html5
 
 Platforms: desktop, server
 
diff --git a/docs/dictionary/function/libURLLastHTTPHeaders.lcdoc b/docs/dictionary/function/libURLLastHTTPHeaders.lcdoc
@@ -12,7 +12,7 @@ Associations: internet library
 
 Introduced: 1.1.1
 
-OS: mac, windows, linux
+OS: mac, windows, linux, html5
 
 Platforms: desktop, server
 
diff --git a/docs/dictionary/function/libURLLastRHHeaders.lcdoc b/docs/dictionary/function/libURLLastRHHeaders.lcdoc
@@ -12,7 +12,7 @@ Associations: internet library
 
 Introduced: 1.1.1
 
-OS: mac, windows, linux
+OS: mac, windows, linux, html5
 
 Platforms: desktop, server
 
diff --git a/docs/dictionary/function/libURLVersion.lcdoc b/docs/dictionary/function/libURLVersion.lcdoc
@@ -11,7 +11,7 @@ Associations: internet library
 
 Introduced: 1.1.1
 
-OS: mac, windows, linux
+OS: mac, windows, linux, html5
 
 Platforms: desktop, server
 
diff --git a/docs/dictionary/function/libUrlFormData.lcdoc b/docs/dictionary/function/libUrlFormData.lcdoc
@@ -12,7 +12,7 @@ Associations: internet library
 
 Introduced: 2.5
 
-OS: mac, windows, linux
+OS: mac, windows, linux, html5
 
 Platforms: desktop, server
 
diff --git a/docs/dictionary/function/libUrlMultipartFormAddPart.lcdoc b/docs/dictionary/function/libUrlMultipartFormAddPart.lcdoc
@@ -14,7 +14,7 @@ Associations: internet library
 
 Introduced: 2.5
 
-OS: mac, windows, linux
+OS: mac, windows, linux, html5
 
 Platforms: desktop, server
 
diff --git a/docs/dictionary/function/libUrlMultipartFormData.lcdoc b/docs/dictionary/function/libUrlMultipartFormData.lcdoc
@@ -15,7 +15,7 @@ Associations: internet library
 
 Introduced: 2.5
 
-OS: mac, windows, linux
+OS: mac, windows, linux, html5
 
 Platforms: desktop, server
 
diff --git a/docs/dictionary/property/HTTPProxy.lcdoc b/docs/dictionary/property/HTTPProxy.lcdoc
@@ -9,7 +9,7 @@ Specifies a <proxy server> to be used for <HTTP> requests.
 
 Introduced: 1.0
 
-OS: mac, windows, linux, ios, android
+OS: mac, windows, linux, ios, android, html5
 
 Platforms: desktop, server, mobile
 
@@ -37,6 +37,9 @@ the <host> <server> and no <proxy server|proxy> is used. This is the
 <default> setting. (On Windows systems, if a <proxy server> is set in
 the <registry>, that setting is used as the <default>.)
 
+> *Cross-platform note:* This setting will be ignored by the HTML5 engine,
+> with platform configured proxy being used instead.
+
 References: accept (command), post (command), property (glossary),
 host (glossary), proxy server (glossary), IP address (glossary),
 port (glossary), registry (glossary), server (glossary),
diff --git a/docs/dictionary/property/httpHeaders.lcdoc b/docs/dictionary/property/httpHeaders.lcdoc
@@ -10,7 +10,7 @@ to an <HTTP> <server>.
 
 Introduced: 1.0
 
-OS: mac, windows, linux, ios, android
+OS: mac, windows, linux, ios, android, html5
 
 Platforms: desktop, server, mobile
 
diff --git a/docs/dictionary/property/urlResponse.lcdoc b/docs/dictionary/property/urlResponse.lcdoc
@@ -10,7 +10,7 @@ operation.
 
 Introduced: 3.5
 
-OS: mac, windows, linux, ios, android
+OS: mac, windows, linux, ios, android, html5
 
 Platforms: desktop, server, mobile
 
diff --git a/docs/notes/bugfix-15924.md b/docs/notes/bugfix-15924.md
@@ -0,0 +1 @@
+# HTML5: unable to import URL
diff --git a/docs/notes/bugfix-20016.md b/docs/notes/bugfix-20016.md
@@ -0,0 +1 @@
+# DataGrids completely unresponsive in HTML 5 standalones
diff --git a/docs/notes/feature-emscripten_basic_networking.md b/docs/notes/feature-emscripten_basic_networking.md
@@ -1,45 +1,5 @@
-# HTML5 Basic Networking Support
+# HTML5 Networking Support (Updated 9.0.0-dp-9)
 
-Basic networking support has been added to the HTML5 engine by way of the **load** command. The HTML5 **load** command functions in the same way as the **load** command on mobile platforms, with a completion message being sent on download, containing the contents of the URL (or any error) and the **urlProgress** message being sent periodically during the request.
+Networking support has been updated in the HTML5 engine to support libURL like syntax for fetching HTTP and HTTPs URLs. In order to use this new functionality, make sure "Internet" is selected in the list of inclusions.
 
-**Note: The current HTML5 support for 'load url' is experimental, and will be replaced by a libUrl-like API in a subsequent DP ensuring it has parity with other platforms when 'Internet Library' is used.**
-
-**Note: Only HTTP and HTTPS protocols are supported and URLs can only be fetched from the domain hosting the web page running the HTML5 engine.**
-
-```
-command fetchURL pURL
-   load URL pURL with "loadComplete"
-end fetchURL
-
-on loadComplete pURL, pStatus, pData, pTotal
-   -- pURL - The URL being fetched.
-   --
-   -- pStatus - The status of the URL: One of:
-   --  * downloaded
-   --  * error
-   --
-   -- pData - This will be:
-   --  * the content of the URL, if pStatus is downloaded
-   --  * the error string, if pStatus is error
-   --
-   -- pTotal - The total size of the URL, in bytes.
-end loadComplete
-
-on urlProgress pURL, pStatus, pData, pTotal
-   -- pURL - The URL being fetched.
-   --
-   -- pStatus - The current status of the operation. One of:
-   --  * contacted
-   --  * requested
-   --  * loading
-   --  * downloaded
-   --  * error
-   --
-   -- pData - This will be:
-   --  * the number of bytes fetched, if pStatus is loading
-   --  * the error string, if pStatus is error
-   --  * empty in all other cases
-   --
-   -- pTotal - The total size of the URL, in bytes.
-end urlProgress
-```
+*Note:* URLs fetched by the HTML5 engine from a domain other than that of the hosting the page may be blocked by web browsers, unless the server hosting the URL sets the "Access-Control-Origin" header appropriately.
