index.html 9.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345
  1. <!DOCTYPE html>
  2. <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
  3. <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
  4. <head>
  5. <meta charset="utf-8">
  6. <meta http-equiv="X-UA-Compatible" content="IE=edge">
  7. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  8. <title>Library reader - Febbweiss</title>
  9. <link rel="shortcut icon" href="../../img/favicon.ico">
  10. <link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
  11. <link rel="stylesheet" href="../../css/theme.css" type="text/css" />
  12. <link rel="stylesheet" href="../../css/theme_extra.css" type="text/css" />
  13. <link rel="stylesheet" href="../../css/highlight.css">
  14. <link href="../../extra/css/extra.css" rel="stylesheet">
  15. <link href="../../extra/css/sis.css" rel="stylesheet">
  16. <script>
  17. // Current page data
  18. var mkdocs_page_name = "Library reader";
  19. var mkdocs_page_input_path = "development/library_reader.md";
  20. var mkdocs_page_url = "/development/library_reader/";
  21. </script>
  22. <script src="../../js/jquery-2.1.1.min.js"></script>
  23. <script src="../../js/modernizr-2.8.3.min.js"></script>
  24. <script type="text/javascript" src="../../js/highlight.pack.js"></script>
  25. <script src="../../js/theme.js"></script>
  26. <script src="../../extra/js/pacman.js"></script>
  27. <script src="../../extra/js/pyramid.js"></script>
  28. <script src="../../extra/js/sis.js"></script>
  29. <script src="../../extra/js/yahtzee.js"></script>
  30. </head>
  31. <body class="wy-body-for-nav" role="document">
  32. <div class="wy-grid-for-nav">
  33. <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
  34. <div class="wy-side-nav-search">
  35. <a href="../.." class="icon icon-home"> Febbweiss</a>
  36. <div role="search">
  37. <form id ="rtd-search-form" class="wy-form" action="../../search.html" method="get">
  38. <input type="text" name="q" placeholder="Search docs" />
  39. </form>
  40. </div>
  41. </div>
  42. <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  43. <ul class="current">
  44. <li>
  45. <li class="toctree-l1 ">
  46. <a class="" href="../..">Home</a>
  47. </li>
  48. <li>
  49. <li>
  50. <ul class="subnav">
  51. <li><span>Development</span></li>
  52. <li class="toctree-l1 ">
  53. <a class="" href="../cloudbudget/">Cloudbudget</a>
  54. </li>
  55. <li class="toctree-l1 ">
  56. <a class="" href="../cloudbudget_angularjs/">Cloudbudget angularjs</a>
  57. </li>
  58. <li class="toctree-l1 ">
  59. <a class="" href="../filebrowser_durandal_widget/">Filebrowser durandal widget</a>
  60. </li>
  61. <li class="toctree-l1 ">
  62. <a class="" href="../java_small_projects/">Java small projects</a>
  63. </li>
  64. <li class="toctree-l1 current">
  65. <a class="current" href="./">Library reader</a>
  66. <ul>
  67. <li class="toctree-l3"><a href="#introduction">Introduction</a></li>
  68. <li><a class="toctree-l4" href="#building">Building</a></li>
  69. <li><a class="toctree-l4" href="#how-it-works">How it works</a></li>
  70. <li><a class="toctree-l4" href="#built-with">Built with</a></li>
  71. <li><a class="toctree-l4" href="#licence">Licence :</a></li>
  72. </ul>
  73. </li>
  74. <li class="toctree-l1 ">
  75. <a class="" href="../project_deployer/">Project deployer</a>
  76. </li>
  77. <li class="toctree-l1 ">
  78. <a class="" href="../scrabble_resolver/">Scrabble resolver</a>
  79. </li>
  80. <li class="toctree-l1 ">
  81. <a class="" href="../springboot_react_webpack/">Springboot react webpack</a>
  82. </li>
  83. </ul>
  84. <li>
  85. <li>
  86. <ul class="subnav">
  87. <li><span>Docker</span></li>
  88. <li class="toctree-l1 ">
  89. <a class="" href="../../docker/docker_apache_log_generator/">Docker apache log generator</a>
  90. </li>
  91. <li class="toctree-l1 ">
  92. <a class="" href="../../docker/docker_gocd/">Docker gocd</a>
  93. </li>
  94. <li class="toctree-l1 ">
  95. <a class="" href="../../docker/docker_java_log_generator/">Docker java log generator</a>
  96. </li>
  97. <li class="toctree-l1 ">
  98. <a class="" href="../../docker/docker_log_centralizer/">Docker log centralizer</a>
  99. </li>
  100. </ul>
  101. <li>
  102. <li>
  103. <ul class="subnav">
  104. <li><span>Games</span></li>
  105. <li class="toctree-l1 ">
  106. <a class="" href="../../games/Space_invaders_stories/">Space invaders stories</a>
  107. </li>
  108. <li class="toctree-l1 ">
  109. <a class="" href="../../games/pacman/">Pacman</a>
  110. </li>
  111. <li class="toctree-l1 ">
  112. <a class="" href="../../games/pyramid/">Pyramid</a>
  113. </li>
  114. <li class="toctree-l1 ">
  115. <a class="" href="../../games/wordfighters/">Wordfighters</a>
  116. </li>
  117. <li class="toctree-l1 ">
  118. <a class="" href="../../games/yahtzee/">Yahtzee</a>
  119. </li>
  120. </ul>
  121. <li>
  122. </ul>
  123. </div>
  124. &nbsp;
  125. </nav>
  126. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
  127. <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
  128. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  129. <a href="../..">Febbweiss</a>
  130. </nav>
  131. <div class="wy-nav-content">
  132. <div class="rst-content">
  133. <div role="navigation" aria-label="breadcrumbs navigation">
  134. <ul class="wy-breadcrumbs">
  135. <li><a href="../..">Docs</a> &raquo;</li>
  136. <li>Development &raquo;</li>
  137. <li>Library reader</li>
  138. <li class="wy-breadcrumbs-aside">
  139. <a href="https://github.com/febbweiss/" class="icon icon-github"> Edit on GitHub</a>
  140. </li>
  141. </ul>
  142. <hr/>
  143. </div>
  144. <div role="main">
  145. <div class="section">
  146. <h1 id="introduction">Introduction</h1>
  147. <p>PDF-Reader is a small web application listing PDF documents and allowing to visualize them.</p>
  148. <h2 id="building">Building</h2>
  149. <p>This project is built using <a href="http://bower.io">Bower</a>.
  150. Just install it and run :</p>
  151. <pre><code>bower install
  152. </code></pre>
  153. <h2 id="how-it-works">How it works</h2>
  154. <p>Written in AngularJS, PDF-Reader calls a resource (<em>/data/documents.json</em>) providing a list of documents such as :</p>
  155. <pre><code>[{&quot;title&quot;: &quot;My report&quot;, &quot;link&quot;: &quot;report.pdf&quot;}]
  156. </code></pre>
  157. <p>The list is rendering such as a paginated table with a quick filter input. Clicking on the <em>View</em> button load the document in the right side pane.</p>
  158. <p>Documents are stored in a <em>documents</em> folder.</p>
  159. <h2 id="built-with">Built with</h2>
  160. <ul>
  161. <li>UI : <a href="https://bulma.io">Bulma</a></li>
  162. <li>MVC : <a href="https://angularjs.org/">AngularJS</a></li>
  163. <li>PDF Reader : <a href="http://github.com/sayanee/angularjs-pdf">angular-pdf</a></li>
  164. <li>Pagination : <a href="https://github.com/michaelbromley/angularUtils.git">angularUtils</a></li>
  165. <li>Icons : <a href="http://fontawesome.io">Font Awesome</a></li>
  166. </ul>
  167. <h2 id="licence">Licence :</h2>
  168. <p>Source code is under <a href="http://opensource.org/licenses/mit-license.php">MIT Licence</a></p>
  169. <p><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/github-fork-ribbon-css/0.2.0/gh-fork-ribbon.min.css" />
  170. <!--[if lt IE 9]>
  171. <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/github-fork-ribbon-css/0.2.0/gh-fork-ribbon.ie.min.css" />
  172. <![endif]-->
  173. <a class="github-fork-ribbon" href="https://github.com/Febbweiss/pdf-reader" target="_blank" title="Fork me on GitHub">Fork me on GitHub</a></p>
  174. </div>
  175. </div>
  176. <footer>
  177. <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
  178. <a href="../project_deployer/" class="btn btn-neutral float-right" title="Project deployer">Next <span class="icon icon-circle-arrow-right"></span></a>
  179. <a href="../java_small_projects/" class="btn btn-neutral" title="Java small projects"><span class="icon icon-circle-arrow-left"></span> Previous</a>
  180. </div>
  181. <hr/>
  182. <div role="contentinfo">
  183. <!-- Copyright etc -->
  184. </div>
  185. Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
  186. </footer>
  187. </div>
  188. </div>
  189. </section>
  190. </div>
  191. <div class="rst-versions" role="note" style="cursor: pointer">
  192. <span class="rst-current-version" data-toggle="rst-current-version">
  193. <a href="https://github.com/febbweiss/" class="icon icon-github" style="float: left; color: #fcfcfc"> GitHub</a>
  194. <span><a href="../java_small_projects/" style="color: #fcfcfc;">&laquo; Previous</a></span>
  195. <span style="margin-left: 15px"><a href="../project_deployer/" style="color: #fcfcfc">Next &raquo;</a></span>
  196. </span>
  197. </div>
  198. </body>
  199. </html>