Skip to content

Replace "chapter" by "article" where appropriate #7485

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 19, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion components/yaml/yaml_format.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ According to the official `YAML`_ website, YAML is "a human friendly data
serialization standard for all programming languages".

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

YAML is a simple language that describes data. As PHP, it has a syntax for
Expand Down
2 changes: 1 addition & 1 deletion configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ specific bundle (i.e. ``FrameworkBundle`` and ``TwigBundle``).

.. sidebar:: Configuration Formats

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

Expand Down
10 changes: 5 additions & 5 deletions configuration/external_parameters.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@
How to Set external Parameters in the Service Container
=======================================================

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

Environment Variables
---------------------
Expand Down
2 changes: 1 addition & 1 deletion configuration/front_controllers_and_kernel.rst
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ This method is responsible for loading the application's
configuration from the right *environment*.

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

Expand Down
12 changes: 6 additions & 6 deletions contributing/documentation/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -126,9 +126,9 @@ memorable name for the new branch (if you are fixing a reported issue, use

.. code-block:: terminal

$ git checkout -b improve_install_chapter upstream/2.7
$ git checkout -b improve_install_article upstream/2.7

In this example, the name of the branch is ``improve_install_chapter`` and the
In this example, the name of the branch is ``improve_install_article`` and the
``upstream/2.7`` value tells Git to create this branch based on the ``2.7``
branch of the ``upstream`` remote, which is the original Symfony Docs repository.

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

.. code-block:: terminal

$ git push origin improve_install_chapter
$ git push origin improve_install_article

The ``origin`` value is the name of the Git remote that corresponds to your
forked repository and ``improve_install_chapter`` is the name of the branch you
forked repository and ``improve_install_article`` is the name of the branch you
created previously.

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

.. _pull-request-format:
Expand All @@ -192,7 +192,7 @@ changes and push the new changes:
.. code-block:: terminal

$ cd projects/symfony-docs/
$ git checkout improve_install_chapter
$ git checkout improve_install_article

# ... do your changes

Expand Down
12 changes: 6 additions & 6 deletions controller.rst
Original file line number Diff line number Diff line change
Expand Up @@ -184,12 +184,12 @@ and ``redirect()`` methods::
The ``redirectToRoute()`` method was introduced in Symfony 2.6. Previously (and still now), you
could use ``redirect()`` and ``generateUrl()`` together for this.

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

.. caution::

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


Expand Down Expand Up @@ -230,7 +230,7 @@ creating unnecessarily deep structures::
));

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

.. index::
single: Controller; Accessing services
Expand Down Expand Up @@ -266,7 +266,7 @@ console command:
.. versionadded:: 2.6
Prior to Symfony 2.6, this command was called ``container:debug``.

For more information, see the :doc:`/service_container` chapter.
For more information, see the :doc:`/service_container` article.

.. tip::

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

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

Expand Down
7 changes: 3 additions & 4 deletions doctrine/registration_form.rst
Original file line number Diff line number Diff line change
Expand Up @@ -290,7 +290,7 @@ encoder in the security configuration:
<encoder class="AppBundle\Entity\User">bcrypt</encoder>
</config>
</srv:container>

.. code-block:: php

// app/config/security.php
Expand All @@ -302,9 +302,8 @@ encoder in the security configuration:
),
));

In this case the recommended ``bcrypt`` algorithm is used. To learn more
about how to encode the users password have a look into the
:ref:`security chapter <security-encoding-user-password>`.
In this case the recommended ``bcrypt`` algorithm is used. If needed, check out
the :ref:`user password encoding <security-encoding-user-password>` article.

.. note::

Expand Down
2 changes: 1 addition & 1 deletion form/csrf_protection.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ using a CSRF token inside your forms.

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

CSRF protection works by adding a hidden field to your form - called ``_token``
Expand Down
2 changes: 1 addition & 1 deletion form/dynamic_form_modification.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ a bare form class looks like::
.. note::

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

Assume for a moment that this form utilizes an imaginary "Product" class
Expand Down
2 changes: 1 addition & 1 deletion form/form_customization.rst
Original file line number Diff line number Diff line change
Expand Up @@ -795,7 +795,7 @@ Customizing Error Output
The Form component only handles *how* the validation errors are rendered,
and not the actual validation error messages. The error messages themselves
are determined by the validation constraints you apply to your objects.
For more information, see the chapter on :doc:`validation </validation>`.
For more information, see the article on :doc:`validation </validation>`.

There are many different ways to customize how errors are rendered when a
form is submitted with errors. The error messages for a field are rendered
Expand Down
4 changes: 2 additions & 2 deletions form/without_class.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ How to Use a Form without a Data Class

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

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

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

.. code-block:: php
Expand Down
10 changes: 5 additions & 5 deletions forms.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Forms

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

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

Expand Down Expand Up @@ -252,7 +252,7 @@ your controller::
'form' => $form->createView(),
));
}

.. caution::

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

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

.. _forms-html5-validation-disable:

Expand Down Expand Up @@ -479,7 +479,7 @@ the documentation for each type.
is left blank. If you don't want this behavior, either
:ref:`disable HTML5 validation <forms-html5-validation-disable>`
or set the ``required`` option on your field to ``false``::

->add('dueDate', 'date', array(
'widget' => 'single_text',
'required' => false
Expand Down
6 changes: 3 additions & 3 deletions http_cache/varnish.rst
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ configuration of PHP, your session cookie has the name ``PHPSESSID``:
set req.http.Cookie = regsuball(req.http.Cookie, ";(PHPSESSID)=", "; \1=");
set req.http.Cookie = regsuball(req.http.Cookie, ";[^ ][^;]*", "");
set req.http.Cookie = regsuball(req.http.Cookie, "^[; ]+|[; ]+$", "");

if (req.http.Cookie == "") {
// If there are no more cookies, remove the header to get page cached.
unset req.http.Cookie;
Expand All @@ -120,7 +120,7 @@ configuration of PHP, your session cookie has the name ``PHPSESSID``:
set req.http.Cookie = regsuball(req.http.Cookie, ";(PHPSESSID)=", "; \1=");
set req.http.Cookie = regsuball(req.http.Cookie, ";[^ ][^;]*", "");
set req.http.Cookie = regsuball(req.http.Cookie, "^[; ]+|[; ]+$", "");

if (req.http.Cookie == "") {
// If there are no more cookies, remove the header to get page cached.
remove req.http.Cookie;
Expand Down Expand Up @@ -168,7 +168,7 @@ using Varnish 3:
Enable Edge Side Includes (ESI)
-------------------------------

As explained in the :doc:`Edge Side Includes chapter </http_cache/esi>`, Symfony
As explained in the :doc:`Edge Side Includes article </http_cache/esi>`, Symfony
detects whether it talks to a reverse proxy that understands ESI or not. When
you use the Symfony reverse proxy, you don't need to do anything. But to make
Varnish instead of Symfony resolve the ESI tags, you need some configuration
Expand Down
16 changes: 8 additions & 8 deletions introduction/from_flat_php_to_symfony2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ Symfony versus Flat PHP

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

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

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

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

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

Where Symfony Delivers
----------------------

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the upcoming documentation articles isn't valid ?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It could be valid ... but we're having some troubles with articles that say "previous articles", "next articles", etc. The docs now follow a non-linear structure, so it's better to say things like "the rest of articles", etc.

Symfony works and how you can organize your project. For now, celebrate at how
migrating the blog from flat PHP to Symfony has improved life:

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

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

And perhaps best of all, by using Symfony, you now have access to a whole
Expand Down
2 changes: 1 addition & 1 deletion introduction/http_fundamentals.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Great news! While you're learning Symfony, you're *also* learning the fundamenta
of the *web*. Symfony is closely modeled after the HTTP Request-Response flow: that
*fundamental* paradigm that's behind almost *all* communication on the web.

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

Requests and Responses in HTTP
Expand Down
4 changes: 2 additions & 2 deletions introduction/symfony1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ at its core, the skills used to master a symfony1 project continue to be
very relevant when developing in Symfony2. Sure, ``app.yml`` is gone, but
routing, controllers and templates all remain.

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

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

.. _`Composer`: https://getcomposer.org
.. _`Symfony Standard Edition`: https://github.com/symfony/symfony-standard
Expand Down
8 changes: 4 additions & 4 deletions page_creation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Creating a Page: Route and Controller
.. tip::

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

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

http://localhost:8000/lucky/number

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

Checking out the Project Structure
Expand Down Expand Up @@ -214,15 +214,15 @@ That exists!

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

What's Next?
------------

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

Ok, time to finish mastering the fundamentals by reading these chapters:
Ok, time to finish mastering the fundamentals by reading these articles:

* :doc:`/routing`
* :doc:`/controller`
Expand Down
2 changes: 1 addition & 1 deletion performance.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Performance
===========

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

.. index::
Expand Down
2 changes: 1 addition & 1 deletion reference/configuration/framework.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1157,7 +1157,7 @@ resources

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

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