Description
The Document Asset displays documents in a scroll or book format.
Intuiface Composer supports:
- Adobe Portable Document Format (.pdf)
- Microsoft Office files (.doc, .docx, .ppt, .pptx)
- XPS Document format (.xps)
Cloud or locally-hosted documents referenced in real-time by an experience running in Player - using, for example, Headless CMS, Excel, Airtable, etc. - must be stored in PDF format. Only in Composer can the other supported file formats be added.
NOTES:
- Exclusive to Windows (both Composer and Player)
- To accelerate on-screen rendering, all documents are converted into bitmaps (specifically, into the png format). In Intuiface Composer, it occurs the first time the document is inserted into a Scene. In Intuiface Player, it occurs the first time an experience runs. All subsequent uses of that document in a given Composer project, and all future runs of that experience in Player, do not regenerate the bitmap.
- You can specify the dpi (dots per inch) resolution for these bitmaps using the DPI property found in the Appearance property category for the Document Asset. The higher the DPI, the higher the resolution (good) and the more RAM required to store the bitmap in memory (not so good). Intuiface defaults to 96 DPI. Increasing the DPI value should solve the issue if your PDF document seems blurry or pixelated when zoomed.
- Excel files are not considered documents but rather a data source to be written to and read from via an interface asset
Supported document formats
The .pdf format
- Adobe's Portable Document Format, .pdf, is natively supported by Intuiface.
- As a natively supported format, you can import and display .pdf files without requiring local installation of Adobe Acrobat.
- All embedded hyperlinks will be lost
- You can enter a web URL in the Document property of the Document Asset to display a PDF file hosted in the cloud. However, links within a web-hosted PDF are unavailable to interactivity, and, therefore, cannot be opened.
Microsoft Office formats
- Microsoft Office files - Word and PowerPoint - can be imported into Intuiface Composer as Document assets if Microsoft Office 2007 or later is installed on the same computer.
- The importation process converts these Office file formats into .pdf files using a virtual printer. All Microsoft Office-specific features of these formats are thus lost during the conversion.
- If you wish to precisely control the look and feel of each post-conversion file, including page layout, use an external .pdf printer from the originating software and import the resulting .pdf file into Composer.
The .xps format
- The XPS document format, .xps, can be imported by Intuiface Composer.
- If you wish to precisely control the look and feel of each post-conversion file, including page layout, use .pdf export from the originating software and import the resulting .pdf file into Composer.
Adding documents to your experience
To work with documents, you can either
- import a document from your hard drive by either dragging & dropping it from Windows Explorer or using the Import Content button in the Content Library; you can also add a blank document from the Assets panel and double-click it to import a document.
- reference, rather than import, a document by entering its file path or Web URL in the Document property of the Document Asset
Imported documents are automatically copied by Composer into your Intuiface project's file structure. As a result, there is no need to store a separate copy of each document on the computers hosting Player.
Referenced documents must have paths/URLs that are universally consistent from one device to the next to ensure successful deployment across multiple PCs.
What to do with unsupported document formats?
Other document formats should be converted into the .pdf format to import them into Composer or Player successfully.
Properties Triggers & Actions
Properties
Document Properties
-
Style defines the style of the manipulation for the document
- Book pages are turned by tapping or dragging the top or bottom outer corner of the document
- Horizontal scroll pages are scrolled horizontally
- Vertical scroll pages are scrolled vertically
Appearance
-
DPI: render quality for the document
- NOTE: a new set of images are generated each time the DPI value is changed. Changing the DPI value will generate a number of images directly proportional with the number of changes multiplied by the number of pages in your document.
- Show curtain shadows: display visual feedback when more pages are browsable
Read-only Properties
These properties are read-only and can only be accessed through the use of binding.
- Current page: the number of the page currently displayed
- Total number of pages: the total number of pages in the document
Triggers
See Triggers Overview to get details of common triggers shared by all assets
Document specific triggers
- Is moved to the first page: Raised when the first page has been reached.
- Is moved to the last page: Raised when the last page has been reached.
- Is moved to the next page: Raised when moved to the next page.
- Is moved to the previous page: Raised when moved to the previous page.
- Page is changed: Raised when the page has changed.
-
Reaches a page: Raised when the specified page number has been reached
- Page number: Defines the "Reaches page" number parameter
The screenshot below illustrates the set of triggers specific to the Document Asset (click to zoom)
Actions
See Actions Overview to get details of common actions shared by all assets
Document specific triggers
- First page: Go to the first page of the document.
-
Go to page: Go to a specific page in the document
- Page number: Defines the "go to page" action parameter.
- Last page: Go to the last page.
- Next page: Go to the next page.
- Previous page: Go to the previous page.
-
Change document: Replace current content with the new content located at a specified URI.
- NOTE: This action only works if the content is a PDF file or a PPTX file.
The screenshot below illustrates the set of actions specific to the Document Asset (click to zoom)
Comments
0 comments
Article is closed for comments.