Compare commits
No commits in common. "a7910c81a8431f65313b90e571a9e1064cb1c554" and "bfeb1242a7a5bd8b29ea08ef4339646a73cfd55c" have entirely different histories.
a7910c81a8
...
bfeb1242a7
179
README.md
179
README.md
|
|
@ -1,178 +1,3 @@
|
||||||
# BIOFRICTION THEME
|
# biofriction-web
|
||||||
This project is to create a theme for the [Biofriction](https://gridspinoza.net/programs/biofriction) project hosted by [Hangar](https://hangar.org).
|
|
||||||
|
|
||||||
It is based on top of [FoundationPress](https://github.com/olefredrik/FoundationPress) and Zurb's [Foundation for Sites 6](https://foundation.zurb.com/sites.html).
|
theme and plugins for the biofriction.org wordpress website
|
||||||
|
|
||||||
|
|
||||||
# FoundationPress
|
|
||||||
|
|
||||||
[](https://gitter.im/olefredrik/foundationpress?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
|
|
||||||
[](https://github.com/olefredrik/FoundationPress/releases)
|
|
||||||
[](https://opensource.org/licenses/MIT)
|
|
||||||
|
|
||||||
This is a starter-theme for WordPress based on Zurb's [Foundation for Sites 6](https://foundation.zurb.com/sites.html), the most advanced responsive (mobile-first) framework in the world. The purpose of FoundationPress, is to act as a small and handy toolbox that contains the essentials needed to build any design. FoundationPress is meant to be a starting point, not the final product.
|
|
||||||
|
|
||||||
Please fork, copy, modify, delete, share or do whatever you like with this.
|
|
||||||
|
|
||||||
All contributions are welcome!
|
|
||||||
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
**This project requires [Node.js](http://nodejs.org) v6.x.x 11.6.x to be installed on your machine.** Please be aware that you might encounter problems with the installation if you are using the most current Node version (bleeding edge) with all the latest features.
|
|
||||||
|
|
||||||
FoundationPress uses [Sass](http://Sass-lang.com/) (CSS with superpowers). In short, Sass is a CSS pre-processor that allows you to write styles more effectively and tidy.
|
|
||||||
|
|
||||||
The Sass is compiled using libsass, which requires the GCC to be installed on your machine. Windows users can install it through [MinGW](http://www.mingw.org/), and Mac users can install it through the [Xcode Command-line Tools](http://osxdaily.com/2014/02/12/install-command-line-tools-mac-os-x/).
|
|
||||||
|
|
||||||
If you have not worked with a Sass-based workflow before, I would recommend reading [FoundationPress for beginners](https://foundationpress.olefredrik.com/posts/tutorials/foundationpress-for-beginners), a short blog post that explains what you need to know.
|
|
||||||
|
|
||||||
## Quickstart
|
|
||||||
|
|
||||||
### 1. Clone the repository and install with npm
|
|
||||||
```bash
|
|
||||||
$ cd my-wordpress-folder/wp-content/themes/
|
|
||||||
$ git clone https://github.com/olefredrik/FoundationPress.git
|
|
||||||
$ cd FoundationPress
|
|
||||||
$ npm install
|
|
||||||
```
|
|
||||||
|
|
||||||
### 2. Configuration
|
|
||||||
|
|
||||||
#### YAML config file
|
|
||||||
FoundationPress includes a `config-default.yml` file. To make changes to the configuration, make a copy of `config-default.yml` and name it `config.yml` and make changes to that file. The `config.yml` file is ignored by git so that each environment can use a different configuration with the same git repo.
|
|
||||||
|
|
||||||
At the start of the build process a check is done to see if a `config.yml` file exists. If `config.yml` exists, the configuration will be loaded from `config.yml`. If `config.yml` does not exist, `config-default.yml` will be used as a fallback.
|
|
||||||
|
|
||||||
#### Browsersync setup
|
|
||||||
If you want to take advantage of [Browsersync](https://www.browsersync.io/) (automatic browser refresh when a file is saved), simply open your `config.yml` file after creating it in the previous step, and put your local dev-server address and port (e.g http://localhost:8888) in the `url` property under the `BROWSERSYNC` object.
|
|
||||||
|
|
||||||
#### Static asset hashing / cache breaker
|
|
||||||
If you want to make sure your users see the latest changes after re-deploying your theme, you can enable static asset hashing. In your `config.yml`, set ``REVISIONING: true;``. Hashing will work on the ``npm run build`` and ``npm run dev`` commands. It will not be applied on the start command with browsersync. This is by design. Hashing will only change if there are actual changes in the files.
|
|
||||||
|
|
||||||
### 3. Get started
|
|
||||||
|
|
||||||
```bash
|
|
||||||
$ npm start
|
|
||||||
```
|
|
||||||
|
|
||||||
### 4. Compile assets for production
|
|
||||||
|
|
||||||
When building for production, the CSS and JS will be minified. To minify the assets in your `/dist` folder, run
|
|
||||||
|
|
||||||
```bash
|
|
||||||
$ npm run build
|
|
||||||
```
|
|
||||||
|
|
||||||
#### To create a .zip file of your theme, run:
|
|
||||||
|
|
||||||
```
|
|
||||||
$ npm run package
|
|
||||||
```
|
|
||||||
|
|
||||||
Running this command will build and minify the theme's assets and place a .zip archive of the theme in the `packaged` directory. This excludes the developer files/directories from your theme like `/node_modules`, `/src`, etc. to keep the theme lightweight for transferring the theme to a staging or production server.
|
|
||||||
|
|
||||||
### Project structure
|
|
||||||
|
|
||||||
In the `/src` folder you will find the working files for all your assets. Every time you make a change to a file that is watched by Gulp, the output will be saved to the `/dist` folder. The contents of this folder is the compiled code that you should not touch (unless you have a good reason for it).
|
|
||||||
|
|
||||||
The `/page-templates` folder contains templates that can be selected in the Pages section of the WordPress admin panel. To create a new page-template, simply create a new file in this folder and make sure to give it a template name.
|
|
||||||
|
|
||||||
I guess the rest is quite self explanatory. Feel free to ask if you feel stuck.
|
|
||||||
|
|
||||||
### Styles and Sass Compilation
|
|
||||||
|
|
||||||
* `style.css`: Do not worry about this file. (For some reason) it's required by WordPress. All styling are handled in the Sass files described below
|
|
||||||
|
|
||||||
* `src/assets/scss/app.scss`: Make imports for all your styles here
|
|
||||||
* `src/assets/scss/global/*.scss`: Global settings
|
|
||||||
* `src/assets/scss/components/*.scss`: Buttons etc.
|
|
||||||
* `src/assets/scss/modules/*.scss`: Topbar, footer etc.
|
|
||||||
* `src/assets/scss/templates/*.scss`: Page template styling
|
|
||||||
|
|
||||||
* `dist/assets/css/app.css`: This file is loaded in the `<head>` section of your document, and contains the compiled styles for your project.
|
|
||||||
|
|
||||||
If you're new to Sass, please note that you need to have Gulp running in the background (``npm start``), for any changes in your scss files to be compiled to `app.css`.
|
|
||||||
|
|
||||||
### JavaScript Compilation
|
|
||||||
|
|
||||||
All JavaScript files, including Foundation's modules, are imported through the `src/assets/js/app.js` file. The files are imported using module dependency with [webpack](https://webpack.js.org/) as the module bundler.
|
|
||||||
|
|
||||||
If you're unfamiliar with modules and module bundling, check out [this resource for node style require/exports](http://openmymind.net/2012/2/3/Node-Require-and-Exports/) and [this resource to understand ES6 modules](http://exploringjs.com/es6/ch_modules.html).
|
|
||||||
|
|
||||||
Foundation modules are loaded in the `src/assets/js/app.js` file. By default all components are loaded. You can also pick and choose which modules to include. Just follow the instructions in the file.
|
|
||||||
|
|
||||||
If you need to output additional JavaScript files separate from `app.js`, do the following:
|
|
||||||
* Create new `custom.js` file in `src/assets/js/`. If you will be using jQuery, add `import $ from 'jquery';` at the top of the file.
|
|
||||||
* In `config.yml`, add `src/assets/js/custom.js` to `PATHS.entries`.
|
|
||||||
* Build (`npm start`)
|
|
||||||
* You will now have a `custom.js` file outputted to the `dist/assets/js/` directory.
|
|
||||||
|
|
||||||
## Demo
|
|
||||||
|
|
||||||
* [Clean FoundationPress install](http://foundationpress.olefredrik.com/)
|
|
||||||
* [FoundationPress Kitchen Sink - see every single element in action](http://foundationpress.olefredrik.com/kitchen-sink/)
|
|
||||||
|
|
||||||
## Local Development
|
|
||||||
We recommend using one of the following setups for local WordPress development:
|
|
||||||
|
|
||||||
* [MAMP](https://www.mamp.info/en/) (macOS)
|
|
||||||
* [WAMP](http://www.wampserver.com/en/download-wampserver-64bits/) (Windows)
|
|
||||||
* [LAMP](https://www.linux.com/learn/easy-lamp-server-installation) (Linux)
|
|
||||||
* [Local](https://local.getflywheel.com/) (macOS/Windows)
|
|
||||||
* [VVV (Varying Vagrant Vagrants)](https://github.com/Varying-Vagrant-Vagrants/VVV) (Vagrant Box)
|
|
||||||
* [Trellis](https://roots.io/trellis/)
|
|
||||||
|
|
||||||
|
|
||||||
## Tutorials
|
|
||||||
|
|
||||||
* [FoundationPress for beginners](https://foundationpress.olefredrik.com/posts/tutorials/foundationpress-for-beginners/)
|
|
||||||
* [Responsive images in WordPress with Interchange](http://rachievee.com/responsive-images-in-wordpress/)
|
|
||||||
* [Learn to use the _settings file to change almost every aspect of a Foundation site](http://zurb.com/university/lessons/66)
|
|
||||||
* [Other lessons from Zurb University](http://zurb.com/university/past-lessons)
|
|
||||||
|
|
||||||
## Documentation
|
|
||||||
|
|
||||||
* [Zurb Foundation Docs](http://foundation.zurb.com/docs/)
|
|
||||||
* [WordPress Codex](http://codex.wordpress.org/)
|
|
||||||
|
|
||||||
## Showcase
|
|
||||||
|
|
||||||
* [Harvard Center for Green Buildings and Cities](http://www.harvardcgbc.org/)
|
|
||||||
* [The New Tropic](http://thenewtropic.com/)
|
|
||||||
* [Parent-Child Home Program](http://www.parent-child.org/)
|
|
||||||
* [Hip and Healthy](http://hipandhealthy.com/)
|
|
||||||
* [Franchise Career Advisors](http://franchisecareeradvisors.com/)
|
|
||||||
* [Maren Schmidt](http://marenschmidt.com/)
|
|
||||||
* [Finnerodja](http://www.finnerodja.se/)
|
|
||||||
* [WP Diamonds](http://www.wpdiamonds.com/)
|
|
||||||
* [Storm Arts](http://stormarts.fi/)
|
|
||||||
* [ProfitGym](http://profitgym.nl/)
|
|
||||||
* [Agritur Piasina](http://www.agriturpiasina.it/)
|
|
||||||
* [Byington Vineyard & Winery](https://byington.com/)
|
|
||||||
* [Show And Tell](http://www.showandtelluk.com/)
|
|
||||||
* [Wahl + Case](https://www.wahlandcase.com/)
|
|
||||||
* [Morgridge Institute for Research](https://morgridge.org)
|
|
||||||
* [Impeach Trump Now](https://impeachdonaldtrumpnow.org/)
|
|
||||||
* [La revanche des sites](https://www.la-revanche-des-sites.fr/)
|
|
||||||
* [Dyami Wilson](https://dyamiwilson.com)
|
|
||||||
* [Madico Solutions](https://madico.com)
|
|
||||||
|
|
||||||
>Credit goes to all the brilliant designers and developers out there. Have **you** made a site that should be on this list? [Please let me know](https://twitter.com/olefredrik)
|
|
||||||
|
|
||||||
## Contributing
|
|
||||||
#### Here are ways to get involved:
|
|
||||||
|
|
||||||
1. [Star](https://github.com/olefredrik/FoundationPress/stargazers) the project!
|
|
||||||
2. Answer questions that come through [GitHub issues](https://github.com/olefredrik/FoundationPress/issues)
|
|
||||||
3. Report a bug that you find
|
|
||||||
4. Share a theme you've built on top of FoundationPress
|
|
||||||
5. [Tweet](https://twitter.com/intent/tweet?original_referer=http%3A%2F%2Ffoundationpress.olefredrik.com%2F&text=Check%20out%20FoundationPress%2C%20the%20ultimate%20%23WordPress%20starter-theme%20built%20on%20%23Foundation%206&tw_p=tweetbutton&url=http%3A%2F%2Ffoundationpress.olefredrik.com&via=olefredrik) and [blog](http://www.justinfriebel.com/my-first-experience-with-foundationpress-a-wordpress-starter-theme-106/) your experience of FoundationPress.
|
|
||||||
|
|
||||||
#### Pull Requests
|
|
||||||
|
|
||||||
Pull requests are highly appreciated. Please follow these guidelines:
|
|
||||||
|
|
||||||
1. Solve a problem. Features are great, but even better is cleaning-up and fixing issues in the code that you discover
|
|
||||||
2. Make sure that your code is bug-free and does not introduce new bugs
|
|
||||||
3. Create a [pull request](https://help.github.com/articles/creating-a-pull-request)
|
|
||||||
4. Verify that all the Travis-CI build checks have passed
|
|
||||||
|
|
@ -0,0 +1,674 @@
|
||||||
|
GNU GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
Preamble
|
||||||
|
|
||||||
|
The GNU General Public License is a free, copyleft license for
|
||||||
|
software and other kinds of works.
|
||||||
|
|
||||||
|
The licenses for most software and other practical works are designed
|
||||||
|
to take away your freedom to share and change the works. By contrast,
|
||||||
|
the GNU General Public License is intended to guarantee your freedom to
|
||||||
|
share and change all versions of a program--to make sure it remains free
|
||||||
|
software for all its users. We, the Free Software Foundation, use the
|
||||||
|
GNU General Public License for most of our software; it applies also to
|
||||||
|
any other work released this way by its authors. You can apply it to
|
||||||
|
your programs, too.
|
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
To protect your rights, we need to prevent others from denying you
|
||||||
|
these rights or asking you to surrender the rights. Therefore, you have
|
||||||
|
certain responsibilities if you distribute copies of the software, or if
|
||||||
|
you modify it: responsibilities to respect the freedom of others.
|
||||||
|
|
||||||
|
For example, if you distribute copies of such a program, whether
|
||||||
|
gratis or for a fee, you must pass on to the recipients the same
|
||||||
|
freedoms that you received. You must make sure that they, too, receive
|
||||||
|
or can get the source code. And you must show them these terms so they
|
||||||
|
know their rights.
|
||||||
|
|
||||||
|
Developers that use the GNU GPL protect your rights with two steps:
|
||||||
|
(1) assert copyright on the software, and (2) offer you this License
|
||||||
|
giving you legal permission to copy, distribute and/or modify it.
|
||||||
|
|
||||||
|
For the developers' and authors' protection, the GPL clearly explains
|
||||||
|
that there is no warranty for this free software. For both users' and
|
||||||
|
authors' sake, the GPL requires that modified versions be marked as
|
||||||
|
changed, so that their problems will not be attributed erroneously to
|
||||||
|
authors of previous versions.
|
||||||
|
|
||||||
|
Some devices are designed to deny users access to install or run
|
||||||
|
modified versions of the software inside them, although the manufacturer
|
||||||
|
can do so. This is fundamentally incompatible with the aim of
|
||||||
|
protecting users' freedom to change the software. The systematic
|
||||||
|
pattern of such abuse occurs in the area of products for individuals to
|
||||||
|
use, which is precisely where it is most unacceptable. Therefore, we
|
||||||
|
have designed this version of the GPL to prohibit the practice for those
|
||||||
|
products. If such problems arise substantially in other domains, we
|
||||||
|
stand ready to extend this provision to those domains in future versions
|
||||||
|
of the GPL, as needed to protect the freedom of users.
|
||||||
|
|
||||||
|
Finally, every program is threatened constantly by software patents.
|
||||||
|
States should not allow patents to restrict development and use of
|
||||||
|
software on general-purpose computers, but in those that do, we wish to
|
||||||
|
avoid the special danger that patents applied to a free program could
|
||||||
|
make it effectively proprietary. To prevent this, the GPL assures that
|
||||||
|
patents cannot be used to render the program non-free.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU General Public License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
|
works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of an
|
||||||
|
exact copy. The resulting work is called a "modified version" of the
|
||||||
|
earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices"
|
||||||
|
to the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work
|
||||||
|
for making modifications to it. "Object code" means any non-source
|
||||||
|
form of a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users
|
||||||
|
can regenerate automatically from other parts of the Corresponding
|
||||||
|
Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that
|
||||||
|
same work.
|
||||||
|
|
||||||
|
2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not
|
||||||
|
convey, without conditions so long as your license otherwise remains
|
||||||
|
in force. You may convey covered works to others for the sole purpose
|
||||||
|
of having them make modifications exclusively for you, or provide you
|
||||||
|
with facilities for running those works, provided that you comply with
|
||||||
|
the terms of this License in conveying all material for which you do
|
||||||
|
not control copyright. Those thus making or running the covered works
|
||||||
|
for you must do so exclusively on your behalf, under your direction
|
||||||
|
and control, on terms that prohibit them from making any copies of
|
||||||
|
your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under
|
||||||
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
|
makes it unnecessary.
|
||||||
|
|
||||||
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such circumvention
|
||||||
|
is effected by exercising rights under this License with respect to
|
||||||
|
the covered work, and you disclaim any intention to limit operation or
|
||||||
|
modification of the work as a means of enforcing, against the work's
|
||||||
|
users, your or third parties' legal rights to forbid circumvention of
|
||||||
|
technological measures.
|
||||||
|
|
||||||
|
4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
|
a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
|
||||||
|
b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under section
|
||||||
|
7. This requirement modifies the requirement in section 4 to
|
||||||
|
"keep intact all notices".
|
||||||
|
|
||||||
|
c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
|
||||||
|
d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms
|
||||||
|
of sections 4 and 5, provided that you also convey the
|
||||||
|
machine-readable Corresponding Source under the terms of this License,
|
||||||
|
in one of these ways:
|
||||||
|
|
||||||
|
a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
|
||||||
|
b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the
|
||||||
|
Corresponding Source from a network server at no charge.
|
||||||
|
|
||||||
|
c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
|
||||||
|
d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
|
||||||
|
e) Convey the object code using peer-to-peer transmission, provided
|
||||||
|
you inform other peers where the object code and Corresponding
|
||||||
|
Source of the work are being offered to the general public at no
|
||||||
|
charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal, family,
|
||||||
|
or household purposes, or (2) anything designed or sold for incorporation
|
||||||
|
into a dwelling. In determining whether a product is a consumer product,
|
||||||
|
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||||
|
product received by a particular user, "normally used" refers to a
|
||||||
|
typical or common use of that class of product, regardless of the status
|
||||||
|
of the particular user or of the way in which the particular user
|
||||||
|
actually uses, or expects or is expected to use, the product. A product
|
||||||
|
is a consumer product regardless of whether the product has substantial
|
||||||
|
commercial, industrial or non-consumer uses, unless such uses represent
|
||||||
|
the only significant mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to install
|
||||||
|
and execute modified versions of a covered work in that User Product from
|
||||||
|
a modified version of its Corresponding Source. The information must
|
||||||
|
suffice to ensure that the continued functioning of the modified object
|
||||||
|
code is in no case prevented or interfered with solely because
|
||||||
|
modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or updates
|
||||||
|
for a work that has been modified or installed by the recipient, or for
|
||||||
|
the User Product in which it has been modified or installed. Access to a
|
||||||
|
network may be denied when the modification itself materially and
|
||||||
|
adversely affects the operation of the network or violates the rules and
|
||||||
|
protocols for communication across the network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders of
|
||||||
|
that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
|
||||||
|
b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
|
||||||
|
c) Prohibiting misrepresentation of the origin of that material, or
|
||||||
|
requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
|
||||||
|
d) Limiting the use for publicity purposes of names of licensors or
|
||||||
|
authors of the material; or
|
||||||
|
|
||||||
|
e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
|
||||||
|
f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions of
|
||||||
|
it) with contractual assumptions of liability to the recipient, for
|
||||||
|
any liability that these contractual assumptions directly impose on
|
||||||
|
those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions;
|
||||||
|
the above requirements apply either way.
|
||||||
|
|
||||||
|
8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your
|
||||||
|
license from a particular copyright holder is reinstated (a)
|
||||||
|
provisionally, unless and until the copyright holder explicitly and
|
||||||
|
finally terminates your license, and (b) permanently, if the copyright
|
||||||
|
holder fails to notify you of the violation by some reasonable means
|
||||||
|
prior to 60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or
|
||||||
|
run a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims
|
||||||
|
owned or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within
|
||||||
|
the scope of its coverage, prohibits the exercise of, or is
|
||||||
|
conditioned on the non-exercise of one or more of the rights that are
|
||||||
|
specifically granted under this License. You may not convey a covered
|
||||||
|
work if you are a party to an arrangement with a third party that is
|
||||||
|
in the business of distributing software, under which you make payment
|
||||||
|
to the third party based on the extent of your activity of conveying
|
||||||
|
the work, and under which the third party grants, to any of the
|
||||||
|
parties who would receive the covered work from you, a discriminatory
|
||||||
|
patent license (a) in connection with copies of the covered work
|
||||||
|
conveyed by you (or copies made from those copies), or (b) primarily
|
||||||
|
for and in connection with specific products or compilations that
|
||||||
|
contain the covered work, unless you entered into that arrangement,
|
||||||
|
or that patent license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under this
|
||||||
|
License and any other pertinent obligations, then as a consequence you may
|
||||||
|
not convey it at all. For example, if you agree to terms that obligate you
|
||||||
|
to collect a royalty for further conveying from those to whom you convey
|
||||||
|
the Program, the only way you could satisfy both those terms and this
|
||||||
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
|
13. Use with the GNU Affero General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU Affero General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the special requirements of the GNU Affero General Public License,
|
||||||
|
section 13, concerning interaction through a network will apply to the
|
||||||
|
combination as such.
|
||||||
|
|
||||||
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU General Public License from time to time. Such new versions will
|
||||||
|
be similar in spirit to the present version, but may differ in detail to
|
||||||
|
address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Program specifies that a certain numbered version of the GNU General
|
||||||
|
Public License "or any later version" applies to it, you have the
|
||||||
|
option of following the terms and conditions either of that numbered
|
||||||
|
version or of any later version published by the Free Software
|
||||||
|
Foundation. If the Program does not specify a version number of the
|
||||||
|
GNU General Public License, you may choose any version ever published
|
||||||
|
by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future
|
||||||
|
versions of the GNU General Public License can be used, that proxy's
|
||||||
|
public statement of acceptance of a version permanently authorizes you
|
||||||
|
to choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||||
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||||
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||||
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
|
16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||||
|
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||||
|
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||||
|
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||||
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||||
|
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||||
|
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||||
|
SUCH DAMAGES.
|
||||||
|
|
||||||
|
17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest
|
||||||
|
to attach them to the start of each source file to most effectively
|
||||||
|
state the exclusion of warranty; and each file should have at least
|
||||||
|
the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
thegreenballoon-wp-plugin
|
||||||
|
Copyright (C) 2019 Jorge vitrubio.net
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
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, see <http://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
|
If the program does terminal interaction, make it output a short
|
||||||
|
notice like this when it starts in an interactive mode:
|
||||||
|
|
||||||
|
thegreenballoon-wp-plugin Copyright (C) 2019 Jorge vitrubio.net
|
||||||
|
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||||
|
This is free software, and you are welcome to redistribute it
|
||||||
|
under certain conditions; type `show c' for details.
|
||||||
|
|
||||||
|
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||||
|
parts of the General Public License. Of course, your program's commands
|
||||||
|
might be different; for a GUI interface, you would use an "about box".
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
|
For more information on this, and how to apply and follow the GNU GPL, see
|
||||||
|
<http://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
The GNU General Public License does not permit incorporating your program
|
||||||
|
into proprietary programs. If your program is a subroutine library, you
|
||||||
|
may consider it more useful to permit linking proprietary applications with
|
||||||
|
the library. If this is what you want to do, use the GNU Lesser General
|
||||||
|
Public License instead of this License. But first, please read
|
||||||
|
<http://www.gnu.org/philosophy/why-not-lgpl.html>.
|
||||||
|
|
@ -0,0 +1,27 @@
|
||||||
|
# Biofriction wp plugin
|
||||||
|
|
||||||
|
Pluggin development for the needs of the wordpress theme for [Biofriction](https://gitlab.com/jorge-vitrubio/biofriction-plugin).
|
||||||
|
|
||||||
|
Several parts of the WP will be coded here such as:
|
||||||
|
- Widgets
|
||||||
|
- MetaBoxes
|
||||||
|
- etc...
|
||||||
|
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
some docs that have been used in the process
|
||||||
|
|
||||||
|
Pluggins
|
||||||
|
- howto write a pluggin by Wordpress.org
|
||||||
|
https://codex.wordpress.org/Writing_a_Plugin
|
||||||
|
- and the best practices for writing pluggins
|
||||||
|
https://developer.wordpress.org/plugins/plugin-basics/best-practices/
|
||||||
|
|
||||||
|
Widgets
|
||||||
|
- howto write widgets
|
||||||
|
https://www.wpbeginner.com/wp-tutorials/how-to-create-a-custom-wordpress-widget/
|
||||||
|
|
||||||
|
Meta Boxes
|
||||||
|
- howto write a pluggin to generate MetaBoxes
|
||||||
|
https://themefoundation.com/wordpress-meta-boxes-guide/
|
||||||
|
|
@ -0,0 +1,32 @@
|
||||||
|
/* #bfr_meta{
|
||||||
|
overflow: hidden;
|
||||||
|
padding-bottom: 1em;
|
||||||
|
}
|
||||||
|
|
||||||
|
#bfr_meta p{
|
||||||
|
clear: both;
|
||||||
|
}
|
||||||
|
|
||||||
|
.bfr-row-title{
|
||||||
|
display: block;
|
||||||
|
float: left;
|
||||||
|
width: 200px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.bfr-row-content{
|
||||||
|
float: left;
|
||||||
|
padding-bottom: 1em;
|
||||||
|
}
|
||||||
|
|
||||||
|
.bfr-row-content label{
|
||||||
|
display: block;
|
||||||
|
line-height: 1.75em;
|
||||||
|
} */
|
||||||
|
|
||||||
|
.button a, .button a:not(.button) {
|
||||||
|
background-color: transparent !important;
|
||||||
|
}
|
||||||
|
|
||||||
|
.button a:hover, .button a:not(.button):hover {
|
||||||
|
background-color: transparent !important;
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,337 @@
|
||||||
|
<?php
|
||||||
|
/**
|
||||||
|
* The plugin bootstrap file
|
||||||
|
*
|
||||||
|
* This file is read by WordPress to generate the plugin information in the plugin
|
||||||
|
* admin area. This file also includes all of the dependencies used by the plugin,
|
||||||
|
* registers the activation and deactivation functions, and defines a function
|
||||||
|
* that starts the plugin.
|
||||||
|
*
|
||||||
|
* @link http://example.com
|
||||||
|
* @since 1.0.0
|
||||||
|
* @package Plugin_Name
|
||||||
|
*
|
||||||
|
* @wordpress-plugin
|
||||||
|
*/
|
||||||
|
|
||||||
|
/*
|
||||||
|
Plugin Name: Biofriction - website options
|
||||||
|
Plugin URI: https://biofriction.org/
|
||||||
|
Description: All the <strong>options</strong> for <strong>Biofriction website</strong> wich do not come by default with wordpress such as: selector for showing buttons, a date picker for old posts, and any other needs.
|
||||||
|
Version: 0.2
|
||||||
|
Author URI: https://vitrubio.net/
|
||||||
|
Author: jorge - vitrubio.net
|
||||||
|
License: GPL 3.0
|
||||||
|
Date: 2020 02 10
|
||||||
|
License URI:https://www.gnu.org/licenses/gpl-3.0.html
|
||||||
|
Text Domain: bfr_plugin_txtdomain
|
||||||
|
Domain Path: /languages
|
||||||
|
*/
|
||||||
|
|
||||||
|
/*
|
||||||
|
if ever read this never forget to check
|
||||||
|
howto write a pluggin by Wordpress.org
|
||||||
|
https://codex.wordpress.org/Writing_a_Plugin
|
||||||
|
and the best practices
|
||||||
|
https://developer.wordpress.org/plugins/plugin-basics/best-practices/
|
||||||
|
and some resources
|
||||||
|
https://themefoundation.com/wordpress-meta-boxes-guide/
|
||||||
|
*/
|
||||||
|
defined( 'ABSPATH' ) or die( 'No script kiddies please!' );
|
||||||
|
|
||||||
|
/* *
|
||||||
|
* Load translation, if it exists
|
||||||
|
* * * * * * * * * * * * * * * * * * */
|
||||||
|
|
||||||
|
function bfr_plugin_init() {
|
||||||
|
$plugin_dir = basename(dirname(__FILE__));
|
||||||
|
load_plugin_textdomain( 'bfr_plugin_txtdomain', null, $plugin_dir.'/assets/languages/' );
|
||||||
|
}
|
||||||
|
add_action('plugins_loaded', 'bfr_plugin_init');
|
||||||
|
|
||||||
|
/* *
|
||||||
|
* add settings link in pluggin page
|
||||||
|
* * * * * * * * * * * * * * * * * * */
|
||||||
|
function bfr_plugin_plugin_action_links($links, $file) {
|
||||||
|
$this_plugin = basename(plugin_dir_url(__FILE__)) . '/bfr-theme-plugin.php';
|
||||||
|
if($file == $this_plugin) {
|
||||||
|
$links[] = '<a href="admin.php?page=biofriction-options">' . __('Settings', 'bfr_plugin_txtdomain') . '</a>';
|
||||||
|
}
|
||||||
|
return $links;
|
||||||
|
}
|
||||||
|
add_filter('plugin_action_links', 'bfr_plugin_plugin_action_links', 10, 2);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Registers stylesheet for a custom plugin.
|
||||||
|
*/
|
||||||
|
function biofriction_theme_plugin_styles_admin() {
|
||||||
|
add_editor_style( 'assets/css/bfr-theme-plugin.css' );
|
||||||
|
}
|
||||||
|
add_action( 'admin_init', 'biofriction_theme_plugin_styles_admin' );
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Proper way to enqueue scripts and styles
|
||||||
|
*/
|
||||||
|
function biofriction_theme_plugin_styles_public() {
|
||||||
|
$this_plugin = basename(plugin_dir_url(__FILE__));
|
||||||
|
wp_enqueue_style( 'bfr-theme-plugin', plugin_dir_url(__FILE__) . 'assets/css/bfr-theme-plugin.css' );
|
||||||
|
// wp_enqueue_script( 'script-name', get_template_directory_uri() . '/js/example.js', array(), '1.0.0', true );
|
||||||
|
}
|
||||||
|
|
||||||
|
add_action( 'wp_enqueue_scripts', 'biofriction_theme_plugin_styles_public' );
|
||||||
|
|
||||||
|
/* *
|
||||||
|
* Custom button in TINYMCE editor for styling
|
||||||
|
* * * * * * * * * * * * * * * * * * * * * * */
|
||||||
|
// as read on
|
||||||
|
// https://codex.wordpress.org/Plugin_API/Filter_Reference/mce_buttons,_mce_buttons_2,_mce_buttons_3,_mce_buttons_4
|
||||||
|
// https://www.wpbeginner.com/wp-tutorials/how-to-add-custom-styles-to-wordpress-visual-editor/
|
||||||
|
// https://kinsta.com/blog/wordpress-tinymce-editor/
|
||||||
|
|
||||||
|
|
||||||
|
// Callback function to insert 'styleselect' into the $buttons array
|
||||||
|
if ( ! function_exists( 'bfr_mce_buttons' ) ) :
|
||||||
|
function bfr_mce_buttons( $buttons ) {
|
||||||
|
// array_unshift( $buttons, 'styleselect', 'removeformat' );
|
||||||
|
array_push( $buttons, 'styleselect', 'removeformat' );
|
||||||
|
return $buttons;
|
||||||
|
}
|
||||||
|
endif;
|
||||||
|
// Register our callback to the appropriate filter
|
||||||
|
add_filter( 'mce_buttons_2', 'bfr_mce_buttons' );
|
||||||
|
|
||||||
|
// Callback function to filter the MCE settings
|
||||||
|
if ( ! function_exists( 'bfr_mce_before_init_insert_formats' ) ) :
|
||||||
|
function bfr_mce_before_init_insert_formats( $init_array ) {
|
||||||
|
|
||||||
|
// Define the style_formats array
|
||||||
|
$style_formats=array(
|
||||||
|
|
||||||
|
// Each array child is a format with it's own settings
|
||||||
|
array(
|
||||||
|
'title' => 'button',
|
||||||
|
'block' => 'span',
|
||||||
|
'classes' => 'button',
|
||||||
|
'wrapper' => true,
|
||||||
|
),
|
||||||
|
array(
|
||||||
|
'title' => 'button secondary',
|
||||||
|
'block' => 'span',
|
||||||
|
'classes' => 'button secondary',
|
||||||
|
'wrapper' => true,
|
||||||
|
),
|
||||||
|
array(
|
||||||
|
'title' => 'button hollow',
|
||||||
|
'block' => 'span',
|
||||||
|
'classes' => 'button hollow primary',
|
||||||
|
'wrapper' => true,
|
||||||
|
),
|
||||||
|
array(
|
||||||
|
'title' => 'button hollow secondary',
|
||||||
|
'block' => 'span',
|
||||||
|
'classes' => 'button hollow secondary',
|
||||||
|
'wrapper' => true,
|
||||||
|
),
|
||||||
|
|
||||||
|
|
||||||
|
);
|
||||||
|
|
||||||
|
// Insert the array, JSON ENCODED, into 'style_formats'
|
||||||
|
$init_array['style_formats'] = json_encode( $style_formats );
|
||||||
|
return $init_array;
|
||||||
|
}
|
||||||
|
endif;
|
||||||
|
|
||||||
|
// Attach callback to 'tiny_mce_before_init'
|
||||||
|
add_filter( 'tiny_mce_before_init', 'bfr_mce_before_init_insert_formats' );
|
||||||
|
|
||||||
|
// function biofriction_mce_buttons_3( $buttons ) {
|
||||||
|
// $buttons[] = 'superscript';
|
||||||
|
// $buttons[] = 'subscript';
|
||||||
|
// $buttons[] = 'cut' ;
|
||||||
|
// $buttons[] = 'copy' ;
|
||||||
|
// $buttons[] = 'paste' ;
|
||||||
|
// $buttons[] = 'hr' ;
|
||||||
|
// $buttons[] = 'backcolor' ;
|
||||||
|
// $buttons[] = 'newdocuement' ;
|
||||||
|
// $buttons[] = 'formatselect' ;
|
||||||
|
// $buttons[] = 'fontselect' ;
|
||||||
|
// $buttons[] = 'fontsizeselect' ;
|
||||||
|
// $buttons[] = 'styleselect' ;
|
||||||
|
// return $buttons;
|
||||||
|
// }
|
||||||
|
// add_filter( 'mce_buttons_3', 'biofriction_mce_buttons_3' );
|
||||||
|
|
||||||
|
/**
|
||||||
|
*
|
||||||
|
* Custom settings page
|
||||||
|
* * * * * * * * * * * * * * * * * * /
|
||||||
|
*
|
||||||
|
* @internal never define functions inside callbacks.
|
||||||
|
* these functions could be run multiple times; this would result in a fatal error.
|
||||||
|
* https://developer.wordpress.org/plugins/settings/custom-settings-page/
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* custom option and settings
|
||||||
|
*/
|
||||||
|
function bfr_settings_init() {
|
||||||
|
// register a new setting for "bfr" page
|
||||||
|
register_setting( 'bfr_settings', 'bfr_options' );
|
||||||
|
|
||||||
|
// register a new section in the "bfr" page
|
||||||
|
add_settings_section(
|
||||||
|
'bfr_section_olderthandate',
|
||||||
|
__( 'Biofrictions Options.', 'bfr_plugin_txtdomain' ),
|
||||||
|
'bfr_section_olderthandate_cb',
|
||||||
|
'bfr_settings'
|
||||||
|
);
|
||||||
|
|
||||||
|
// register a new field in the "bfr_section_olderthandate" section, inside the "bfr" page
|
||||||
|
add_settings_field(
|
||||||
|
'bfr_field_olderthandate', // as of WP 4.6 this value is used only internally
|
||||||
|
// use $args' label_for to populate the id inside the callback
|
||||||
|
__( 'Hide content older than...', 'bfr_plugin_txtdomain' ),
|
||||||
|
'bfr_field_olderthandate_cb',
|
||||||
|
'bfr_settings',
|
||||||
|
'bfr_section_olderthandate',
|
||||||
|
[
|
||||||
|
'label_for' => 'bfr_field_olderthandate',
|
||||||
|
'class' => 'bfr_row',
|
||||||
|
'bfr_custom_data' => 'custom',
|
||||||
|
]
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* register our bfr_settings_init to the admin_init action hook
|
||||||
|
*/
|
||||||
|
add_action( 'admin_init', 'bfr_settings_init' );
|
||||||
|
|
||||||
|
/**
|
||||||
|
* custom option and settings:
|
||||||
|
* callback functions
|
||||||
|
*/
|
||||||
|
|
||||||
|
// olderthandate section cb
|
||||||
|
|
||||||
|
// section callbacks can accept an $args parameter, which is an array.
|
||||||
|
// $args have the following keys defined: title, id, callback.
|
||||||
|
// the values are defined at the add_settings_section() function.
|
||||||
|
function bfr_section_olderthandate_cb( $args ) {
|
||||||
|
?>
|
||||||
|
<p id="<?php echo esc_attr( $args['id'] ); ?>">
|
||||||
|
<?php esc_html_e( 'Here you should set the options for the older content to be marked as it.', 'bfr_plugin_txtdomain' ); ?>
|
||||||
|
</p>
|
||||||
|
<?php
|
||||||
|
}
|
||||||
|
|
||||||
|
// daysback field cb
|
||||||
|
|
||||||
|
// field callbacks can accept an $args parameter, which is an array.
|
||||||
|
// $args is defined at the add_settings_field() function.
|
||||||
|
// wordpress has magic interaction with the following keys: label_for, class.
|
||||||
|
// the "label_for" key value is used for the "for" attribute of the <label>.
|
||||||
|
// the "class" key value is used for the "class" attribute of the <tr> containing the field.
|
||||||
|
// you can add custom key value pairs to be used inside your callbacks.
|
||||||
|
function bfr_field_olderthandate_cb( $args ) {
|
||||||
|
// get the value of the setting we've registered with register_setting()
|
||||||
|
$options = get_option( 'bfr_options' );
|
||||||
|
// output the field
|
||||||
|
?>
|
||||||
|
|
||||||
|
<p class="description">
|
||||||
|
<?php _e( 'You should set up the <b>number of days</b> from today to the past or the date from wich will be <b>considered old posts</b>. Then the class <span style="font-family:monospace;">oldpost</span> will be added to the post and pages so you can apply a css style to your theme.', 'bfr_plugin_txtdomain' ); ?>
|
||||||
|
</p>
|
||||||
|
<form id="bfr-oldpost-numberofdays" class="bfr-oldpost-numberofdays">
|
||||||
|
<label for="bfr-oldpost-numberofdays">Number of days:</label>
|
||||||
|
<input type="number" id="bfr-oldpost-numberofdays" name="bfr-oldpost-numberofdays" min="1" max="100">
|
||||||
|
</form>
|
||||||
|
<form id="bfr-oldpost-enddate" class="bfr-oldpost-enddate">
|
||||||
|
<label for="bfr-oldpost-enddate">Start date:</label>
|
||||||
|
<input type="date" id="bfr-oldpost-enddate" name="bfr-oldpost-endate" value="">
|
||||||
|
</form>
|
||||||
|
|
||||||
|
<!-- borrar desde aqui -->
|
||||||
|
<p>
|
||||||
|
label_for:<?php echo esc_attr( $args['label_for'] ); ?>
|
||||||
|
<br />
|
||||||
|
bfr_custom_data:<?php echo esc_attr( $args['bfr_custom_data'] ); ?>
|
||||||
|
<br />
|
||||||
|
class:<?php echo esc_attr( $args['class'] ); ?>
|
||||||
|
<br />
|
||||||
|
<?php esc_html_e( 'daysback', 'bfr_plugin_txtdomain' ); ?>
|
||||||
|
<br />
|
||||||
|
|
||||||
|
</p>
|
||||||
|
<!-- borrar hasta aqui -->
|
||||||
|
|
||||||
|
<?php
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* top level menu
|
||||||
|
* https://developer.wordpress.org/reference/functions/add_menu_page/
|
||||||
|
*/
|
||||||
|
function bfr_options_page() {
|
||||||
|
// add top level menu page
|
||||||
|
add_menu_page(
|
||||||
|
$page_title = 'Biofriction Options', // $page_title
|
||||||
|
$menu_title = 'Biofriction', //$menu_title
|
||||||
|
$capability = 'manage_options', //'edit_others_posts', // $capability
|
||||||
|
$menu_slug = 'biofriction-options', // $menu_slug
|
||||||
|
$function = 'bfr_options_page_html', //$function
|
||||||
|
$icon_url = 'dashicons-rest-api',// $icon_url //https://developer.wordpress.org/resource/dashicons/#menu
|
||||||
|
$position = '50'// $position
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* register our bfr_options_page to the admin_menu action hook
|
||||||
|
*/
|
||||||
|
add_action( 'admin_menu', 'bfr_options_page' );
|
||||||
|
|
||||||
|
/**
|
||||||
|
* top level menu:
|
||||||
|
* callback functions
|
||||||
|
*/
|
||||||
|
function bfr_options_page_html() {
|
||||||
|
// check user capabilities
|
||||||
|
if ( ! current_user_can( 'manage_options' ) ) {
|
||||||
|
?>
|
||||||
|
<p class="description">
|
||||||
|
<?php esc_html_e( 'Sorry, you do not have permission to edit this settings, please, contact any admin to get granted.', 'bfr_plugin_txtdomain' ); ?>
|
||||||
|
</p>
|
||||||
|
<?php
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// add error/update messages
|
||||||
|
|
||||||
|
// check if the user have submitted the settings
|
||||||
|
// wordpress will add the "settings-updated" $_GET parameter to the url
|
||||||
|
if ( isset( $_GET['settings-updated'] ) ) {
|
||||||
|
// add settings saved message with the class of "updated"
|
||||||
|
add_settings_error( 'bfr_messages', 'bfr_message', __( 'Settings Saved', 'bfr_plugin_txtdomain' ), 'updated' );
|
||||||
|
}
|
||||||
|
|
||||||
|
// show error/update messages
|
||||||
|
settings_errors( 'bfr_messages' );
|
||||||
|
?>
|
||||||
|
<div class="wrap">
|
||||||
|
<h1><?php echo esc_html( get_admin_page_title() ); ?></h1>
|
||||||
|
<form action="options.php" method="post">
|
||||||
|
<?php
|
||||||
|
// output security fields for the registered setting "bfr"
|
||||||
|
settings_fields( 'bfr_settings' );
|
||||||
|
// output setting sections and their fields
|
||||||
|
// (sections are registered for "bfr", each field is registered to a specific section)
|
||||||
|
do_settings_sections( 'bfr_settings' );
|
||||||
|
// output save settings button
|
||||||
|
submit_button( 'Save Settings' );
|
||||||
|
?>
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
<?php
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,3 @@
|
||||||
|
<?php
|
||||||
|
// Silence is golden;
|
||||||
|
?>
|
||||||
|
|
@ -0,0 +1,23 @@
|
||||||
|
<?php
|
||||||
|
/*
|
||||||
|
howto uninstall the pluggin
|
||||||
|
https://developer.wordpress.org/plugins/plugin-basics/uninstall-methods/
|
||||||
|
*/
|
||||||
|
|
||||||
|
// if uninstall.php is not called by WordPress, die
|
||||||
|
if (!defined('WP_UNINSTALL_PLUGIN')) {
|
||||||
|
die;
|
||||||
|
}
|
||||||
|
|
||||||
|
$option_name = 'wporg_option';
|
||||||
|
|
||||||
|
delete_option($option_name);
|
||||||
|
|
||||||
|
// for site options in Multisite
|
||||||
|
delete_site_option($option_name);
|
||||||
|
|
||||||
|
// drop a custom database table
|
||||||
|
global $wpdb;
|
||||||
|
$wpdb->query("DROP TABLE IF EXISTS {$wpdb->prefix}mytable");
|
||||||
|
|
||||||
|
?>
|
||||||
|
|
@ -0,0 +1,27 @@
|
||||||
|
<!-- as explained here to translate custom post fields -->
|
||||||
|
<!-- https://polylang.pro/doc/the-wpml-config-xml-file/ -->
|
||||||
|
<!-- -->
|
||||||
|
<wpml-config>
|
||||||
|
<custom-fields>
|
||||||
|
<custom-field action="copy">tgb_homehero-checkbox</custom-field>
|
||||||
|
<custom-field action="translate">tgb_post-wysiwygsummary</custom-field>
|
||||||
|
</custom-fields>
|
||||||
|
<!-- <custom-types>
|
||||||
|
<custom-type translate="1">book</custom-type>
|
||||||
|
<custom-type translate="1">DVD</custom-type>
|
||||||
|
</custom-types> -->
|
||||||
|
<!-- <taxonomies>
|
||||||
|
<taxonomy translate="1">genre</taxonomy>
|
||||||
|
</taxonomies> -->
|
||||||
|
<!-- <admin-texts>
|
||||||
|
<key name="tgb_showinhome_hero">
|
||||||
|
<key name="option_name_1" />
|
||||||
|
<key name="option_name_2" />
|
||||||
|
<key name="options_group_1">
|
||||||
|
<key name="sub_option_name_11" />
|
||||||
|
<key name="sub_option_name_12" />
|
||||||
|
</key>
|
||||||
|
</key>
|
||||||
|
<key name="simple_string_option" />
|
||||||
|
</admin-texts> -->
|
||||||
|
</wpml-config>
|
||||||
|
|
@ -0,0 +1,178 @@
|
||||||
|
# BIOFRICTION THEME
|
||||||
|
This project is to create a theme for the [Biofriction](https://gridspinoza.net/programs/biofriction) project hosted by [Hangar](https://hangar.org).
|
||||||
|
|
||||||
|
It is based on top of [FoundationPress](https://github.com/olefredrik/FoundationPress) and Zurb's [Foundation for Sites 6](https://foundation.zurb.com/sites.html).
|
||||||
|
|
||||||
|
|
||||||
|
# FoundationPress
|
||||||
|
|
||||||
|
[](https://gitter.im/olefredrik/foundationpress?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
|
||||||
|
[](https://github.com/olefredrik/FoundationPress/releases)
|
||||||
|
[](https://opensource.org/licenses/MIT)
|
||||||
|
|
||||||
|
This is a starter-theme for WordPress based on Zurb's [Foundation for Sites 6](https://foundation.zurb.com/sites.html), the most advanced responsive (mobile-first) framework in the world. The purpose of FoundationPress, is to act as a small and handy toolbox that contains the essentials needed to build any design. FoundationPress is meant to be a starting point, not the final product.
|
||||||
|
|
||||||
|
Please fork, copy, modify, delete, share or do whatever you like with this.
|
||||||
|
|
||||||
|
All contributions are welcome!
|
||||||
|
|
||||||
|
## Requirements
|
||||||
|
|
||||||
|
**This project requires [Node.js](http://nodejs.org) v6.x.x 11.6.x to be installed on your machine.** Please be aware that you might encounter problems with the installation if you are using the most current Node version (bleeding edge) with all the latest features.
|
||||||
|
|
||||||
|
FoundationPress uses [Sass](http://Sass-lang.com/) (CSS with superpowers). In short, Sass is a CSS pre-processor that allows you to write styles more effectively and tidy.
|
||||||
|
|
||||||
|
The Sass is compiled using libsass, which requires the GCC to be installed on your machine. Windows users can install it through [MinGW](http://www.mingw.org/), and Mac users can install it through the [Xcode Command-line Tools](http://osxdaily.com/2014/02/12/install-command-line-tools-mac-os-x/).
|
||||||
|
|
||||||
|
If you have not worked with a Sass-based workflow before, I would recommend reading [FoundationPress for beginners](https://foundationpress.olefredrik.com/posts/tutorials/foundationpress-for-beginners), a short blog post that explains what you need to know.
|
||||||
|
|
||||||
|
## Quickstart
|
||||||
|
|
||||||
|
### 1. Clone the repository and install with npm
|
||||||
|
```bash
|
||||||
|
$ cd my-wordpress-folder/wp-content/themes/
|
||||||
|
$ git clone https://github.com/olefredrik/FoundationPress.git
|
||||||
|
$ cd FoundationPress
|
||||||
|
$ npm install
|
||||||
|
```
|
||||||
|
|
||||||
|
### 2. Configuration
|
||||||
|
|
||||||
|
#### YAML config file
|
||||||
|
FoundationPress includes a `config-default.yml` file. To make changes to the configuration, make a copy of `config-default.yml` and name it `config.yml` and make changes to that file. The `config.yml` file is ignored by git so that each environment can use a different configuration with the same git repo.
|
||||||
|
|
||||||
|
At the start of the build process a check is done to see if a `config.yml` file exists. If `config.yml` exists, the configuration will be loaded from `config.yml`. If `config.yml` does not exist, `config-default.yml` will be used as a fallback.
|
||||||
|
|
||||||
|
#### Browsersync setup
|
||||||
|
If you want to take advantage of [Browsersync](https://www.browsersync.io/) (automatic browser refresh when a file is saved), simply open your `config.yml` file after creating it in the previous step, and put your local dev-server address and port (e.g http://localhost:8888) in the `url` property under the `BROWSERSYNC` object.
|
||||||
|
|
||||||
|
#### Static asset hashing / cache breaker
|
||||||
|
If you want to make sure your users see the latest changes after re-deploying your theme, you can enable static asset hashing. In your `config.yml`, set ``REVISIONING: true;``. Hashing will work on the ``npm run build`` and ``npm run dev`` commands. It will not be applied on the start command with browsersync. This is by design. Hashing will only change if there are actual changes in the files.
|
||||||
|
|
||||||
|
### 3. Get started
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ npm start
|
||||||
|
```
|
||||||
|
|
||||||
|
### 4. Compile assets for production
|
||||||
|
|
||||||
|
When building for production, the CSS and JS will be minified. To minify the assets in your `/dist` folder, run
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ npm run build
|
||||||
|
```
|
||||||
|
|
||||||
|
#### To create a .zip file of your theme, run:
|
||||||
|
|
||||||
|
```
|
||||||
|
$ npm run package
|
||||||
|
```
|
||||||
|
|
||||||
|
Running this command will build and minify the theme's assets and place a .zip archive of the theme in the `packaged` directory. This excludes the developer files/directories from your theme like `/node_modules`, `/src`, etc. to keep the theme lightweight for transferring the theme to a staging or production server.
|
||||||
|
|
||||||
|
### Project structure
|
||||||
|
|
||||||
|
In the `/src` folder you will find the working files for all your assets. Every time you make a change to a file that is watched by Gulp, the output will be saved to the `/dist` folder. The contents of this folder is the compiled code that you should not touch (unless you have a good reason for it).
|
||||||
|
|
||||||
|
The `/page-templates` folder contains templates that can be selected in the Pages section of the WordPress admin panel. To create a new page-template, simply create a new file in this folder and make sure to give it a template name.
|
||||||
|
|
||||||
|
I guess the rest is quite self explanatory. Feel free to ask if you feel stuck.
|
||||||
|
|
||||||
|
### Styles and Sass Compilation
|
||||||
|
|
||||||
|
* `style.css`: Do not worry about this file. (For some reason) it's required by WordPress. All styling are handled in the Sass files described below
|
||||||
|
|
||||||
|
* `src/assets/scss/app.scss`: Make imports for all your styles here
|
||||||
|
* `src/assets/scss/global/*.scss`: Global settings
|
||||||
|
* `src/assets/scss/components/*.scss`: Buttons etc.
|
||||||
|
* `src/assets/scss/modules/*.scss`: Topbar, footer etc.
|
||||||
|
* `src/assets/scss/templates/*.scss`: Page template styling
|
||||||
|
|
||||||
|
* `dist/assets/css/app.css`: This file is loaded in the `<head>` section of your document, and contains the compiled styles for your project.
|
||||||
|
|
||||||
|
If you're new to Sass, please note that you need to have Gulp running in the background (``npm start``), for any changes in your scss files to be compiled to `app.css`.
|
||||||
|
|
||||||
|
### JavaScript Compilation
|
||||||
|
|
||||||
|
All JavaScript files, including Foundation's modules, are imported through the `src/assets/js/app.js` file. The files are imported using module dependency with [webpack](https://webpack.js.org/) as the module bundler.
|
||||||
|
|
||||||
|
If you're unfamiliar with modules and module bundling, check out [this resource for node style require/exports](http://openmymind.net/2012/2/3/Node-Require-and-Exports/) and [this resource to understand ES6 modules](http://exploringjs.com/es6/ch_modules.html).
|
||||||
|
|
||||||
|
Foundation modules are loaded in the `src/assets/js/app.js` file. By default all components are loaded. You can also pick and choose which modules to include. Just follow the instructions in the file.
|
||||||
|
|
||||||
|
If you need to output additional JavaScript files separate from `app.js`, do the following:
|
||||||
|
* Create new `custom.js` file in `src/assets/js/`. If you will be using jQuery, add `import $ from 'jquery';` at the top of the file.
|
||||||
|
* In `config.yml`, add `src/assets/js/custom.js` to `PATHS.entries`.
|
||||||
|
* Build (`npm start`)
|
||||||
|
* You will now have a `custom.js` file outputted to the `dist/assets/js/` directory.
|
||||||
|
|
||||||
|
## Demo
|
||||||
|
|
||||||
|
* [Clean FoundationPress install](http://foundationpress.olefredrik.com/)
|
||||||
|
* [FoundationPress Kitchen Sink - see every single element in action](http://foundationpress.olefredrik.com/kitchen-sink/)
|
||||||
|
|
||||||
|
## Local Development
|
||||||
|
We recommend using one of the following setups for local WordPress development:
|
||||||
|
|
||||||
|
* [MAMP](https://www.mamp.info/en/) (macOS)
|
||||||
|
* [WAMP](http://www.wampserver.com/en/download-wampserver-64bits/) (Windows)
|
||||||
|
* [LAMP](https://www.linux.com/learn/easy-lamp-server-installation) (Linux)
|
||||||
|
* [Local](https://local.getflywheel.com/) (macOS/Windows)
|
||||||
|
* [VVV (Varying Vagrant Vagrants)](https://github.com/Varying-Vagrant-Vagrants/VVV) (Vagrant Box)
|
||||||
|
* [Trellis](https://roots.io/trellis/)
|
||||||
|
|
||||||
|
|
||||||
|
## Tutorials
|
||||||
|
|
||||||
|
* [FoundationPress for beginners](https://foundationpress.olefredrik.com/posts/tutorials/foundationpress-for-beginners/)
|
||||||
|
* [Responsive images in WordPress with Interchange](http://rachievee.com/responsive-images-in-wordpress/)
|
||||||
|
* [Learn to use the _settings file to change almost every aspect of a Foundation site](http://zurb.com/university/lessons/66)
|
||||||
|
* [Other lessons from Zurb University](http://zurb.com/university/past-lessons)
|
||||||
|
|
||||||
|
## Documentation
|
||||||
|
|
||||||
|
* [Zurb Foundation Docs](http://foundation.zurb.com/docs/)
|
||||||
|
* [WordPress Codex](http://codex.wordpress.org/)
|
||||||
|
|
||||||
|
## Showcase
|
||||||
|
|
||||||
|
* [Harvard Center for Green Buildings and Cities](http://www.harvardcgbc.org/)
|
||||||
|
* [The New Tropic](http://thenewtropic.com/)
|
||||||
|
* [Parent-Child Home Program](http://www.parent-child.org/)
|
||||||
|
* [Hip and Healthy](http://hipandhealthy.com/)
|
||||||
|
* [Franchise Career Advisors](http://franchisecareeradvisors.com/)
|
||||||
|
* [Maren Schmidt](http://marenschmidt.com/)
|
||||||
|
* [Finnerodja](http://www.finnerodja.se/)
|
||||||
|
* [WP Diamonds](http://www.wpdiamonds.com/)
|
||||||
|
* [Storm Arts](http://stormarts.fi/)
|
||||||
|
* [ProfitGym](http://profitgym.nl/)
|
||||||
|
* [Agritur Piasina](http://www.agriturpiasina.it/)
|
||||||
|
* [Byington Vineyard & Winery](https://byington.com/)
|
||||||
|
* [Show And Tell](http://www.showandtelluk.com/)
|
||||||
|
* [Wahl + Case](https://www.wahlandcase.com/)
|
||||||
|
* [Morgridge Institute for Research](https://morgridge.org)
|
||||||
|
* [Impeach Trump Now](https://impeachdonaldtrumpnow.org/)
|
||||||
|
* [La revanche des sites](https://www.la-revanche-des-sites.fr/)
|
||||||
|
* [Dyami Wilson](https://dyamiwilson.com)
|
||||||
|
* [Madico Solutions](https://madico.com)
|
||||||
|
|
||||||
|
>Credit goes to all the brilliant designers and developers out there. Have **you** made a site that should be on this list? [Please let me know](https://twitter.com/olefredrik)
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
#### Here are ways to get involved:
|
||||||
|
|
||||||
|
1. [Star](https://github.com/olefredrik/FoundationPress/stargazers) the project!
|
||||||
|
2. Answer questions that come through [GitHub issues](https://github.com/olefredrik/FoundationPress/issues)
|
||||||
|
3. Report a bug that you find
|
||||||
|
4. Share a theme you've built on top of FoundationPress
|
||||||
|
5. [Tweet](https://twitter.com/intent/tweet?original_referer=http%3A%2F%2Ffoundationpress.olefredrik.com%2F&text=Check%20out%20FoundationPress%2C%20the%20ultimate%20%23WordPress%20starter-theme%20built%20on%20%23Foundation%206&tw_p=tweetbutton&url=http%3A%2F%2Ffoundationpress.olefredrik.com&via=olefredrik) and [blog](http://www.justinfriebel.com/my-first-experience-with-foundationpress-a-wordpress-starter-theme-106/) your experience of FoundationPress.
|
||||||
|
|
||||||
|
#### Pull Requests
|
||||||
|
|
||||||
|
Pull requests are highly appreciated. Please follow these guidelines:
|
||||||
|
|
||||||
|
1. Solve a problem. Features are great, but even better is cleaning-up and fixing issues in the code that you discover
|
||||||
|
2. Make sure that your code is bug-free and does not introduce new bugs
|
||||||
|
3. Create a [pull request](https://help.github.com/articles/creating-a-pull-request)
|
||||||
|
4. Verify that all the Travis-CI build checks have passed
|
||||||
|
Before Width: | Height: | Size: 699 KiB After Width: | Height: | Size: 699 KiB |
|
Before Width: | Height: | Size: 141 KiB After Width: | Height: | Size: 141 KiB |
|
Before Width: | Height: | Size: 876 KiB After Width: | Height: | Size: 876 KiB |
|
Before Width: | Height: | Size: 37 KiB After Width: | Height: | Size: 37 KiB |
|
Before Width: | Height: | Size: 975 KiB After Width: | Height: | Size: 975 KiB |
|
Before Width: | Height: | Size: 1.8 MiB After Width: | Height: | Size: 1.8 MiB |
|
Before Width: | Height: | Size: 3.3 MiB After Width: | Height: | Size: 3.3 MiB |
|
Before Width: | Height: | Size: 60 KiB After Width: | Height: | Size: 60 KiB |
|
Before Width: | Height: | Size: 5.9 KiB After Width: | Height: | Size: 5.9 KiB |
|
Before Width: | Height: | Size: 29 KiB After Width: | Height: | Size: 29 KiB |
|
Before Width: | Height: | Size: 11 KiB After Width: | Height: | Size: 11 KiB |
|
Before Width: | Height: | Size: 21 KiB After Width: | Height: | Size: 21 KiB |
|
Before Width: | Height: | Size: 13 KiB After Width: | Height: | Size: 13 KiB |
|
Before Width: | Height: | Size: 16 KiB After Width: | Height: | Size: 16 KiB |
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue