Skip to content

Commit 78b215b

Browse files
authored
Merge pull request #7180 from kenjis/fix-docs-urls.rst-route-path
docs: define new term "Route path"
2 parents 7811d2a + 6b93671 commit 78b215b

2 files changed

Lines changed: 20 additions & 14 deletions

File tree

user_guide_src/source/general/common_functions.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -396,12 +396,12 @@ Miscellaneous Functions
396396
397397
:param string $method: Route name or Controller::method
398398
:param int|string ...$params: One or more parameters to be passed to the route. The last parameter allows you to set the locale.
399-
:returns: a route (URI path)
399+
:returns: a route path (URI path relative to baseURL)
400400
:rtype: string
401401

402402
.. note:: This function requires the controller/method to have a route defined in **app/Config/routes.php**.
403403

404-
.. important:: ``route_to()`` returns a *route*, not a full URI path for your site.
404+
.. important:: ``route_to()`` returns a *route* path, not a full URI path for your site.
405405
If your **baseURL** contains sub folders, the return value is not the same
406406
as the URI to link. In that case, just use :php:func:`url_to()` instead.
407407
See also :ref:`urls-url-structure`.

user_guide_src/source/general/urls.rst

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,15 @@ When you have the Base URL **https://www.example.com/** and imagine the followin
2929

3030
We use the following terms:
3131

32-
======== ============================
33-
Base URL **https://www.example.com/**
34-
URI path /blog/news/2022/10
35-
Route /blog/news/2022/10
36-
Query page=2
37-
======== ============================
32+
========== ============================ =========================================
33+
Term Example Description
34+
========== ============================ =========================================
35+
Base URL **https://www.example.com/** Base URL is often denoted as **baseURL**.
36+
URI path /blog/news/2022/10
37+
Route path /blog/news/2022/10 The URI path relative to the Base URL.
38+
It is also called as **URI string**.
39+
Query page=2
40+
========== ============================ =========================================
3841

3942
Base URL contains Sub folders
4043
-----------------------------
@@ -45,12 +48,15 @@ When you have the Base URL **https://www.example.com/ci-blog/** and imagine the
4548

4649
We use the following terms:
4750

48-
======== ====================================
49-
Base URL **https://www.example.com/ci-blog/**
50-
URI path /ci-blog/blog/news/2022/10
51-
Route /blog/news/2022/10
52-
Query page=2
53-
======== ====================================
51+
========== ==================================== =========================================
52+
Term Example Description
53+
========== ==================================== =========================================
54+
Base URL **https://www.example.com/ci-blog/** Base URL is often denoted as **baseURL**.
55+
URI path /ci-blog/blog/news/2022/10
56+
Route path /blog/news/2022/10 The URI path relative to the Base URL.
57+
It is also called as **URI string**.
58+
Query page=2
59+
========== ==================================== =========================================
5460

5561
.. _urls-remove-index-php:
5662

0 commit comments

Comments
 (0)