spelling, grammar, and punctuation fixes.

This commit is contained in:
theshka 2015-11-04 10:54:59 -06:00
parent 27f89a9786
commit 4bcef44c9b
11 changed files with 32 additions and 23 deletions

View file

@ -12,7 +12,7 @@ You can override the default Pico settings (and add your own custom settings) by
### URL Rewriting
Picos default URLs (e.g. http://example.com/pico/?sub/page) already are very user friendly. Pico anyway offers you an URL rewrite feature to make URLs even more user friendly (e.g. http://example.com/pico/sub/page).
Pico's default URLs (e.g. http://example.com/pico/?sub/page) already are very user-friendly. Pico anyway offers you an URL rewrite feature to make URLs even more user-friendly (e.g. http://example.com/pico/sub/page).
If you're using the Apache web server, URL rewriting should be enabled automatically. If you get an error message from your web server, please make sure to enable the `mod_rewrite` module. Assumed rewritten URLs work, but Pico still shows no rewritten URLs, force URL rewriting by setting `$config['rewrite_url'] = true;` in your `config/config.php`.

View file

@ -6,11 +6,13 @@ nav: 8
## Contribute
You want to contribute to Pico? We really appreciate that! You can help making Pico better by [contributing code][PullRequests] or [reporting issues][Issues], but please take note of our [contribution guidelines][ContributionGuidelines]. In general you can contribute in three different areas:
You want to contribute to Pico? We really appreciate that! You can help make Pico better by [contributing code][PullRequests] or [reporting issues][Issues], but please take note of our [contribution guidelines][ContributionGuidelines]. In general you can contribute in three different areas:
1. Plugins & Themes: You're a plugin developer or theme designer? We love you guys! You can find tons of information about how to develop plugins and themes at {{ site.base_url }}/plugin-dev.html.html. If you have created a plugin or theme, please add it to our [Wiki][], either on the [plugins][WikiPlugins] or [themes page][WikiThemes]. Doing so, we may select and promote your plugin or theme on [our website][OfficialPlugins] as officially supported!
1. Plugins & Themes: You're a plugin developer or theme designer? We love you guys! You can find tons of information about how to develop plugins and themes at {{ site.base_url }}/plugin-dev.html.html. If you have created a plugin or theme, please add it to our [Wiki][], either on the [plugins][WikiPlugins] or [themes page][WikiThemes]. Maybe we will then promote your plugin or theme on [our website][OfficialPlugins] as officially supported!
2. Documentation: We always appreciate people improving our documentation. You can either improve the [inline user docs][EditInlineDocs] or the more extensive [user docs on our website][EditUserDocs]. You can also improve the [docs for plugin and theme developers][EditDevDocs]. Simply fork Pico from {{ site.gh_project_url }}, change the Markdown files and open a [pull request][PullRequests].
3. Picos Core: The supreme discipline is to work on Picos Core. Your contribution should help *every* Pico user to have a better experience with Pico. If this is the case, fork Pico from {{ site.gh_project_url }} and open a [pull request][PullRequests]. We look forward to your contribution!
3. Pico's Core: The supreme discipline is to work on Pico's Core. Your contribution should help *every* Pico user to have a better experience with Pico. If this is the case, fork Pico from {{ site.gh_project_url }} and open a [pull request][PullRequests]. We look forward to your contribution!
[OfficialPlugins]: {{ site.base_url }}/plugins.html
[Wiki]: {{ site.gh_project_url }}/wiki

View file

@ -46,7 +46,7 @@ If you create a folder within the content folder (e.g. `content-sample/sub`) and
If a file cannot be found, the file `content-sample/404.md` will be shown. You can add `404.md` files to any directory, so if you want to use a special error page for your blog, simply create `content-sample/blog/404.md`.
Instead of adding your own contents to the `content-sample` folder, you should create your own `content` directory in Picos root directory. You can then add and access your contents as described above.
Instead of adding your own content to the `content-sample` folder, you should create your own `content` directory in Pico's root directory. You can then add and access your contents as described above.
### Text File Markup

View file

@ -9,7 +9,7 @@ nav: 5
## Customization
Pico is highly customizable in two different ways: On the one hand you can change Picos appearance by using themes, on the other hand you can add new functionality by using plugins. Doing the former includes changing Picos HTML, CSS and JavaScript, the latter mostly consists of PHP programming.
Pico is highly customizable in two different ways: On the one hand you can change Pico's appearance by using themes, on the other hand you can add new functionality by using plugins. Doing the former includes changing Pico's HTML, CSS and JavaScript, the latter mostly consists of PHP programming.
This is all Greek to you? Don't worry, you don't have to spend time on these techie talk - it's very easy to use one of the great themes or plugins others developed and released to the public. Please refer to the next sections for details.
@ -62,7 +62,7 @@ Pages can be used like the following:
You can use different templates for different content files by specifying the `Template` meta header. Simply add e.g. `Template: blog-post` to a content file and Pico will use the `blog-post.twig` file in your theme folder to render the page.
You don't have to create your own theme if Picos default theme isn't sufficient for you, you can use one of the great themes third-party developers and designers created in the past. As with plugins, you can find themes in [our Wiki][WikiThemes].
You don't have to create your own theme if Pico's default theme isn't sufficient for you, you can use one of the great themes third-party developers and designers created in the past. As with plugins, you can find themes in [our Wiki][WikiThemes].
### Plugins
@ -76,7 +76,7 @@ Plugins which were written to work with Pico 1.0 can be enabled and disabled thr
#### Plugins for developers
You're a plugin developer? We love you guys! You can find tons of information about how to develop plugins at {{ site.base_url }}/plugin-dev.html. If you'd developed a plugin for Pico 0.9 and older, you probably want to upgrade it to the brand new plugin system introduced with Pico 1.0. Please refer to the [upgrade section of the docs][PluginUpgrade].
You're a plugin developer? We love you guys! You can find tons of information about how to develop plugins at {{ site.base_url }}/plugin-dev.html. If you've developed a plugin for Pico 0.9 or older, you probably want to upgrade it to the brand new plugin system introduced with Pico 1.0. Please refer to the [upgrade section of the docs][PluginUpgrade].
[Twig]: http://twig.sensiolabs.org/documentation
[WikiThemes]: {{ site.gh_project_url }}/wiki/Pico-Themes

View file

@ -11,7 +11,7 @@ nav: 7
## Getting Help
### Getting Help as a user
If you want to get started using Pico, please refer to the [user docs][HelpUserDocs] (you're reading them right now!). Please read the [upgrade notes][HelpUpgrade] if you want to upgrade from Pico 0.8 or 0.9 to Pico 1.0. You can find officially supported plugins and themes on [our website][OfficialPlugins]. A greater choice of third-party plugins and themes can be found in our [Wiki][] on the [plugins][WikiPlugins] or [themes page][WikiThemes] respectively. If you want to create your own plugin or theme, please refer to the ["Getting Help as a developer" section](#getting-help-as-a-developer) below.
If you want to get started using Pico, please refer to the [user docs][HelpUserDocs] (you're reading them right now!). Please read the [upgrade notes][HelpUpgrade] if you want to upgrade from Pico 0.8 or 0.9 to Pico 1.0. You can find officially supported plugins and themes on [our website][OfficialPlugins]. A greater choice of third-party plugins and themes can be found in our [Wiki][] on the [plugins][WikiPlugins] or [themes][WikiThemes] pages respectively. If you want to create your own plugin or theme, please refer to the ["Getting Help as a developer" section](#getting-help-as-a-developer) below.
### Getting Help as a developer
If you're a developer, please refer to the ["Contribute" section](#contribute) below and our [contribution guidelines][ContributionGuidelines]. To get you started with creating a plugin or theme, please read the [dev docs on our website][HelpDevDocs].
@ -19,7 +19,7 @@ If you're a developer, please refer to the ["Contribute" section](#contribute) b
### You still need help or experience a problem with Pico?
When the docs can't answer your question or when you're experiencing problems with Pico, please don't hesitate to create a new [Issue][Issues] on GitHub. Concerning problems with plugins or themes, please refer to the website of the developer of this plugin or theme.
Before creating a new Issue, please make sure the problem wasn't reported yet using [GitHubs search engine][IssuesSearch]. Please describe your issue as clear as possible and always include steps to reproduce the problem.
__Before creating a new Issue__, please make sure the problem wasn't reported yet using [GitHubs search engine][IssuesSearch]. Please describe your issue as clear as possible and always include steps to reproduce the problem.
[HelpUpgrade]: {{ site.base_url }}/upgrade.html
[HelpUserDocs]: {{ site.base_url }}/docs.html

View file

@ -9,7 +9,7 @@ nav: 1
## Install
You can install Pico either using a pre-bundled release or with composer. Pico is also available on [Packagist.org][] and may be included in other projects via `composer require picocms/pico`. Pico requires PHP 5.3+
You can install Pico either using a pre-bundled release or with composer. Pico is also available on [Packagist.org][Packagist] and may be included in other projects via `composer require picocms/pico`. Pico requires PHP 5.3+
### Using a pre-bundled release
@ -18,10 +18,10 @@ Just [download the latest Pico release][LatestRelease] and upload all files to t
### Composer
#### Step 1 - for users
[Download the *source code* of Picos latest release][LatestRelease], upload all files to the `httpdocs` directory (e.g. `/var/www/html`) of your server and navigate to the upload directory using a shell.
[Download the *source code* of Pico's latest release][LatestRelease], upload all files to the `httpdocs` directory (e.g. `/var/www/html`) of your server and navigate to the upload directory using a shell.
#### Step 1 - for developers
Open a shell and navigate to the desired install directory of Pico within the `httpdocs` directory (e.g. `/var/www/html`) of your server. You can now clone Picos Git repository as follows:
Open a shell and navigate to the desired install directory of Pico within the `httpdocs` directory (e.g. `/var/www/html`) of your server. You can now clone Pico's Git repository as follows:
<pre><code>$ git clone {{ site.gh_project_url }}.git .</code></pre>
Please note that this gives you the current development version of Pico, what is likely *unstable* and *not ready for production use*!
@ -30,5 +30,6 @@ Download [composer][] and run it with the `install` option:
<pre><code>$ curl -sS https://getcomposer.org/installer | php
$ php composer.phar install</code></pre>
[Packagist]: http://packagist.org/packages/picocms/pico
[LatestRelease]: {{ site.gh_project_url }}/releases/latest
[composer]: https://getcomposer.org/

View file

@ -6,13 +6,13 @@ nav: 3
## Run
You have nothing to consider specially, simply navigate to your Pico install using your favorite web browser. Picos default contents will explain how to use your brand new, stupidly simple, blazing fast, flat file CMS.
You have nothing to consider specially, simply navigate to your Pico install using your favorite web browser. Pico's default contents will explain how to use your brand new, stupidly simple, blazing fast, flat file CMS.
### You don't have a web server?
Starting with PHP 5.4 the easiest way to try Pico is using [the built-in web server of PHP][PHPServer]. Please note that PHPs built-in web server is for development and testing purposes only!
#### Step 1
Navigate to Picos installation directory using a shell.
Navigate to Pico's installation directory using a shell.
#### Step 2
Start PHPs built-in web server:

View file

@ -6,15 +6,17 @@ nav: 2
## Upgrade
Upgrading Pico is very easy: You just have to replace all of Picos files - that's it! Nevertheless you should *always* create a backup of your Pico installation before upgrading.
Upgrading Pico is very easy: You just have to replace all of Pico's files - that's it! Nevertheless you should *always* create a backup of your Pico installation before upgrading.
Pico follows [Semantic Versioning 2.0][SemVer] and uses version numbers like `MAJOR`.`MINOR`.`PATCH`. When we update...
- the `PATCH` version (e.g. `1.0.0` to `1.0.1`), we made backwards-compatible bug fixes. It's then sufficient to extract [Picos latest release][LatestRelease] to your existing installation directory and overwriting all files.
- the `MINOR` version (e.g. `1.0` to `1.1`), we added functionality in a backwards-compatible manner, but anyway recommend you to "install" Pico newly. Backup all of your files, empty your installation directory and install Pico as elucidated above. You can then copy your `config/config.php` and `content` directory without any change. If applicable, you can also copy the folder of your custom theme within the `themes` directory. Provided that you're using plugins, also copy all of your plugins from the `plugins` directory.
- the `MAJOR` version (e.g. `1.0` to `2.0`), a appropriate upgrade tutorial will be provided.
- the `PATCH` version (e.g. `1.0.0` to `1.0.1`), we made backwards-compatible bug fixes. It's then sufficient to extract [Pico's latest release][LatestRelease] to your existing installation directory and overwriting all files.
Upgrading Pico 0.8 or 0.9 to Pico 1.0 is a special case. The new `PicoDeprecated` plugin ensures backwards compatibility, so you basically can follow the above upgrade instructions as if we updated the `MINOR` version. However, we recommend you to take some further steps to confine the neccessity of `PicoDeprecated` as far as possible. For more information about what has changed with Pico 1.0 and a step-by-step upgrade tutorial, please refer to the [upgrade page of our website][HelpUpgrade].
- the `MINOR` version (e.g. `1.0` to `1.1`), we added functionality in a backwards-compatible manner, but anyway recommend you to "install" Pico newly. Backup all of your files, empty your installation directory and install Pico as elucidated above. You can then copy your `config/config.php` and `content` directory without any change. If applicable, you can also copy the folder of your custom theme within the `themes` directory. Provided that you're using plugins, also copy all of your plugins from the `plugins` directory.
- the `MAJOR` version (e.g. `1.0` to `2.0`), an appropriate upgrade tutorial will be provided.
Upgrading Pico 0.8 or 0.9 to Pico 1.0 is a special case. The new `PicoDeprecated` plugin ensures backwards compatibility, so you basically can follow the above upgrade instructions as if we updated the `MINOR` version. However, we recommend you to take some further steps to confine the necessity of `PicoDeprecated` as far as possible. For more information about what has changed with Pico 1.0 and a step-by-step upgrade tutorial, please refer to the [upgrade page of our website][HelpUpgrade].
[SemVer]: http://semver.org
[LatestRelease]: {{ site.gh_project_url }}/releases/latest

View file

@ -11,4 +11,4 @@ nav: 2
It's generally not a good idea to make modifications to the core of Pico. If you
are looking to add or change functionality, can it be accomplished with a plugin?
If not, and you want to contribute to Picos core please refer to our [CONTRIBUTING.md]({{ site.gh_project_url }}/blob/{{ site.gh_project_branch }}/CONTRIBUTING.md) on GitHub.
If not, and you want to contribute to Pico's core please refer to our [CONTRIBUTING.md]({{ site.gh_project_url }}/blob/{{ site.gh_project_branch }}/CONTRIBUTING.md) on GitHub.

View file

@ -19,11 +19,13 @@ Officially tested plugins can be found at {{ site.base_url }}/plugins.html,
but there are many awesome third-party plugins out there! A good start point
for discovery is our [Wiki](#plugin-wiki).
---
### Migrating from 0.X to 1.0
The new event system supports plugin dependencies as well as some new events.
You will be able to set an enabled/disabled state by default as well. If you
have previously cerated a plugin for Pico, it is *HIGHLY* recommended that you
have previously created a plugin for Pico, it is *HIGHLY* recommended that you
update your class to extend from [AbstractPicoPlugin]({{ site.base_url }}/phpDoc/master/classes/AbstractPicoPlugin.html) and use the new events
to avoid activating the [PicoDeprecated]({{ site.gh_project_url }}/blob/{{ site.gh_project_branch }}/plugins/00-PicoDeprecated.php) plugin.
@ -48,6 +50,8 @@ to avoid activating the [PicoDeprecated]({{ site.gh_project_url }}/blob/{{ site.
| onPageRendering | before_render($twigVariables, $twig, $templateName) |
| onPageRendered | after_render($output) |
---
### Your First Plugin
#### 1. To get started, navigate to your `plugins` directory

View file

@ -2,7 +2,7 @@
layout: collection
title: Development
headline: Create your own plugins & themes
description: Below is our developer documentation, you may also refer to Picos [class documentation](phpDoc/master/).
description: Below is our developer documentation, you may also refer to Pico's [class documentation](phpDoc/master/).
collection: plugin-dev
nav: 3
---