Make local TOCs consistent

jim-parry · jim-parry · commit 300a174399fa · 2018-09-23T02:25:21.000-07:00
diff --git a/user_guide_src/source/concepts/services.rst b/user_guide_src/source/concepts/services.rst
@@ -2,6 +2,10 @@
 Services
 ########
 
+.. contents::
+    :local:
+    :depth: 2
+
 Introduction
 ============
 
diff --git a/user_guide_src/source/database/configuration.rst b/user_guide_src/source/database/configuration.rst
@@ -2,6 +2,10 @@
 Database Configuration
 ######################
 
+.. contents::
+    :local:
+    :depth: 2
+
 CodeIgniter has a config file that lets you store your database
 connection values (username, password, database name, etc.). The config
 file is located at application/Config/Database.php. You can also set
diff --git a/user_guide_src/source/database/entities.rst b/user_guide_src/source/database/entities.rst
@@ -6,8 +6,9 @@ CodeIgniter supports Entity classes as a first-class citizen in it's database la
 them completely optional to use. They are commonly used as part of the Repository pattern, but can
 be used directly with the :doc:`Model </database/model>` if that fits your needs better.
 
-.. contents:: Page Contents
-	:local:
+.. contents::
+    :local:
+    :depth: 2
 
 Entity Usage
 ============
diff --git a/user_guide_src/source/database/forge.rst b/user_guide_src/source/database/forge.rst
@@ -5,8 +5,9 @@ Database Forge Class
 The Database Forge Class contains methods that help you manage your
 database.
 
-.. contents:: Table of Contents
-    :depth: 3
+.. contents::
+    :local:
+    :depth: 2
 
 ****************************
 Initializing the Forge Class
diff --git a/user_guide_src/source/database/metadata.rst b/user_guide_src/source/database/metadata.rst
@@ -2,6 +2,10 @@
 Database Metadata
 #################
 
+.. contents::
+    :local:
+    :depth: 2
+
 **************
 Table MetaData
 **************
diff --git a/user_guide_src/source/database/queries.rst b/user_guide_src/source/database/queries.rst
@@ -2,7 +2,9 @@
 Queries
 #######
 
-.. contents:: Table of Contents
+.. contents::
+    :local:
+    :depth: 2
 
 ************
 Query Basics
diff --git a/user_guide_src/source/database/query_builder.rst b/user_guide_src/source/database/query_builder.rst
@@ -17,7 +17,7 @@ system.
 
 .. contents::
     :local:
-    :depth: 1
+    :depth: 2
 
 *************************
 Loading the Query Builder
diff --git a/user_guide_src/source/general/cli_commands.rst b/user_guide_src/source/general/cli_commands.rst
@@ -8,7 +8,9 @@ need to have routes defined for, making them perfect for building tools that dev
 their jobs simpler, whether by handling migrations or database seeding, checking cronjob status, or even
 building out custom code generators for your company.
 
-.. contents:: Page Contents
+.. contents::
+    :local:
+    :depth: 2
 
 ****************
 Running Commands
diff --git a/user_guide_src/source/general/common_functions.rst b/user_guide_src/source/general/common_functions.rst
@@ -5,8 +5,10 @@ Global Functions and Constants
 CodeIgniter uses provides a few functions and variables that are globally defined, and are available to you at any point.
 These do not require loading any additional libraries or helpers.
 
-.. contents:: Page Contents
-	:local:
+.. contents::
+    :local:
+    :depth: 2
+
 
 ================
 Global Functions
diff --git a/user_guide_src/source/general/configuration.rst b/user_guide_src/source/general/configuration.rst
@@ -8,6 +8,10 @@ hold a class that contains its settings as public properties. Unlike in many oth
 there is no single class that you need to use to access your settings. Instead, you simply
 create an instance of the class and all your settings are there for you.
 
+.. contents::
+    :local:
+    :depth: 2
+
 Accessing Config Files
 ======================
 
diff --git a/user_guide_src/source/general/controllers.rst b/user_guide_src/source/general/controllers.rst
@@ -4,7 +4,10 @@ Controllers
 
 Controllers are the heart of your application, as they determine how HTTP requests should be handled.
 
-.. contents:: Page Contents
+.. contents::
+    :local:
+    :depth: 2
+
 
 What is a Controller?
 =====================
diff --git a/user_guide_src/source/general/debugging.rst b/user_guide_src/source/general/debugging.rst
@@ -2,8 +2,9 @@
 Debugging Your Application
 **************************
 
-.. contents:: Table of Contents
-	:depth: 3
+.. contents::
+    :local:
+    :depth: 2
 
 ================
 Replace var_dump
diff --git a/user_guide_src/source/general/errors.rst b/user_guide_src/source/general/errors.rst
@@ -8,6 +8,10 @@ default action when an error or exception is thrown is to display a detailed err
 is running under the ``production`` environment. In this case, a more generic  message is displayed to
 keep the best user experience for your users.
 
+.. contents::
+    :local:
+    :depth: 2
+
 Using Exceptions
 ================
 
diff --git a/user_guide_src/source/general/filters.rst b/user_guide_src/source/general/filters.rst
@@ -2,6 +2,10 @@
 Controller Filters
 ##################
 
+.. contents::
+    :local:
+    :depth: 2
+
 Controller Filters allow you to perform actions either before or after the controllers execute. Unlike :doc:`events </general/events>`,
 you can very simply choose which URI's in your application have the filters applied to them. Incoming filters may
 modify the Request, while after filters can act on and even modify the Response, allowing for a lot of flexibility
diff --git a/user_guide_src/source/general/helpers.rst b/user_guide_src/source/general/helpers.rst
@@ -9,6 +9,10 @@ you create form elements, **Text Helpers** perform various text formatting
 routines, **Cookie Helpers** set and read cookies, **File Helpers** help you
 deal with files, etc.
 
+.. contents::
+    :local:
+    :depth: 2
+
 Unlike most other systems in CodeIgniter, Helpers are not written in an
 Object Oriented format. They are simple, procedural functions. Each
 helper function performs one specific task, with no dependence on other
diff --git a/user_guide_src/source/general/logging.rst b/user_guide_src/source/general/logging.rst
@@ -2,6 +2,10 @@
 Logging Information
 ###################
 
+.. contents::
+    :local:
+    :depth: 2
+
 You can log information to the local log files by using the ``log_message()`` method. You must supply
 the "level" of the error in the first parameter, indicating what type of message it is (debug, error, etc).
 The second parameter is the message itself::
diff --git a/user_guide_src/source/general/modules.rst b/user_guide_src/source/general/modules.rst
@@ -7,7 +7,9 @@ centered around a specific subject, and can be thought of as mini-applications w
 of the standard file types within the framework are supported, like controllers, models, views, config files, helpers,
 language files, etc. Modules may contain as few, or as many, of these as you like.
 
-.. contents:: Page Contents
+.. contents::
+    :local:
+    :depth: 2
 
 ==========
 Namespaces
diff --git a/user_guide_src/source/general/routing.rst b/user_guide_src/source/general/routing.rst
@@ -2,7 +2,9 @@
 URI Routing
 ###########
 
-.. contents:: Page Contents
+.. contents::
+    :local:
+    :depth: 2
 
 Typically there is a one-to-one relationship between a URL string and its corresponding
 controller class/method. The segments in a URI normally follow this pattern::
diff --git a/user_guide_src/source/general/view_parser.rst b/user_guide_src/source/general/view_parser.rst
@@ -2,6 +2,10 @@
 View Parser
 ###########
 
+.. contents::
+    :local:
+    :depth: 2
+
 The View Parser can perform simple text substitution for
 pseudo-variables contained within your view files.
 It can parse simple variables or variable tag pairs.
diff --git a/user_guide_src/source/general/view_renderer.rst b/user_guide_src/source/general/view_renderer.rst
@@ -2,6 +2,10 @@
 View Renderer
 #############
 
+.. contents::
+    :local:
+    :depth: 2
+
 The ``view()`` function is a convenience function that grabs an instance of the
 ``renderer`` service, sets the data, and renders the view. While this is often
 exactly what you want, you may find times where you want to work with it more directly.
diff --git a/user_guide_src/source/general/views.rst b/user_guide_src/source/general/views.rst
@@ -2,6 +2,10 @@
 Views
 #####
 
+.. contents::
+    :local:
+    :depth: 2
+
 A view is simply a web page, or a page fragment, like a header, footer, sidebar, etc. In fact,
 views can flexibly be embedded within other views (within other views, etc.) if you need
 this type of hierarchy.
diff --git a/user_guide_src/source/installation/downloads.rst b/user_guide_src/source/installation/downloads.rst
@@ -2,17 +2,14 @@
 Downloading CodeIgniter
 #######################
 
--  `CodeIgniter v4.0.0-dev (Upcoming version) <https://codeload.github.com/bcit-ci/CodeIgniter4/zip/develop>`_
-
-******
-GitHub
-******
-
 `Git <http://git-scm.com/about>`_ is a distributed version control system.
 
 Public Git access is available at `GitHub <https://github.com/bcit-ci/CodeIgniter4>`_.
 Please note that while every effort is made to keep this code base
 functional, we cannot guarantee the functionality of code taken from
 the develop branch.
 
-Stable versions are also available via `GitHub Releases <https://github.com/bcit-ci/CodeIgniter4/releases>`_.
+Stable versions are available via `GitHub Releases <https://github.com/bcit-ci/CodeIgniter4/releases>`_.
+
+You can also download a zip of the `development branch <https://codeload.github.com/bcit-ci/CodeIgniter4/zip/develop>`_,
+i.e. the upcoming version.
diff --git a/user_guide_src/source/libraries/api_responses.rst b/user_guide_src/source/libraries/api_responses.rst
@@ -7,8 +7,9 @@ single page application, or as a standalone product. CodeIgniter provides an API
 used with any controller to make common response types simple, with no need to remember which HTTP status code
 should be returned for which response types.
 
-.. contents:: Page Contents
-	:local:
+.. contents::
+    :local:
+    :depth: 2
 
 *************
 Example Usage
diff --git a/user_guide_src/source/libraries/benchmark.rst b/user_guide_src/source/libraries/benchmark.rst
@@ -10,8 +10,9 @@ performance and memory statistics to help you decide which version is the best.
 The Timer class is always active, being started from the moment the framework is invoked until right before
 sending the output to the user, enabling a very accurate timing of the entire system execution.
 
-.. contents:: Page Contents
-	:local:
+.. contents::
+    :local:
+    :depth: 2
 
 ===============
 Using the Timer
diff --git a/user_guide_src/source/libraries/caching.rst b/user_guide_src/source/libraries/caching.rst
@@ -7,8 +7,9 @@ fast and dynamic caching. All but file-based caching require specific
 server requirements, and a Fatal Exception will be thrown if server
 requirements are not met.
 
-.. contents:: Page Contents
-	:local:
+.. contents::
+    :local:
+    :depth: 2
 
 *************
 Example Usage
diff --git a/user_guide_src/source/libraries/cli.rst b/user_guide_src/source/libraries/cli.rst
@@ -10,7 +10,9 @@ CodeIgniter's CLI library makes creating interactive command-line scripts simple
 * Showing progress bars during long tasks
 * Wrapping long text lines to fit the window.
 
-.. contents:: Page Contents
+.. contents::
+    :local:
+    :depth: 2
 
 Initializing the Class
 ======================
diff --git a/user_guide_src/source/libraries/curlrequest.rst b/user_guide_src/source/libraries/curlrequest.rst
@@ -6,6 +6,10 @@ The ``CURLRequest`` class is a lightweight HTTP client based on CURL that allows
 web sites and servers. It can be used to get the contents of a Google search, retrieve a web page or image,
 or communicate with an API, among many other things.
 
+.. contents::
+    :local:
+    :depth: 2
+
 This class is modelled after the `Guzzle HTTP Client <http://docs.guzzlephp.org/en/latest/>`_ library since
 it is one of the more widely used libraries. Where possible, the syntax has been kept the same so that if
 your application needs something a little more powerful than what this library provides, you will have
diff --git a/user_guide_src/source/libraries/email.rst b/user_guide_src/source/libraries/email.rst
@@ -17,7 +17,8 @@ CodeIgniter's robust Email Class supports the following features:
 -  Email Debugging tools
 
 .. contents::
-  :local:
+    :local:
+    :depth: 2
 
 .. raw:: html
 
diff --git a/user_guide_src/source/libraries/files.rst b/user_guide_src/source/libraries/files.rst
@@ -6,8 +6,9 @@ CodeIgniter provides a File class that wraps the `SplFileInfo <http://php.net/ma
 and provides some additional convenience methods. This class is the base class for :doc:`uploaded files </libraries/uploaded_files>`
 and :doc:`images </libraries/images>`.
 
-.. contents:: Page Contents
+.. contents::
     :local:
+    :depth: 2
 
 Getting a File instance
 =======================
diff --git a/user_guide_src/source/libraries/honeypot.rst b/user_guide_src/source/libraries/honeypot.rst
@@ -7,7 +7,9 @@ If it's enabled in ``Application\Config\Filters.php`` file. This is done by atta
 and this form field is hidden from human but accessible to Bot. When data is entered into the field it's 
 assumed the request is coming from a Bot, then an execption is thrown.
 
-.. contents:: Page Contents
+.. contents::
+    :local:
+    :depth: 2
 
 Enabling Honeypot
 =====================
diff --git a/user_guide_src/source/libraries/images.rst b/user_guide_src/source/libraries/images.rst
@@ -15,6 +15,7 @@ The following image libraries are supported: GD/GD2, and ImageMagick.
 
 .. contents::
     :local:
+    :depth: 2
 
 **********************
 Initializing the Class
diff --git a/user_guide_src/source/libraries/incomingrequest.rst b/user_guide_src/source/libraries/incomingrequest.rst
@@ -6,7 +6,9 @@ The IncomingRequest class provides an object-oriented representation of an HTTP
 It extends from, and has access to all the methods of the :doc:`Request </libraries/request>` and :doc:`Message </libraries/message>`
 classes, in addition to the methods listed below.
 
-.. contents:: Page Contents
+.. contents::
+    :local:
+    :depth: 2
 
 Accessing the Request
 =====================
diff --git a/user_guide_src/source/libraries/localization.rst b/user_guide_src/source/libraries/localization.rst
@@ -4,6 +4,7 @@ Localization
 
 .. contents::
     :local:
+    :depth: 2
 
 ********************
 Working With Locales
diff --git a/user_guide_src/source/libraries/response.rst b/user_guide_src/source/libraries/response.rst
@@ -5,7 +5,9 @@ HTTP Responses
 The Response class extends the :doc:`HTTP Message Class </libraries/message>` with methods only appropriate for
 a server responding to the client that called it.
 
-.. contents:: Page Contents
+.. contents::
+    :local:
+    :depth: 2
 
 Working with the Response
 =========================
diff --git a/user_guide_src/source/libraries/security.rst b/user_guide_src/source/libraries/security.rst
@@ -4,8 +4,9 @@ Security Class
 
 The Security Class contains methods that help protect your site against Cross-Site Request Forgery attacks.
 
-.. contents:: Page Contents
-	:local:
+.. contents::
+    :local:
+    :depth: 2
 
 *******************
 Loading the Library
diff --git a/user_guide_src/source/libraries/sessions.rst b/user_guide_src/source/libraries/sessions.rst
diff --git a/user_guide_src/source/libraries/throttler.rst b/user_guide_src/source/libraries/throttler.rst
diff --git a/user_guide_src/source/libraries/time.rst b/user_guide_src/source/libraries/time.rst
diff --git a/user_guide_src/source/libraries/uploaded_files.rst b/user_guide_src/source/libraries/uploaded_files.rst
diff --git a/user_guide_src/source/libraries/uri.rst b/user_guide_src/source/libraries/uri.rst
diff --git a/user_guide_src/source/libraries/user_agent.rst b/user_guide_src/source/libraries/user_agent.rst
diff --git a/user_guide_src/source/libraries/validation.rst b/user_guide_src/source/libraries/validation.rst
