mirror of
https://github.com/inretio/WordPress-Plugin-Boilerplate
synced 2024-12-22 11:53:53 +02:00
Adding the initial version of the README
This commit is contained in:
Tom McFarlin
parent
436ca4a72b
commit
0d21f63eda
1 changed files with 106 additions and 4 deletions
110
README.md
110
README.md
|
|
@ -1,9 +1,111 @@
|
|||
# WordPress Plugin Boilerplate
|
||||
|
||||
* **Last Updated:** 19 August 2014
|
||||
A standardized, organized, object-oriented foundation for building high-quality WordPress Plugins.
|
||||
|
||||
This branch is currently for a rewrite of the WordPress Plugin Boilerplate. The branch is currently in beta.
|
||||
## Contents
|
||||
|
||||
This is experimental code and is not intended for use until it's been merged into the `master` branch.
|
||||
The WordPress Plugin Boilerplate includes the following files:
|
||||
|
||||
Please review the [ChangeLog](https://github.com/tommcfarlin/WordPress-Plugin-Boilerplate/blob/develop/ChangeLog.md) for more information.
|
||||
* `README.md`. The file that you’re currently reading.
|
||||
* `ChangeLog.md`. The list of changes to the core project.
|
||||
* A `plugin-name` subdirectory that contains the source code - a fully executable WordPress plugin.
|
||||
|
||||
## Features
|
||||
|
||||
* The Boilerplate is based on the [Plugin API](http://codex.wordpress.org/Plugin_API), [Coding Standards](http://codex.wordpress.org/WordPress_Coding_Standards), and [Documentation Standards](http://make.wordpress.org/core/handbook/inline-documentation-standards/php-documentation-standards/).
|
||||
* All classes, functions, and variables are documented so that you know what you need to be changed.
|
||||
* The Boilerplate uses a strict file organization scheme that correspond both to the WordPress Plugin Repository structure, and that make it easy to organize the files that compose the plugin.
|
||||
* The project includes a `.pot` file as a starting point for internationalization.
|
||||
|
||||
## Installation
|
||||
|
||||
1. Copy the `plugin-name` directory into your `wp-content/plugins` directory.
|
||||
2. In the WordPress dashboard, navigation to the *Plugins* page
|
||||
Locate the menu item that reads “The WordPress Plugin Boilerplate.”
|
||||
3. Click on *Activate.*
|
||||
|
||||
Note that this will activate the source code of the Boilerplate, but because the Boilerplate has no real functionality so no menu items, meta boxes, or custom post types will be added.
|
||||
|
||||
Examples are slated to be added to the [Boilerplate’s website](http://wppb.io) as the site continues to grow.
|
||||
|
||||
## Recommended Tools
|
||||
|
||||
### i18n Tools
|
||||
|
||||
The WordPress Plugin Boilerplate uses a variable to store the text domain used when internationalizing strings throughout the Boilerplate. To take advantage of this method, there are tools that are recommended for providing correct, translatable files:
|
||||
|
||||
* [Poedit](http://www.poedit.net/)
|
||||
* [makepot](http://i18n.svn.wordpress.org/tools/trunk/)
|
||||
* [i18n](https://github.com/grappler/i18n)
|
||||
|
||||
Any of the above tools should provide you with the proper tooling to internationalize the plugin.
|
||||
|
||||
## License
|
||||
|
||||
The WordPress Plugin Boilerplate is licensed under the GPL v2 or later.
|
||||
|
||||
> This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, version 2, as published by the Free Software Foundation.
|
||||
|
||||
> This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
|
||||
|
||||
> You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
|
||||
|
||||
A copy of the license is included in the root of the plugin’s directory. The file is named `LICENSE`.
|
||||
|
||||
## Important Notes
|
||||
|
||||
### Licensing
|
||||
|
||||
The WordPress Plugin Boilerplate is licensed under the GPL v2 or later; however, if you opt to use third-party code that is not compatible with v2, then you may need to switch to using code that is GPL v3 compatible.
|
||||
|
||||
For reference, [here's a discussion](http://make.wordpress.org/themes/2013/03/04/licensing-note-apache-and-gpl/) that covers the Apache 2.0 License used by [Bootstrap](http://twitter.github.io/bootstrap/).
|
||||
|
||||
### Includes
|
||||
|
||||
Note that if you include your own classes, or third-party libraries, there are three locations in which said files may go:
|
||||
|
||||
* `plugin-name/includes` is where functionality shared between the dashboard and the public-facing parts of the side reside
|
||||
* `plugin-name/admin` is for all dashboard-specific functionality
|
||||
* `plugin-name/public` is for all public-facing functionality
|
||||
|
||||
Note that previous versions of the Boilerplate did not include `Plugin_Name_Loader` but this class is used to register all filters and actions with WordPress.
|
||||
|
||||
The example code provided shows how to register your hooks with the Loader class. More information will be provided in the upcoming documentation on the website.
|
||||
|
||||
### Assets
|
||||
|
||||
The `assets` directory contains three files.
|
||||
|
||||
1. `banner-772x250.png` is used to represent the plugin’s header image.
|
||||
2. `icon-256x256.png` is a used to represent the plugin’s icon image (which is new as of WordPress 4.0).
|
||||
3. `screenshot-1.png` is used to represent a single screenshot of the plugin that corresponds to the “Screenshots” heading in your plugin `README.txt`.
|
||||
|
||||
The WordPress Plugin Repository directory structure contains three directories:
|
||||
|
||||
1. `assets`
|
||||
2. `branches`
|
||||
3. `trunk`
|
||||
|
||||
The Boilerplate offers support for `assets` and `trunk` as `branches` is something that isn’t often used and, when it is, is done so under advanced circumstances.
|
||||
|
||||
When committing code to the WordPress Plugin Repository, all of the banner, icon, and screenshot should be placed in the `assets` directory of the Repository, and the core code should be placed in the `trunk` directory.
|
||||
|
||||
### What About Other Features?
|
||||
|
||||
The previous version of the WordPress Plugin Boilerplate included support for a number of different projects such as the [GitHub Updater](https://github.com/afragen/github-updater).
|
||||
|
||||
These tools are not part of the core of this Boilerplate, as I see them as being additions, forks, or other contributions to the Boilerplate.
|
||||
|
||||
The same is true of using tools like Grunt, Composer, etc. These are all fantastic tools, but not everyone uses them. In order to keep the core Boilerplate as light as possible, this feature have been removed and will be introduced in other editions, and will be listed and maintained on the project homepage
|
||||
|
||||
# Credits
|
||||
|
||||
The WordPress Plugin Boilerplate was started in 2011 by [Tom McFarlin](http://twitter.com/tommcfarlin/) and his since included a number of great contributions.
|
||||
|
||||
The current version of the Boilerplate was developed in conjunction with [Josh Eaton](https://twitter.com/jjeaton), [Ulrich Pogson](https://twitter.com/grapplerulrich), and [Brad Vincent](https://twitter.com/themergency).
|
||||
|
||||
The homepage is based on a design as provided by [HTML5Up](http://html5up.net), and the Boilerplate logo was designed by Rob McCaskill of [BungaWeb](http://bungaweb.com).
|
||||
|
||||
## Documentation, FAQs, and More
|
||||
|
||||
Because this version is a major rewrite of the core plugin, we’re working to create an entire site around the Boilerplate. If you’re interested, please [let me know](http://tommcfarlin.com/contact) and we’ll see what we can do.
|
||||
Loading…
Reference in a new issue