This cheat sheet describes the links/URLs that can be used with hotspots created in PDFs using the Adobe suite such as InDesign or Acrobat. Some can also be used in HTML links/URLs. See the Oomph sample magazines for examples.
We recommend printing out this page and keeping it handy when creating Oomph content
Version | Function | Description | Example |
---|---|---|---|
2010 | Page link* | Page links are used to jump between any page in the publication. You can either link by section name (advised) or by section number (not advised), e.g. PContents-3. | P[SECTION NAME]-[PAGE NUMBER] i.e If your page is named Contents-1 then your hyperlink will be named PContents-1 If you would like to link to a section then you would name as follows: P[SECTION NUMBER]-[PAGE NUMBER] e.g. P240-4 |
2010 | Web link | Web links are used to open a full screen browser within the application which brings the user to the specified link. | e.g. www.oomphhq.com |
2010 | Email link | The built in compose email interface appears, allowing the user to send an email to the specified email address | e.g. info@oomphhq.com |
2010 | Video link (bundled)* | This plays the video from the section its in, in a full screen movie player. Link to V1.m4v in the current section | V[VIDEO NUMBER] e.g. V1 |
2010 | Video link (bundled)* | This plays the video from another section you reference, in a full screen movie player. Link to V1.m4v in the “Feature” section. You can use this link to link to a video from any section, not just the current one. See also In page Video | V[SECTION NAME] e.g. VFeature-1 |
2010 | Video link(internet) | Link to a streaming video hosted on the Internet. Note: This link must be to a video, i.e. must end with m4v, mov etc | V[URL] e.g. Vhttp://m.com/video.m4v |
2010 | Full screen slideshow* | Displays the contents of the folder S[Number] in a full page | S[FOLDER NUMBER] e.g S1 |
2010 | In-page slideshow | In page slideshows show a slideshow inside the hotspot box. Swipe the slides left or right. Slides will come from a folder in the current section.i.e. in a directory called “IPS1” in the section directory. | IPS[FOLDER NUMBER] e.g. IPS1 |
2010 | Vertical in page slideshow | As above, swipe the slides up or down. Slides from a a directory called “VIPS1” | VIPS[FOLDER NUMBER] e.g. VIPS1 |
2010 | In Page Video | Show video inside the hotspot box. Videos should be named IPV1.mp4 or IPV1.mov in your section directories. | IPV[VIDEO NUMBER] e.g. IPV1 |
2010 | Toggle layer* | Turns on/off all content layers except the bottom-most layer. | T |
2010 | Page swap | In a page swap PDF, swaps the current page with page 3 of the swap PDF. Page numbers are relative to the swap PDF, not the section. | R[PAGE NUMBER] e.g. R3 |
2010 | Page link with custom name for bookmarks | Link to the second page of the “Recipe of the Month” section, and use the name “Chicken Chaucer” as the page name in when its used as a bookmarks. | P[SECTION NAME]-[PAGE NUMBER],[BOOKMARK NAME] e.g. PCover Recipe-2,Chicken Chaucer |
2010 | Cardflip | Animated flip between two pages. Like turning a playing card over. If there is more than 2 pages, the superfluous pages will be ignored | Cardflip[FOLDER NUMBER] e.g. Cardflip1 |
2010 | Flipbook (360) | Flip through an image sequence, can be used for 360 views. Images named sequentially, i.e. 001.jpg … 324.jpg | Flipbook[FOLDER NUMBER] e.g. Flipbook1 |
May 2011 | Flipbook Vertical | As above but to control the hotspot you need to swipe your finger vertically. | FlipbookVertical[FOLDER NUMBER] e.g. FlipbookVertical1 |
May 2011 | Deprecated, as of 6th March 2013 due twitter api changes, see TwitterTimeline. | ||
May 2011 | AnimatedImage | Show a sequence of images at 10* frames per second. *10 is the default but you can specify different values. | AnimatedImage[FOLDER NUMBER] e.g AnimatedImage1 |
May 2011 | AudioPlayer | Plays an audio file when the user clicks the button, subsequently pauses if clicked while playing. Able to play remote files. The default style can be overridden by placing a style.css in the folder. | AudioPlayer[FOLDER NUMBER] e.g. AudioPlayer1 or streaming audio; AudioPlayer1,http://url/to/song.mp3 |
May 2011 | WebClip | Shows content specified with a XPath statement from a particular website. | WebClip[FOLDER NUMBER],[URL],[XPATH] e.g WebClip,enableScroll,<url>,<xpath> *enableScroll is optional |
July 2011 | Voice Control ON | This forces the Voice control feature on, does not give the user control over the feature and does not show any image on the screen. (Turning on debug will display it) | VoicatControl[COMMAND] e.g. VoiceControlON |
July 2011 | Voice Control OFF | This forces the Voice control feature off, it does not give the user control over the feature and does not show any image on the screen. (Turning on debug will display it) | VoicatControl[COMMAND] e.g. VoiceControlOFF |
July 2011 | Voice Control | This allows the user to choose whether they want voice control on or off. The image for the on and off buttons should be supplied in a folder (e.g. VoiceControl1). These images should be names on and off (png or jpg) | VoiceControl[FOLDER NUMBER] e.g. VoiceControl1 |
July 2011 | Google Maps | Maps can be placed on any page. Specified locations can be placed on the map using CSV files. Links to things such as websites, pages, other maps etc can also be added | Map[NUMBER],[LATITUDE],[LONGITUDE],[ZOOM],[TYPE] e.g. Map2,40.0,0.0,2.1,Hybrid |
July 2011 | Calendar Event | Allows you to add events with any time, date, re-occurrence, finish to a users calendar, e.g. a training schedule | CalendarEvent,title=,location=,start=,end=,recur=,finish= e.g CalendarEvent,title=Something,location=Syndey,start=31/10/2016 18:00,end=31/10/16 20:30,recur=3monthly,finish=31/10/2017 |
July 2011 | Notes | Allows a user to add a note for the page that this hotspot is specified on | e.g. Notes |
July 2011 | Object | Essentially the same as an In page slideshow for example but allows for Actions and Animations to be easily added to them | Object[FOLDER NUMBER] e.g Object1 |
July 2011 | Animations | Add animations to your pages or widgets easily by appending things like “MoveInFromLeft” to the file name, or using animations in combination with Objects and Actions | [PAGE NAME]-[ANIMATION NAME] e.g. P2-1-FadeIn.pdf |
July 2011 | Actions | Allows you to perform custom actions when a hotspot is tapped, like telling a cardflip to flip automatically | Action,[OBJECT],[PAGE=],[TRANSITION=],[ANIMATION] e.g. Action,Object3,Page=4,FadeIn |
September 2011 | PopUp | Provides you with a dialog like pop up box to display content. It can handle all Oomph content, but just one page e.g. S1-1.png, S1-2.pdf are supported but S2-1 etc are not supported | PopUp[NUMBER] e.g. PopUp2 |
Oomph 14 (2012) | Shared Assets (aka Layouts) | This allows you to share pages that are use in many sections but do not change in each section. Allows you to create templated content easily |
[NUMBER]-[Folder Name] | [SharedFolderName] e.g. 100-Contents | ContentsBackground |
Oomph 14 (2012) | Smarfit | Smartfit is a mechanism to allow object hotspots to dynamically resize and reflow to suit their contents. |
[HotspotName],Smartfit e.g. Object1,Smartfit |
Oomph 15 (2012) | Text Objects and CSS | Text Objects are text files that you can add as a Layer or within Objects. These text files are automatically converted to HTML, which you can then style with CSS |
Add a normal Object Hotpost to your page. Within the content, add a .txt file as the content. (Optional) Add a .css file to style that content. |
Oomph 16 (2012) | Publisher Sign In | This is a button in the Help page that allows a publisher/tester to sign into the application in order to enable QA Mode |
Sign in to the application via a button located in the Help tab |
Oomph 16 (2012) | URI Scheme | URI Schemes allow you to use a hotspot link, or a link in an email to open an app to a particular place, or issue in the Downloads screen |
(YOUR_URI_Scheme)://goto/purchase/[ISSUE] e.g. oomph-122344://goto/purchase/com.mogeneration.oomph.issue01 |
Oomph 17 (2012) | Content Localisation | With Content Localisations you can include any number of localised content that you wish. You just add the localised content along with your normal zipped content. |
Add the extra content to folders labeled for the intended language translation e.g. en-US or en-AU or fr and so on |
Oomph 17 (2012) | Share Widgets | Our share widgets now allow you to customise the dialog that is shared to Facebook, Twitter, Weibo and via Email |
You can do this either by the hotspot link, or additional files within your content (advanced use). A custom hotspot would resemble something like: ShareTwitter1,body=This is a twitter share widget |
Oomph 17 (2012) | Content Templating | This feature is used along with Share Widgets. It allows you to make templates for the custom sharing dialog. Gives the possibility of create once, use everywhere custom sharing dialog. |
In your custom Share Widget HTML files you would add any of the supported template variables e.g. Shared from the iPad edition of {{APP_NAME}} |
Oomph 18 (2012) | Geolocation Specific Content | Content can be customised based on a users location (currently limited to Australian states) |
Add additional content for each state you wish to supply custom content for. (TIP: Default content should also be supplied). The folder with the custom content would be called something like: AU-QLD which would denote; Australia, Queensland |
Oomph 19 (2012) | Native Flipbook Widget | Flip through an image sequence, can be used for 360 views. Images named sequentially, i.e. 001.jpg … 324.jpg |
This is an upgrade to the above Flipbook widget (see above). It is updated to be faster and more stable. It has also introduced some new features, like "pixels per frame", "momentum" and "vertical". Flipbook[FOLDER NUMBER] (plus any extra options) e.g. Flipbook1,ppf=7,vertical |
Oomph 19 (2012) | Native Animated Image | Show a sequence of images at 10* frames per second. *10 is the default but you can specify different values. |
This is an upgrade to the above Animated Image widget (see above). It is updated to be faster and more stable. It has also introduced some new features, like "repeat" and "frames per second". AnimatedImage[FOLDER NUMBER] (plus any extra options) e.g AnimatedImage1,repeat |
Oomph 19 (2012) | Wide IPS |
In page slideshows show a slideshow inside the hotspot box. Swipe the slides left or right. Slides will come from a folder in the current section.i.e. in a directory called “IPS1” in the section directory. |
Update to in page slideshows to display "wide" content - similar to how vertical in page slideshows function. For example, if you have a hotspot that is 100 pixels wide, but your content is 500 pixels wide, rather than scale the image, it will now scroll the image. IPS[FOLDER NUMBER] e.g. IPS1 |
Oomph 19 (2012) | Pre-filled Search |
Search a key word of phase across all downloaded bundles of an app. Requires search index to be created through publish. |
Search,[word or phrase] e.g. Search,Grandma's Brownies |
Oomph 19 (2012) | Timer Widget |
A timer that the user can choose to start or not, useful for cooking mode. |
Customisable timers can now be added to content. When a timer is present, tapping on the hotspot will display a timer with preset number of minutes. On completion the timer will display a customisable alert and sounds if specified. TIMER[FOLDER NUMBER] (plus optional extras) e.g. Timer1,3,TimerText=Three Minute Timer,TimerTextColour=#0000FF |
Oomph 20 (2012) | Bookmark Widget |
Hotspot that can be added to the content to make the bookmarking feature more obvious to the user. |
Adding this hotspot to the content allows user to bookmark the page that they are on directly from the content rather than having to tap to bring up the menu. Allowing the content creator to prompt the users to bookmark and engage with content more. Bookmark[FOLDER NUMBER] e.g. Bookmark1 |
Oomph 21 (2013) |
TwitterTimeline |
in-page scrollable twitter timeline |
The TWITTER_WIDGET_ID is generated by twitter when you create a widget here (https://twitter.com/settings/widgets) TwitterTimeline,id=[TWITTER_WIDGET_ID] |
Comments
0 comments
Article is closed for comments.