Skip to content

Commit 3955a4b

Browse files
committed
Replace "chapter" by "article" where appropriate
1 parent 0607517 commit 3955a4b

34 files changed

+84
-85
lines changed

components/yaml/yaml_format.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ According to the official `YAML`_ website, YAML is "a human friendly data
88
serialization standard for all programming languages".
99

1010
Even if the YAML format can describe complex nested data structure, this
11-
chapter only describes the minimum set of features needed to use YAML as a
11+
article only describes the minimum set of features needed to use YAML as a
1212
configuration file format.
1313

1414
YAML is a simple language that describes data. As PHP, it has a syntax for

configuration.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ specific bundle (i.e. ``FrameworkBundle`` and ``TwigBundle``).
9595

9696
.. sidebar:: Configuration Formats
9797

98-
Throughout the chapters, all configuration examples will be shown in
98+
Throughout the documentation, all configuration examples will be shown in
9999
three formats (YAML, XML and PHP). YAML is used by default, but you can
100100
choose whatever you like best. There is no performance difference:
101101

configuration/external_parameters.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@
44
How to Set external Parameters in the Service Container
55
=======================================================
66

7-
In the chapter :doc:`/configuration`, you learned how to manage your application
8-
configuration. At times, it may benefit your application
9-
to store certain credentials outside of your project code. Database configuration
10-
is one such example. The flexibility of the Symfony service container allows
11-
you to easily do this.
7+
In the article :doc:`/configuration`, you learned how to manage your application
8+
configuration. At times, it may benefit your application to store certain
9+
credentials outside of your project code. Database configuration is one such
10+
example. The flexibility of the Symfony service container allows you to easily
11+
do this.
1212

1313
Environment Variables
1414
---------------------

configuration/front_controllers_and_kernel.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ This method is responsible for loading the application's
144144
configuration from the right *environment*.
145145

146146
Environments have been covered extensively
147-
:doc:`in the previous chapter </configuration/environments>`,
147+
:doc:`in the previous article </configuration/environments>`,
148148
and you probably remember that the Symfony Standard Edition comes with three
149149
of them - ``dev``, ``prod`` and ``test``.
150150

contributing/documentation/overview.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -126,9 +126,9 @@ memorable name for the new branch (if you are fixing a reported issue, use
126126

127127
.. code-block:: terminal
128128
129-
$ git checkout -b improve_install_chapter upstream/2.7
129+
$ git checkout -b improve_install_article upstream/2.7
130130
131-
In this example, the name of the branch is ``improve_install_chapter`` and the
131+
In this example, the name of the branch is ``improve_install_article`` and the
132132
``upstream/2.7`` value tells Git to create this branch based on the ``2.7``
133133
branch of the ``upstream`` remote, which is the original Symfony Docs repository.
134134

@@ -151,10 +151,10 @@ even remove any content and do your best to comply with the
151151

152152
.. code-block:: terminal
153153
154-
$ git push origin improve_install_chapter
154+
$ git push origin improve_install_article
155155
156156
The ``origin`` value is the name of the Git remote that corresponds to your
157-
forked repository and ``improve_install_chapter`` is the name of the branch you
157+
forked repository and ``improve_install_article`` is the name of the branch you
158158
created previously.
159159

160160
**Step 7.** Everything is now ready to initiate a **pull request**. Go to your
@@ -171,7 +171,7 @@ changes should be applied:
171171
In this example, the **base fork** should be ``symfony/symfony-docs`` and
172172
the **base** branch should be the ``2.7``, which is the branch that you selected
173173
to base your changes on. The **head fork** should be your forked copy
174-
of ``symfony-docs`` and the **compare** branch should be ``improve_install_chapter``,
174+
of ``symfony-docs`` and the **compare** branch should be ``improve_install_article``,
175175
which is the name of the branch you created and where you made your changes.
176176

177177
.. _pull-request-format:
@@ -192,7 +192,7 @@ changes and push the new changes:
192192
.. code-block:: terminal
193193
194194
$ cd projects/symfony-docs/
195-
$ git checkout improve_install_chapter
195+
$ git checkout improve_install_article
196196
197197
# ... do your changes
198198

controller.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -184,12 +184,12 @@ and ``redirect()`` methods::
184184
The ``redirectToRoute()`` method was introduced in Symfony 2.6. Previously (and still now), you
185185
could use ``redirect()`` and ``generateUrl()`` together for this.
186186

187-
For more information, see the :doc:`Routing chapter </routing>`.
187+
For more information, see the :doc:`Routing article </routing>`.
188188

189189
.. caution::
190190

191-
The ``redirect()`` method does not check its destination in any way. If you
192-
redirect to some URL provided by the end-users, your application may be open
191+
The ``redirect()`` method does not check its destination in any way. If you
192+
redirect to some URL provided by the end-users, your application may be open
193193
to the `unvalidated redirects security vulnerability`_.
194194

195195

@@ -230,7 +230,7 @@ creating unnecessarily deep structures::
230230
));
231231

232232
The Symfony templating system and Twig are explained more in the
233-
:doc:`Creating and Using Templates chapter </templating>`.
233+
:doc:`Creating and Using Templates article </templating>`.
234234

235235
.. index::
236236
single: Controller; Accessing services
@@ -266,7 +266,7 @@ console command:
266266
.. versionadded:: 2.6
267267
Prior to Symfony 2.6, this command was called ``container:debug``.
268268

269-
For more information, see the :doc:`/service_container` chapter.
269+
For more information, see the :doc:`/service_container` article.
270270

271271
.. tip::
272272

@@ -548,7 +548,7 @@ A) Shortcut methods (like ``render()`` and ``redirectToRoute()``);
548548
B) Access to *all* of the useful objects (services) in the system via the
549549
:ref:`get() <controller-accessing-services>` method.
550550

551-
In other chapters, you'll learn how to use specific services from inside your controller
551+
In other articles, you'll learn how to use specific services from inside your controller
552552
that will help you persist and fetch objects from a database, process form submissions,
553553
handle caching and more.
554554

doctrine/registration_form.rst

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -290,7 +290,7 @@ encoder in the security configuration:
290290
<encoder class="AppBundle\Entity\User">bcrypt</encoder>
291291
</config>
292292
</srv:container>
293-
293+
294294
.. code-block:: php
295295
296296
// app/config/security.php
@@ -302,9 +302,8 @@ encoder in the security configuration:
302302
),
303303
));
304304
305-
In this case the recommended ``bcrypt`` algorithm is used. To learn more
306-
about how to encode the users password have a look into the
307-
:ref:`security chapter <security-encoding-user-password>`.
305+
In this case the recommended ``bcrypt`` algorithm is used. If needed, check out
306+
the :ref:`user password encoding <security-encoding-user-password>` article.
308307

309308
.. note::
310309

form/csrf_protection.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ using a CSRF token inside your forms.
1111

1212
The good news is that, by default, Symfony embeds and validates CSRF tokens
1313
automatically for you. This means that you can take advantage of the CSRF
14-
protection without doing anything. In fact, every form in this chapter has
14+
protection without doing anything. In fact, every form in this article has
1515
taken advantage of the CSRF protection!
1616

1717
CSRF protection works by adding a hidden field to your form - called ``_token``

form/dynamic_form_modification.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ a bare form class looks like::
6767
.. note::
6868

6969
If this particular section of code isn't already familiar to you, you
70-
probably need to take a step back and first review the :doc:`Forms chapter </forms>`
70+
probably need to take a step back and first review the :doc:`Forms article </forms>`
7171
before proceeding.
7272

7373
Assume for a moment that this form utilizes an imaginary "Product" class

form/form_customization.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -795,7 +795,7 @@ Customizing Error Output
795795
The Form component only handles *how* the validation errors are rendered,
796796
and not the actual validation error messages. The error messages themselves
797797
are determined by the validation constraints you apply to your objects.
798-
For more information, see the chapter on :doc:`validation </validation>`.
798+
For more information, see the article on :doc:`validation </validation>`.
799799

800800
There are many different ways to customize how errors are rendered when a
801801
form is submitted with errors. The error messages for a field are rendered

form/without_class.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ How to Use a Form without a Data Class
66

77
In most cases, a form is tied to an object, and the fields of the form get
88
and store their data on the properties of that object. This is exactly what
9-
you've seen so far in this chapter with the `Task` class.
9+
you've seen so far in this article with the `Task` class.
1010

1111
But sometimes, you may just want to use a form without a class, and get back
1212
an array of the submitted data. This is actually really easy::
@@ -76,7 +76,7 @@ simple array of your submitted data, how can you add constraints to the data of
7676
your form?
7777

7878
The answer is to setup the constraints yourself, and attach them to the individual
79-
fields. The overall approach is covered a bit more in the :doc:`validation chapter </validation/raw_values>`,
79+
fields. The overall approach is covered a bit more in :doc:`this validation article </validation/raw_values>`,
8080
but here's a short example:
8181

8282
.. code-block:: php

forms.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Forms
66

77
Dealing with HTML forms is one of the most common - and challenging - tasks for
88
a web developer. Symfony integrates a Form component that makes dealing with
9-
forms easy. In this chapter, you'll build a complex form from the ground up,
9+
forms easy. In this article, you'll build a complex form from the ground up,
1010
learning the most important features of the form library along the way.
1111

1212
.. note::
@@ -59,7 +59,7 @@ going to need to build a form. But before you begin, first focus on the generic
5959
This class is a "plain-old-PHP-object" because, so far, it has nothing
6060
to do with Symfony or any other library. It's quite simply a normal PHP object
6161
that directly solves a problem inside *your* application (i.e. the need to
62-
represent a task in your application). Of course, by the end of this chapter,
62+
represent a task in your application). Of course, by the end of this article,
6363
you'll be able to submit data to a ``Task`` instance (via an HTML form), validate
6464
its data, and persist it to the database.
6565

@@ -252,7 +252,7 @@ your controller::
252252
'form' => $form->createView(),
253253
));
254254
}
255-
255+
256256
.. caution::
257257

258258
Be aware that the ``createView()`` method should be called *after* ``handleRequest()``
@@ -400,7 +400,7 @@ That's it! If you re-submit the form with invalid data, you'll see the
400400
corresponding errors printed out with the form.
401401

402402
Validation is a very powerful feature of Symfony and has its own
403-
:doc:`dedicated chapter </validation>`.
403+
:doc:`dedicated article </validation>`.
404404

405405
.. _forms-html5-validation-disable:
406406

@@ -479,7 +479,7 @@ the documentation for each type.
479479
is left blank. If you don't want this behavior, either
480480
:ref:`disable HTML5 validation <forms-html5-validation-disable>`
481481
or set the ``required`` option on your field to ``false``::
482-
482+
483483
->add('dueDate', 'date', array(
484484
'widget' => 'single_text',
485485
'required' => false

http_cache/varnish.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ configuration of PHP, your session cookie has the name ``PHPSESSID``:
102102
set req.http.Cookie = regsuball(req.http.Cookie, ";(PHPSESSID)=", "; \1=");
103103
set req.http.Cookie = regsuball(req.http.Cookie, ";[^ ][^;]*", "");
104104
set req.http.Cookie = regsuball(req.http.Cookie, "^[; ]+|[; ]+$", "");
105-
105+
106106
if (req.http.Cookie == "") {
107107
// If there are no more cookies, remove the header to get page cached.
108108
unset req.http.Cookie;
@@ -120,7 +120,7 @@ configuration of PHP, your session cookie has the name ``PHPSESSID``:
120120
set req.http.Cookie = regsuball(req.http.Cookie, ";(PHPSESSID)=", "; \1=");
121121
set req.http.Cookie = regsuball(req.http.Cookie, ";[^ ][^;]*", "");
122122
set req.http.Cookie = regsuball(req.http.Cookie, "^[; ]+|[; ]+$", "");
123-
123+
124124
if (req.http.Cookie == "") {
125125
// If there are no more cookies, remove the header to get page cached.
126126
remove req.http.Cookie;
@@ -168,7 +168,7 @@ using Varnish 3:
168168
Enable Edge Side Includes (ESI)
169169
-------------------------------
170170

171-
As explained in the :doc:`Edge Side Includes chapter </http_cache/esi>`, Symfony
171+
As explained in the :doc:`Edge Side Includes article </http_cache/esi>`, Symfony
172172
detects whether it talks to a reverse proxy that understands ESI or not. When
173173
you use the Symfony reverse proxy, you don't need to do anything. But to make
174174
Varnish instead of Symfony resolve the ESI tags, you need some configuration

introduction/from_flat_php_to_symfony2.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ Symfony versus Flat PHP
1010

1111
If you've never used a PHP framework, aren't familiar with the
1212
`Model-View-Controller`_ (MVC) philosophy, or just wonder what all the *hype*
13-
is around Symfony, this chapter is for you. Instead of *telling* you that
13+
is around Symfony, this article is for you. Instead of *telling* you that
1414
Symfony allows you to develop faster and better software than with flat PHP,
1515
you'll see for yourself.
1616

17-
In this chapter, you'll write a simple application in flat PHP, and then
17+
In this article, you'll write a simple application in flat PHP, and then
1818
refactor it to be more organized. You'll travel through time, seeing the
1919
decisions behind why web development has evolved over the past several years
2020
to where it is now.
@@ -25,7 +25,7 @@ let you take back control of your code.
2525
A Simple Blog in Flat PHP
2626
-------------------------
2727

28-
In this chapter, you'll build the token blog application using only flat PHP.
28+
In this article, you'll build the token blog application using only flat PHP.
2929
To begin, create a single page that displays blog entries that have been
3030
persisted to the database. Writing in flat PHP is quick and dirty:
3131

@@ -717,14 +717,14 @@ And rewriting ``layout.html.php`` template in Twig would look like this:
717717

718718
Twig is well-supported in Symfony. And while PHP templates will always
719719
be supported in Symfony, the many advantages of Twig will continue to
720-
be discussed. For more information, see the :doc:`templating chapter </templating>`.
720+
be discussed. For more information, see the :doc:`templating article </templating>`.
721721

722722
Where Symfony Delivers
723723
----------------------
724724

725-
In the upcoming chapters, you'll learn more about how each piece of Symfony
726-
works and how you can organize your project. For now, celebrate at how migrating
727-
the blog from flat PHP to Symfony has improved life:
725+
In the rest of documentation articles, you'll learn more about how each piece of
726+
Symfony works and how you can organize your project. For now, celebrate at how
727+
migrating the blog from flat PHP to Symfony has improved life:
728728

729729
* Your application now has **clear and consistently organized code** (though
730730
Symfony doesn't force you into this). This promotes **reusability** and
@@ -746,7 +746,7 @@ the blog from flat PHP to Symfony has improved life:
746746

747747
* Symfony's HTTP-centric architecture gives you access to powerful tools
748748
such as **HTTP caching** powered by **Symfony's internal HTTP cache** or
749-
more powerful tools such as `Varnish`_. This is covered in a later chapter
749+
more powerful tools such as `Varnish`_. This is covered in another article
750750
all about :doc:`caching </http_cache>`.
751751

752752
And perhaps best of all, by using Symfony, you now have access to a whole

introduction/http_fundamentals.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Great news! While you're learning Symfony, you're *also* learning the fundamenta
1010
of the *web*. Symfony is closely modeled after the HTTP Request-Response flow: that
1111
*fundamental* paradigm that's behind almost *all* communication on the web.
1212

13-
In this chapter, you'll walk through the HTTP fundamentals and find out how these
13+
In this article, you'll walk through the HTTP fundamentals and find out how these
1414
are applied throughout Symfony.
1515

1616
Requests and Responses in HTTP

introduction/symfony1.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ at its core, the skills used to master a symfony1 project continue to be
1010
very relevant when developing in Symfony2. Sure, ``app.yml`` is gone, but
1111
routing, controllers and templates all remain.
1212

13-
This chapter walks through the differences between symfony1 and Symfony2.
13+
This article walks through the differences between symfony1 and Symfony2.
1414
As you'll see, many tasks are tackled in a slightly different way. You'll
1515
come to appreciate these minor differences as they promote stable, predictable,
1616
testable and decoupled code in your Symfony2 applications.
@@ -359,7 +359,7 @@ You can now access this from a controller, for example::
359359

360360
In reality, the Symfony2 configuration is much more powerful and is used
361361
primarily to configure objects that you can use. For more information, see
362-
the chapter titled ":doc:`/service_container`".
362+
the article titled ":doc:`/service_container`".
363363

364364
.. _`Composer`: https://getcomposer.org
365365
.. _`Symfony Standard Edition`: https://github.com/symfony/symfony-standard

page_creation.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Creating a Page: Route and Controller
3232
.. tip::
3333

3434
Before continuing, make sure you've read the :doc:`Setup </setup>`
35-
chapter and can access your new Symfony app in the browser.
35+
article and can access your new Symfony app in the browser.
3636

3737
Suppose you want to create a page - ``/lucky/number`` - that generates a lucky (well,
3838
random) number and prints it. To do that, create a "Controller class" and a
@@ -149,7 +149,7 @@ to get your *new* lucky number!
149149

150150
http://localhost:8000/lucky/number
151151

152-
In the :doc:`/templating` chapter, you'll learn all about Twig: how to loop, render
152+
In the :doc:`/templating` article, you'll learn all about Twig: how to loop, render
153153
other templates and leverage its powerful layout inheritance system.
154154

155155
Checking out the Project Structure
@@ -214,15 +214,15 @@ That exists!
214214

215215
You can control how your bundles behave via the ``app/config/config.yml`` file.
216216
That file - and other details like environments & parameters - are discussed in
217-
the :doc:`/configuration` chapter.
217+
the :doc:`/configuration` article.
218218

219219
What's Next?
220220
------------
221221

222222
Congrats! You're already starting to master Symfony and learn a whole new
223223
way of building beautiful, functional, fast and maintainable apps.
224224

225-
Ok, time to finish mastering the fundamentals by reading these chapters:
225+
Ok, time to finish mastering the fundamentals by reading these articles:
226226

227227
* :doc:`/routing`
228228
* :doc:`/controller`

performance.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Performance
55
===========
66

77
Symfony is fast, right out of the box. Of course, if you really need speed,
8-
there are many ways that you can make Symfony even faster. In this chapter,
8+
there are many ways that you can make Symfony even faster. In this article,
99
you'll explore some of the ways to make your Symfony application even faster.
1010

1111
.. index::

reference/configuration/framework.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1157,7 +1157,7 @@ resources
11571157

11581158
A list of all resources for form theming in PHP. This setting is not required
11591159
if you're using the Twig format for your templates, in that case refer to
1160-
:ref:`the form chapter <forms-theming-twig>`.
1160+
:ref:`the form article <forms-theming-twig>`.
11611161

11621162
Assume you have custom global form themes in
11631163
``src/WebsiteBundle/Resources/views/Form``, you can configure this like:

0 commit comments

Comments
 (0)