Documentation

• FAQ
  • Frequently asked questions
• Tutorials
  • ...how to start
• Embedding into HTML
  • swfkrpano.js
• XML Reference
  • static XML code
• Actions / Scripting
  • dynamic XML code
• Quick Reference
  • ...quick code lookup
• krpanoJS
  • iPhone / iPad / HTML5 Viewer
• Plugin Interface
  • Actionscript3 Flash Plugins
  • Javascript HTML5 Plugins
• Javascript Interface
  • ...control krpano from external
• Notes
  • Local / Offline Usage
  • License Errors on IIS Servers

Tutorials

1. Quick Start Tutorial

   Link: Quick Start Tutorial

2. How to start working with the krpano xml files...
   1. Install the Standalone Flashplayer (also called Flashplayer Projector) first.
      With it you can open the Flash .swf files direct without the browser.
      
      You can get the Standalone Flashplayer here:
      http://www.adobe.com/support/flashplayer/downloads.html
      
      Here are direct links for Windows and Mac:
      
      • Windows Standalone Flashplayer
      • Mac Standalone Flashplayer
      
      After downloading copy the Flashplayer anywhere and start it once (with Administrator rights) to associate .swf files with it.
      
   2. Get a texteditor with XML syntax highlighting.
      Here some well known source code editors with syntax highlighting:
      Wikipedia - Some well known source code editors
      
   3. Copy the krpano.swf to a new folder.
      
   4. Create a empty krpano.xml file in that folder.
      
   5. Now you can start the viewer by double clicking the krpano.swf. But because the krpano.xml is empty you will only see a black screen. You can press the 'O' key in the viewer to open the krpano log and see the current krpano and Flashplayer version informations.
   6. To add a simple spherical pano open the krpano.xml in a texteditor add this code:

      <krpano>
        <image>
          <sphere url="pano.jpg" />
        </image>
      </krpano>
      

      Also copy a "pano.jpg" to the folder to have a pano to view (but note this is just a simple example, the best quality you will get with a cubical pano).
      Now double click the krpano.swf again and you should see the pano in the viewer.
      
      The <krpano> xml node is the root node of the whole xml document. Everything else must be placed inside it. The <image> xml node is used to define the pano image. The "pano.jpg" file must in the same folder.
   7. To place images like logos or buttons in the viewer there is the <plugin> xml node. Each <plugin> entry in the must be defined with an unique name for identification.
      The path to the image files to be included is set in the url attribute. And for setting the aligment and position the align/edge/x/y/ox/oy attributes can be used - see here an illustration about the plugin positioning.
      To get also some interactive action there are some events for the plugin, e.g. like the onclick event. The code there will be executed when the image will be clicked. In such event the krpano Actions can be used.
      
      For example try this xml code and run the viewer again:
      

      <krpano>
      
        <image>
          <sphere url="pano.jpg" />
        </image>
        
        <plugin name="logo"
                url="logo-image.png"
                align="rightbottom"
                x="10"
                y="10"
                onclick="openurl('http://homepage.com');"
                />
                  
      </krpano>
      

   8. The get informations about all available xml tags and all interactive actions have a look at the XML Reference and Actions Reference documentations.
3. How to use the MAKE VTOUR droplet?
   
   

   See here how to use the MAKE VTOUR droplet.