Skip to content

Commit e6ff9f7

Browse files
committed
minor #5464 Removed the glossary (WouterJ)
This PR was submitted for the 2.3 branch but it was merged into the 2.7 branch instead (closes #5464). Discussion ---------- Removed the glossary | Q | A | --- | --- | Doc fix? | yes | New docs? | no | Applies to | all | Fixed tickets | #5462 It's funny that 99% of the `:term:` usages were located in sentences describing a term. So we didn't loose any information there. In some cases, I've tweaked the sentence a bit not loose any important information. As for the genindex mentioned by @xabbuh in the issue, I believe this one is created automatically by Sphinx based on all `.. index::` directives in the documentation. When removing the glossary, the genindex will automatically not include the terms anymore (/cc @javiereguiluz please confirm). Commits ------- 1c05aad Removed the glossary
2 parents efea90e + 1c05aad commit e6ff9f7

File tree

11 files changed

+46
-183
lines changed

11 files changed

+46
-183
lines changed

book/from_flat_php_to_symfony2.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -123,9 +123,9 @@ is primarily an HTML file that uses a template-like PHP syntax:
123123
</html>
124124

125125
By convention, the file that contains all the application logic - ``index.php`` -
126-
is known as a "controller". The term :term:`controller` is a word you'll hear
127-
a lot, regardless of the language or framework you use. It refers simply
128-
to the area of *your* code that processes user input and prepares the response.
126+
is known as a "controller". The term controller is a word you'll hear a lot,
127+
regardless of the language or framework you use. It refers simply to the area
128+
of *your* code that processes user input and prepares the response.
129129

130130
In this case, the controller prepares data from the database and then includes
131131
a template to present that data. With the controller isolated, you could
@@ -312,8 +312,8 @@ to security...
312312
A "Front Controller" to the Rescue
313313
----------------------------------
314314

315-
The solution is to use a :term:`front controller`: a single PHP file through
316-
which *all* requests are processed. With a front controller, the URIs for the
315+
The solution is to use a front controller: a single PHP file through which
316+
*all* requests are processed. With a front controller, the URIs for the
317317
application change slightly, but start to become more flexible:
318318

319319
.. code-block:: text

book/http_cache.rst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,11 @@ websites, or is it? In this chapter, you'll see how the Symfony cache
2626
system works and why this is the best possible approach.
2727

2828
The Symfony cache system is different because it relies on the simplicity
29-
and power of the HTTP cache as defined in the :term:`HTTP specification`.
30-
Instead of reinventing a caching methodology, Symfony embraces the standard
31-
that defines basic communication on the Web. Once you understand the fundamental
32-
HTTP validation and expiration caching models, you'll be ready to master
33-
the Symfony cache system.
29+
and power of the HTTP cache as defined in the `HTTP specification`_. Instead of
30+
reinventing a caching methodology, Symfony embraces the standard that defines
31+
basic communication on the Web. Once you understand the fundamental HTTP
32+
validation and expiration caching models, you'll be ready to master the Symfony
33+
cache system.
3434

3535
For the purposes of learning how to cache with Symfony, the
3636
subject is covered in four steps:
@@ -1260,3 +1260,4 @@ Learn more from the Cookbook
12601260
.. _`FrameworkExtraBundle documentation`: https://symfony.com/doc/current/bundles/SensioFrameworkExtraBundle/annotations/cache.html
12611261
.. _`ESI`: http://www.w3.org/TR/esi-lang
12621262
.. _`FOSHttpCacheBundle`: http://foshttpcachebundle.readthedocs.org/
1263+
.. _`HTTP specification`: http://www.w3.org/Protocols/rfc2616/rfc2616.html

book/http_fundamentals.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -334,8 +334,8 @@ breaking all of your links?) and the fact that each file *must* manually
334334
include some set of core files so that security, database connections and
335335
the "look" of the site can remain consistent.
336336

337-
A much better solution is to use a :term:`front controller`: a single PHP
338-
file that handles every request coming into your application. For example:
337+
A much better solution is to use a front controller: a single PHP file that
338+
handles every request coming into your application. For example:
339339

340340
+------------------------+------------------------+
341341
| ``/index.php`` | executes ``index.php`` |
@@ -401,8 +401,8 @@ the same simple pattern for every request:
401401

402402
Each "page" of your site is defined in a routing configuration file that
403403
maps different URLs to different PHP functions. The job of each PHP function,
404-
called a :term:`controller`, is to use information from the request - along
405-
with many other tools Symfony makes available - to create and return a ``Response``
404+
called a controller, is to use information from the request - along with many
405+
other tools Symfony makes available - to create and return a ``Response``
406406
object. In other words, the controller is where *your* code goes: it's where
407407
you interpret the request and create a response.
408408

book/service_container.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -39,13 +39,13 @@ the service container makes writing good code so easy.
3939
What is a Service?
4040
------------------
4141

42-
Put simply, a :term:`Service` is any PHP object that performs some sort of
43-
"global" task. It's a purposefully-generic name used in computer science
44-
to describe an object that's created for a specific purpose (e.g. delivering
45-
emails). Each service is used throughout your application whenever you need
46-
the specific functionality it provides. You don't have to do anything special
47-
to make a service: simply write a PHP class with some code that accomplishes
48-
a specific task. Congratulations, you've just created a service!
42+
Put simply, a service is any PHP object that performs some sort of "global"
43+
task. It's a purposefully-generic name used in computer science to describe an
44+
object that's created for a specific purpose (e.g. delivering emails). Each
45+
service is used throughout your application whenever you need the specific
46+
functionality it provides. You don't have to do anything special to make a
47+
service: simply write a PHP class with some code that accomplishes a specific
48+
task. Congratulations, you've just created a service!
4949

5050
.. note::
5151

@@ -72,8 +72,8 @@ are key to being a good developer in almost any language.
7272
What is a Service Container?
7373
----------------------------
7474

75-
A :term:`Service Container` (or *dependency injection container*) is simply
76-
a PHP object that manages the instantiation of services (i.e. objects).
75+
A service container (or *dependency injection container*) is simply a PHP
76+
object that manages the instantiation of services (i.e. objects).
7777

7878
For example, suppose you have a simple PHP class that delivers email messages.
7979
Without a service container, you must manually create the object whenever

book/translation.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,9 +51,9 @@ to learn even more. Overall, the process has several steps:
5151
Configuration
5252
-------------
5353

54-
Translations are handled by a ``translator`` :term:`service` that uses the
55-
user's locale to lookup and return translated messages. Before using it,
56-
enable the ``translator`` in your configuration:
54+
Translations are handled by a ``translator`` service that uses the user's
55+
locale to lookup and return translated messages. Before using it, enable the
56+
``translator`` in your configuration:
5757

5858
.. configuration-block::
5959

components/form/introduction.rst

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -362,10 +362,12 @@ and then access it whenever you need to build a form.
362362
this object in some more "global" way so you can access it from anywhere.
363363

364364
Exactly how you gain access to your one form factory is up to you. If you're
365-
using a :term:`Service Container`, then you should add the form factory to
366-
your container and grab it out whenever you need to. If your application
367-
uses global or static variables (not usually a good idea), then you can store
368-
the object on some static class or do something similar.
365+
using a service container (like provided with the
366+
:doc:`DependencyInjection component </components/dependency_injection/introduction>`),
367+
then you should add the form factory to your container and grab it out whenever
368+
you need to. If your application uses global or static variables (not usually a
369+
good idea), then you can store the object on some static class or do something
370+
similar.
369371

370372
Regardless of how you architect your application, just remember that you
371373
should only have one form factory and that you'll need to be able to access

cookbook/symfony1.rst

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -218,11 +218,6 @@ Of course, there's nothing wrong with having multiple applications in your
218218
project, that's entirely up to you. A second application would mean a new
219219
directory, e.g. ``my_app/``, with the same basic setup as the ``app/`` directory.
220220

221-
.. tip::
222-
223-
Read the definition of a :term:`Project`, an :term:`Application`, and a
224-
:term:`Bundle` in the glossary.
225-
226221
Bundles and Plugins
227222
-------------------
228223

glossary.rst

Lines changed: 0 additions & 136 deletions
This file was deleted.

quick_tour/the_architecture.rst

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ into the architecture now.
1010
Understanding the Directory Structure
1111
-------------------------------------
1212

13-
The directory structure of a Symfony :term:`application` is rather flexible,
14-
but the recommended structure is as follows:
13+
The directory structure of a Symfony application is rather flexible, but the
14+
recommended structure is as follows:
1515

1616
``app/``
1717
The application configuration, templates and translations.
@@ -26,8 +26,9 @@ The ``web/`` Directory
2626
~~~~~~~~~~~~~~~~~~~~~~
2727

2828
The web root directory is the home of all public and static files like images,
29-
stylesheets and JavaScript files. It is also where each :term:`front controller`
30-
lives, such as the production controller shown here::
29+
stylesheets and JavaScript files. It is also where each front controller (the
30+
file that handles all requests to your application) lives, such as the
31+
production controller shown here::
3132

3233
// web/app.php
3334
require_once __DIR__.'/../app/bootstrap.php.cache';
@@ -72,7 +73,7 @@ Understanding the Bundle System
7273
-------------------------------
7374

7475
This section introduces one of the greatest and most powerful features of
75-
Symfony, the :term:`bundle` system.
76+
Symfony: The bundle system.
7677

7778
A bundle is kind of like a plugin in other software. So why is it
7879
called a *bundle* and not a *plugin*? This is because *everything* is a
@@ -179,8 +180,8 @@ defines the configuration for a specific bundle. For example, ``framework``
179180
configures the FrameworkBundle while ``swiftmailer`` configures the
180181
SwiftmailerBundle.
181182

182-
Each :term:`environment` can override the default configuration by providing
183-
a specific configuration file. For example, the ``dev`` environment loads
183+
Each environment can override the default configuration by providing a
184+
specific configuration file. For example, the ``dev`` environment loads
184185
the ``config_dev.yml`` file, which loads the main configuration (i.e.
185186
``config.yml``) and then modifies it to add some debugging tools:
186187

quick_tour/the_big_picture.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -199,10 +199,10 @@ environments**.
199199
What is an Environment?
200200
~~~~~~~~~~~~~~~~~~~~~~~
201201

202-
An :term:`environment` represents a group of configurations that's used
203-
to run your application. Symfony defines two environments by default: ``dev``
204-
(suited for when developing the application locally) and ``prod`` (optimized
205-
for when executing the application on production).
202+
An environment represents a group of configurations that's used to run your
203+
application. Symfony defines two environments by default: ``dev`` (suited for
204+
when developing the application locally) and ``prod`` (optimized for when
205+
executing the application on production).
206206

207207
When you visit the ``http://localhost:8000`` URL in your browser, you're
208208
executing your Symfony application in the ``dev`` environment. To visit

reference/constraints/Callback.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -244,7 +244,7 @@ You can then use the following configuration to invoke this validator:
244244
.. note::
245245

246246
The Callback constraint does *not* support global callback functions
247-
nor is it possible to specify a global function or a :term:`service` method
247+
nor is it possible to specify a global function or a service method
248248
as callback. To validate using a service, you should
249249
:doc:`create a custom validation constraint </cookbook/validation/custom_constraint>`
250250
and add that new constraint to your class.

0 commit comments

Comments
 (0)