Merge remote-tracking branch 'upstream/develop' into 4.4

Author: kenjis

user_guide_src/source/dbmgmt/forge.rst

@@ -86,6 +86,8 @@ There are several things you may wish to do when creating tables. Add
 fields, add keys to the table, alter columns. CodeIgniter provides a
 mechanism for this.
 
+.. _adding-fields:
+
 Adding Fields
 =============
 
@@ -116,7 +118,7 @@ After the fields have been defined, they can be added using
 $forge->addField()
 ------------------
 
-The add fields method will accept the above array.
+The ``addField()`` method will accept the above array.
 
 .. _forge-addfield-default-value-rawsql:
 
@@ -249,8 +251,8 @@ $forge->addColumn()
 -------------------
 
 The ``addColumn()`` method is used to modify an existing table. It
-accepts the same field array as above, and can be used for an unlimited
-number of additional fields.
+accepts the same field array as :ref:`Creating Tables <adding-fields>`, and can
+be used to add additional fields.
 
 .. literalinclude:: forge/022.php
 
@@ -348,15 +350,15 @@ Class Reference
         :returns:    true on success, false on failure
         :rtype:    bool
 
-        Adds a column to a table. Usage:  See `Adding a Field to a Table`_.
+        Adds a column to an existing table. Usage: See `Adding a Field to a Table`_.
 
     .. php:method:: addField($field)
 
         :param    array    $field: Field definition to add
-        :returns:    \CodeIgniter\Database\Forge instance (method chaining)
-        :rtype:    \CodeIgniter\Database\Forge
+        :returns:    ``\CodeIgniter\Database\Forge`` instance (method chaining)
+        :rtype:    ``\CodeIgniter\Database\Forge``
 
-        Adds a field to the set that will be used to create a table. Usage:  See `Adding Fields`_.
+        Adds a field to the set that will be used to create a table. Usage: See `Adding Fields`_.
 
     .. php:method:: addForeignKey($fieldName, $tableName, $tableField[, $onUpdate = '', $onDelete = '', $fkName = ''])
 
@@ -366,10 +368,10 @@ Class Reference
         :param    string    $onUpdate: Desired action for the "on update"
         :param    string    $onDelete: Desired action for the "on delete"
         :param    string    $fkName: Name of foreign key. This does not work with SQLite3
-        :returns:    \CodeIgniter\Database\Forge instance (method chaining)
-        :rtype:    \CodeIgniter\Database\Forge
+        :returns:    ``\CodeIgniter\Database\Forge`` instance (method chaining)
+        :rtype:    ``\CodeIgniter\Database\Forge``
 
-        Adds a foreign key to the set that will be used to create a table. Usage:  See `Adding Foreign Keys`_.
+        Adds a foreign key to the set that will be used to create a table. Usage: See `Adding Foreign Keys`_.
 
         .. note:: ``$fkName`` can be used since v4.3.0.
 
@@ -379,32 +381,32 @@ Class Reference
         :param    bool    $primary: Set to true if it should be a primary key or a regular one
         :param    bool    $unique: Set to true if it should be a unique key or a regular one
         :param    string    $keyName: Name of key to be added
-        :returns:    \CodeIgniter\Database\Forge instance (method chaining)
-        :rtype:    \CodeIgniter\Database\Forge
+        :returns:    ``\CodeIgniter\Database\Forge`` instance (method chaining)
+        :rtype:    ``\CodeIgniter\Database\Forge``
 
-        Adds a key to the set that will be used to create a table. Usage:  See `Adding Keys`_.
+        Adds a key to the set that will be used to create a table. Usage: See `Adding Keys`_.
 
         .. note:: ``$keyName`` can be used since v4.3.0.
 
     .. php:method:: addPrimaryKey($key[, $keyName = ''])
 
         :param    mixed    $key: Name of a key field or an array of fields
         :param    string    $keyName: Name of key to be added
-        :returns:    \CodeIgniter\Database\Forge instance (method chaining)
-        :rtype:    \CodeIgniter\Database\Forge
+        :returns:    ``\CodeIgniter\Database\Forge`` instance (method chaining)
+        :rtype:    ``\CodeIgniter\Database\Forge``
 
-        Adds a primary key to the set that will be used to create a table. Usage:  See `Adding Keys`_.
+        Adds a primary key to the set that will be used to create a table. Usage: See `Adding Keys`_.
 
         .. note:: ``$keyName`` can be used since v4.3.0.
 
     .. php:method:: addUniqueKey($key[, $keyName = ''])
 
         :param    mixed    $key: Name of a key field or an array of fields
         :param    string    $keyName: Name of key to be added
-        :returns:    \CodeIgniter\Database\Forge instance (method chaining)
-        :rtype:    \CodeIgniter\Database\Forge
+        :returns:    ``\CodeIgniter\Database\Forge`` instance (method chaining)
+        :rtype:    ``\CodeIgniter\Database\Forge``
 
-        Adds a unique key to the set that will be used to create a table. Usage:  See `Adding Keys`_.
+        Adds a unique key to the set that will be used to create a table. Usage: See `Adding Keys`_.
 
         .. note:: ``$keyName`` can be used since v4.3.0.
 
@@ -415,7 +417,7 @@ Class Reference
         :returns:    true on success, false on failure
         :rtype:    bool
 
-        Creates a new database. Usage:  See `Creating and Dropping Databases`_.
+        Creates a new database. Usage: See `Creating and Dropping Databases`_.
 
     .. php:method:: createTable($table[, $if_not_exists = false[, array $attributes = []]])
 
@@ -425,7 +427,7 @@ Class Reference
         :returns:  Query object on success, false on failure
         :rtype:    mixed
 
-        Creates a new table. Usage:  See `Creating a Table`_.
+        Creates a new table. Usage: See `Creating a Table`_.
 
     .. php:method:: dropColumn($table, $column_name)
 
@@ -434,15 +436,15 @@ Class Reference
         :returns:    true on success, false on failure
         :rtype:    bool
 
-        Drops single or multiple columns from a table. Usage:  See `Dropping Fields From a Table`_.
+        Drops single or multiple columns from a table. Usage: See `Dropping Fields From a Table`_.
 
     .. php:method:: dropDatabase($dbName)
 
         :param    string    $dbName: Name of the database to drop
         :returns:    true on success, false on failure
         :rtype:    bool
 
-        Drops a database. Usage:  See `Creating and Dropping Databases`_.
+        Drops a database. Usage: See `Creating and Dropping Databases`_.
 
     .. php:method:: dropKey($table, $keyName[, $prefixKeyName = true])
 
@@ -474,7 +476,7 @@ Class Reference
         :returns:    true on success, false on failure
         :rtype:    bool
 
-        Drops a table. Usage:  See `Dropping a Table`_.
+        Drops a table. Usage: See `Dropping a Table`_.
 
     .. php:method:: processIndexes($table)
 
@@ -495,7 +497,7 @@ Class Reference
         :returns:    true on success, false on failure
         :rtype:    bool
 
-        Modifies a table column. Usage:  See `Modifying a Field in a Table`_.
+        Modifies a table column. Usage: See `Modifying a Field in a Table`_.
 
     .. php:method:: renameTable($table_name, $new_table_name)
 
@@ -504,4 +506,4 @@ Class Reference
         :returns:  Query object on success, false on failure
         :rtype:    mixed
 
-        Renames a table. Usage:  See `Renaming a Table`_.
+        Renames a table. Usage: See `Renaming a Table`_.

user_guide_src/source/installation/repositories.rst

@@ -16,24 +16,31 @@ There are several development repositories, of interest to potential contributor
 +------------------+--------------+-----------------------------------------------------------------+
 | Repository       | Audience     | Description                                                     |
 +==================+==============+=================================================================+
-| CodeIgniter4     | contributors | Project codebase, including tests & user guide sources          |
+| CodeIgniter4_    | contributors | Project codebase, including tests & user guide sources          |
 +------------------+--------------+-----------------------------------------------------------------+
-| translations     | developers   | System message translations                                     |
+| translations_    | developers   | System message translations                                     |
 +------------------+--------------+-----------------------------------------------------------------+
 | coding-standard_ | contributors | Coding style conventions & rules                                |
 +------------------+--------------+-----------------------------------------------------------------+
-| devkit           | developers   | Development toolkit for CodeIgniter libraries and projects      |
+| devkit_          | developers   | Development toolkit for CodeIgniter libraries and projects      |
 +------------------+--------------+-----------------------------------------------------------------+
-| settings         | developers   | Settings Library for CodeIgniter 4                              |
+| settings_        | developers   | Settings Library for CodeIgniter 4                              |
 +------------------+--------------+-----------------------------------------------------------------+
-| shield           | developers   | Authentication and Authorization Library for CodeIgniter 4      |
+| shield_          | developers   | Authentication and Authorization Library for CodeIgniter 4      |
 +------------------+--------------+-----------------------------------------------------------------+
-| tasks            | developers   | Task Scheduler for CodeIgniter 4                                |
+| tasks_           | developers   | Task Scheduler for CodeIgniter 4                                |
 +------------------+--------------+-----------------------------------------------------------------+
-| cache            | developers   | PSR-6 and PSR-16 Cache Adapters for CodeIgniter 4               |
+| cache_           | developers   | PSR-6 and PSR-16 Cache Adapters for CodeIgniter 4               |
 +------------------+--------------+-----------------------------------------------------------------+
 
+.. _CodeIgniter4: https://github.com/codeigniter4/CodeIgniter4
+.. _translations: https://github.com/codeigniter4/translations
 .. _coding-standard: https://github.com/CodeIgniter/coding-standard
+.. _devkit: https://github.com/codeigniter4/devkit
+.. _settings: https://github.com/codeigniter4/settings
+.. _shield: https://codeigniter4.github.io/shield
+.. _tasks: https://github.com/codeigniter4/tasks
+.. _cache: https://github.com/codeigniter4/cache
 
 There are also several deployment repositories, referenced in the installation directions.
 The deployment repositories are built automatically when a new version is released, and they
@@ -42,14 +49,18 @@ are not directly contributed to.
 +------------------+--------------+-----------------------------------------------------------------+
 | Repository       | Audience     | Description                                                     |
 +==================+==============+=================================================================+
-| framework        | developers   | Released versions of the framework                              |
+| framework_       | developers   | Released versions of the framework                              |
 +------------------+--------------+-----------------------------------------------------------------+
-| appstarter       | developers   | Starter project (app/public/writable).                          |
+| appstarter_      | developers   | Starter project (app/public/writable).                          |
 |                  |              | Dependent on "framework"                                        |
 +------------------+--------------+-----------------------------------------------------------------+
-| userguide        | anyone       | Pre-built user guide                                            |
+| userguide_       | anyone       | Pre-built user guide                                            |
 +------------------+--------------+-----------------------------------------------------------------+
 
+.. _framework: https://github.com/codeigniter4/framework
+.. _appstarter: https://github.com/codeigniter4/appstarter
+.. _userguide: https://github.com/codeigniter4/userguide
+
 In all the above, the latest version of a repository can be downloaded
 by selecting the "releases" link in the secondary navbar inside
 the "Code" tab of its GitHub repository page. The current (in development) version of each can
@@ -83,9 +94,12 @@ but which showcase it or make it easier to work with!
 +------------------+--------------+-----------------------------------------------------------------+
 | Repository       | Audience     | Description                                                     |
 +==================+==============+=================================================================+
-| website          | developers   | The codeigniter.com website, written in CodeIgniter 4           |
+| website_         | developers   | The codeigniter.com website, written in CodeIgniter 4           |
 +------------------+--------------+-----------------------------------------------------------------+
-| playground       | developers   | Basic code examples in project form. Still growing.             |
+| playground_      | developers   | Basic code examples in project form. Still growing.             |
 +------------------+--------------+-----------------------------------------------------------------+
 
+.. _website: https://github.com/codeigniter4projects/website
+.. _playground: https://github.com/codeigniter4projects/playground
+
 These are not composer-installable repositories.