Changeset 2668381

Timestamp:

01/28/2022 04:17:40 PM (4 years ago)

Author:

driveworks

Message:

Release 1.0.1

File:

• driveworks-shortcode-form-embed/trunk/readme.txt (modified) (7 diffs)

driveworks-shortcode-form-embed/trunk/readme.txt

@@ -2 +2 @@
 Contributors: driveworks
 Tags: driveworks, driveworks live, embed, driveapp, project, shortcode, integration theme, integration
-Stable tag: 1.0.0
+Stable tag: 1.0.1
 Requires at least: 4.0
 Tested up to: 5.8
@@ -19 +19 @@
 > Note: this plugin *requires* an external [DriveWorks Live Integration Server](https://docs.driveworkspro.com/Topic/IntegrationThemeLive) to be configured and running, which allows connections from your WordPress domain.
 
-To embed a Form, simply provide the following:
-* `server_url` - The URL of your Integration Theme server. Used to load the client library, and create a client connection.
-* `group_alias` - The alias of the Group to connect to.
+**To embed a Form**, simply provide the following:
+
+* **server_url** - The URL of your Integration Theme server. Used to load the client library, and create a client connection.
+* **group_alias** - The alias of the Group to connect to.
 * Either: 
-  * `project_name` - The name of the Project to render
-  * `drive_app_alias` - The name of the DriveApp to render
+  * **project_name** - The name of the Project to render
+  * **drive_app_alias** - The name of the DriveApp to render
 
 Optionally provide:
-* `ping_interval` - The interval (in seconds) at which the server is automatically sent a request. Useful to keep a session alive without manual interaction. Disable by setting to `0`, or excluding this setting.
-* `height` - The height of the container that Form is rendered into, including the unit. Useful if the Form does not have a natural height. Examples: `800px`, `10em`, `75vh`.
 
-**Example**
+* **ping_interval** - The interval (in seconds) at which the server is automatically sent a request. Useful to keep a session alive without manual interaction. Disable by setting to `0`, or excluding this setting.
+* **height** - The height of the container that Form is rendered into, including the unit. Useful if the Form does not have a natural height. Examples: `800px`, `10em`, `75vh`.
+
+**Examples**
 
 Render a Project:
@@ -46 +48 @@
 A pre-written script using standard methods from the [DriveWorks Live Client SDK](https://webapi.driveworkslive.com/help/client/), running on your own server, performs a login and renders the configured Form.
 
-The script will not send any credentials during login, so *a default user must be specified* in DriveWorksConfigUser.xml.
+The script will not send any credentials during login, so **a default user must be specified** in **DriveWorksConfigUser.xml**.
 If a default user is not set server-side, the connection will not be authorized.
 
@@ -54 +56 @@
 Clear warnings will be shown if any errors are made in the config or during connection.
 
-For alternative examples on how to render a DriveWorks Form, see our public [Client SDK Examples](https://webapi.driveworkslive.com/home.html).
+For alternative examples on how to render a DriveWorks Form, see our public [Client SDK Examples](https://webapi.driveworkslive.com/home.html) and our [Official GitHub](https://github.com/driveworks).
 
 == Frequently Asked Questions ==
@@ -61 +63 @@
 
 Yes - this plugin is free. However, it requires an existing DriveWorks Live Integration Theme server to be setup and running - which it will then connect to.
-For configuration guidance, see: https://docs.driveworkspro.com/Topic/IntegrationThemeSelect
+For more information and configuration guidance, see: [](https://docs.driveworkspro.com/Topic/IntegrationThemeLive)
 
 = Can I use multiple embeds on one page? =
 
-Yes - however they will *all share the same client library script*. Only *1* version of the library can be loaded on the same page.
+Yes - however they will **all share the same client library script**.
+Only **1** version of the library can be loaded on the same page.
 The first server url found in the content will be used to load the client library script.
 
@@ -81 +84 @@
 
 To troubleshoot, ensure that:
+
 * The configuration in your shortcode is correct.
-* Your Integration Theme server is configured correctly in DriveWorksConfigUser.xml
+* Your Integration Theme server is configured correctly in **DriveWorksConfigUser.xml**
 * Your Integration Theme server is running, and allows connections from this site.
-* The Group Alias has a default username and password set in DriveWorksConfigUser.xml
+* The Group Alias has a default username and password set in **DriveWorksConfigUser.xml**
 
 For more setup instructions, see:
+
 * [Selecting the Integration Theme](https://docs.driveworkspro.com/Topic/IntegrationThemeSelect)
 * [Configuring the Integration Theme](https://docs.driveworkspro.com/Topic/IntegrationThemeSettings)
@@ -92 +97 @@
 == Screenshots ==
 
-1. Enter the shortcode
-2. Configure connection details and other options
-3. Save and view Form rendered in your content
+1. Enter the shortcode into text content.
+2. Enter connection details and other configuration options.
+3. Save and view the Form rendered in your content.
 
 == Changelog ==
 
-= 1.0 =
-* Initial release - with Project & DriveApp support.
+= 1.0.1 =
+
+* Fixed: Grammatical errors and markdown syntax
+
+= 1.0.0 =
+
+* Initial release - with Project & DriveApp support