php/yii2
1
0
Fork 0
mirror of https://github.com/yiisoft/yii2.git synced 2025-11-25 19:20:29 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #6306 from cdvrooman/patch-35

Browse Source 
Update output-theming.md
This commit is contained in:
Qiang Xue
2014-11-28 18:09:55 -05:00
parent c6b0e24a45 88343c1f57
commit 589af41210
1 changed files with 14 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
docs/guide/output-theming.md
View File

@@ -4,17 +4,17 @@ Theming
> Note: This section is under development. > Note: This section is under development.
A theme is a directory of view and layout files. Each file of the theme overrides corresponding file of an application A theme is a directory of view and layout files. Each file of the theme overrides corresponding file of an application
when rendered. A single application may use multiple themes and each may provide totally different experience. At any when rendered. A single application may use multiple themes and each may provide totally different experiences. At any
time only one theme can be active. time only one theme can be active.
> Note: Themes usually do not meant to be redistributed since views are too application specific. If you want to > Note: Themes are usually not meant to be redistributed since views are too application specific. If you want to
redistribute customized look and feel consider CSS and JavaScript files in form of [asset bundles](structure-assets.md) instead. redistribute a customized look and feel, consider CSS and JavaScript files in the form of [asset bundles](structure-assets.md) instead.
Configuring a theme Configuring a theme
------------------- -------------------
Theme configuration is specified via `view` component of the application. In order to set up a theme to work with basic Theme configuration is specified via the `view` component of the application. In order to set up a theme to work with basic
application views the following should be in your application config file: application views, the following should be in your application config file:
```php ```php
'components' => [ 'components' => [
@@ -27,8 +27,8 @@ application views the following should be in your application config file:
], ],
``` ```
In the above `pathMap` defines a map of original paths to themed paths while `baseUrl` defines base URL for In the above, `pathMap` defines a map of original paths to themed paths while `baseUrl` defines the base URL for
resources referenced from theme files. resources referenced by theme files.
In our case `pathMap` is `['@app/views' => '@app/themes/basic']`. That means that every view in `@app/views` will be In our case `pathMap` is `['@app/views' => '@app/themes/basic']`. That means that every view in `@app/views` will be
first searched under `@app/themes/basic` and if a view exists in the theme directory it will be used instead of the first searched under `@app/themes/basic` and if a view exists in the theme directory it will be used instead of the
@@ -40,7 +40,7 @@ For example, with a configuration above a themed version of a view file `@app/vi
### Theming modules ### Theming modules
In order to theme modules `pathMap` may look like the following: In order to theme modules, `pathMap` may look like the following:
```php ```php
'components' => [ 'components' => [
@@ -59,8 +59,8 @@ It will allow you to theme `@app/modules/blog/views/comment/index.php` with `@ap
### Theming widgets ### Theming widgets
In order to theme a widget view located at `@app/widgets/currency/views/index.php` you need the following config for In order to theme a widget view located at `@app/widgets/currency/views/index.php`, you need the following configuration for
view component theme: the view component theme:
```php ```php
'components' => [ 'components' => [
@@ -72,7 +72,7 @@ view component theme:
], ],
``` ```
With the config above you can create themed version of `@app/widgets/currency/index.php` view in With the configuration above you can create a themed version of the `@app/widgets/currency/index.php` view in
`@app/themes/basic/widgets/currency/index.php`. `@app/themes/basic/widgets/currency/index.php`.
Using multiple paths Using multiple paths
@@ -89,7 +89,7 @@ It is possible to map a single path to multiple theme paths. For example,
] ]
``` ```
In this case, the view will be searched in `@app/themes/christmas/site/index.php` then if it's not found it will check In this case, first the view will be searched for 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. `@app/themes/basic/site/index.php`. If there's no view there as well, then the application view will be used.
This ability is especially useful if you want to temporary or conditionally override some views. This ability is especially useful if you want to temporarily or conditionally override some views.