Ei kuvausta

default.html 9.4KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
  6. <meta name="viewport" content="width=device-width, initial-scale=1">
  7. <meta name="description" content="Create .zip files using JavaScript. Provides a simple API to place any content generated by JavaScript into a .zip file for your users." />
  8. <title>{{page.title}}</title>
  9. <!--
  10. Any version of jQuery will do (it's just to write some examples), this one
  11. happens to be available in our tests.
  12. -->
  13. <script type="text/javascript" src="{{site.baseurl}}/test/jquery-1.8.3.min.js"></script>
  14. <!-- Latest compiled and minified CSS -->
  15. <link rel="stylesheet" href="//netdna.bootstrapcdn.com/bootstrap/3.1.1/css/bootstrap.min.css">
  16. <!-- Optional theme -->
  17. <link rel="stylesheet" href="//netdna.bootstrapcdn.com/bootstrap/3.1.1/css/bootstrap-theme.min.css">
  18. <!-- Latest compiled and minified JavaScript -->
  19. <script src="//netdna.bootstrapcdn.com/bootstrap/3.1.1/js/bootstrap.min.js"></script>
  20. <link rel="stylesheet" href="{{site.baseurl}}/documentation/css/pygments.css">
  21. <link rel="stylesheet" href="{{site.baseurl}}/documentation/css/main.css">
  22. <script type="text/javascript" src="{{site.baseurl}}/dist/jszip.js"></script>
  23. <script type="text/javascript" src="//stuk.github.io/jszip-utils/dist/jszip-utils.js"></script>
  24. <!--
  25. Mandatory in IE 6, 7, 8 and 9.
  26. -->
  27. <!--[if IE]>
  28. <script type="text/javascript" src="//stuk.github.io/jszip-utils/dist/jszip-utils-ie.js"></script>
  29. <![endif]-->
  30. <script type="text/javascript" src="{{site.baseurl}}/vendor/FileSaver.js"></script>
  31. </head>
  32. <body>
  33. <div class="container">
  34. <div class="navbar navbar-default" role="navigation">
  35. <div class="container-fluid">
  36. <div class="navbar-header">
  37. <a class="navbar-brand" href="{{site.baseurl}}/"><strong>JS</strong>Zip</a>
  38. </div>
  39. <ul class="nav navbar-nav">
  40. <li {% if page.section == "api" %}class="active"{% endif %}>
  41. <a href="{{site.baseurl}}/documentation/api_jszip.html">API</a>
  42. </li>
  43. <li {% if page.section == "example" %}class="active"{% endif %}>
  44. <a href="{{site.baseurl}}/documentation/examples.html">How to / examples</a>
  45. </li>
  46. <li {% if page.section == "limitations" %}class="active"{% endif %}>
  47. <a href="{{site.baseurl}}/documentation/limitations.html">Performances / limitations</a>
  48. </li>
  49. </ul>
  50. <ul class="nav navbar-nav navbar-right">
  51. <li>
  52. <a href="https://github.com/Stuk/jszip">JSZip on Github</a>
  53. </li>
  54. </ul>
  55. </div>
  56. </div>
  57. {% if page.section and page.fullpage != true %}
  58. <div class="row">
  59. <nav class="col-md-3">
  60. {% case page.section %}
  61. {% when "main" %}
  62. <h4>JSZip users :</h4>
  63. <ul class="nav">
  64. <li><a href="{{site.baseurl}}/">Installation</a></li>
  65. <li><a href="{{site.baseurl}}/documentation/faq.html">FAQ</a></li>
  66. <li><a href="{{site.baseurl}}/CHANGES.html">Changelog</a></li>
  67. <li><a href="{{site.baseurl}}/documentation/upgrade_guide.html">Upgrade guide</a></li>
  68. <li><a href="https://github.com/Stuk/jszip/issues">Bug tracker</a></li>
  69. </ul>
  70. <h4>JSZip developers :</h4>
  71. <ul class="nav">
  72. <li><a href="{{site.baseurl}}/documentation/contributing.html">How to contribute</a></li>
  73. <li><a href="https://github.com/Stuk/jszip/graphs/contributors">Contributors</a></li>
  74. </ul>
  75. {% when "api" %}
  76. <ul class="nav">
  77. <li><a href="{{site.baseurl}}/documentation/api_jszip.html">JSZip</a>
  78. <ul>
  79. <li><a href="{{site.baseurl}}/documentation/api_jszip/constructor.html">new JSZip() or JSZip()</a></li>
  80. <li><a href="{{site.baseurl}}/documentation/api_jszip/file_name.html">JSZip#file(name)</a></li>
  81. <li><a href="{{site.baseurl}}/documentation/api_jszip/file_regex.html">JSZip#file(regex)</a></li>
  82. <li><a href="{{site.baseurl}}/documentation/api_jszip/file_data.html">JSZip#file(name, data [,options])</a></li>
  83. <li><a href="{{site.baseurl}}/documentation/api_jszip/folder_name.html">JSZip#folder(name)</a></li>
  84. <li><a href="{{site.baseurl}}/documentation/api_jszip/folder_regex.html">JSZip#folder(regex)</a></li>
  85. <li><a href="{{site.baseurl}}/documentation/api_jszip/for_each.html">JSZip#forEach(callback)</a></li>
  86. <li><a href="{{site.baseurl}}/documentation/api_jszip/filter.html">JSZip#filter(predicate)</a></li>
  87. <li><a href="{{site.baseurl}}/documentation/api_jszip/remove.html">JSZip#remove(name)</a></li>
  88. <li><a href="{{site.baseurl}}/documentation/api_jszip/generate_async.html">JSZip#generateAsync(options[, onUpdate])</a></li>
  89. <li><a href="{{site.baseurl}}/documentation/api_jszip/generate_node_stream.html">JSZip#generateNodeStream(options[, onUpdate])</a></li>
  90. <li><a href="{{site.baseurl}}/documentation/api_jszip/generate_internal_stream.html">JSZip#generateInternalStream(options)</a></li>
  91. <li><a href="{{site.baseurl}}/documentation/api_jszip/load_async.html">JSZip#loadAsync(data [, options])</a></li>
  92. <li><a href="{{site.baseurl}}/documentation/api_jszip/load_async_object.html">JSZip.loadAsync(data [, options])</a></li>
  93. <li><a href="{{site.baseurl}}/documentation/api_jszip/support.html">JSZip.support</a></li>
  94. <li><a href="{{site.baseurl}}/documentation/api_jszip/external.html">JSZip.external</a></li>
  95. <li><a href="{{site.baseurl}}/documentation/api_jszip/version.html">JSZip.version</a></li>
  96. </ul>
  97. </li>
  98. <li><a href="{{site.baseurl}}/documentation/api_zipobject.html">ZipObject</a></li>
  99. <ul>
  100. <li><a href="{{site.baseurl}}/documentation/api_zipobject/async.html">ZipObject#async(type[, onUpdate])</a></li>
  101. <li><a href="{{site.baseurl}}/documentation/api_zipobject/node_stream.html">ZipObject#nodeStream(type[, onUpdate])</a></li>
  102. <li><a href="{{site.baseurl}}/documentation/api_zipobject/internal_stream.html">ZipObject#internalStream(type)</a></li>
  103. </ul>
  104. <li><a href="{{site.baseurl}}/documentation/api_streamhelper.html">StreamHelper</a>
  105. <ul>
  106. <li><a href="{{site.baseurl}}/documentation/api_streamhelper/on.html">StreamHelper#on(event, callback)</a></li>
  107. <li><a href="{{site.baseurl}}/documentation/api_streamhelper/accumulate.html">StreamHelper#accumulate( [updateCallback])</a></li>
  108. <li><a href="{{site.baseurl}}/documentation/api_streamhelper/resume.html">StreamHelper#resume()</a></li>
  109. <li><a href="{{site.baseurl}}/documentation/api_streamhelper/pause.html">StreamHelper#pause()</a></li>
  110. </ul>
  111. </li>
  112. </ul>
  113. {% when "example" %}
  114. <h4>How to ...</h4>
  115. <ul class="nav">
  116. <li><a href="{{site.baseurl}}/documentation/examples.html">Use JSZip</a></li>
  117. <li><a href="{{site.baseurl}}/documentation/howto/read_zip.html">Read a file</a></li>
  118. <li><a href="{{site.baseurl}}/documentation/howto/write_zip.html">Write a file</a></li>
  119. </ul>
  120. <h4>Examples</h4>
  121. <ul class="nav">
  122. <li><a href="{{site.baseurl}}/documentation/examples/read-local-file-api.html">Read local file</a></li>
  123. <li><a href="{{site.baseurl}}/documentation/examples/get-binary-files-ajax.html">Read remote file</a></li>
  124. <li><a href="{{site.baseurl}}/documentation/examples/download-zip-file.html">Give the user its zip file</a></li>
  125. <li><a href="{{site.baseurl}}/documentation/examples/downloader.html">Mini app : downloader</a></li>
  126. </ul>
  127. {% endcase %}
  128. <!-- <ul class="nav"> -->
  129. <!-- <li><a href="{{site.baseurl}}/documentation/faq.html">FAQ</a></li> -->
  130. <!-- </ul> -->
  131. <!-- <li><a href="{{site.baseurl}}/">installation</a></li> -->
  132. </nav>
  133. {% endif %}
  134. <div class="{% if page.section and page.fullpage != true%}col-md-9{% else %}col-md-12{% endif %}">
  135. <h1>{{page.title}}</h1>
  136. <!-- ===================== -->
  137. <!-- === C O N T E N T === -->
  138. <!-- ===================== -->
  139. {{content}}
  140. <!-- ===================== -->
  141. <!-- == / C O N T E N T == -->
  142. <!-- ===================== -->
  143. </div>
  144. </div>
  145. </div>
  146. <script>
  147. // FIXME find how to do that cleanly
  148. (function(){
  149. var tables = document.getElementsByTagName("table");
  150. for(var i = 0; i < tables.length; i++) {
  151. tables[i].className += " table table-condensed table-striped table-bordered ";
  152. }
  153. })();
  154. </script>
  155. <script>
  156. (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
  157. (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
  158. m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
  159. })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
  160. ga('create', 'UA-52085706-1', 'stuk.github.io');
  161. ga('send', 'pageview');
  162. </script>
  163. </body>
  164. </html>