install.htm 5.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml" >
  3. <head>
  4. <title>YoxView Installation Instructions</title>
  5. <style type="text/css">
  6. body{ margin-bottom: 1em; font-family: Arial, Sans-Serif; }
  7. #main{ width: 800px; margin: 0 auto;}
  8. pre{
  9. font-family: Courier New;
  10. font-size: 10pt;
  11. background: #c7d2d8;
  12. background: rgba(102, 133, 150, 0.34);
  13. border: solid 1px #768ea5;
  14. padding: 10px 15px;
  15. margin-top: 0.5em;
  16. margin-bottom: 2em;
  17. color: Black;
  18. overflow: auto;
  19. -moz-border-radius: 10px;
  20. -moz-border-radius-topright: 0;
  21. -moz-border-radius-topleft: 0;
  22. -webkit-border-radius: 10px;
  23. -webkit-border-top-left-radius: 0;
  24. -webkit-border-top-right-radius: 0;
  25. }
  26. a{ color: #0084e0; text-decoration: none;}
  27. a:hover{ text-decoration: underline; }
  28. p#lastUpdate{ font-size: smaller; margin-top: 2em; color: #666; }
  29. </style>
  30. </head>
  31. <body>
  32. <div id="main">
  33. <h1>YoxView Installation Instructions</h1>
  34. <p>For full usage instruction, demos and information, please refer to the <a href="http://yoxigen.com/yoxview/usage.aspx">
  35. YoxView usage page</a>.</p>
  36. <a href="#thumbnails">
  37. 1. Prepare your thumbnails<br />
  38. </a><a href="#load">2. Load YoxView</a><br />
  39. <a href="#options">
  40. 3. Options<br />
  41. </a><a href="#plugins">
  42. 4. Plugins (Picasa/Flickr)</a><br /><br />
  43. <h2 id="installation">Installation</h2>
  44. <ol>
  45. <li>
  46. <h3>Create your thumbnails</h3>
  47. Your thumbnails should be placed inside a container and link to their respective full-size images, like this:
  48. <pre>&lt;div class="yoxview"&gt;
  49. &lt;a href="img/01.jpg"&gt;&lt;img src="img/thumbnails/01.jpg" alt="First" title="First image" /&gt;&lt;/a&gt;
  50. &lt;a href="img/02.jpg"&gt;&lt;img src="img/thumbnails/02.jpg" alt="Second" title="Second image" /&gt;&lt;/a&gt;
  51. &lt;/div&gt;
  52. </pre>
  53. <p>The viewer displays the TITLE attribute of the image tag as the image's title inside the viewer, so it's recommended to use it.</p>
  54. <p>Note - If you use YoxView's <a href="#plugins">plugins</a> to get your images from Flickr/Picasa, it creates the thumbnails for you, so you can bypass this step.</p>
  55. </li>
  56. <li>
  57. <h3>Include the YoxView script in your page</h3>
  58. Put the following line in the HEAD section of your page (just make sure that the
  59. SRC points to the correct folder):<br />
  60. <pre class="script">&lt;script type="text/javascript" src="yoxview/yoxview-init.js"&gt;&lt;/script&gt;</pre>
  61. </li>
  62. <li>
  63. <h3>Apply YoxView to &nbsp;the element that contains your thumbnails</h3>
  64. <ul>
  65. <li><h4>Simple use (use if you don't know jQuery or as a shortcut):</h4>
  66. First make sure that the element containing your thumbnails has the class "yoxview",
  67. like shown above (&lt;div <strong>class="yoxview"</strong>&gt;). Then,
  68. open the file yoxview-init.js and uncomment the last line:<br />
  69. <pre class="script">LoadScript(yoxviewPath + "yoxview-nojquery.js");</pre>
  70. </li>
  71. <li>
  72. <h4>Regular jQuery plugin use:</h4>
  73. (Don't forget to call it from within $(document).ready!)
  74. <pre>$("#thumbnails").yoxview([options]);</pre>
  75. </li>
  76. </ul>
  77. </li>
  78. </ol>
  79. <span class="demo"><strong>Demo</strong>: <a href="http://www.yoxigen.com/yoxview/demo/demo - basic usage.html">Basic installation and usage</a></span>
  80. <h2 id="options">3. Options</h2>
  81. You can specify options when calling YoxView, either from your script or, if you're using the yoxview-nojquery.js file, from there.
  82. <pre>$("#thumbnails").yoxview({
  83. backgroundColor: 'Blue',
  84. playDelay: 5000
  85. });</pre>
  86. <span class="demo"><strong>Demo</strong>: <a href="http://www.yoxigen.com/yoxview/demo/demo - customizing with options.html">Using options</a></span><br />
  87. For a full list of available options <a href="http://yoxigen.com/yoxview/usage.aspx#options">
  88. click here</a>.
  89. <h2 id="plugins">4. Plugins</h2>
  90. <span class="demo"><strong>Demo</strong>: <a href="http://www.yoxigen.com/yoxview/demo/demo - using plugins.html">Using the YoxView plugins</a></span><br />
  91. For complete information and usage instructions for YoxView plugins, <a href="http://yoxigen.com/yoxview/plugins.aspx">
  92. click here</a>.
  93. <p> YoxView is capable of displaying images from external sources, such as Picasa or Flickr. Images and information about them are retrieved using AJAX (or JSONP) and thumbnails are then created in the page.</p>
  94. <p>Images from outside sources can be retrieved using the <em>dataUrl</em> option,
  95. by copying a URL from one of the supported data sources.
  96. Here's an example of adding an album from picasa to your web page (the scripts can
  97. be either in the HEAD or BODY of your page):</p>
  98. <pre>&lt;script type="text/javascript" src="yoxview/yoxview-init.js"&gt;&lt;/script&gt;
  99. &lt;script type="text/javascript"&gt;
  100. $(document).ready(function(){
  101. $("#yoxview_picasa").yoxview({
  102. dataUrl: 'http://picasaweb.google.com/yoxigen/Trips'
  103. });
  104. });
  105. &lt;/script&gt;
  106. &lt;div id="yoxview_picasa"&gt;&lt;/div&gt;</pre>
  107. <a href="http://yoxigen.com/yoxview/plugins.aspx#urlsTable">
  108. Click here</a> for a full list of supported data URL's.
  109. <p id="lastUpdate">
  110. Last update to this file: May 20th, 2010
  111. </p>
  112. </div>
  113. </body>
  114. </html>