Skip to content

Commit

Permalink
Added Demo
Browse files Browse the repository at this point in the history
Added better demo content for testing to documentation.
  • Loading branch information
qharouff committed Aug 18, 2020
1 parent 50d36a8 commit 4a6b8a0
Show file tree
Hide file tree
Showing 4 changed files with 31 additions and 0 deletions.
Binary file modified .DS_Store
Binary file not shown.
2 changes: 2 additions & 0 deletions .gitignore
@@ -0,0 +1,2 @@

.DS_Store
28 changes: 28 additions & 0 deletions docs/demo.md
@@ -0,0 +1,28 @@
<h1>Demo Content</h1>

The following content is provided as a known working configuration and sample for users just getting started.

***

**Example App Configuration** <br />
The following configuration will load a sample CSV playlist and images from the Exhibit GitHub repository. This configuration can be tested by adding it to your Exhibit Mobile Device App record under the **App Configuration** tab. <br />

```xml
<dict>
<key>edu.nebraska.ImageViewer.dataURL</key>
<string>https://raw.githubusercontent.com/NU-ITS/Exhibit/master/Demo/Playlist.csv</string>
</dict>
```

***

**Example CSV Playlist** <br />**Note: If using this as a template, [please download the CSV file from GitHub here](https://raw.githubusercontent.com/NU-ITS/Exhibit/master/Demo/Playlist.csv).** The following table shows the content within the App Configuration listed above.<br />

| Name | URL | Duration | UpdateInterval | StartOn | EndBy | Cache |
| --------- | ------------------------------------------------------------ | -------- | -------------- | ----------- | -------------- | ----- |
| Exhibit01 | https://github.com/NU-ITS/Exhibit/raw/master/Demo/Exhibit01.png | 0:00:10 | 1:00:00 | 1/1/18 0:00 | 12/31/30 23:59 | yes |
| Exhibit02 | https://github.com/NU-ITS/Exhibit/raw/master/Demo/Exhibit02.png | 0:00:10 | 1:00:00 | 1/1/18 0:00 | 12/31/30 23:59 | yes |
| Exhibit03 | https://github.com/NU-ITS/Exhibit/raw/master/Demo/Exhibit03.png | 0:00:10 | 1:00:00 | 1/1/18 0:00 | 12/31/30 23:59 | yes |
| Exhibit04 | https://github.com/NU-ITS/Exhibit/raw/master/Demo/Exhibit04.png | 0:00:10 | 1:00:00 | 1/1/18 0:00 | 12/31/30 23:59 | yes |

***
1 change: 1 addition & 0 deletions mkdocs.yml
Expand Up @@ -5,6 +5,7 @@ nav:
- 'Installation': 'installation.md'
- 'Managed App Config': 'app-config.md'
- 'Content Playlist': 'playlist.md'
- 'Demo Content': 'demo.md'
- About:
- 'Release Notes': 'release-notes.md'
- 'Known Issues': 'known-issues.md'
Expand Down

0 comments on commit 4a6b8a0

Please sign in to comment.