Fix user guide errors

user_guide_src/source/changelog.rst

@@ -2,66 +2,104 @@
 Change Log
 ##########
 
-Version 4.0-Pre-Alpha1
-======================
+Version |version|
+=================
 
 **Rewrite of the CodeIgniter framework**
 
 Release Date: Not Released
 
 New core classes:
-
     - CodeIgniter (bootstrap)
     - Common (shared functions)
     - ComposerScripts (integrate third party tools)
     - Controller (base controller)
     - Model (base model)
+    - Entity (entity encapsulation)
 
 New packages:
-
-    - Autoloader \\ AutoLoader, FileLocator
-    - CLI \\ CLI
-    - Commands \\ MigrationsCommand
-    - Config \\ AutoloadConfig, BaseConfig, DotEnv, Routes
+    - API 
+        - \\ ResponseTrait
+    - Autoloader 
+        - \\ AutoLoader, FileLocator
+    - CLI 
+        - \\ BaseCommand, CLI, CommandRunner, Console
+    - Cache 
+        - \\ CacheFactory, CacheInterface
+        - \\ Handlers ... Dummy, File, Memcached, Predis, Redis, Wincache
+    - Commands 
+        - \\ Help, ListCommands
+        - \\ Database \\ CreateMigration, MigrateCurrent, MigrateLatest, MigrateRefresh,
+          MigrateRollback, MigrateStatus, MigrateVersion, Seed
+        - \\ Server \\ Serve
+        - \\ Sessions \\ CreateMigration
+        - \\ Utilities \\ Namespaces, Routes
+    - Config 
+        -   \\ AutoloadConfig, BaseConfig, BaseService, Config, DotEnv, ForeignCharacters, 
+            Routes, Services, View
     - Database
-
-        -   \\ BaseBuilder, BaseConnection, BaseResult, BaseUtils, Config,
-            ConnectionInterface, Database, Forge, Migration, MigrationRunner, Query,
+        -   \\ BaseBuilder, BaseConnection, BasePreparedQuery, BaseResult, BaseUtils, Config,
+            ConnectionInterface, Database, Forge, Migration, MigrationRunner, PreparedQueryInterface, Query,
             QueryInterface, ResultInterface, Seeder
-        -   \\ MySQLi \\ Builder, Connection, Forge, Result
-        -   \\ Postgre \\ Builder, Connection, Forge, Result, Utils
-
+        -   \\ MySQLi \\ Builder, Connection, Forge, PreparedQuery, Result
+        -   \\ Postgre \\ Builder, Connection, Forge, PreparedQuery, Result, Utils
+        -   \\ SQLite3 \\ Builder, Connection, Forge, PreparedQuery, Result, Utils
     - Debug
-
-        - \\ CustomExceptions, Exceptions, Iterator, Timer, Toolbar
-        - Kint \\ Kint **third party**
-
+        - \\ Exceptions, Iterator, Timer, Toolbar
+        - \\ Toolbar \\ Collectors...
+    - Email
+        - \\ Email
+    - Events
+        - \\ Events
+    - Files
+        - \\ File
+    - Filters
+        - \\ FilterInterface, Filters  
+    - Format
+        - \\ FormatterInterface, JSONFormatter, XMLFormatter
     - HTTP
-
         -   \\ CLIRequest, CURLRequest, ContentSecurityPolicy, Header,
             IncomingRequest, Message, Negotiate, Request, RequestInterface,
-            Response, ResponseInterface, URI
+            Response, ResponseInterface, URI, UserAgent
         -   \\ Files \\ FileCollection, UploadedFile, UploadedFileInterface
-
-    - Helpers ... uri
-    - Events \\ Events
+    - Helpers 
+        -   ... array, cookie, date, filesystem, form, html, inflector, number,
+            security, text, url
+    - Honeypot 
+        - \\ Honeypot
+    - I18n
+        - \\ Time, TimeDifference
+    - Images
+        - \\ Image, ImageHandlerInterface
+        - \\ Handlers ... Base, GD, ImageMagick
+    - Language
+        - \\ Language
     - Log
-
         -   Logger, LoggerAwareTrait
-        -   \\ Handlers \\  BaseHandler, ChromeLoggerHandler, FileHandler, HandlerInterface
-        -   Psr \\ Log **third party**
-
-    - Router \\ RouteCollection, RouteCollectionInterface, Router, RouterInterface
-    - Security \\ Security
+        -   \\ Handlers ...  Base, ChromeLogger, File, HandlerInterface
+    - Pager
+        - \\ Pager, PagerInterface, PagerRenderer
+    - Router 
+        - \\ RouteCollection, RouteCollectionInterface, Router, RouterInterface
+    - Security 
+        - \\ Security
     - Session
-
         -   \\ Session, SessionInterface
-        -   \\ Handlers \\ BaseHandler, FileHandler, MemcachedHandler, RedisHandler
-
-    - Test \\ CIDatabaseTestCase, CIUnitTestCase, ReflectionHelper
+        -   \\ Handlers ... Base, File, Memcached, Redis
+    - Test 
+        - \\ CIDatabaseTestCase, CIUnitTestCase, FeatureResponse, FeatureTestCase, ReflectionHelper
+        - \\ Filters \\ CITestStreamFilter
+    - ThirdParty (bundled)
+        - \\ Kint (for \\Debug)
+        - \\ PSR \\ Log (for \\Log)
+        - \\ ZendEscaper \\ Escaper (for \\View)
+    - Throttle
+        - \\ Throttler, ThrottlerInterface
+    - Typography
+        - \\ Typography
+    - Validation
+        - \\ CreditCardRules, FileRules, FormatRules, Rules, Validation, ValidationInterface
     - View
-
-        -   Zend \\ Escaper, Exception \\ ... **third party**
-        -   RendererInterface, View
+        -   \\ Cell, Filters, Parser, Plugins, RendererInterface, View
 
 User Guide adapted or rewritten.

user_guide_src/source/conf.py

@@ -48,9 +48,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '4.0.0'
+version = '4.0-dev'
 # The full version, including alpha/beta/rc tags.
-release = '4.0.0-dev'
+release = '4.0.0-not'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

user_guide_src/source/general/configuration.rst

@@ -170,6 +170,7 @@ held instead::
 then the result would be the same as above.
 
 .. _registrars:
+
 Registrars
 ==========
 
@@ -222,4 +223,3 @@ by treating `RegionalSalesModel` as a "registrar". The resulting configuration p
 
     $target   = 45;
     $campaign = "Winter Wonderland";
-

user_guide_src/source/general/modules.rst

@@ -68,7 +68,7 @@ configured to make integrating modules into your applications simpler by automat
 file types, including:
 
 - :doc:`Events </general/events>`
-- :ref:`registrars`
+- :doc:`Registrars </general/configuration>`
 - :doc:`Route files </general/routing>`
 - :doc:`Services </concepts/services>`
 

user_guide_src/source/general/view_renderer.rst

@@ -101,6 +101,7 @@ Class Reference
 .. php:class:: CodeIgniter\\View\\View
 
 	.. php:method:: render($view[, $options[, $saveData=false]]])
+                :noindex:
 
 		:param  string  $view: File name of the view source
 		:param  array   $options: Array of options, as key/value pairs
@@ -113,6 +114,7 @@ Class Reference
 			echo $view->render('myview');
 
 	.. php:method:: renderString($view[, $options[, $saveData=false]]])
+                :noindex:
 
 		:param  string  $view: Contents of the view to render, for instance content retrieved from a database
 		:param  array   $options: Array of options, as key/value pairs
@@ -130,6 +132,7 @@ Class Reference
 		appropriately!
 
 	.. php:method:: setData([$data[, $context=null]])
+                :noindex:
 
 		:param  array   $data: Array of view data strings, as key/value pairs
 		:param  string  $context: The context to use for data escaping.
@@ -147,6 +150,7 @@ Class Reference
 		until the view is rendered.
 
 	.. php:method:: setVar($name[, $value=null[, $context=null]])
+                :noindex:
 
 		:param  string  $name: Name of the view data variable
 		:param  mixed   $value: The value of this view data

user_guide_src/source/helpers/url_helper.rst

@@ -95,7 +95,6 @@ The following functions are available:
 	viewed.
 
 	.. note:: Calling this function is the same as doing this::
-
 		base_url(uri_string());
 
 .. php:function:: previous_url([$returnObject = false])

user_guide_src/source/index.rst

@@ -2,9 +2,6 @@
 CodeIgniter4 User Guide
 #######################
 
-- :doc:`License Agreement <license>`
-- :doc:`Change Log <changelog>`
-
 .. contents::
    :local:
    :depth: 2
@@ -92,3 +89,9 @@ Testing
 	:titlesonly:
 
 	testing/index
+
+.. toctree::
+        :hidden:
+
+        license
+        changelog

user_guide_src/source/intro/psr.rst

@@ -9,7 +9,8 @@ status of our compliance with the various accepted, and some draft, proposals.
 
 **PSR-1: Basic Coding Standard**
 
-This recommendation covers basic class, method, and file-naming standards. Our :doc:`style guide </contributing/styleguide>`
+This recommendation covers basic class, method, and file-naming standards. Our 
+`style guide <https://github.com/bcit-ci/CodeIgniter4/blob/develop/contributing/styleguide.rst>_`
 meets PSR-1 and adds its own requirements on top of it.
 
 **PSR-2: Coding Style Guide**

user_guide_src/source/libraries/images.rst

@@ -14,7 +14,7 @@ actions:
 The following image libraries are supported: GD/GD2, and ImageMagick.
 
 .. contents::
-:local:
+    :local:
 
 **********************
 Initializing the Class

user_guide_src/source/libraries/incomingrequest.rst

@@ -314,8 +314,8 @@ The methods provided by the parent classes that are available are:
 	.. php:method:: getVar([$index = null[, $filter = null[, $flags = null]]])
 
 		:param  string  $index: The name of the variable/key to look for.
-		:param  int     $filter: The type of filter to apply. A list of filters can be found `here <http://php.net/manual/en/filter.filters.php>`_.
-		:param  int     $flags: Flags to apply. A list of flags can be found `here <http://php.net/manual/en/filter.filters.flags.php>`_.
+		:param  int     $filter: The type of filter to apply. A list of filters can be found `here <http://php.net/manual/en/filter.filters.php>`__.
+		:param  int     $flags: Flags to apply. A list of flags can be found `here <http://php.net/manual/en/filter.filters.flags.php>`__.
 		:returns:   $_REQUEST if no parameters supplied, otherwise the REQUEST value if found, or null if not
 		:rtype: mixed|null
 
@@ -351,8 +351,8 @@ The methods provided by the parent classes that are available are:
 	.. php:method:: getGet([$index = null[, $filter = null[, $flags = null]]])
 
 		:param  string  $index: The name of the variable/key to look for.
-		:param  int  $filter: The type of filter to apply. A list of filters can be found `here <http://php.net/manual/en/filter.filters.php>`_.
-		:param  int     $flags: Flags to apply. A list of flags can be found `here <http://php.net/manual/en/filter.filters.flags.php>`_.
+		:param  int  $filter: The type of filter to apply. A list of filters can be found `here <http://php.net/manual/en/filter.filters.php>`__.
+		:param  int     $flags: Flags to apply. A list of flags can be found `here <http://php.net/manual/en/filter.filters.flags.php>`__.
 		:returns:   $_GET if no parameters supplied, otherwise the GET value if found, or null if not
 		:rtype: mixed|null
 
@@ -361,8 +361,8 @@ The methods provided by the parent classes that are available are:
 	.. php:method:: getPost([$index = null[, $filter = null[, $flags = null]]])
 
 		:param  string  $index: The name of the variable/key to look for.
-		:param  int  $filter: The type of filter to apply. A list of filters can be found `here <http://php.net/manual/en/filter.filters.php>`_.
-		:param  int     $flags: Flags to apply. A list of flags can be found `here <http://php.net/manual/en/filter.filters.flags.php>`_.
+		:param  int  $filter: The type of filter to apply. A list of filters can be found `here <http://php.net/manual/en/filter.filters.php>`__.
+		:param  int     $flags: Flags to apply. A list of flags can be found `here <http://php.net/manual/en/filter.filters.flags.php>`__.
 		:returns:   $_POST if no parameters supplied, otherwise the POST value if found, or null if not
 		:rtype: mixed|null
 
@@ -371,8 +371,8 @@ The methods provided by the parent classes that are available are:
 	.. php:method:: getPostGet([$index = null[, $filter = null[, $flags = null]]])
 
 		:param  string  $index: The name of the variable/key to look for.
-		:param  int     $filter: The type of filter to apply. A list of filters can be found `here <http://php.net/manual/en/filter.filters.php>`_.
-		:param  int     $flags: Flags to apply. A list of flags can be found `here <http://php.net/manual/en/filter.filters.flags.php>`_.
+		:param  int     $filter: The type of filter to apply. A list of filters can be found `here <http://php.net/manual/en/filter.filters.php>`__.
+		:param  int     $flags: Flags to apply. A list of flags can be found `here <http://php.net/manual/en/filter.filters.flags.php>`__.
 		:returns:   $_POST if no parameters supplied, otherwise the POST value if found, or null if not
 		:rtype: mixed|null
 
@@ -385,8 +385,8 @@ The methods provided by the parent classes that are available are:
 	.. php:method:: getGetPost([$index = null[, $filter = null[, $flags = null]]])
 
 		:param  string  $index: The name of the variable/key to look for.
-		:param  int     $filter: The type of filter to apply. A list of filters can be found `here <http://php.net/manual/en/filter.filters.php>`_.
-		:param  int     $flags: Flags to apply. A list of flags can be found `here <http://php.net/manual/en/filter.filters.flags.php>`_.
+		:param  int     $filter: The type of filter to apply. A list of filters can be found `here <http://php.net/manual/en/filter.filters.php>`__.
+		:param  int     $flags: Flags to apply. A list of flags can be found `here <http://php.net/manual/en/filter.filters.flags.php>`__.
 		:returns:   $_POST if no parameters supplied, otherwise the POST value if found, or null if not
 		:rtype: mixed|null
 
@@ -399,8 +399,8 @@ The methods provided by the parent classes that are available are:
 	.. php:method:: getCookie([$index = null[, $filter = null[, $flags = null]]])
 
 		:param	mixed	$index: COOKIE name
-		:param  int     $filter: The type of filter to apply. A list of filters can be found `here <http://php.net/manual/en/filter.filters.php>`_.
-		:param  int     $flags: Flags to apply. A list of flags can be found `here <http://php.net/manual/en/filter.filters.flags.php>`_.
+		:param  int     $filter: The type of filter to apply. A list of filters can be found `here <http://php.net/manual/en/filter.filters.php>`__.
+		:param  int     $flags: Flags to apply. A list of flags can be found `here <http://php.net/manual/en/filter.filters.flags.php>`__.
 		:returns:	$_COOKIE if no parameters supplied, otherwise the COOKIE value if found or null if not
 		:rtype:	mixed
 
@@ -420,8 +420,8 @@ The methods provided by the parent classes that are available are:
 	.. php:method:: getServer([$index = null[, $filter = null[, $flags = null]]])
 
 		:param	mixed	$index: Value name
-		:param  int     $filter: The type of filter to apply. A list of filters can be found `here <http://php.net/manual/en/filter.filters.php>`_.
-		:param  int     $flags: Flags to apply. A list of flags can be found `here <http://php.net/manual/en/filter.filters.flags.php>`_.
+		:param  int     $filter: The type of filter to apply. A list of filters can be found `here <http://php.net/manual/en/filter.filters.php>`__.
+		:param  int     $flags: Flags to apply. A list of flags can be found `here <http://php.net/manual/en/filter.filters.flags.php>`__.
 		:returns:	$_SERVER item value if found, NULL if not
 		:rtype:	mixed
 
@@ -438,7 +438,7 @@ The methods provided by the parent classes that are available are:
 
 	.. php:method:: getUserAgent([$filter = null])
 
-		:param  int  $filter: The type of filter to apply. A list of filters can be found `here <http://php.net/manual/en/filter.filters.php>`_.
+		:param  int  $filter: The type of filter to apply. A list of filters can be found `here <http://php.net/manual/en/filter.filters.php>`__.
 		:returns:  The User Agent string, as found in the SERVER data, or null if not found.
 		:rtype: mixed
 

user_guide_src/source/libraries/message.rst

@@ -118,6 +118,7 @@ Class Reference
 			en, en-US
 
 	.. php:method:: setHeader([$name[, $value]])
+                :noindex:
 
 		:param string $name: The name of the header to set the value for.
 		:param mixed  $value: The value to set the header to.

user_guide_src/source/libraries/request.rst

@@ -73,10 +73,11 @@ Class Reference
 			echo $request->getMethod(); // Outputs: post
 
 	.. php:method:: getServer([$index = null[, $filter = null[, $flags = null]]])
+                :noindex:
 
 		:param	mixed	$index: Value name
-		:param  int     $filter: The type of filter to apply. A list of filters can be found `here <http://php.net/manual/en/filter.filters.php>`_.
-		:param  int     $flags: Flags to apply. A list of flags can be found `here <http://php.net/manual/en/filter.filters.flags.php>`_.
+		:param  int     $filter: The type of filter to apply. A list of filters can be found `here <http://php.net/manual/en/filter.filters.php>`__.
+		:param  int     $flags: Flags to apply. A list of flags can be found `here <http://php.net/manual/en/filter.filters.flags.php>`__.
 		:returns:	$_SERVER item value if found, NULL if not
 		:rtype:	mixed
 

user_guide_src/source/libraries/response.rst

@@ -347,6 +347,7 @@ The methods provided by the parent class that are available are:
 			$response->setLastModified(DateTime::createFromFormat('u', $time));
 
 	.. php:method:: send()
+                :noindex:
 
 		:returns: The current response instance.
 		:rtype: CodeIgniter\HTTP\Response

user_guide_src/source/libraries/sessions.rst

@@ -176,8 +176,8 @@ you need it.
 You can simply assign data to the ``$_SESSION`` array, as with any other
 variable. Or as a property of ``$session``.
 
-userdata method is deprecated.
- That however passing an array containing your new sessiondata to the
+The former userdata method is deprecated,
+but you can pass an array containing your new session data to the
 ``set()`` method::
 
 	$session->set($array);
@@ -193,7 +193,7 @@ an example::
 
 	$session->set($newdata);
 
-If you want to add sessiondata one value at a time, ``set()`` also
+If you want to add session data one value at a time, ``set()`` also
 supports this syntax::
 
 	$session->set('some_name', 'some_value');