Skip to content

Commit

Permalink
Version 5.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
ChrisWinters authored Mar 18, 2023
2 parents ab855fb + 9267da6 commit 0709cd3
Show file tree
Hide file tree
Showing 461 changed files with 18,902 additions and 104,824 deletions.
5 changes: 1 addition & 4 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
.gitattributes export-ignore
.gitignore export-ignore
CHANGELOG.md export-ignore
package-lock.json export-ignore
package.json export-ignore
assets/css/bootstrap4 export-ignore
assets/psds export-ignore
assets/images/screenshots export-ignore
gulpfile.js export-ignore
copy.sh export-ignore
includes.zip export-ignore
5 changes: 1 addition & 4 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,2 @@
.git
node_modules
assets/css/bootstrap4
about.html
copy-config.sh
node_modules
102 changes: 0 additions & 102 deletions CHANGELOG.md

This file was deleted.

9 changes: 0 additions & 9 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,12 +1,3 @@
The Includes WordPress license is comprised of two parts:

(1) Excluding WordPress core functions and features, all plugin parts
including but not limited to template HTML/CSS marketup, images, design,
and custom PHP is licensed according to the terms of your purchase.

(2) WordPress core functions and features including HTML, CSS, Images,
Icons, Logos, etc are licensed under General Public License (GPL).

GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007

Expand Down
100 changes: 32 additions & 68 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,94 +1,58 @@
# WordPress Plugin - Includes for WordPress

Include Content Anywhere!
# Includes for WordPress - Include Content Anywhere

Includes is a unique custom post type that can be accessed with a shortcode. Publish custom "Includes" posts directly into widgets, widget titles, menu items, posts, pages, custom post types (yes, WooCommerce too), and even theme templates. Centralize the management of text widgets, locally hosted advertisements, rotate content, schedule updates, and all repeated content blocks within posts/pages. Easily update duplicated content like email opt-in forms, author bio's, realtor requirements, shop guarantees, and much more - all from a single location!

![Includes for WordPress - Include Content Anywhere!](https://raw.githubusercontent.com/ChrisWinters/includes/master/assets/images/590x300.jpg)

## Open Source Premium + Free Plugin

* **Master Branch:** Full current release
* **Develop Branch:** Work in progress, else matches master
* **Recent Release:** [Release Versions](https://github.com/ChrisWinters/includes/releases)

Includes is a premium first WordPress plugin, with a built-in free version that never expires, and does not require a license or opt-in to use.

3rd party premium license management is provided by [Freemius](https://freemius.com/) - All users will be asked to enter a premium license key upon activation; press the skip button to activate the free version.

[Plugin Update Checker](https://github.com/YahnisElsts/plugin-update-checker)(PUC) is a built-in 3rd party extension that allows Github hosted plugins to update like any other WordPress plugin.

**Current version:** 5.0.0 | **Requires PHP:** 7.2 | **WordPress version:** 6.1.1

## Free-Premium Plugin
## Plugin features

Both free & premium versions are built into one plugin; if the free plugin works without issue, then the premium features will work without issue for you too. A one time purchase provides a lifetime key. No extra download/install required.
* Works with both classic and block editors and widgets
* Unique ``` [includes slug=""] ``` shortcode that allows you to include centralized content all over your website
* Unique ``` [includes code slug=""] ``` shortcode that allows parsing of actual code - this feature must be enabled
* Categorize all Includes and display Includes by category ``` [includes category=""] ```
* Orderby none, post ID, date, title, slug, random, or date modified in descending or ascending order
* Quick access shortcodes within the Includes content list, posts, and categories
* Enable/disable custom shortcode previewer - use theme templates or empty template to preview Includes
* Shortcode widget for classic widgets, and fully renders shortcode in block widgets
* Optionally alow "slugs" from posts and pages to be used by the Includes shortcode
* Optionally allow shortcodes in post and page titles, menus, and widgets

### What you can do with the plugin

### Shared Features

* Unique [includes] shortcode that allows you to include centralized content all over your website
* Orderby none, post ID, date, title, slug, random, or date modified in descending or ascending order
* Create & update webpage components reducing the need to edit primary copy directly
* Schedule and publish changes like any other post/pages, make your website appear more live
* Rotate content (links, ads, etc) within an Includes category, keeping things fresh for the user
* Help Support The Plugin!


### Premium Only Features

* Unique [code] shortcode that allows parsing of actual code - this feature must be enabled
* Categories enabled for Includes, allowing shortcode to access Include posts by category
* New quick access shortcode fields when editing taxonomy terms
* JSON export of plugin settings allowing for quick importing across installs
* Extended documentation related to premium features
* Help Support The Plugin!


## Download & Prepare

Includes is a GitHub hosted plugin, manual installation is required.

1. Download the [Latest Release](https://github.com/ChrisWinters/includes/releases) from the Includes repo
2. Rename the downloaded zip file to includes.zip


## Upload & Activate

Future plugin updates will happen like any other plugin once activated.

1. Open your WordPress Admin Area -> Plugins menu item -> Add New link -> Upload Plugin button
2. Select Choose File button, locate and select the includes.zip file
3. Click the Install button, then Activate the plugin

* Organize duplicate post content (opt-ins, ads, bios, etc) into a single easy to manage location
* Add styling or scripting to any Include to further customize dynamic content
* [More usage examples](https://github.com/ChrisWinters/includes/wiki/3)-Usage-examples)

## Documentation

All plugin documentation can be accessed directly within the Plugin Admin area (Includes menu > Settings sub-menu link > Documentation tab).


## Contributing

* [Create a fork](https://help.github.com/articles/fork-a-repo/): git clone https://github.com/YOUR-USERNAME/includes
* Make your changes, comment your code, follow the [WordPress Coding Standards](https://make.wordpress.org/core/handbook/best-practices/coding-standards/php/)
* Push the changes to your fork with a related commit message, not a book, comment your code to explain detailed changes
* Submit a [pull request](https://help.github.com/articles/using-pull-requests/)

* [Download, install, and activate](https://github.com/ChrisWinters/includes/wiki)
* [Shortcode and attributes](https://github.com/ChrisWinters/includes/wiki/1)-Shortcode-and-attributes)
* [Plugin settings overview](https://github.com/ChrisWinters/includes/wiki/2)-Plugin-settings)
* [Shortcode usage examples](https://github.com/ChrisWinters/includes/wiki/3)-Usage-examples)
* [Previewing the shortcode](https://github.com/ChrisWinters/includes/wiki/4)-Preview-template)

## Changelog
## Issue and feature requests

= 4.1.1 =
* Released: 2020-05-06
* Changelog: https://github.com/ChrisWinters/includes/blob/master/CHANGELOG.md#411
[Submit an issue](https://github.com/ChrisWinters/includes/issues) if you need assistance, found a bug, or if you would like to request a feature.

## GNU GPLv3 license

## License
* [GNU General Public License v3.0](https://raw.githubusercontent.com/ChrisWinters/includes/master/LICENSE)

1. Excluding WordPress core functions and features, all plugin parts including but not limited to template HTML/CSS marketup, images, design, and custom PHP is licensed according to the terms of your purchase.
2. WordPress core functions and features including HTML, CSS, Images, Icons, Logos, etc are licensed under [General Public License](/blob/master/LICENSE)(GPL).
Permissions of this strong copyleft license are conditioned on making available complete source code of licensed works and modifications, which include larger works using a licensed work, under the same license. Copyright and license notices must be preserved. Contributors provide an express grant of patent rights.

* **Allowed for**: Commercial use, modification, distribution, patent use, private use
* **Limitations**: No liability, no warranty
* **Conditions**: License and copyright notice, state changes, disclose source, same license

## Disclaimer

Includes ("Includes", "Includes plugin") a plugin for WordPress installs; is provided by Chris Winters the ("author") "as is" and "with all faults. The author makes no representations or warranties of any kind concerning the safety, suitability, lack of viruses, inaccuracies, typographical errors, or other harmful components realted to the Includes plugin. There are inherent dangers in the use of any software, and you are solely responsible for determining whether the Includes plugin is compatible with your equipment and other software installed on your equipment. You are also solely responsible for the protection of your equipment and backup of your data, and the author will not be liable for any damages you may suffer in connection with using, modifying, or distributing the Includes plugin.
Includes ("the Includes plugin") is provided by Chris Winters the ("author") "as is" and "with all faults." The author makes no representations or warranties of any kind concerning the safety, suitability, lack of viruses, inaccuracies, typographical errors, or other harmful components related to the Includes plugin. There are inherent dangers in the use of any software, and you are solely responsible for determining whether the Includes plugin is compatible with your equipment and other software installed on your equipment. You are also solely responsible for the protection of your equipment and backup of your data, and the author will not be liable for any damages you may suffer in connection with using, modifying, or distributing the Includes plugin.

The information provided by the author" of the Includes plugin is for general informational purposes only. All information related to the Includes plugin is provided in good faith, however the author makes no representation or warranty of any kind, express or implied, regarding the accuracy, adequacy, validity, reliability, availability or completeness of provided information.

Expand Down
53 changes: 53 additions & 0 deletions _src/configInquirer.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
#!/usr/bin/env node

/*!
* Inquirer config: Questions for inquirer.
*/

export function inquirerQuestions(
oldPluginVersion,
requiredPHPVersion,
requiredWPVersion,
testedWPVersion
) {
return [
{
type: "input",
name: "new_plugin_version",
message:
"Enter the new plugin version number (Current version is " +
oldPluginVersion +
"):",
},
{
type: "input",
name: "new_required_php_version",
message:
"Enter the minimum required PHP version (Current version is " +
requiredPHPVersion +
"):",
},
{
type: "input",
name: "new_required_wp_version",
message:
"Enter minimum required WordPress version (Current version is " +
requiredWPVersion +
"):",
when(answers) {
return answers;
},
},
{
type: "input",
name: "new_tested_wp_version",
message:
"Enter the highest tested WordPress version (Current version is " +
testedWPVersion +
"):",
when(answers) {
return answers;
},
},
];
}
26 changes: 26 additions & 0 deletions _src/configLastUpdated.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
#!/usr/bin/env node

/*!
* Replace config: Set last updated date and time
*/

// Files replace will update.
export function lastUpdatedFiles() {
return [
"./updates.json",
];
}

// Items replace to search for.
export function lastUpdatedFrom(lastUpdatedPlugin) {
return [
'"last_updated": "' + lastUpdatedPlugin + '"', // File: updates.json
];
}

// Items replace will update to.
export function lastUpdatedTo(dateAndTime) {
return [
'"last_updated": "' + dateAndTime + '"', // File: updates.json
];
}
41 changes: 41 additions & 0 deletions _src/configPluginVersion.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
#!/usr/bin/env node

/*!
* Replace config: Update plugin version
*/

// Files replace will update.
export function pluginVersionFiles() {
return [
"./readme.txt",
"./README.md",
"./includes.php",
"./package.json",
"./package-lock.json",
"./updates.json",
];
}

// Items replace to search for.
export function pluginVersionFrom(oldVersion) {
return [
"Stable tag: " + oldVersion, // File: readme.txt file
"Current version:** " + oldVersion, // File: README.MD
"Version: " + oldVersion, // File: includes.php
"'plugin_version' => '" + oldVersion + "'", // File: includes.php
'"version": "' + oldVersion + '"', // Files: package.json, package-lock.json, updates.json
"tag/" + oldVersion, // File: updates.json
];
}

// Items replace will update to.
export function pluginVersionTo(newVersion) {
return [
"Stable tag: " + newVersion, // File: readme.txt file
"Current version:** " + newVersion, // File: README.MD
"Version: " + newVersion, // File: includes.php
"'plugin_version' => '" + newVersion + "'", // File: includes.php
'"version": "' + newVersion + '"', // Files: package.json, package-lock.json, updates.json
"tag/" + newVersion, // File: updates.json
];
}
Loading

0 comments on commit 0709cd3

Please sign in to comment.