Commit ada39df6 by Alexander Makarov

Corrected theming docs not to give an example of theme view files under webroot

parent 3a232743
......@@ -18,7 +18,7 @@ be in your application config file:
'components' => [
'view' => [
'theme' => [
'pathMap' => ['@app/views' => '@webroot/themes/basic'],
'pathMap' => ['@app/views' => '@app/themes/basic'],
'baseUrl' => '@web/themes/basic',
],
],
......@@ -26,8 +26,8 @@ be in your application config file:
```
In the above `pathMap` defines where to look for view files while `baseUrl` defines base URL for resources referenced
from these files. For example, if `pathMap` is `['/web/views' => '/web/themes/basic']`, then the themed version
for a view file `/web/views/site/index.php` will be `/web/themes/basic/site/index.php`.
from these files. In our case `pathMap` is `['@app/views' => '@app/themes/basic']` so the themed version
for a view file `@app/views/site/index.php` will be `@app/themes/basic/site/index.php`.
Using multiple paths
--------------------
......@@ -36,14 +36,14 @@ It is possible to map a single path to multiple paths. For example,
```php
'pathMap' => [
'/web/views' => [
'/web/themes/christmas',
'/web/themes/basic',
'@app/views' => [
'@app/themes/christmas',
'@app/themes/basic',
],
]
```
In this case, the view will be searched in `/web/themes/christmas/site/index.php` then if it's not found it will check
`/web/themes/basic/site/index.php`. If there's no view there as well application view will be used.
In this case, the view will be searched in `@app/themes/christmas/site/index.php` then if it's not found it will check
`@app/themes/basic/site/index.php`. If there's no view there as well application view will be used.
This ability is especially useful if you want to temporary or conditionally override some views.
......@@ -27,23 +27,23 @@ use yii\helpers\FileHelper;
* to replace the original view file.
* 4. If Step 2 or 3 fails, the original view file will be used.
*
* For example, if [[pathMap]] is `['/web/views' => '/web/themes/basic']`,
* then the themed version for a view file `/web/views/site/index.php` will be
* `/web/themes/basic/site/index.php`.
* For example, if [[pathMap]] is `['@app/views' => '@app/themes/basic']`,
* then the themed version for a view file `@app/views/site/index.php` will be
* `@app/themes/basic/site/index.php`.
*
* It is possible to map a single path to multiple paths. For example,
*
* ~~~
* 'pathMap' => [
* '/web/views' => [
* '/web/themes/christmas',
* '/web/themes/basic',
* '@app/views' => [
* '@app/themes/christmas',
* '@app/themes/basic',
* ],
* ]
* ~~~
*
* In this case, the themed version could be either `/web/themes/christmas/site/index.php` or
* `/web/themes/basic/site/index.php`. The former has precedence over the latter if both files exist.
* In this case, the themed version could be either `@app/themes/christmas/site/index.php` or
* `@app/themes/basic/site/index.php`. The former has precedence over the latter if both files exist.
*
* To use a theme, you should configure the [[View::theme|theme]] property of the "view" application
* component like the following:
......@@ -51,7 +51,7 @@ use yii\helpers\FileHelper;
* ~~~
* 'view' => [
* 'theme' => [
* 'basePath' => '@webroot/themes/basic',
* 'basePath' => '@app/themes/basic',
* 'baseUrl' => '@web/themes/basic',
* ],
* ],
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment