Skip to content

Commit

Permalink
started docs work
Browse files Browse the repository at this point in the history
  • Loading branch information
sorl committed Nov 26, 2010
1 parent cd42713 commit 813f42c
Show file tree
Hide file tree
Showing 7 changed files with 25 additions and 31 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
.DS_Store
._*
_build
*.swp
11 changes: 5 additions & 6 deletions docs/browser-detection.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
=====================
=================
Broswer detection
=====================

=================
These static variables are mainly used to detect browsers.

Example usage
-------------

::

<script>
Expand All @@ -16,7 +15,7 @@ Example usage
</script>
IE
---
--
Detects IE6+ using object detection.

IE6
Expand Down Expand Up @@ -73,4 +72,4 @@ Detects android using browser sniffing.

TOUCH
-----
Detects touch devices using browser sniffing.
Detects touch devices using browser sniffing.
15 changes: 0 additions & 15 deletions docs/contents.rst

This file was deleted.

3 changes: 3 additions & 0 deletions docs/events.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
Events
======

.. highlight:: javascript


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 jQuery's event model, except that it adds event.scope that refers to the current gallery scope of each event. Some events will add even further properties to the event object, specified here.

Use ``.bind()`` to listen to the Galleria events. In the callback, the this keyword inside the callback always refers to the same gallery scope. Example::
Expand Down
7 changes: 0 additions & 7 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,3 @@ Plugins

plugins/flickr

Misc
----

.. toctree::
:maxdepth: 1

contents
15 changes: 13 additions & 2 deletions docs/options/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,16 @@
Options
=======

.. toctree::
:hidden:
:glob:

*


.. highlight:: javascript


Galleria options are defined using a flat object during initialization.::

$('#galleria').galleria({
Expand All @@ -10,10 +20,11 @@ Galleria options are defined using a flat object during initialization.::
image_crop: true
});

**Note:** You can define your own options and set defaults for each theme using the Theme builder API.
.. note:: You can define your own options and set defaults for each theme using
the Theme builder API.

List of options
***************
---------------

:doc:`autoplay` Sets Galleria to play slidehow when initialized.

Expand Down
4 changes: 3 additions & 1 deletion docs/tutorials/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
Getting started
===============

.. highlight:: javascript

Requirements
============

Expand Down Expand Up @@ -99,4 +101,4 @@ With extra options::

Customize
---------
If you wish to add alternative sources of image data, try the flickr and ssp documentation. If you would like to add more advanced cunstomizations, read the **Extending Galleria** section. *Good luck!*
If you wish to add alternative sources of image data, try the flickr and ssp documentation. If you would like to add more advanced cunstomizations, read the **Extending Galleria** section. *Good luck!*

0 comments on commit 813f42c

Please sign in to comment.