Permalink
Browse files

Docs moved to separate repo

  • Loading branch information...
2 parents 6f65378 + 14e5149 commit ff3f8e6c7e228ba331ca8df0012b35db85bfd039 @davidhellsing davidhellsing committed Oct 28, 2013
Showing with 5 additions and 13,258 deletions.
  1. +0 −130 docs/Makefile
  2. +0 −189 docs/api/events.rst
  3. +0 −535 docs/api/methods.rst
  4. +0 −156 docs/api/utilities.rst
  5. +0 −216 docs/conf.py
  6. +0 −179 docs/getting_started/beginners_guide.rst
  7. +0 −140 docs/getting_started/quick_start.rst
  8. +0 −75 docs/index.rst
  9. +0 −3 docs/jsdoc/build
  10. +0 −33 docs/jsdoc/src/app/frame.js
  11. +0 −102 docs/jsdoc/src/app/frame/Chain.js
  12. +0 −144 docs/jsdoc/src/app/frame/Dumper.js
  13. +0 −84 docs/jsdoc/src/app/frame/Hash.js
  14. +0 −173 docs/jsdoc/src/app/frame/Link.js
  15. +0 −10 docs/jsdoc/src/app/frame/Namespace.js
  16. +0 −134 docs/jsdoc/src/app/frame/Opt.js
  17. +0 −26 docs/jsdoc/src/app/frame/Reflection.js
  18. +0 −93 docs/jsdoc/src/app/frame/String.js
  19. +0 −129 docs/jsdoc/src/app/frame/Testrun.js
  20. +0 −26 docs/jsdoc/src/app/handlers/FOODOC.js
  21. +0 −26 docs/jsdoc/src/app/handlers/XMLDOC.js
  22. +0 −159 docs/jsdoc/src/app/handlers/XMLDOC/DomReader.js
  23. +0 −16 docs/jsdoc/src/app/handlers/XMLDOC/XMLDoc.js
  24. +0 −292 docs/jsdoc/src/app/handlers/XMLDOC/XMLParse.js
  25. +0 −106 docs/jsdoc/src/app/lib/JSDOC.js
  26. +0 −204 docs/jsdoc/src/app/lib/JSDOC/DocComment.js
  27. +0 −294 docs/jsdoc/src/app/lib/JSDOC/DocTag.js
  28. +0 −140 docs/jsdoc/src/app/lib/JSDOC/JsDoc.js
  29. +0 −109 docs/jsdoc/src/app/lib/JSDOC/JsPlate.js
  30. +0 −144 docs/jsdoc/src/app/lib/JSDOC/Lang.js
  31. +0 −146 docs/jsdoc/src/app/lib/JSDOC/Parser.js
  32. +0 −33 docs/jsdoc/src/app/lib/JSDOC/PluginManager.js
  33. +0 −644 docs/jsdoc/src/app/lib/JSDOC/Symbol.js
  34. +0 −243 docs/jsdoc/src/app/lib/JSDOC/SymbolSet.js
  35. +0 −41 docs/jsdoc/src/app/lib/JSDOC/TextStream.js
  36. +0 −18 docs/jsdoc/src/app/lib/JSDOC/Token.js
  37. +0 −332 docs/jsdoc/src/app/lib/JSDOC/TokenReader.js
  38. +0 −133 docs/jsdoc/src/app/lib/JSDOC/TokenStream.js
  39. +0 −32 docs/jsdoc/src/app/lib/JSDOC/Util.js
  40. +0 −507 docs/jsdoc/src/app/lib/JSDOC/Walker.js
  41. +0 −111 docs/jsdoc/src/app/main.js
  42. +0 −20 docs/jsdoc/src/app/plugins/commentSrcJson.js
  43. +0 −16 docs/jsdoc/src/app/plugins/frameworkPrototype.js
  44. +0 −10 docs/jsdoc/src/app/plugins/functionCall.js
  45. +0 −62 docs/jsdoc/src/app/plugins/publishSrcHilite.js
  46. +0 −10 docs/jsdoc/src/app/plugins/symbolLink.js
  47. +0 −31 docs/jsdoc/src/app/plugins/tagParamConfig.js
  48. +0 −43 docs/jsdoc/src/app/plugins/tagSynonyms.js
  49. +0 −348 docs/jsdoc/src/app/run.js
  50. +0 −144 docs/jsdoc/src/app/t/TestDoc.js
  51. +0 −13 docs/jsdoc/src/app/t/runner.js
  52. +0 −342 docs/jsdoc/src/app/test.js
  53. +0 −24 docs/jsdoc/src/app/test/addon.js
  54. +0 −14 docs/jsdoc/src/app/test/anon_inner.js
  55. +0 −31 docs/jsdoc/src/app/test/augments.js
  56. +0 −26 docs/jsdoc/src/app/test/augments2.js
  57. +0 −46 docs/jsdoc/src/app/test/borrows.js
  58. +0 −23 docs/jsdoc/src/app/test/borrows2.js
  59. +0 −22 docs/jsdoc/src/app/test/config.js
  60. +0 −18 docs/jsdoc/src/app/test/constructs.js
  61. +0 −10 docs/jsdoc/src/app/test/encoding.js
  62. +0 −12 docs/jsdoc/src/app/test/encoding_other.js
  63. +0 −54 docs/jsdoc/src/app/test/event.js
  64. +0 −14 docs/jsdoc/src/app/test/exports.js
  65. +0 −39 docs/jsdoc/src/app/test/functions_anon.js
  66. +0 −33 docs/jsdoc/src/app/test/functions_nested.js
  67. +0 −13 docs/jsdoc/src/app/test/global.js
  68. +0 −25 docs/jsdoc/src/app/test/globals.js
  69. +0 −10 docs/jsdoc/src/app/test/ignore.js
  70. +0 −16 docs/jsdoc/src/app/test/inner.js
  71. +0 −477 docs/jsdoc/src/app/test/jsdoc_test.js
  72. +0 −33 docs/jsdoc/src/app/test/lend.js
  73. +0 −19 docs/jsdoc/src/app/test/memberof.js
  74. +0 −38 docs/jsdoc/src/app/test/memberof2.js
  75. +0 −33 docs/jsdoc/src/app/test/memberof3.js
  76. +0 −17 docs/jsdoc/src/app/test/memberof_constructor.js
  77. +0 −17 docs/jsdoc/src/app/test/module.js
  78. +0 −25 docs/jsdoc/src/app/test/multi_methods.js
  79. +0 −19 docs/jsdoc/src/app/test/name.js
  80. +0 −23 docs/jsdoc/src/app/test/namespace_nested.js
  81. +0 −13 docs/jsdoc/src/app/test/nocode.js
  82. +0 −20 docs/jsdoc/src/app/test/oblit_anon.js
  83. +0 −20 docs/jsdoc/src/app/test/overview.js
  84. +0 −37 docs/jsdoc/src/app/test/param_inline.js
  85. +0 −8 docs/jsdoc/src/app/test/params_optional.js
  86. +0 −17 docs/jsdoc/src/app/test/prototype.js
  87. +0 −9 docs/jsdoc/src/app/test/prototype_nested.js
  88. +0 −13 docs/jsdoc/src/app/test/prototype_oblit.js
  89. +0 −24 docs/jsdoc/src/app/test/prototype_oblit_constructor.js
  90. +0 −10 docs/jsdoc/src/app/test/public.js
  91. +0 −5 docs/jsdoc/src/app/test/scripts/code.js
  92. +0 −5 docs/jsdoc/src/app/test/scripts/notcode.txt
  93. +0 −42 docs/jsdoc/src/app/test/shared.js
  94. +0 −2 docs/jsdoc/src/app/test/shared2.js
  95. +0 −22 docs/jsdoc/src/app/test/shortcuts.js
  96. +0 −13 docs/jsdoc/src/app/test/static_this.js
  97. +0 −31 docs/jsdoc/src/app/test/synonyms.js
  98. +0 −23 docs/jsdoc/src/app/test/tosource.js
  99. +0 −14 docs/jsdoc/src/app/test/variable_redefine.js
  100. +0 −36 docs/jsdoc/src/java/build.xml
  101. +0 −36 docs/jsdoc/src/java/build_1.4.xml
  102. BIN docs/jsdoc/src/java/classes/js.jar
  103. +0 −21 docs/jsdoc/src/java/src/JsDebugRun.java
  104. +0 −21 docs/jsdoc/src/java/src/JsRun.java
  105. BIN docs/jsdoc/src/jsdebug.jar
  106. BIN docs/jsdoc/src/jsrun.jar
  107. +0 −52 docs/jsdoc/src/jsrun.sh
  108. +0 −17 docs/jsdoc/src/templates/jsdoc/allclasses.tmpl
  109. +0 −56 docs/jsdoc/src/templates/jsdoc/allfiles.tmpl
  110. +0 −649 docs/jsdoc/src/templates/jsdoc/class.tmpl
  111. +0 −39 docs/jsdoc/src/templates/jsdoc/index.tmpl
  112. +0 −201 docs/jsdoc/src/templates/jsdoc/publish.js
  113. +0 −162 docs/jsdoc/src/templates/jsdoc/static/default.css
  114. +0 −2 docs/jsdoc/src/templates/jsdoc/static/header.html
  115. +0 −19 docs/jsdoc/src/templates/jsdoc/static/index.html
  116. +0 −35 docs/jsdoc/src/templates/jsdoc/symbol.tmpl
  117. +0 −170 docs/make.bat
  118. +0 −17 docs/options/autoplay.rst
  119. +0 −12 docs/options/carousel.rst
  120. +0 −17 docs/options/carouselSpeed.rst
  121. +0 −19 docs/options/carouselSteps.rst
  122. +0 −11 docs/options/clicknext.rst
  123. +0 −21 docs/options/dailymotion.rst
  124. +0 −76 docs/options/dataConfig.rst
  125. +0 −39 docs/options/dataSelector.rst
  126. +0 −22 docs/options/dataSort.rst
  127. +0 −62 docs/options/dataSource.rst
  128. +0 −18 docs/options/debug.rst
  129. +0 −15 docs/options/dummy.rst
  130. +0 −16 docs/options/easing.rst
  131. +0 −30 docs/options/extend.rst
  132. +0 −8 docs/options/fullscreenCrop.rst
  133. +0 −8 docs/options/fullscreenDoubleTap.rst
  134. +0 −9 docs/options/fullscreenTransition.rst
  135. +0 −29 docs/options/height.rst
  136. +0 −14 docs/options/idleMode.rst
  137. +0 −11 docs/options/idleSpeed.rst
  138. +0 −11 docs/options/idleTime.rst
  139. +0 −15 docs/options/imageCrop.rst
  140. +0 −11 docs/options/imageMargin.rst
  141. +0 −16 docs/options/imagePan.rst
  142. +0 −9 docs/options/imagePanSmoothness.rst
  143. +0 −13 docs/options/imagePosition.rst
  144. +0 −9 docs/options/imageTimeout.rst
  145. +0 −174 docs/options/index.rst
  146. +0 −19 docs/options/initialTransition.rst
  147. +0 −33 docs/options/keepSource.rst
  148. +0 −9 docs/options/layerFollow.rst
  149. +0 −19 docs/options/lightbox.rst
  150. +0 −9 docs/options/lightboxFadeSpeed.rst
  151. +0 −9 docs/options/lightboxTransitionSpeed.rst
  152. +0 −11 docs/options/maxScaleRatio.rst
  153. +0 −11 docs/options/maxVideoSize.rst
  154. +0 −11 docs/options/minScaleRatio.rst
  155. +0 −8 docs/options/overlayBackground.rst
  156. +0 −8 docs/options/overlayOpacity.rst
  157. +0 −9 docs/options/pauseOnInteraction.rst
  158. +0 −9 docs/options/popupLinks.rst
  159. +0 −14 docs/options/preload.rst
  160. +0 −12 docs/options/queue.rst
  161. +0 −9 docs/options/responsive.rst
  162. +0 −9 docs/options/show.rst
  163. +0 −8 docs/options/showCounter.rst
  164. +0 −8 docs/options/showImagenav.rst
  165. +0 −8 docs/options/showInfo.rst
  166. +0 −8 docs/options/swipe.rst
  167. +0 −8 docs/options/thumbCrop.rst
  168. +0 −9 docs/options/thumbDisplayOrder.rst
  169. +0 −14 docs/options/thumbFit.rst
  170. +0 −9 docs/options/thumbMargin.rst
  171. +0 −13 docs/options/thumbPosition.rst
  172. +0 −12 docs/options/thumbQuality.rst
  173. +0 −24 docs/options/thumbnails.rst
  174. +0 −8 docs/options/touchTransition.rst
  175. +0 −18 docs/options/transition.rst
  176. +0 −9 docs/options/transitionSpeed.rst
  177. +0 −11 docs/options/trueFullscreen.rst
  178. +0 −20 docs/options/vimeo.rst
  179. +0 −23 docs/options/wait.rst
  180. +0 −9 docs/options/width.rst
  181. +0 −22 docs/options/youtube.rst
  182. +0 −180 docs/plugins/flickr.rst
  183. +0 −21 docs/plugins/history.rst
  184. +0 −131 docs/plugins/picasa.rst
  185. +0 −168 docs/references/changelog.rst
  186. +0 −240 docs/references/data.rst
  187. +0 −95 docs/references/dom.rst
  188. +0 −238 docs/references/errors.rst
  189. +0 −126 docs/references/extending.rst
  190. +0 −69 docs/references/faq.rst
  191. +0 −58 docs/references/optimize.rst
  192. +0 −51 docs/themes/azur.rst
  193. +0 −27 docs/themes/classic.rst
  194. +0 −93 docs/themes/creating_a_theme.rst
  195. +0 −37 docs/themes/folio.rst
  196. +0 −32 docs/themes/fullscreen.rst
  197. +0 −37 docs/themes/miniml.rst
  198. +0 −51 docs/themes/twelve.rst
  199. +0 −83 docs/themes/using_themes.rst
  200. +5 −38 src/galleria.js
View
@@ -1,130 +0,0 @@
-# Makefile for Sphinx documentation
-#
-
-# You can set these variables from the command line.
-SPHINXOPTS =
-SPHINXBUILD = sphinx-build
-PAPER =
-BUILDDIR = _build
-
-# Internal variables.
-PAPEROPT_a4 = -D latex_paper_size=a4
-PAPEROPT_letter = -D latex_paper_size=letter
-ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
-
-.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
-
-help:
- @echo "Please use \`make <target>' where <target> is one of"
- @echo " html to make standalone HTML files"
- @echo " dirhtml to make HTML files named index.html in directories"
- @echo " singlehtml to make a single large HTML file"
- @echo " pickle to make pickle files"
- @echo " json to make JSON files"
- @echo " htmlhelp to make HTML files and a HTML help project"
- @echo " qthelp to make HTML files and a qthelp project"
- @echo " devhelp to make HTML files and a Devhelp project"
- @echo " epub to make an epub"
- @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
- @echo " latexpdf to make LaTeX files and run them through pdflatex"
- @echo " text to make text files"
- @echo " man to make manual pages"
- @echo " changes to make an overview of all changed/added/deprecated items"
- @echo " linkcheck to check all external links for integrity"
- @echo " doctest to run all doctests embedded in the documentation (if enabled)"
-
-clean:
- -rm -rf $(BUILDDIR)/*
-
-html:
- $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
- @echo
- @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
-
-dirhtml:
- $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
- @echo
- @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
-
-singlehtml:
- $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
- @echo
- @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
-
-pickle:
- $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
- @echo
- @echo "Build finished; now you can process the pickle files."
-
-json:
- $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
- @echo
- @echo "Build finished; now you can process the JSON files."
-
-htmlhelp:
- $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
- @echo
- @echo "Build finished; now you can run HTML Help Workshop with the" \
- ".hhp project file in $(BUILDDIR)/htmlhelp."
-
-qthelp:
- $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
- @echo
- @echo "Build finished; now you can run "qcollectiongenerator" with the" \
- ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
- @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Galleria.qhcp"
- @echo "To view the help file:"
- @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Galleria.qhc"
-
-devhelp:
- $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
- @echo
- @echo "Build finished."
- @echo "To view the help file:"
- @echo "# mkdir -p $$HOME/.local/share/devhelp/Galleria"
- @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Galleria"
- @echo "# devhelp"
-
-epub:
- $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
- @echo
- @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
-
-latex:
- $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
- @echo
- @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
- @echo "Run \`make' in that directory to run these through (pdf)latex" \
- "(use \`make latexpdf' here to do that automatically)."
-
-latexpdf:
- $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
- @echo "Running LaTeX files through pdflatex..."
- make -C $(BUILDDIR)/latex all-pdf
- @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
-
-text:
- $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
- @echo
- @echo "Build finished. The text files are in $(BUILDDIR)/text."
-
-man:
- $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
- @echo
- @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
-
-changes:
- $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
- @echo
- @echo "The overview file is in $(BUILDDIR)/changes."
-
-linkcheck:
- $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
- @echo
- @echo "Link check complete; look for any errors in the above output " \
- "or in $(BUILDDIR)/linkcheck/output.txt."
-
-doctest:
- $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
- @echo "Testing of doctests in the sources finished, look at the " \
- "results in $(BUILDDIR)/doctest/output.txt."
View
@@ -1,189 +0,0 @@
-******
-Events
-******
-
-You can bind functions to the Galleria events to build custom themes. All
-callbacks contains an event object as a function argument. The event object is
-similar to the one that jQuery uses in their event model, except that it adds even further
-properties to the event object, specified here.
-
-In the callback, the ``this`` keyword inside the callback always refers to the gallery scope.
-
-.. highlight:: javascript
-
-=====================
-How to use the events
-=====================
-
-You can use the global ``Galleria.on()`` function to bind functions to events, f.ex::
-
- Galleria.on('image', function(e) {
- Galleria.log(this); // the gallery scope
- Galleria.log(e.imageTarget); // the currently active IMG element
- });
-
-Or you can use ``.bind()`` inside the ``Galleria.ready`` or ``extend`` to listen to
-the Galleria events. Example::
-
- Galleria.ready(function() {
-
- this.bind("thumbnail", function(e) {
- Galleria.log(this); // the gallery scope
- Galleria.log(e) // the event object
- });
-
- this.bind("loadstart", function(e) {
- if ( !e.cached ) {
- Galleria.log(e.target + ' is not cached. Begin preload...');
- }
- });
- });
-
-=======================
-List of Galleria events
-=======================
-
-
-thumbnail
-=========
-Triggers when a thumbnail is loaded and displayed in Galleria.
-
-Event properties:
------------------
-
-- **galleriaData** (Object) The currently active data object
-
-- **thumbTarget** (HTML element) The thumbnail IMG element
-
-- **index** (int) the index of the thumbnail, starting at 0
-
-
-loadstart
-=========
-Triggers every time Galleria begins loading an image.
-
-Event properties:
------------------
-
-- **galleriaData** (Object) The currently active data object
-
-- **cached** (boolean) is true if the image is cached (no loading required).
-
-- **imageTarget** (HTML element) The ``IMG`` element of the image about to load.
-
-- **thumbTarget** (HTML element) The ``IMG`` element of the thumbnail that
- belongs to the imageTarget.
-
-- **index** (Number) The galleria index of the image about to load.
-
-
-loadfinish
-==========
-Triggers every time Galleria has finished loading an image.
-
-Event properties:
------------------
-
-- **galleriaData** (Object) The currently active data object
-
-- **cached** (boolean) is true if the image is cached (no loading required).
-
-- **imageTarget** (HTML element) The ``IMG`` element of the now loaded image
- before transition.
-
-- **thumbTarget** (HTML element) The ``IMG`` element of the thumbnail that
- belongs to the imageTarget.
-
-- **index** (Number) The galleria index of the image loaded.
-
-
-image
-=====
-Triggers when the gallery image is displayed after loading and transition.
-
-Event properties:
------------------
-
-- **galleriaData** (Object) The currently active data object
-
-- **imageTarget** (HTML element) The ``IMG`` element of the now active
- displayed image after transition.
-
-- **thumbTarget** (HTML element) The ``IMG`` element of the active thumbnail.
-
-- **index** (Number) The galleria index of the image loaded.
-
-
-play
-====
-Triggers when the galleria slideshow starts playing.
-
-
-pause
-=====
-Triggers when the galleria slideshow stops playing.
-
-
-progress
-========
-Triggers every x milliseconds during slideshow. You can listen to this if you
-want to create a progress bar for slideshows.
-
-Event properties:
------------------
-
-- **percent** (Number) prints the percent (0-100) of the slideshow progress.
-
-- **seconds** (Number) prints the seconds elapsed since the last image during
- slideshow.
-
-- **milliseconds** (Number) prints the milliseconds elapsed since the last
- image during slideshow.
-
-
-fullscreen_enter
-================
-Triggers when the gallery goes into fullscreen mode.
-
-
-fullscreen_exit
-===============
-Triggers when the gallery exits the fullscreen mode.
-
-
-idle_enter
-==========
-Triggers when the gallery goes into idle mode.
-
-
-idle_exit
-=========
-Triggers when the gallery exists idle mode.
-
-
-rescale
-=======
-Triggers every time the rescale() method is used and completed for rescaling
-the gallery.
-
-
-lightbox_open
-=============
-Triggers every time the lightbox is opened.
-
-
-lightbox_close
-==============
-Triggers every time the lightbox is closed.
-
-
-lightbox_image
-==============
-Triggers when the lightbox image is displayed after loading and transition.
-
-Event properties:
------------------
-
-- **imageTarget** (HTML element) The ``IMG`` element of the now active
- displayed image after transition.
-
Oops, something went wrong.

0 comments on commit ff3f8e6

Please sign in to comment.