created basic index

Author: n1k0

modules/cli.rst renamed to cli.rst

@@ -1,8 +1,10 @@
-.. _cli_module:
+.. _cli:
 
-==================
-The ``cli`` module
-==================
+.. index:: Command line, CLI, PhantomJS, Shell, arguments, options
+
+======================
+Using the command line
+======================
 
 CasperJS ships with a built-in command line parser on top of PhantomJS' one, located in the ``cli`` module; it exposes passed arguments as **positional ones** and **named options**
 
@@ -85,10 +87,15 @@ Last but not least, you can still use all PhantomJS standard CLI options as you
 Hint To remember what the native phantomjs available cli options are,
 run the ``phantomjs --help`` command.
 
+
+.. index:: Raw values
+
 Raw parameter values
 --------------------
 
-Added in 1.0 By default, the cli object will process every passed argument & cast them to the appropriate detected type; example script::
+.. versionadded:: 1.0
+
+By default, the cli object will process every passed argument & cast them to the appropriate detected type; example script::
 
     var casper = require('casper').create();
     var utils = require('utils');

debugging.rst

@@ -1,15 +1,18 @@
 .. _debugging:
 
+.. index:: Bugs, Debugging
+
 =========
 Debugging
 =========
 
 Here's are a few tips for debugging your casper scripts.
 
-Use the verbose mode
---------------------
 
-By default & by design, a ``Casper`` instance won't print anything to the console. This can be very limitating & frustrating when creating or debugging scripts, so a good practice is to always start coding a scrip using these settings::
+Use the :index:`verbose` mode
+-----------------------------
+
+By default & by design, a ``Casper`` instance won't print anything to the console. This can be very limitating & frustrating when creating or debugging scripts, so a good practice is to always start coding a script using these :index:`settings`::
 
     var casper = require('casper').create({
         verbose: true,
@@ -22,8 +25,9 @@ The ``verbose`` setting will tell Casper to write every logged message at the ``
 
    Output will then be pretty verbose, and will potentially display sensitive informations onto the console. **Use with care on production.**
 
-Hook in the deep using events
------------------------------
+
+Hook in the deep using :index:`events`
+--------------------------------------
 
 :doc:`Events <events-filters>` are a very powerful features of CasperJS, and you should probably give it a look if you haven't already.
 
@@ -43,11 +47,31 @@ Listening to an event is dead easy::
 
 Ensure to check the :ref:`full list <events_list>` of all the other available events.
 
+
+.. _debugging_dump:
+
+Dump serialized values to the console
+-------------------------------------
+
+Sometimes it's helpful to inspect a variable, especially Object contents. The :ref:`utils_dump() <utils_dump>` function can achieve just that::
+
+    require('utils').dump({
+        foo: {
+            bar: 42
+        },
+    });
+
+.. note::
+
+   :ref:`utils_dump() <utils_dump>` won't be able to serialize function nor complex cyclic structures though.
+
+
 Localize yourself in modules
 ----------------------------
 
 If you're creating Casper modules, a cool thing to know is that there's a special built-in variable available in every module, ``__file__``, which contains the absolute path to current javascript file (the module file).
 
+
 Name your closures
 ------------------
 
@@ -73,6 +97,6 @@ Probably one of the most easy but effective best practice, always name your clos
         });
     });
 
-That way, everytime one is failing, its name will be printed out in the *stack trace*, **so you can more easily locate it within your code**.
+That way, everytime one is failing, its name will be printed out in the :index:`stack trace`, **so you can more easily locate it within your code**.
 
 Note that this one also applies for all your other Javascript works, of course ;)

events-filters.rst

@@ -6,6 +6,8 @@ Events & filters
 CasperJS provides an `event handler <#events>`_ very similar to the `nodejs <http://nodejs.org>`_' `one <https://github.com/joyent/node/blob/master/lib/events.js>`_; actually it borrows most of its codebase. CasperJS also adds `filters <#filters>`_, which are basically ways to alter values asynchronously.
 
 
+.. index:: ! events
+
 Events
 ------
 
@@ -20,9 +22,7 @@ Using events is pretty much straightforward if you're a node developer, or if yo
 Emitting you own events
 +++++++++++++++++++++++
 
-Of course you can emit your own events, using the ``Casper.emit()`` method:
-
-::
+Of course you can emit your own events, using the ``Casper.emit()`` method::
 
     var casper = require('casper').create();
 
@@ -48,15 +48,16 @@ Events reference
 
 **Arguments:** ``None``
 
-Emitted when the embedded browser is asked to go back a step in its
-history.
+Emitted when the embedded browser is asked to go back a step in its history.
 
 ``capture.saved``
 ~~~~~~~~~~~~~~~~~
 
 **Arguments:** ``targetFile``
 
-Emitted when a screenshot image has been captured.
+Emitted when a :index:`screenshot` image has been captured.
+
+.. index:: click
 
 ``click``
 ~~~~~~~~~
@@ -72,13 +73,17 @@ Emitted when the ``Casper.click()`` method has been called.
 
 Emitted when the ``Casper.die()`` method has been called.
 
+.. index:: download
+
 ``downloaded.file``
 ~~~~~~~~~~~~~~~~~~~
 
 **Arguments:** ``targetPath``
 
 Emitted when a file has been downloaded by :ref:`Casper.download() <casper_download>`; ``target`` will contain the path to the downloaded file.
 
+.. index:: error
+
 ``error``
 ~~~~~~~~~
 
@@ -88,13 +93,17 @@ Emitted when a file has been downloaded by :ref:`Casper.download() <casper_downl
 
 Emitted when an error hasn't been caught. Do basically what PhantomJS' ``onError()`` native handler does.
 
+.. index:: exit
+
 ``exit``
 ~~~~~~~~
 
 **Arguments:** ``status``
 
 Emitted when the ``Casper.exit()`` method has been called.
 
+.. index:: fill
+
 ``fill``
 ~~~~~~~~
 
@@ -109,21 +118,23 @@ Emitted when a form is filled using the ``Casper.fill()`` method.
 
 Emitted when the embedded browser is asked to go forward a step in its history.
 
+.. index:: auth
+
 ``http.auth``
 ~~~~~~~~~~~~~
 
 **Arguments:** ``username, password``
 
 Emitted when http authentication parameters are set.
 
+.. index:: HTTP
+
 ``http.status.[code]``
 ~~~~~~~~~~~~~~~~~~~~~~
 
 **Arguments:** ``resource``
 
-Emitted when any given HTTP reponse is received with the status code specified by ``[code]``, eg.:
-
-::
+Emitted when any given HTTP reponse is received with the status code specified by ``[code]``, eg.::
 
     casper.on('http.status.404', function(resource) {
         casper.echo(resource.url + ' is 404');
@@ -150,14 +161,14 @@ Emitted when PhantomJS' ``WebPage.onLoadFinished`` event callback has been calle
 
 Emitted when PhantomJS' ``WebPage.onLoadFinished`` event callback is called.
 
+.. index:: log
+
 ``log``
 ~~~~~~~
 
 **Arguments:** ``entry``
 
-Emitted when the ``Casper.log()`` method has been called. The ``entry`` parameter is an Object like this:
-
-::
+Emitted when the ``Casper.log()`` method has been called. The ``entry`` parameter is an Object like this::
 
     {
         level:   "debug",
@@ -166,6 +177,8 @@ Emitted when the ``Casper.log()`` method has been called. The ``entry`` paramete
         date:    "a javascript Date instance"
     }
 
+..index:: click
+
 ``mouse.click``
 ~~~~~~~~~~~~~~~
 
@@ -203,14 +216,14 @@ Emitted when the mouse releases the left button over something or somewhere.
 
 Emitted each time a navigation operation has been requested. Available navigation types are: ``LinkClicked``, ``FormSubmitted``, ``BackOrForward``, ``Reload``, ``FormResubmitted`` and ``Other``.
 
+.. index:: HTTP
+
 ``open``
 ~~~~~~~~
 
 ``location, settings``
 
-Emitted when an HTTP request is sent. First callback arg is the location, second one is a request settings Object of the form:
-
-::
+Emitted when an HTTP request is sent. First callback arg is the location, second one is a request settings Object of the form::
 
     {
         method: "post",
@@ -229,9 +242,7 @@ Emitted when PhantomJS' ``WebPage`` object used by CasperJS has been created.
 
 **Arguments:** ``message, trace``
 
-Emitted when retrieved page leaved a Javascript error uncaught:
-
-::
+Emitted when retrieved page leaved a Javascript error uncaught::
 
     casper.on("page.error", function(msg, trace) {
         this.echo("Error: " + msg, "ERROR");
@@ -244,13 +255,17 @@ Emitted when retrieved page leaved a Javascript error uncaught:
 
 Emitted when PhantomJS' ``WebPage`` object used by CasperJS has been initialized.
 
+.. index:: HTTP
+
 ``page.resource.received``
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 **Arguments:** ``response``
 
 Emitted when the HTTP response corresponding to current required url has been received.
 
+.. index:: HTTP
+
 ``page.resource.requested``
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -391,6 +406,8 @@ Emitted when the execution time of the script has reached the ``Casper.options.t
 
 Added in 1.0 Emitted each time the current page url changes.
 
+.. index:: viewport
+
 ``viewport.changed``
 ~~~~~~~~~~~~~~~~~~~~
 
@@ -420,12 +437,12 @@ Emitted when a ``Casper.wait()`` operation starts.
 Emitted when the execution time of a ``Casper.wait*()`` operation has exceeded the value of ``Casper.options.stepTimeout``.
 
 
+.. index:: filters
+
 Filters
 -------
 
-Filters allow you to alter some values asynchronously. Sounds obscure? Let's take a simple example and imagine you would like to alter every single url opened by CasperJS to append a ``foo=42`` query string parameter:
-
-::
+Filters allow you to alter some values asynchronously. Sounds obscure? Let's take a simple example and imagine you would like to alter every single url opened by CasperJS to append a ``foo=42`` query string parameter::
 
     var casper = require('casper').create();
 
@@ -440,6 +457,8 @@ Here'a the list of all available filters with their expected return value:
 Filters reference
 +++++++++++++++++
 
+.. index:: screenshot
+
 ``capture.target_filename``
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -485,9 +504,7 @@ Allows to alter every url before it being opened.
 
 .. versionadded:: 1.0
 
-Allows to react on a javascript ``confirm()`` call:
-
-::
+Allows to react on a javascript ``confirm()`` call::
 
     casper.setFilter("page.confirm", function(msg) {
         return msg === "Do you like vbscript?" ? false : true;
@@ -502,9 +519,7 @@ Allows to react on a javascript ``confirm()`` call:
 
 .. versionadded:: 1.0
 
-Allows to react on a javascript ``prompt()`` call:
-
-::
+Allows to react on a javascript ``prompt()`` call::
 
     casper.setFilter("page.prompt", function(msg, value) {
         if (msg === "What's your name?") {

extending.rst

@@ -1,5 +1,7 @@
 .. _extending:
 
+.. index:: extending, inheritance, prototype
+
 =========
 Extending
 =========
@@ -92,7 +94,10 @@ But that's just plain old *monkey-patching* the ``casper`` object, and you may p
 
    **Don't forget to call ``Casper``'s parent constructor!**
 
-Note Of course this approach is bit more verbose than the easy *monkey-patching* one, so please ensure you're not just overengineering stuff by subclassing the ``Casper`` class.
+   Of course this approach is bit more verbose than the easy *monkey-patching* one, so please ensure you're not just overengineering stuff by subclassing the ``Casper`` class.
+
+
+.. index:: coffeescript
 
 Using CoffeeScript
 ~~~~~~~~~~~~~~~~~~