Merge pull request #8780 from kenjis/docs-improve-views

docs: improve View pages

user_guide_src/source/general/common_functions.rst

@@ -180,6 +180,7 @@ Service Accessors
  :rtype: string
 
  Grabs the current RendererInterface-compatible class
+ (:doc:`View <../outgoing/view_renderer>` class by default)
  and tells it to render the specified view. Simply provides
  a convenience method that can be used in Controllers,
  libraries, and routed closures.

user_guide_src/source/outgoing/index.rst

@@ -8,9 +8,9 @@ View components are used to build what is returned to the user.
  :titlesonly:
 
  views
- view_cells
  view_renderer
  view_layouts
+ view_cells
  view_parser
  view_decorators
  table

user_guide_src/source/outgoing/view_decorators.rst

@@ -2,20 +2,36 @@
 View Decorators
 ###############
 
+.. contents::
+ :local:
+ :depth: 2
+
+*************************
+What are View Decorators?
+*************************
+
 View Decorators allow your application to modify the HTML output during the rendering process. This happens just
 prior to being cached, and allows you to apply custom functionality to your views.
 
+You can use View Decorators with :doc:`view_renderer` or :doc:`view_parser`.
+
 *******************
 Creating Decorators
 *******************
 
+Creating Decorator Class
+========================
+
 Creating your own view decorators requires creating a new class that implements ``CodeIgniter\View\ViewDecoratorInterface``.
 This requires a single method that takes the generated HTML string, performs any modifications on it, and returns
 the resulting HTML.
 
 .. literalinclude:: view_decorators/001.php
 
-Once created, the class must be registered in ``app/Config/View.php``:
+Registering Decorator Class
+===========================
+
+Once created, the class must be registered in **app/Config/View.php**:
 
 .. literalinclude:: view_decorators/002.php
 

user_guide_src/source/outgoing/view_decorators/002.php

@@ -6,9 +6,9 @@
 
 class View extends BaseView
 {
+ // ...
+
  public array $decorators = [
  'App\Views\Decorators\MyDecorator',
  ];
-
- // ...
 }

user_guide_src/source/outgoing/view_parser.rst

@@ -81,7 +81,7 @@ need to be unique, or a later parameter setting will over-ride an earlier one.
 This also impacts escaping parameter values for different contexts inside your
 script. You will have to give each escaped value a unique parameter name.
 
-Parser templates
+Parser Templates
 ================
 
 You can use the ``render()`` method to parse (or render) simple templates,
@@ -90,10 +90,12 @@ like this:
 .. literalinclude:: view_parser/003.php
 
 View parameters are passed to ``setData()`` as an associative
-array of data to be replaced in the template. In the above example, the
-template would contain two variables: ``{blog_title}`` and ``{blog_heading}``
-The first parameter to ``render()`` contains the name of the :doc:`view
-file </outgoing/views>`, Where *blog_template* is the name of your view file.
+array of data to be replaced in the template.
+
+In the above example, the template would contain two variables: ``{blog_title}`` and ``{blog_heading}``
+
+The first parameter to ``render()`` contains the name of the template, where
+``blog_template`` is the name of your view template file.
 
 .. important:: If the file extension is omitted, then the views are expected to end with the .php extension.
 
@@ -102,7 +104,7 @@ Parser Configuration Options
 
 Several options can be passed to the ``render()`` or ``renderString()`` methods.
 
-- ``cache`` - the time in seconds, to save a view's results; ignored for renderString()
+- ``cache`` - the time in seconds, to save a view's results; ignored for ``renderString()``
 - ``cache_name`` - the ID used to save/retrieve a cached view result; defaults to the viewpath;
  ignored for renderString()
 - ``saveData`` - true if the view data parameters should be retained for subsequent calls;

user_guide_src/source/outgoing/views.rst

@@ -47,6 +47,8 @@ Where *name* is the name of your view file.
 
 .. important:: If the file extension is omitted, then the views are expected to end with the **.php** extension.
 
+.. note:: The ``view()`` function uses :doc:`view_renderer` internally.
+
 Now, create a file called **Blog.php** in the **app/Controllers** directory,
 and put this in it: