Update docs to reflect 9b7523b

This commit is contained in:
Daniel Rudolf 2017-02-06 00:01:25 +01:00
parent d4c65fa523
commit 882a80a179
No known key found for this signature in database
GPG key ID: A061F02CD8DE4538
3 changed files with 22 additions and 22 deletions

View file

@ -20,7 +20,7 @@
<!-- exclude user config -->
<ignore>config/*</ignore>
<file>config/config.php.template</file>
<file>config/config.yml.template</file>
<!-- exclude all plugins -->
<ignore>plugins/*</ignore>

View file

@ -156,15 +156,15 @@ details.
You can create themes for your Pico installation in the `themes` folder. Check
out the default theme for an example. Pico uses [Twig][] for template
rendering. You can select your theme by setting the `$config['theme']` option
in `config/config.php` to the name of your theme folder.
rendering. You can select your theme by setting the `theme` option in
`config/config.yml` to the name of your theme folder.
All themes must include an `index.twig` (or `index.html`) file to define the
HTML structure of the theme. Below are the Twig variables that are available
to use in your theme. Please note that paths (e.g. `{{ base_dir }}`) and URLs
(e.g. `{{ base_url }}`) don't have a trailing slash.
* `{{ config }}` - Contains the values you set in `config/config.php`
* `{{ config }}` - Contains the values you set in `config/config.yml`
(e.g. `{{ config.theme }}` becomes `default`)
* `{{ base_dir }}` - The path to your Pico root directory
* `{{ base_url }}` - The URL to your Pico site; use Twigs `link` filter to
@ -173,7 +173,7 @@ to use in your theme. Please note that paths (e.g. `{{ base_dir }}`) and URLs
is enabled or not
* `{{ theme_dir }}` - The path to the currently active theme
* `{{ theme_url }}` - The URL to the currently active theme
* `{{ site_title }}` - Shortcut to the site title (see `config/config.php`)
* `{{ site_title }}` - Shortcut to the site title (see `config/config.yml`)
* `{{ meta }}` - Contains the meta values from the current page
* `{{ meta.title }}`
* `{{ meta.description }}`
@ -247,10 +247,10 @@ steps (e.g. specifying config variables), the plugin docs or `README` file will
explain what to do.
Plugins which were written to work with Pico 1.0 can be enabled and disabled
through your `config/config.php`. If you want to e.g. disable the `PicoExcerpt`
plugin, add the following line to your `config/config.php`:
`$config['PicoExcerpt.enabled'] = false;`. To force the plugin to be enabled
replace `false` with `true`.
through your `config/config.yml`. If you want to e.g. disable the `PicoExcerpt`
plugin, add the following line to your `config/config.yml`:
`PicoExcerpt.enabled: false`. To force the plugin to be enabled replace `false`
with `true`.
#### Plugins for developers
@ -281,14 +281,14 @@ enabled - try it yourself, click on the [second URL](%base_url%/sub/page). If
you get an error message from your web server, please make sure to enable the
[`mod_rewrite` module][ModRewrite]. Assuming the second URL works, but Pico
still shows no rewritten URLs, force URL rewriting by setting
`$config['rewrite_url'] = true;` in your `config/config.php`.
`rewrite_url: true` in your `config/config.yml`.
If you're using Nginx, you can use the following configuration to enable URL
rewriting (lines `5` to `8`) and denying access to Pico's internal files
(lines `1` to `3`). You'll need to adjust the path (`/pico` on lines `1`, `5`
and `7`) to match your installation directory. Additionally, you'll need to
enable URL rewriting by setting `$config['rewrite_url'] = true;` in your
`config/config.php`. The Nginx configuration should provide the *bare minimum*
enable URL rewriting by setting `rewrite_url: true` in your
`config/config.yml`. The Nginx configuration should provide the *bare minimum*
you need for Pico. Nginx is a very extensive subject. If you have any trouble,
please read through our [Nginx configuration docs][NginxConfig].

View file

@ -652,15 +652,15 @@ class Pico
}
/**
* Loads the config.php and any *.config.php from Pico::$configDir
* Loads the config.yml and any other *.yml from Pico::$configDir
*
* After loading the {@path "config/config.php"}, Pico proceeds with any
* existing `config/*.config.php` in alphabetical order. The file order is
* crucial: Config values which has been set already, cannot be overwritten
* by a succeeding file. This is also true for arrays, i.e. when specifying
* `$config['test'] = array('foo' => 'bar')` in `config/a.config.php` and
* `$config['test'] = array('baz' => 42)` in `config/b.config.php`,
* `$config['test']['baz']` will be undefined!
* After loading {@path "config/config.yml"}, Pico proceeds with any other
* existing `config/*.yml` file in alphabetical order. The file order is
* crucial: Config values which have been set already, cannot be
* overwritten by a succeeding file. This is also true for arrays, i.e.
* when specifying `test: { foo: bar }` in `config/a.yml` and
* `test: { baz: 42 }` in `config/b.yml`, `{{ config.test.baz }}` will be
* undefined!
*
* @see Pico::setConfig()
* @see Pico::getConfig()
@ -763,12 +763,12 @@ class Pico
* Sets Pico's config before calling Pico::run()
*
* This method allows you to modify Pico's config without creating a
* {@path "config/config.php"} or changing some of its variables before
* {@path "config/config.yml"} or changing some of its variables before
* Pico starts processing.
*
* You can call this method between {@link Pico::__construct()} and
* {@link Pico::run()} only. Options set with this method cannot be
* overwritten by {@path "config/config.php"}.
* overwritten by {@path "config/config.yml"}.
*
* @see Pico::loadConfig()
* @see Pico::getConfig()