diff options
Diffstat (limited to 'user_guide_src/source/documentation')
| -rw-r--r-- | user_guide_src/source/documentation/index.rst | 95 |
1 files changed, 51 insertions, 44 deletions
diff --git a/user_guide_src/source/documentation/index.rst b/user_guide_src/source/documentation/index.rst index e977566d2..b080c0efa 100644 --- a/user_guide_src/source/documentation/index.rst +++ b/user_guide_src/source/documentation/index.rst @@ -8,12 +8,28 @@ Markdown or Textile, you will quickly grasp reStructuredText. The focus is on readability, user friendliness, and an "I've got your hand, baby" feel. While they can be quite technical, we always write for humans! -A table of contents should always be included like the one below. -It is created automatically by inserting the ``.. contents::`` -directive on a line by itself. +A local table of contents should always be included like the one below. +It is created automatically by inserting the the following: -.. contents:: Page Contents +:: + .. contents:: + :local: + + .. raw:: html + + <div class="custom-index container"></div> + +.. contents:: + :local: + +.. raw:: html + + <div class="custom-index container"></div> + +The <div> that is inserted as raw HTML is a hook for the documentation's +JavaScript to dynamically add links to any function and method definitions +contained in the current page. ************** Tools Required @@ -50,39 +66,39 @@ overlines. Other headings just use underlines, with the following hierarchy:: - for subsubsections ^ for subsubsubsections " for subsubsubsubsections (!) - + The :download:`TextMate ELDocs Bundle <./ELDocs.tmbundle.zip>` can help you create these with the following tab triggers:: title-> - + ########## Page Title ########## sec-> - + ************* Major Section ************* - + sub-> - + Subsection ========== - + sss-> - + SubSubSection ------------- - + ssss-> - + SubSubSubSection ^^^^^^^^^^^^^^^^ - + sssss-> - + SubSubSubSubSection (!) """"""""""""""""""""""" @@ -99,12 +115,9 @@ ReST: .. code-block:: rst - .. php:class:: Some_class - - some_method() - ============= + .. class:: Some_class - .. php:method:: some_method ( $foo [, $bar [, $bat]]) + .. method:: some_method ( $foo [, $bar [, $bat]]) This function will perform some action. The ``$bar`` array must contain a something and something else, and along with ``$bat`` is an optional @@ -114,8 +127,8 @@ ReST: :param mixed $bar: A data array that must contain aa something and something else :param bool $bat: whether or not to do something :returns: FALSE on failure, TRUE if successful - :rtype: Boolean - + :rtype: bool + :: $this->load->library('some_class'); @@ -131,29 +144,25 @@ ReST: { show_error('An Error Occurred Doing Some Method'); } - + .. note:: Here is something that you should be aware of when using some_method(). For real. - - See also :php:meth:`Some_class::should_do_something` - should_do_something() - ===================== + See also :meth:`Some_class::should_do_something` + - .. php:method:: should_do_something() + .. method:: should_do_something() - :returns: whether or something should be done or not - :rtype: Boolean + :returns: Whether or something should be done or not + :rtype: bool It creates the following display: -.. php:class:: Some_class +.. class:: Some_class -some_method() -============= - .. php:method:: some_method ( $foo [, $bar [, $bat]]) + .. method:: some_method ( $foo [, $bar [, $bat]]) This function will perform some action. The ``$bar`` array must contain a something and something else, and along with ``$bat`` is an optional @@ -163,8 +172,8 @@ some_method() :param mixed $bar: A data array that must contain aa something and something else :param bool $bat: whether or not to do something :returns: FALSE on failure, TRUE if successful - :rtype: Boolean - + :rtype: bool + :: $this->load->library('some_class'); @@ -180,16 +189,14 @@ some_method() { show_error('An Error Occurred Doing Some Method'); } - + .. note:: Here is something that you should be aware of when using some_method(). For real. - - See also :php:meth:`Some_class::should_do_something` -should_do_something() -===================== + See also :meth:`Some_class::should_do_something` + - .. php:method:: should_do_something() + .. method:: should_do_something() - :returns: whether or something should be done or not - :rtype: Boolean + :returns: Whether or something should be done or not + :rtype: bool
\ No newline at end of file |