diff --git a/README.md b/README.md index 5e48a22..d535f90 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -# DriveWorks Live - Integration Theme Example - Simple Embedded Form +# DriveWorks Live - Integration Theme Example - Embedded Form ### Release: 21.1 #### Minimum DriveWorks Version: 18.0 -A distributable template that renders a predefined project into an embedded section of the page - set via a config file. +A distributable template that renders a predefined Project into an embedded section of the page - set via a config file. --- @@ -12,7 +12,7 @@ Join our [online community](https://my.driveworks.co.uk) for discussion, resourc --- ### Overview: -- Dynamically injects the DriveWorks Live Client library script using the configured server url (see config.js). +- Dynamically injects the DriveWorks Live Client library script using the configured server url (see `config.js`). - Provides an example of loading from a static URL, if preferred. - Connects to the DriveWorks Live Integration Theme API. - Renders a DriveWorks Form embedded within placeholder page content. @@ -20,23 +20,23 @@ Join our [online community](https://my.driveworks.co.uk) for discussion, resourc - Optional loading state - to avoid an initial empty output. ### To use: -1. Clone this repository, or download as a .zip +1. Clone this repository, or download as a `.zip` file. -2. Enter your Integration Theme details into `config.js` +2. Enter your Integration Theme details into `config.js`. * `serverUrl` - The URL that hosts your Integration Theme, including any ports. - * `groupAlias` - The public alias created for the Group containing the project to render - as configured in DriveWorksConfigUser.xml. + * `groupAlias` - The public alias created for the Group containing the Project to render - as configured in `DriveWorksConfigUser.xml`. * This *must* be specified for each Group you wish to use. * This allows you to mask the true Group name publicly, if desired. * See [Integration Theme Settings](https://docs.driveworkspro.com/Topic/IntegrationThemeSettings) for additional guidance. * `projectName` - The name of the Project to render. - * `specificationPingInterval` - [optional] The interval at which to 'ping' the server automatically + * `specificationPingInterval` - [optional] The interval at which to 'ping' the server automatically. * This ensures a session is kept alive during inactivity, if desired. 3. Ensure that the Integration Theme server is running, using any of the available methods (e.g. Personal Web Edition, DriveWorks Live, IIS). * For more information, see [Selecting the Integration Theme](https://docs.driveworkspro.com/Topic/IntegrationThemeSelect). 4. Host the example locally or on a remote server. - * Ensure `` in DriveWorksConfigUser.xml permits requests from this location. + * Ensure `` in `DriveWorksConfigUser.xml` permits requests from this location. See [Integration Theme Settings](https://docs.driveworkspro.com/Topic/IntegrationThemeSettings) for additional guidance. ### Troubleshooting: @@ -46,7 +46,7 @@ If encountering any issues, please check the browser's console for error message If you are unable to use the dynamic library loading demonstrated in this example: 1. In `index.html`, uncomment "Option A" & replace "YOUR-DRIVEWORKS-LIVE-SERVER-URL.COM" with the URL of your own DriveWorks Live server that is serving `DriveWorksLiveIntegrationClient.min.js` - including any ports. * This should be the URL that hosts the Integration Theme, and serves it's landing page. - * To check that this URL is correct, attempt to load DriveWorksLiveIntegrationClient.min.js in a browser. It should return a minified code library. + * To check that this URL is correct, attempt to load `DriveWorksLiveIntegrationClient.min.js` in a browser. It should return a minified code library. 2. Remove the "Option B" `