Skip to content

Commit 8ea6f22

Browse files
authored
Merge pull request #1235 from jim-parry/doc/fixes
Doc/fixes
2 parents 5a66516 + e44b60c commit 8ea6f22

49 files changed

Lines changed: 171 additions & 99 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

user_guide_src/source/concepts/http.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,18 +12,18 @@ how to work with the requests and responses within CodeIgniter.
1212
What is HTTP?
1313
=============
1414

15-
HTTP is simply a text-based language that allows two machines to talk to each other. When a browser
15+
HTTP is simply a text-based convention that allows two machines to talk to each other. When a browser
1616
requests a page, it asks the server if it can get the page. The server then prepares the page and sends
17-
response back to the browser that asked for it. That's pretty much it. Obviously, there are some complexities
17+
a response back to the browser that asked for it. That's pretty much it. Obviously, there are some complexities
1818
that you can use, but the basics are really pretty simple.
1919

20-
HTTP is the term used to describe that language. It stands for HyperText Transfer Protocol. Your goal when
20+
HTTP is the term used to describe that exchange convention. It stands for HyperText Transfer Protocol. Your goal when
2121
you develop web applications is to always understand what the browser is requesting, and be able to
2222
respond appropriately.
2323

2424
The Request
2525
-----------
26-
Whenever a client makes a request (a web browser, smartphone app, etc), it is sending a small text message
26+
Whenever a client (a web browser, smartphone app, etc) makes a request, it sends a small text message
2727
to the server and waits for a response.
2828

2929
The request would look something like this::
@@ -67,7 +67,7 @@ Working with Requests and Responses
6767
-----------------------------------
6868

6969
While PHP provides ways to interact with the request and response headers, CodeIgniter, like most frameworks,
70-
abstract them so that you have a consistent, simple interface to them. The :doc:`IncomingRequest class </libraries/incomingrequest>`
70+
abstracts them so that you have a consistent, simple interface to them. The :doc:`IncomingRequest class </libraries/incomingrequest>`
7171
is an object-oriented representation of the HTTP request. It provides everything you need::
7272

7373
use CodeIgniter\HTTP\IncomingRequest;

user_guide_src/source/concepts/mvc.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,11 +73,11 @@ then determine what to do with it. This often involves passing the data to a mod
7373
the model that is then passed on to the view to be displayed. This also includes loading up other utility classes,
7474
if needed, to handle specialized tasks that is outside of the purview of the model.
7575

76-
The other responsibility of the controller is to handles everything that pertains to HTTP requests - redirects,
76+
The other responsibility of the controller is to handle everything that pertains to HTTP requests - redirects,
7777
authentication, web safety, encoding, etc. In short, the controller is where you make sure that people are allowed to
7878
be there, and they get the data they need in a format they can use.
7979

8080
Controllers are typically stored in **/application/Controllers**, though they can use a namespace to be grouped however
8181
you need.
8282

83-
:doc:`Find out more about controllers </general/controllers>`
83+
:doc:`Find out more about controllers </general/controllers>`

user_guide_src/source/concepts/services.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22
Services
33
########
44

5+
.. contents::
6+
:local:
7+
:depth: 2
8+
59
Introduction
610
============
711

user_guide_src/source/concepts/structure.rst

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -74,14 +74,11 @@ production servers.
7474

7575
docs
7676
----
77-
This directory holds the CodeIgniter documentation. The ``user_guide`` subfolder contains a local copy of the
78-
User Guide, and the ``api_docs`` subfolder contains a local copy of the CodeIgniter components API reference.
77+
This directory holds a local copy of the CodeIgniter4
78+
User Guide.
7979

8080
Modifying Directory Locations
8181
-----------------------------
8282

83-
If you've relocated any of the main directories, you can let the application
84-
know the new location within the main ``index.php`` file.
85-
86-
Starting around line 50, you will find three variables that hold the location to the **application**,
87-
**system**, and **writable** directories. These paths are relative to **index.php**.
83+
If you've relocated any of the main directories, you can change the configuration
84+
settings inside ``application/Config/Paths``.

user_guide_src/source/database/configuration.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22
Database Configuration
33
######################
44

5+
.. contents::
6+
:local:
7+
:depth: 2
8+
59
CodeIgniter has a config file that lets you store your database
610
connection values (username, password, database name, etc.). The config
711
file is located at application/Config/Database.php. You can also set

user_guide_src/source/database/entities.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,9 @@ CodeIgniter supports Entity classes as a first-class citizen in it's database la
66
them completely optional to use. They are commonly used as part of the Repository pattern, but can
77
be used directly with the :doc:`Model </database/model>` if that fits your needs better.
88

9-
.. contents:: Page Contents
10-
:local:
9+
.. contents::
10+
:local:
11+
:depth: 2
1112

1213
Entity Usage
1314
============

user_guide_src/source/database/forge.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,9 @@ Database Forge Class
55
The Database Forge Class contains methods that help you manage your
66
database.
77

8-
.. contents:: Table of Contents
9-
:depth: 3
8+
.. contents::
9+
:local:
10+
:depth: 2
1011

1112
****************************
1213
Initializing the Forge Class

user_guide_src/source/database/metadata.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22
Database Metadata
33
#################
44

5+
.. contents::
6+
:local:
7+
:depth: 2
8+
59
**************
610
Table MetaData
711
**************

user_guide_src/source/database/queries.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22
Queries
33
#######
44

5-
.. contents:: Table of Contents
5+
.. contents::
6+
:local:
7+
:depth: 2
68

79
************
810
Query Basics

user_guide_src/source/database/query_builder.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ system.
1717

1818
.. contents::
1919
:local:
20-
:depth: 1
20+
:depth: 2
2121

2222
*************************
2323
Loading the Query Builder

0 commit comments

Comments
 (0)