diff options
author | Derek Jones <derek.jones@ellislab.com> | 2011-10-10 23:32:55 +0200 |
---|---|---|
committer | Derek Jones <derek.jones@ellislab.com> | 2011-10-10 23:32:55 +0200 |
commit | bf6df692d7da01a8b3da4a7c4618f1dd1e7265c5 (patch) | |
tree | 165da355ed08948b1089584fbad09e4af8167f33 /user_guide_src | |
parent | 77a8c1fbae04389be9a524ce565bb09b51ffec3e (diff) | |
parent | 619b122cc8c213df558838ce9cc1c157a85a65b6 (diff) |
Merge branch 'feature/userguide-toc' into develop
Conflicts:
user_guide_src/source/_themes/eldocs/layout.html
user_guide_src/source/general/index.rst
user_guide_src/source/index.rst
Diffstat (limited to 'user_guide_src')
-rw-r--r-- | user_guide_src/source/_themes/eldocs/layout.html | 10 | ||||
-rw-r--r-- | user_guide_src/source/_themes/eldocs/static/asset/css/common.css | 2 | ||||
-rw-r--r-- | user_guide_src/source/database/index.rst | 32 | ||||
-rw-r--r-- | user_guide_src/source/general/index.rst | 62 | ||||
-rw-r--r-- | user_guide_src/source/general/styleguide.rst | 7 | ||||
-rw-r--r-- | user_guide_src/source/index.rst | 7 | ||||
-rw-r--r-- | user_guide_src/source/overview/index.rst | 16 |
7 files changed, 69 insertions, 67 deletions
diff --git a/user_guide_src/source/_themes/eldocs/layout.html b/user_guide_src/source/_themes/eldocs/layout.html index da59e5302..a79720ef1 100644 --- a/user_guide_src/source/_themes/eldocs/layout.html +++ b/user_guide_src/source/_themes/eldocs/layout.html @@ -124,7 +124,15 @@ {%- block footer %} <div id="footer"> - <p class="top"><a href="#header" title="Return to top">Return to top</a></p> + <p class="top"> + {% if prev %} + <span class="prev">Previous Topic: <a href="{{ prev.link }}">{{ prev.title }}</a></span> + {% endif %} + {% if next %} + <span class="next">Next Topic: <a href="{{ next.link }}">{{ next.title }}</a></span> + {% endif %} + <a href="#header" title="Return to top">Return to top</a> + </p> <p><a href="{{ project_url }}">{{ project }}</a> – Copyright © {{ copyright }}</a> – Last updated: {{ last_updated }}</p> </div><!-- /#footer --> {%- endblock %} diff --git a/user_guide_src/source/_themes/eldocs/static/asset/css/common.css b/user_guide_src/source/_themes/eldocs/static/asset/css/common.css index c216c3666..28182a162 100644 --- a/user_guide_src/source/_themes/eldocs/static/asset/css/common.css +++ b/user_guide_src/source/_themes/eldocs/static/asset/css/common.css @@ -119,6 +119,8 @@ img{ display: block; max-width: 100%; } fieldset{ border: 0; } .top{ float: right; } +.next{ padding: 0 20px 0 10px; } +.prev{ padding-right: 10px; } .highlight-ci, .highlight-ee, diff --git a/user_guide_src/source/database/index.rst b/user_guide_src/source/database/index.rst index 3b59986be..ab12b7cb7 100644 --- a/user_guide_src/source/database/index.rst +++ b/user_guide_src/source/database/index.rst @@ -6,24 +6,20 @@ CodeIgniter comes with a full-featured and very fast abstracted database class that supports both traditional structures and Active Record patterns. The database functions offer clear, simple syntax. -- :doc:`Quick Start: Usage Examples <examples>` -- :doc:`Database Configuration <configuration>` -- :doc:`Connecting to a Database <connecting>` -- :doc:`Running Queries <queries>` -- :doc:`Generating Query Results <results>` -- :doc:`Query Helper Functions <helpers>` -- :doc:`Active Record Class <active_record>` -- :doc:`Transactions <transactions>` -- :doc:`Table MetaData <table_data>` -- :doc:`Field MetaData <fields>` -- :doc:`Custom Function Calls <call_function>` -- :doc:`Query Caching <caching>` -- :doc:`Database manipulation with Database Forge <forge>` -- :doc:`Database Utilities Class <utilities>` - .. toctree:: - :glob: :titlesonly: - :hidden: - *
\ No newline at end of file + Quick Start: Usage Examples <examples> + Database Configuration <configuration> + Connecting to a Database <connecting> + Running Queries <queries> + Generating Query Results <results> + Query Helper Functions <helpers> + Active Record Class <active_record> + Transactions <transactions> + Table MetaData <table_data> + Field MetaData <fields> + Custom Function Calls <call_function> + Query Caching <caching> + Database Manipulation with Database Forge <forge> + Database Utilities Class <utilities>
\ No newline at end of file diff --git a/user_guide_src/source/general/index.rst b/user_guide_src/source/general/index.rst index ae0d0961c..1335e9dd4 100644 --- a/user_guide_src/source/general/index.rst +++ b/user_guide_src/source/general/index.rst @@ -1,39 +1,33 @@ -################## -General -################## - - -- :doc:`CodeIgniter URLs <urls>` -- :doc:`Controllers <controllers>` -- :doc:`Reserved Names <reserved_names>` -- :doc:`Views <views>` -- :doc:`Models <models>` -- :doc:`Helpers <helpers>` -- :doc:`Using CodeIgniter Libraries <libraries>` -- :doc:`Creating Your Own Libraries <creating_libraries>` -- :doc:`Using CodeIgniter Drivers <drivers>` -- :doc:`Creating Your Own Drivers <creating_drivers>` -- :doc:`Creating Core Classes <core_classes>` -- :doc:`Creating Ancillary Classes <ancillary_classes>` -- :doc:`Hooks - Extending the Core <hooks>` -- :doc:`Auto-loading Resources <autoloader>` -- :doc:`Common Function <common_functions>` -- :doc:`URI Routing <routing>` -- :doc:`Error Handling <errors>` -- :doc:`Caching <caching>` -- :doc:`Profiling Your Application <profiling>` -- :doc:`Running via the CLI <cli>` -- :doc:`Managing Applications <managing_apps>` -- :doc:`Handling Multiple Environments <environments>` -- :doc:`Alternative PHP Syntax <alternative_php>` -- :doc:`Security <security>` -- :doc:`PHP Style Guide <styleguide>` -- :doc:`Server Requirements <requirements>` -- :doc:`Credits <credits>` +############## +General Topics +############## .. toctree:: - :glob: :titlesonly: :hidden: - *
\ No newline at end of file + urls + controllers + reserved_names + views + models + Helpers <helpers> + libraries + creating_libraries + drivers + creating_drivers + core_classes + ancillary_classes + hooks + autoloader + common_functions + routing + errors + Caching <caching> + profiling + cli + managing_apps + environments + alternative_php + security + PHP Style Guide <styleguide> diff --git a/user_guide_src/source/general/styleguide.rst b/user_guide_src/source/general/styleguide.rst index 0373fc791..b3dc08871 100644 --- a/user_guide_src/source/general/styleguide.rst +++ b/user_guide_src/source/general/styleguide.rst @@ -1,6 +1,7 @@ -######################## -General Style and Syntax -######################## +############### +PHP Style Guide +############### + The following page describes the use of coding rules adhered to when developing CodeIgniter. diff --git a/user_guide_src/source/index.rst b/user_guide_src/source/index.rst index 0e6bc5003..6cdeb2442 100644 --- a/user_guide_src/source/index.rst +++ b/user_guide_src/source/index.rst @@ -37,10 +37,13 @@ CodeIgniter is right for you if: * overview/index + general/requirements installation/index general/index libraries/index - database/index helpers/index + database/index documentation/index - tutorial/index
\ No newline at end of file + tutorial/index + general/quick_reference + general/credits
\ No newline at end of file diff --git a/user_guide_src/source/overview/index.rst b/user_guide_src/source/overview/index.rst index d541e796c..dc91f78c4 100644 --- a/user_guide_src/source/overview/index.rst +++ b/user_guide_src/source/overview/index.rst @@ -4,15 +4,13 @@ CodeIgniter Overview The following pages describe the broad concepts behind CodeIgniter: -- :doc:`CodeIgniter at a Glance <at_a_glance>` -- :doc:`Supported Features <features>` -- :doc:`Application Flow Chart <appflow>` -- :doc:`Introduction to the Model-View-Controller <mvc>` -- :doc:`Design and Architectural Goals <goals>` - .. toctree:: - :glob: - :hidden: :titlesonly: - *
\ No newline at end of file + Getting Started <getting_started> + CodeIgniter at a Glance <at_a_glance> + CodeIgniter Cheatsheets <cheatsheets> + Supported Features <features> + Application Flow Chart <appflow> + Model-View-Controller <mvc> + Architectural Goals <goals>
\ No newline at end of file |