Merge pull request #2 from box/update-docs

Move documentation into viewer folders
box · Mar 22, 2017 · e54cb0e · e54cb0e
2 parents 2d43af1 + e78b591
commit e54cb0e
Show file tree

Hide file tree

Showing 30 changed files with 302 additions and 293 deletions.
diff --git a/docs/viewers/csv.md b/docs/viewers/csv.md
diff --git a/docs/viewers/dash.md b/docs/viewers/dash.md
diff --git a/docs/viewers/markdown.md b/docs/viewers/markdown.md
diff --git a/docs/viewers/mp3.md b/docs/viewers/mp3.md
diff --git a/docs/viewers/mp4.md b/docs/viewers/mp4.md
diff --git a/docs/viewers/presentation.md b/docs/viewers/presentation.md
diff --git a/docs/viewers/text.md b/docs/viewers/text.md
diff --git a/docs/viewers/images/csv.png → images/csv.png b/docs/viewers/images/csv.png → images/csv.png
diff --git a/docs/viewers/images/dash.png → images/dash.png b/docs/viewers/images/dash.png → images/dash.png
diff --git a/docs/viewers/images/document.png → images/document.png b/docs/viewers/images/document.png → images/document.png
diff --git a/docs/viewers/images/image.png → images/image.png b/docs/viewers/images/image.png → images/image.png
diff --git a/docs/viewers/images/image360.png → images/image360.png b/docs/viewers/images/image360.png → images/image360.png
diff --git a/docs/viewers/images/markdown.png → images/markdown.png b/docs/viewers/images/markdown.png → images/markdown.png
diff --git a/docs/viewers/images/model3d.png → images/model3d.png b/docs/viewers/images/model3d.png → images/model3d.png
diff --git a/docs/viewers/images/mp3.png → images/mp3.png b/docs/viewers/images/mp3.png → images/mp3.png
diff --git a/docs/viewers/images/mp4.png → images/mp4.png b/docs/viewers/images/mp4.png → images/mp4.png
diff --git a/docs/viewers/images/office.png → images/office.png b/docs/viewers/images/office.png → images/office.png
diff --git a/docs/viewers/images/presentation.png → images/presentation.png b/docs/viewers/images/presentation.png → images/presentation.png
diff --git a/docs/viewers/images/text.png → images/text.png b/docs/viewers/images/text.png → images/text.png
diff --git a/docs/viewers/images/video360.png → images/video360.png b/docs/viewers/images/video360.png → images/video360.png
diff --git a/docs/viewers/image360.md → src/lib/viewers/box3d/image360/README.md b/docs/viewers/image360.md → src/lib/viewers/box3d/image360/README.md
@@ -4,7 +4,7 @@ The 360 image viewer renders a preview of an image stored as an equirectangular
 
 ## Screenshot
 
-![Screenshot of 360 image viewer](images/image360.png)
+![Screenshot of 360 image viewer](../../../../../images/image360.png)
 
 ## Behavior
 

diff --git a/docs/viewers/model3d.md → src/lib/viewers/box3d/model3d/README.md b/docs/viewers/model3d.md → src/lib/viewers/box3d/model3d/README.md
@@ -4,7 +4,7 @@ The Model3D viewer renders previews of 3d model files and allows you to enable d
 
 ## Screenshot
 
-![Screenshot of Model3D viewer](images/model3d.png)
+![Screenshot of Model3D viewer](../../../../../images/model3d.png)
 
 ## Behavior
 

diff --git a/docs/viewers/video360.md → src/lib/viewers/box3d/video360/README.md b/docs/viewers/video360.md → src/lib/viewers/box3d/video360/README.md
@@ -4,7 +4,7 @@ The 360 video viewer renders a preview of a video stored as an equirectangular p
 
 ## Screenshot
 
-<img src=./images/video360.png />
+![Screenshot of 360 video viewer](../../../../../images/video360.png)
 
 ## Behavior
 

diff --git a/docs/viewers/document.md → src/lib/viewers/doc/README.md b/docs/viewers/document.md → src/lib/viewers/doc/README.md
@@ -4,7 +4,7 @@ The document viewer renders previews for a variety of document types.
 
 ## Screenshot
 
-![Screenshot of document viewer](images/document.png)
+![Screenshot of document viewer](../../../../images/document.png)
 
 ## Behavior
 
@@ -45,3 +45,48 @@ The document viewer fires the following events
 | scrollend | The viewer stops scrolling | 1. {number} **scrollTop**: number of pixels scrolled from top of viewport 2. {number} **scrollLeft**: number of pixels scrolled from left of viewport |
 | printsuccess | An attempt to print triggered successfully ||
 | printsuccess | An attempt to print failed ||
+
+
+# Presentation Viewer
+
+The presentation viewer renders previews of powerpoint files.
+
+## Screenshot
+![Screenshot of presentation viewer](../../../../images/presentation.png)
+
+## Behavior
+
+The presentation viewer remembers which slide you were viewing upon closing the preview. The next time that file is opened, you will immediately be brought to that page. Scrolling the mouse up and down, or swiping up and down on mobile will transition between slides. Zooming in or out will increase or decrease the size of the slide respectively. If the zoom level causes the content to overflow, scrolling the mouse will allow you to scroll around the slide. To return to normal scrolling behavior, the user must zoom out until the overflow is removed.
+
+### Controls:
+* Zoom In
+* Zoom Out
+* Set Page: either with the up and down arrows, or by clicking the page number and entering text
+* Fullscreen: can be exited with the escape key
+
+## Supported File Extensions
+
+`ppt, pptx, odp`
+
+## Options
+
+| Option | Type | Description |
+| --- | --- | --- |
+| annotations | boolean | Optional. Whether annotations on content are shown. Defaults  to false |
+
+## Events
+The presentation viewer fires the following events
+
+| Event Name | Explanation | Event Data |
+| --- | --- | --- |
+| destroy | The preview is intentionally destroyed ||
+| load |  The preview loads | 1. {string} **error** (optional): error message 2. {object} **file**: current file 3. {object} **metrics**: information from the logger 4. {object} **viewer**: current viewer |
+| notification | A notification is displayed ||
+| navigate | The preview is shown for a given index | {object} file |
+| reload | The preview reloads ||
+| resize | The preview resizes | 1. {number} **height**: window height 2. {number} **width**: window width |
+| zoom | The preview zooms in or out | 1. {number} **zoom**: new zoom value 2. {boolean} **canZoomIn**: true if the viewer can zoom in more 3. {boolean} **canZoomOut**: true if the viewer can zoom out more |
+| pagerendered | A page renders | {number} page number of rendered page |
+| pagefocus | A page is visible | {number} page number of focused page |
+| scrollstart | The viewer starts to scroll | 1. {number} **scrollTop**: number of pixels scrolled from top of viewport 2. {number} **scrollLeft**: number of pixels scrolled from left of viewport |
+| scrollend | The viewer stops scrolling | 1. {number} **scrollTop**: number of pixels scrolled from top of viewport 2. {number} **scrollLeft**: number of pixels scrolled from left of viewport |
diff --git a/docs/viewers/iframe.md → src/lib/viewers/iframe/README.md b/docs/viewers/iframe.md → src/lib/viewers/iframe/README.md
diff --git a/docs/viewers/image.md → src/lib/viewers/image/README.md b/docs/viewers/image.md → src/lib/viewers/image/README.md
@@ -3,7 +3,7 @@
 The image viewer renders previews of image files.
 
 ## Screenshot
-![Screenshot of image viewer](images/image.png)
+![Screenshot of image viewer](../../../../images/image.png)
 
 ## Behavior
 Rotating the viewer will rotate the image 90 degrees clockwise. At the default zoom level, clicking on the image will zoom in once. When zoomed in, clicking on the document will return to the default zoom level. When zoomed out, clicking on the document will zoom in until the original zoom level is reached.