Skip to content

Commit 2b7e0f6

Browse files
committed
minor #3497 Fix highlighting (WouterJ)
This PR was merged into the 2.3 branch. Discussion ---------- Fix highlighting Initial idea was to fix the highlighting. While doing that, others things also got a fix: * indenting * missing formats * some `...` in XML elements * missing comments in other formats | Q | A | --- | --- | Doc fix? | yes | New docs? | no | Applies to | all | Fixed tickets | partially #1886 Commits ------- 7c0cf89 Fixed (mostly) yaml code blocks 2a43a97 Fixed YAML code blocks in the book
2 parents 30f94a6 + 7c0cf89 commit 2b7e0f6

39 files changed

+185
-138
lines changed

book/propel.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -55,10 +55,10 @@ configuration file (``config.yml``):
5555
5656
propel:
5757
dbal:
58-
driver: "%database_driver%"
59-
user: "%database_user%"
60-
password: "%database_password%"
61-
dsn: "%database_driver%:host=%database_host%;dbname=%database_name%;charset=%database_charset%"
58+
driver: "%database_driver%"
59+
user: "%database_user%"
60+
password: "%database_password%"
61+
dsn: "%database_driver%:host=%database_host%;dbname=%database_name%;charset=%database_charset%"
6262
6363
Now that Propel knows about your database, Symfony2 can create the database for
6464
you:

book/security.rst

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ authentication (i.e. the old-school username/password box):
4545
security:
4646
firewalls:
4747
secured_area:
48-
pattern: ^/
48+
pattern: ^/
4949
anonymous: ~
5050
http_basic:
5151
realm: "Secured Demo Area"
@@ -300,11 +300,11 @@ First, enable form login under your firewall:
300300
security:
301301
firewalls:
302302
secured_area:
303-
pattern: ^/
303+
pattern: ^/
304304
anonymous: ~
305305
form_login:
306-
login_path: login
307-
check_path: login_check
306+
login_path: login
307+
check_path: login_check
308308
309309
.. code-block:: xml
310310
@@ -373,10 +373,10 @@ submission (i.e. ``/login_check``):
373373
374374
# app/config/routing.yml
375375
login:
376-
path: /login
377-
defaults: { _controller: AcmeSecurityBundle:Security:login }
376+
path: /login
377+
defaults: { _controller: AcmeSecurityBundle:Security:login }
378378
login_check:
379-
path: /login_check
379+
path: /login_check
380380
381381
.. code-block:: xml
382382
@@ -637,8 +637,8 @@ see :doc:`/cookbook/security/form_login`.
637637
638638
firewalls:
639639
login_firewall:
640-
pattern: ^/login$
641-
anonymous: ~
640+
pattern: ^/login$
641+
anonymous: ~
642642
secured_area:
643643
pattern: ^/
644644
form_login: ~
@@ -1094,13 +1094,14 @@ aren't stored anywhere in a database. The actual user object is provided
10941094
by Symfony (:class:`Symfony\\Component\\Security\\Core\\User\\User`).
10951095

10961096
.. tip::
1097+
10971098
Any user provider can load users directly from configuration by specifying
10981099
the ``users`` configuration parameter and listing the users beneath it.
10991100

11001101
.. caution::
11011102

11021103
If your username is completely numeric (e.g. ``77``) or contains a dash
1103-
(e.g. ``user-name``), you should use that alternative syntax when specifying
1104+
(e.g. ``user-name``), you should use an alternative syntax when specifying
11041105
users in YAML:
11051106

11061107
.. code-block:: yaml

book/translation.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -452,8 +452,8 @@ by the routing system using the special ``_locale`` parameter:
452452
.. code-block:: yaml
453453
454454
contact:
455-
path: /{_locale}/contact
456-
defaults: { _controller: AcmeDemoBundle:Contact:index, _locale: en }
455+
path: /{_locale}/contact
456+
defaults: { _controller: AcmeDemoBundle:Contact:index, _locale: en }
457457
requirements:
458458
_locale: en|fr|de
459459

components/config/definition.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,14 @@ applied to it (like: "the value for ``auto_connect`` must be a boolean value"):
2121
default_connection: mysql
2222
connections:
2323
mysql:
24-
host: localhost
25-
driver: mysql
24+
host: localhost
25+
driver: mysql
2626
username: user
2727
password: pass
2828
sqlite:
29-
host: localhost
30-
driver: sqlite
31-
memory: true
29+
host: localhost
30+
driver: sqlite
31+
memory: true
3232
username: user
3333
password: pass
3434
@@ -473,9 +473,9 @@ in this config:
473473
.. code-block:: yaml
474474
475475
connection:
476-
name: my_mysql_connection
477-
host: localhost
478-
driver: mysql
476+
name: my_mysql_connection
477+
host: localhost
478+
driver: mysql
479479
username: user
480480
password: pass
481481

components/dependency_injection/parameters.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -134,8 +134,8 @@ making the class of a service a parameter:
134134
135135
services:
136136
mailer:
137-
class: '%mailer.class%'
138-
arguments: ['%mailer.transport%']
137+
class: "%mailer.class%"
138+
arguments: ["%mailer.transport%"]
139139
140140
.. code-block:: xml
141141

components/dependency_injection/parentservices.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ The service config for these classes would look something like this:
6262
my_email_formatter:
6363
# ...
6464
newsletter_manager:
65-
class: "%newsletter_manager.class%"
65+
class: "%newsletter_manager.class%"
6666
calls:
6767
- [setMailer, ["@my_mailer"]]
6868
- [setEmailFormatter, ["@my_email_formatter"]]
@@ -196,7 +196,7 @@ a parent for a service.
196196
- [setEmailFormatter, ["@my_email_formatter"]]
197197
198198
newsletter_manager:
199-
class: "%newsletter_manager.class%"
199+
class: "%newsletter_manager.class%"
200200
parent: mail_manager
201201
202202
greeting_card_manager:
@@ -321,13 +321,13 @@ to the ``NewsletterManager`` class, the config would look like this:
321321
- [setEmailFormatter, ["@my_email_formatter"]]
322322
323323
newsletter_manager:
324-
class: "%newsletter_manager.class%"
324+
class: "%newsletter_manager.class%"
325325
parent: mail_manager
326326
calls:
327327
- [setMailer, ["@my_alternative_mailer"]]
328328
329329
greeting_card_manager:
330-
class: "%greeting_card_manager.class%"
330+
class: "%greeting_card_manager.class%"
331331
parent: mail_manager
332332
333333
.. code-block:: xml

components/dependency_injection/types.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ Another possibility is just setting public fields of the class directly::
184184
my_mailer:
185185
# ...
186186
newsletter_manager:
187-
class: NewsletterManager
187+
class: NewsletterManager
188188
properties:
189189
mailer: "@my_mailer"
190190

cookbook/assetic/apply_to_option.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@ An example configuration might look like this:
2020
assetic:
2121
filters:
2222
coffee:
23-
bin: /usr/bin/coffee
24-
node: /usr/bin/node
25-
node_paths: [ /usr/lib/node_modules/ ]
23+
bin: /usr/bin/coffee
24+
node: /usr/bin/node
25+
node_paths: [/usr/lib/node_modules/]
2626
2727
.. code-block:: xml
2828
@@ -130,10 +130,10 @@ applied to all ``.coffee`` files:
130130
assetic:
131131
filters:
132132
coffee:
133-
bin: /usr/bin/coffee
134-
node: /usr/bin/node
135-
node_paths: [ /usr/lib/node_modules/ ]
136-
apply_to: "\.coffee$"
133+
bin: /usr/bin/coffee
134+
node: /usr/bin/node
135+
node_paths: [/usr/lib/node_modules/]
136+
apply_to: "\.coffee$"
137137
138138
.. code-block:: xml
139139

cookbook/assetic/uglifyjs.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,7 @@ your JavaScripts:
7575
7676
<!-- app/config/config.xml -->
7777
<assetic:config>
78+
<!-- bin: the path to the uglifyjs executable -->
7879
<assetic:filter
7980
name="uglifyjs2"
8081
bin="/usr/local/bin/uglifyjs" />
@@ -86,6 +87,7 @@ your JavaScripts:
8687
$container->loadFromExtension('assetic', array(
8788
'filters' => array(
8889
'uglifyjs2' => array(
90+
// the path to the uglifyjs executable
8991
'bin' => '/usr/local/bin/uglifyjs',
9092
),
9193
),

cookbook/bundles/override.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ in the core FrameworkBundle:
5353
5454
# app/config/config.yml
5555
parameters:
56-
translator.class: Acme\HelloBundle\Translation\Translator
56+
translator.class: Acme\HelloBundle\Translation\Translator
5757
5858
.. code-block:: xml
5959

cookbook/bundles/prepend_extension.rst

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,6 @@ for ``acme_hello`` is set to ``non_default``:
9999
.. code-block:: yaml
100100
101101
# app/config/config.yml
102-
103102
acme_something:
104103
# ...
105104
use_acme_goodbye: false
@@ -112,7 +111,6 @@ for ``acme_hello`` is set to ``non_default``:
112111
.. code-block:: xml
113112
114113
<!-- app/config/config.xml -->
115-
116114
<acme-something:config use-acme-goodbye="false">
117115
<acme-something:entity-manager-name>non_default</acme-something:entity-manager-name>
118116
</acme-something:config>
@@ -122,7 +120,6 @@ for ``acme_hello`` is set to ``non_default``:
122120
.. code-block:: php
123121
124122
// app/config/config.php
125-
126123
$container->loadFromExtension('acme_something', array(
127124
...,
128125
'use_acme_goodbye' => false,

cookbook/configuration/apache_router.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ To test that it's working, let's create a very basic route for the AcmeDemoBundl
6060
6161
# app/config/routing.yml
6262
hello:
63-
path: /hello/{name}
63+
path: /hello/{name}
6464
defaults: { _controller: AcmeDemoBundle:Demo:hello }
6565
6666
.. code-block:: xml

cookbook/configuration/environments.rst

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,18 +64,21 @@ easily and transparently:
6464
6565
imports:
6666
- { resource: config.yml }
67+
6768
# ...
6869
6970
.. code-block:: xml
7071
7172
<imports>
7273
<import resource="config.xml" />
7374
</imports>
75+
7476
<!-- ... -->
7577
7678
.. code-block:: php
7779
7880
$loader->import('config.php');
81+
7982
// ...
8083
8184
To share common configuration, each environment's configuration file
@@ -188,12 +191,12 @@ environment by using this code and changing the environment string.
188191
189192
doctrine:
190193
dbal:
191-
logging: "%kernel.debug%"
194+
logging: "%kernel.debug%"
192195
# ...
193196
194197
.. code-block:: xml
195198
196-
<doctrine:dbal logging="%kernel.debug%" ... />
199+
<doctrine:dbal logging="%kernel.debug%" />
197200
198201
.. code-block:: php
199202

cookbook/configuration/pdo_session_storage.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ configuration format of your choice):
2929
framework:
3030
session:
3131
# ...
32-
handler_id: session.handler.pdo
32+
handler_id: session.handler.pdo
3333
3434
parameters:
3535
pdo.db_options:

cookbook/controller/service.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ Then you can define it as a service as follows:
6060
6161
services:
6262
acme.hello.controller:
63-
class: "%acme.controller.hello.class%"
63+
class: "%acme.controller.hello.class%"
6464
6565
.. code-block:: xml
6666
@@ -112,8 +112,8 @@ the route ``_controller`` value:
112112
113113
# app/config/routing.yml
114114
hello:
115-
path: /hello
116-
defaults: { _controller: acme.hello.controller:indexAction }
115+
path: /hello
116+
defaults: { _controller: acme.hello.controller:indexAction }
117117
118118
.. code-block:: xml
119119

cookbook/doctrine/dbal.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ mapping types, read Doctrine's `Custom Mapping Types`_ section of their document
9292
doctrine:
9393
dbal:
9494
types:
95-
custom_first: Acme\HelloBundle\Type\CustomFirst
95+
custom_first: Acme\HelloBundle\Type\CustomFirst
9696
custom_second: Acme\HelloBundle\Type\CustomSecond
9797
9898
.. code-block:: xml
@@ -143,7 +143,7 @@ mapping type:
143143
dbal:
144144
connections:
145145
default:
146-
// Other connections parameters
146+
# other connections parameters
147147
mapping_types:
148148
enum: string
149149
@@ -160,6 +160,7 @@ mapping type:
160160
<doctrine:dbal>
161161
<doctrine:dbal default-connection="default">
162162
<doctrine:connection>
163+
<!-- other connections parameters -->
163164
<doctrine:mapping-type name="enum">string</doctrine:mapping-type>
164165
</doctrine:connection>
165166
</doctrine:dbal>
@@ -173,6 +174,7 @@ mapping type:
173174
'dbal' => array(
174175
'connections' => array(
175176
'default' => array(
177+
// other connection parameers
176178
'mapping_types' => array(
177179
'enum' => 'string',
178180
),

cookbook/doctrine/multiple_entity_managers.rst

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ The following configuration code shows how you can configure two entity managers
2424
2525
doctrine:
2626
dbal:
27-
default_connection: default
27+
default_connection: default
2828
connections:
2929
default:
3030
driver: "%database_driver%"
@@ -44,22 +44,21 @@ The following configuration code shows how you can configure two entity managers
4444
charset: UTF8
4545
4646
orm:
47-
default_entity_manager: default
47+
default_entity_manager: default
4848
entity_managers:
4949
default:
50-
connection: default
50+
connection: default
5151
mappings:
52-
AcmeDemoBundle: ~
52+
AcmeDemoBundle: ~
5353
AcmeStoreBundle: ~
5454
customer:
55-
connection: customer
55+
connection: customer
5656
mappings:
5757
AcmeCustomerBundle: ~
5858
5959
.. code-block:: xml
6060
6161
<?xml version="1.0" encoding="UTF-8"?>
62-
6362
<srv:container xmlns="http://symfony.com/schema/dic/doctrine"
6463
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
6564
xmlns:srv="http://symfony.com/schema/dic/services"

0 commit comments

Comments
 (0)