Merge pull request #5758 from kenjis/fix-docs-tutorial

docs: small fixes in tutorial

Author: kenjis

user_guide_src/source/tutorial/create_news_items.rst

@@ -1,4 +1,4 @@
-Create news items
+Create News Items
 #################
 
 You now know how you can read data from a database using CodeIgniter, but
@@ -7,7 +7,7 @@ you'll expand your news controller and model created earlier to include
 this functionality.
 
 Enable CSRF Filter
-------------------
+******************
 
 Before creating a form, let's enable the CSRF protection.
 
@@ -22,16 +22,14 @@ You can read more about the CSRF protection in :doc:`Security </libraries/securi
     because auto-routing permits any HTTP method to access a controller.
     Accessing the controller with a method you don't expect could bypass the filter.
 
-Create a form
--------------
+Create a Form
+*************
 
 To input data into the database, you need to create a form where you can
 input the information to be stored. This means you'll be needing a form
 with two fields, one for the title and one for the text. You'll derive
 the slug from our title in the model. Create a new view at
-**app/Views/news/create.php**.
-
-::
+**app/Views/news/create.php**::
 
     <h2><?= esc($title) ?></h2>
 
@@ -89,14 +87,12 @@ slug, perfect for creating URIs.
 After this, a view is loaded to display a success message. Create a view at
 **app/Views/news/success.php** and write a success message.
 
-This could be as simple as:
-
-::
+This could be as simple as::
 
     News item created successfully.
 
 Model Updating
--------------------------------------------------------
+**************
 
 The only thing that remains is ensuring that your model is set up
 to allow data to be saved properly. The ``save()`` method that was
@@ -119,7 +115,7 @@ This helps protect against Mass Assignment Vulnerabilities. If your model is
 handling your timestamps, you would also leave those out.
 
 Routing
--------------------------------------------------------
+*******
 
 Before you can start adding news items into your CodeIgniter application
 you have to add an extra rule to **app/Config/Routes.php** file. Make sure your
@@ -144,7 +140,7 @@ Add some news and check out the different pages you made.
     :width: 45%
 
 Congratulations
--------------------------------------------------------
+***************
 
 You just completed your first CodeIgniter4 application!
 

user_guide_src/source/tutorial/index.rst

@@ -22,7 +22,7 @@ This tutorial will primarily focus on:
 -  Model-View-Controller basics
 -  Routing basics
 -  Form validation
--  Performing basic database queries using CodeIgniter's "Query Builder"
+-  Performing basic database queries using CodeIgniter's Model
 
 The entire tutorial is split up over several pages, each explaining a
 small part of the functionality of the CodeIgniter framework. You'll go
@@ -55,9 +55,7 @@ Getting Up and Running
 
 You can download a release manually from the site, but for this tutorial we will
 use the recommended way and install the AppStarter package through Composer.
-From your command line type the following:
-
-::
+From your command line type the following::
 
     > composer create-project codeigniter4/appstarter ci-news
 
@@ -88,9 +86,7 @@ The Welcome Page
 ****************
 
 Now point your browser to the correct URL you will be greeted by a welcome screen.
-Try it now by heading to the following URL:
-
-::
+Try it now by heading to the following URL::
 
     http://localhost:8080
 

user_guide_src/source/tutorial/news_section.rst

@@ -1,13 +1,13 @@
-News section
-###############################################################################
+News Section
+############
 
 In the last section, we went over some basic concepts of the framework
 by writing a class that references static pages. We cleaned up the URI by
 adding custom routing rules. Now it's time to introduce dynamic content
 and start using a database.
 
-Create a database to work with
--------------------------------------------------------
+Create a Database to Work with
+******************************
 
 The CodeIgniter installation assumes that you have set up an appropriate
 database, as outlined in the :doc:`requirements </intro/requirements>`.
@@ -18,13 +18,7 @@ commands (mysql, MySQL Workbench, or phpMyAdmin).
 You need to create a database that can be used for this tutorial,
 and then configure CodeIgniter to use it.
 
-Using your database client, connect to your database and run the SQL command below (MySQL).
-Also, add some seed records. For now, we'll just show you the SQL statements needed
-to create the table, but you should be aware that this can be done programmatically
-once you are more familiar with CodeIgniter; you can read about :doc:`Migrations <../dbmgmt/migration>`
-and :doc:`Seeds <../dbmgmt/seeds>` to create more useful database setups later.
-
-::
+Using your database client, connect to your database and run the SQL command below (MySQL)::
 
     CREATE TABLE news (
         id INT UNSIGNED NOT NULL AUTO_INCREMENT,
@@ -35,36 +29,37 @@ and :doc:`Seeds <../dbmgmt/seeds>` to create more useful database setups later.
         KEY slug (slug)
     );
 
+Also, add some seed records. For now, we'll just show you the SQL statements needed
+to create the table, but you should be aware that this can be done programmatically
+once you are more familiar with CodeIgniter; you can read about :doc:`Migrations <../dbmgmt/migration>`
+and :doc:`Seeds <../dbmgmt/seeds>` to create more useful database setups later.
+
 A note of interest: a "slug", in the context of web publishing, is a
 user- and SEO-friendly short text used in a URL to identify and describe a resource.
 
-The seed records might be something like:
-
-::
+The seed records might be something like::
 
     INSERT INTO news VALUES
     (1,'Elvis sighted','elvis-sighted','Elvis was sighted at the Podunk internet cafe. It looked like he was writing a CodeIgniter app.'),
     (2,'Say it isn\'t so!','say-it-isnt-so','Scientists conclude that some programmers have a sense of humor.'),
     (3,'Caffeination, Yes!','caffeination-yes','World\'s largest coffee shop open onsite nested coffee shop for staff only.');
 
-Connect to your database
--------------------------------------------------------
+Connect to Your Database
+************************
 
 The local configuration file, ``.env``, that you created when you installed
 CodeIgniter, should have the database property settings uncommented and
 set appropriately for the database you want to use. Make sure you've configured
-your database properly as described :doc:`here <../database/configuration>`.
-
-::
+your database properly as described :doc:`here <../database/configuration>`::
 
     database.default.hostname = localhost
     database.default.database = ci4tutorial
     database.default.username = root
     database.default.password = root
     database.default.DBDriver = MySQLi
 
-Setting up your model
--------------------------------------------------------
+Setting up Your Model
+*********************
 
 Instead of writing database operations right in the controller, queries
 should be placed in a model, so they can easily be reused later. Models
@@ -106,8 +101,8 @@ that use the Query Builder to run their commands on the current table, and
 returning an array of results in the format of your choice. In this example,
 ``findAll()`` returns an array of array.
 
-Display the news
--------------------------------------------------------
+Display the News
+****************
 
 Now that the queries are written, the model should be tied to the views
 that are going to display the news items to the user. This could be done
@@ -174,7 +169,7 @@ The only thing left to do is create the corresponding view at
 .. literalinclude:: news_section/007.php
 
 Routing
--------------------------------------------------------
+*******
 
 Because of the wildcard routing rule created earlier, you need an extra
 route to view the controller that you just made. Modify your routing file

user_guide_src/source/tutorial/static_pages.rst

@@ -1,5 +1,5 @@
-Static pages
-###############################################################################
+Static Pages
+############
 
 .. note:: This tutorial assumes you've downloaded CodeIgniter and
    :doc:`installed the framework <../installation/index>` in your
@@ -9,26 +9,22 @@ The first thing you're going to do is set up a **controller** to handle
 static pages. A controller is simply a class that helps delegate work.
 It is the glue of your web application.
 
-For example, when a call is made to:
-
-::
+For example, when a call is made to::
 
     http://example.com/news/latest/10
 
 We might imagine that there is a controller named "news". The method
 being called on news would be "latest". The news method's job could be to
 grab 10 news items, and render them on the page. Very often in MVC,
-you'll see URL patterns that match:
-
-::
+you'll see URL patterns that match::
 
     http://example.com/[controller-class]/[controller-method]/[arguments]
 
 As URL schemes become more complex, this may change. But for now, this
 is all we will need to know.
 
-Let's make our first controller
--------------------------------------------------------
+Let's Make our First Controller
+*******************************
 
 Create a file at **app/Controllers/Pages.php** with the following
 code.
@@ -85,8 +81,8 @@ includes the following code::
     function. It's a global function provided by CodeIgniter to help prevent
     XSS attacks. You can read more about it :doc:`here </general/common_functions>`.
 
-Adding logic to the controller
--------------------------------------------------------
+Adding Logic to the Controller
+******************************
 
 Earlier you set up a controller with a ``view()`` method. The method
 accepts one parameter, which is the name of the page to be loaded. The
@@ -131,16 +127,14 @@ view.
     :doc:`here </outgoing/views>`.
 
 Running the App
--------------------------------------------------------
+***************
 
 Ready to test? You cannot run the app using PHP's built-in server,
 since it will not properly process the ``.htaccess`` rules that are provided in
 ``public``, and which eliminate the need to specify "index.php/"
 as part of a URL. CodeIgniter has its own command that you can use though.
 
-From the command line, at the root of your project:
-
-::
+From the command line, at the root of your project::
 
     > php spark serve
 
@@ -177,14 +171,12 @@ controller you made above produces...
     +---------------------------------+-----------------------------------------------------------------+
 
 Routing
--------------------------------------------------------
+*******
 
 The controller is now functioning!
 
 Using custom routing rules, you have the power to map any URI to any
-controller and method, and break free from the normal convention:
-
-::
+controller and method, and break free from the normal convention::
 
     http://example.com/[controller-class]/[controller-method]/[arguments]