bump version number

CHANGELOG.md

@@ -1,5 +1,29 @@
 # Changelog
 
+## 1.1.3
+### New Features
+- added new filter "wppedia_crosslink_ignored_tags" where users might add or remove specific HTML tags in which no automatic crosslinks should be created
+- added new option to enable / disable the tooltip feature
+- added new option to select tooltip styles
+- new tooltip style "light-with-border"
+- new tooltip style "material"
+- new tooltip style "translucent"
+- added loop section identifiers
+- added featured image in archive and singular page layouts
+
+### Bug fixes
+- fixed a bug where rewrite rules were not flushed when updating the glossary frontpage or the permalink base setting
+- fixed loop pagination priority
+
+### Enhancements
+- changed behaviour of filter wppedia_template_path: the returned template path must not include a trailing slash anymore
+- excluded wppedia-search script on pages where no searchbar is active
+- removed the excerpt wrapper in post loop if a post has no excerpt content
+- optimized default styles to fix some issues in several themes
+
+### Code Quality
+- improved documentation in the comments
+
 ## 1.1.2
 ### Bug fixes
 - fixed a bug where WPPedia Templates were used on other post types

core/classes/options.php

@@ -3,7 +3,7 @@
 /**
  * Admin View
  * 
- * @since 1.1.0
+ * @since 1.1.3
  */
 
 namespace bf\wpPedia;

core/classes/post_type.php

@@ -3,7 +3,7 @@
 /**
  * wpPedia Post Type related
  * 
- * @since 1.1.2
+ * @since 1.1.3
  */
 
 namespace bf\wpPedia;
@@ -87,7 +87,7 @@ function set_permalink_base() {
    * 
 	 * @uses register_post_type
 	 * 
-   * @since 1.0.0
+   * @since 1.1.3
    */
   public function register_wppedia_post_type() {
 

core/classes/template.php

@@ -3,7 +3,7 @@
 /**
  * WP Wiki Template
  * 
- * @since 1.1.0
+ * @since 1.1.3
  */
 
 namespace bf\wpPedia;
@@ -174,7 +174,7 @@ public function custom_search_php( $template ) {
 	/**
 	 * Load WPPedia default Templates
 	 * 
-	 * @since 1.1.2
+	 * @since 1.1.3
 	 * 
 	 * @return string $template
 	 */

core/inc/assets.php

@@ -3,15 +3,15 @@
 /**
  * Include Styles and Scripts
  * 
- * @since 1.1.0
+ * @since 1.1.3
  */
 
 use bf\wpPedia\options;
 
 /**
  * Enqueue Assets
  * 
- * @since 1.0.0 
+ * @since 1.1.3 
  */
 function wppedia_enqueue_frontend_assets() {
 

docs/developers/readme.md

@@ -1,2 +1,3 @@
 # WPPedia Developer Docs
 
+## Shortcodes

docs/getting-started.md

@@ -0,0 +1,15 @@
+# Getting started with WPPedia
+
+WPPedia is a free WordPress plugin that allows you to turn your website in a feature rich glossary.
+
+## Installation and updating
+1. Download WPPedia from wordpress.org
+2. Upload the entire `wppedia` folder to the `/wp-content/plugins/` directory
+3. Activate the plugin through the 'Plugins' menu in WordPress
+4. Go and manage your glossary...
+
+or
+
+1. go to https://wordpress.org/plugins/wppedia/ or search for **WPPedia** in the WordPress plugin repository
+2. install and activate the plugin
+3. Go and manage your glossary...

docs/readme.md

@@ -1,5 +1,11 @@
 # WPPedia Documentation
 
-## Quick Links
-- Developer Docs (*coming soon*)
-- User Handbook (*coming soon*)
+## Getting started
+Transform your WordPress website into a thoroughbred encyclopedia.  
+[Learn how](./getting-started.md)
+
+## Codex
+
+## Theming
+
+## Action & Filter Reference

readme.txt

@@ -1,45 +1,52 @@
-=== Glossary by WPPEDIA ===
+=== Glossary by WPPedia - Best Glossary plugin for WordPress ===
 Contributors: steinrein, bastianfiessinger, wppedia
 Tested up to: 5.7.2
-Stable tag: 1.1.2
-Tags: glossary, encyclopedia, wiki, vocabulary, dictionary, tooltip, lexicon, clavis
+Stable tag: 1.1.3
+Tags: glossary, encyclopedia, wiki, lexicon, vocabulary, dictionary, tooltip, clavis
 License: GPLv3 or later
 License URI: http://www.gnu.org/licenses/gpl-3.0.html
 
-The ultimate glossary plugin that will fit all your needs. Create your own encyclopedia / lexicon / wiki with superpowers! 📖
+The ultimate Glossary plugin that will fit all your needs. Create your own glossary (also called encyclopedia, or wiki) with all the features you need! 📖
 
 == Description ==
 
-## The ultimate Glossary plugin for WordPress
+**WPPedia - The best Glossary Plugin for WordPress**
 
-With WPPedia you can build a Glossary / Encyclopedia on your WordPress with ease. Just install, setup some quality posts and you are ready to go.
-Having a glossary on your site can significantly increase your User Experience, SEO and Google Rankings.
+With WPPedia you can build a Glossary / Encyclopedia / Lexicon in WordPress with ease.
 
-If you are searching for a feature rich Glossary plugin for Wordpress you just found it.
+Having a glossary on your site can be a very efficient way to increase your User Experience, SEO and Google Rankings.
+Glossary by WPPedia combines all the tools you need to build the perfect web glossary solution.
 
-WPPedia offers a good out of the box system for creating a glossary / encyclopedia on your Website and comes with a **free** and a **PRO** Version to fit all your needs.
-
-*Be your own Wikipedia!*
+GLossary by WPPedia offers the best out of the box system for creating a glossary / encyclopedia on your Website and comes with a **free** and a **PRO** Version to fit all your needs.
 
 ### What can this Glossary plugin do for you?
 
 #### 🅰️ Alphabetical Index / archive
-WPPedia creates glossary archives with posts indexed by their initial character.
+Glossary by WPPedia creates glossary archives with posts indexed by their initial character.
 
 #### ⛓️ Automated crosslinking between glossary articles
-Our Glossary plugin comes with a powerful automatic crosslinking solution that builds links to other Posts directly from your content. No need for time consuming manual internal linking. WPPedia captures all occurances of your post titles and alternative terms provided by you and replaces them with links to the matching article.
+Our Glossary plugin comes with a powerful automatic crosslinking / auto linking engine.
+
+Glossary by WPPedia automatically recognizes any occurances of terms associated to another glossary article on your page.  
+All terms are then linked to the corresponding post and provided with a tooltip, which increases the user-friendliness of the page
+
+Now you don't need to take the time consuming effort of manually adding internal links all over your glossary term's content.
+
+The free Version of WPPedia allows you to add up to 3 seperate alternative post terms for each glossary term. So if you have a glossary term about Elon Musk and you want this post to be linked if you type E. Musk in another article this feature is the right for your needs.
 
 #### ℹ️ Beautifully styled tooltips
-All automatic generated links are rendered with tooltips just like it's known from pages like Wikipedia. These tooltips help your users to browse through your encyclopedia with ease. Hovering over an autogenerated link will reveal a beautiful card containing useful data giving you a brief insight what's behind the next glossary article. 
+All automatic generated links are rendered with tooltips just like it's known from pages like Wikipedia. These tooltips help your users to browse through your encyclopedia in a very efficient way. Hovering over an autogenerated link will reveal a beautiful card containing useful data giving you a brief insight what's behind the next glossary article.
 
-#### 🔎 Live updating glossary terms search
-The Glossary plugin comes with an easy to use searchbar with autosuggestions. No need to submit a search form to get the expected results. Just click on a result while searching and you get redirected to the matching term.
+Glossary by WPPedia free offers you 4 different tooltip styles.
+
+#### 🔎 Autosuggest search for glossary terms
+The Glossary plugin comes with an easy to use searchbar with autosuggestions. No need to submit a search form to get the expected results. Just click on a result while searching and you will get redirected to the matching term.
 
 #### ✍️ Support for Gutenberg and other page builders
 Of course the plugin is **100%** compatible with Gutenberg and other page builders out of the box - You don't need to worry about this.
 
 #### 🍦 Only vanilla JavaScript
-Speed matters! The Glossary works completely without the use of jQuery. All frontend scripts are running on good old plain (yet modern) JavaScript.
+Speed matters! The Glossary works completely without jQuery as a dependency. All frontend scripts are running on good old plain (yet modern) JavaScript.
 
 #### 💖 Need more?
 We are constantly updating this plugin to offer as many features as possible.  
@@ -57,7 +64,7 @@ Another way to restructure WPPedia is to use it's actions and filters to modify
 A glossary, often called encyclopedia or wiki is an industry-specific word list with the corresponding explanations. 
 It's very important that the terms defined are easy to understand and comprehensible.
 
-#### How can your website benefit from a glossary?
+### How can your website benefit from a glossary?
 Your website is likely filled with blog posts, shop products, case studies and more. Everything you need to get conversions, leads, etc.
 
 Providing a glossary on your website on the other hand is an ideal way to pass expert knowledge about a specific topic.  
@@ -66,13 +73,23 @@ These visitors are then more likely to convert into customers.
 
 However, by providing educational and informational quality content you can significantly improve your website’s SEO and ranking on search engines like Google, Bing, etc.
 
+### Who can benefit from Glossary by WPPedia?
+✔ Blogs
+✔ eCommerce Store Owners
+✔ Niche Sites
+✔ Business Sites
+✔ Startups
+✔ in particular anyone who wants to increase his traffic with good content
+
 ### Free Features
 * Alphabetical glossary index / archive
 * Easy to understand template system / structure that can be adjusted via your theme or childtheme
 * Full support for the Gutenberg Block Editor out of the box.
 * support for all popular pagebuilder plugins.
 * powerfull and adjustable crosslinking solution to create links between your articles on the fly.
+* Up to 3 alternative post terms for searching and the autolink engine.
 * beautiful accessible tooltips for autogenerated links.
+* 4 different Tooltip styles
 * autosuggest search for your glossary entries.
 * let the plugin generate the archive page for you or use a static page with contents defined by you.
 * all scripts run on vanilla JavaScript. No jQuery needed.
@@ -81,16 +98,17 @@ However, by providing educational and informational quality content you can sign
 
 ### PRO Features
 * All the features in the free version
+* Unlimited glossary terms
 * Extended permalink settings
-* Let WPPedia create a crosslink index for each post. This allows the page creation to be a lot faster on large Glossary pages
+* Let WPPedia create a crosslink index for each post. This ensures faster loading times.
 * Allow crosslinking to other post types (not just glossary terms)
 * **more coming soon**
 
 ### Support
 We offer dedicated support for all buyers of the **PRO** version.
 If you have any questions, suggestions or whatever bothers you we will try to assist you as quick as possible.
 
-Support requests for the free version will be treated with less priority. We ask for your understanding.
+If you use the free Version of glossary by WPPedia head over to the [Support forum here on wordpress.org](https://wordpress.org/support/plugin/wppedia/)
 
 == Frequently Asked Questions ==
 
@@ -127,6 +145,30 @@ or
 
 == Changelog ==
 
+= 1.1.3 =
+##### New Features
+- added new filter "wppedia_crosslink_ignored_tags" where users might add or remove specific HTML tags in which no automatic crosslinks should be created
+- added new option to enable / disable the tooltip feature
+- added new option to select tooltip styles
+- new tooltip style "light-with-border"
+- new tooltip style "material"
+- new tooltip style "translucent"
+- added loop section identifiers
+- added featured image in archive and singular page layouts
+
+##### Bug fixes
+- fixed a bug where rewrite rules were not flushed when updating the glossary frontpage or the permalink base setting
+- fixed loop pagination priority
+
+##### Enhancements
+- changed behaviour of filter wppedia_template_path: the returned template path must not include a trailing slash anymore
+- excluded wppedia-search script on pages where no searchbar is active
+- removed the excerpt wrapper in post loop if a post has no excerpt content
+- optimized default styles to fix some issues in several themes
+
+##### Code Quality
+- improved documentation in the comments
+
 = 1.1.2 =
 ##### Bug fixes
 - fixed a bug where WPPedia Templates were used on other post types

template-hooks/loop.php

@@ -73,7 +73,7 @@ function wppedia_loop_featured_image() {
 /**
  * Loop excerpt
  * 
- * @since 1.0.0
+ * @since 1.1.3
  */
 if ( ! function_exists( 'wppedia_loop_excerpt' ) ) {
 	function wppedia_loop_excerpt() {
@@ -90,7 +90,7 @@ function wppedia_loop_excerpt() {
 /**
  * Pagination
  * 
- * @since 1.0.0
+ * @since 1.1.3
  */
 if ( ! function_exists( 'wppedia_posts_pagination' ) ) {
 	function wppedia_posts_pagination() {

templates/archive.php

@@ -16,7 +16,7 @@
  * @see https://developer.wordpress.org/themes/basics/template-hierarchy/
  *
  * @package wppedia
- * @version 1.0.0
+ * @version 1.1.3
  */
 
 defined( 'ABSPATH' ) || exit;

webpack.config.js

@@ -12,7 +12,6 @@ const DependencyExtractionWebpackPlugin = require( '@wordpress/dependency-extrac
 const jsExternals = {
 	jquery: 'jQuery',
 	'@yaireo/tagify': 'Tagify',
-	'tippy.js': 'tippy',
 	// WordPress Packages.
 	'@wordpress/hooks': 'wp.hooks',
 }
@@ -162,11 +161,6 @@ module.exports = [
 						from: 'tagify.(min.js|css)',
 						to: path.resolve(__dirname, 'dist/vendor'),
 						context: path.resolve(__dirname, 'node_modules/@yaireo/tagify/dist')
-					},
-					{
-						from: 'tippy(-bundle.umd.js|.css)',
-						to: path.resolve(__dirname, 'dist/vendor'),
-						context: path.resolve(__dirname, 'node_modules/tippy.js/dist')
 					}
 				]
 			})

wppedia.php

@@ -9,7 +9,7 @@
  * Description: The most advanced Glossary solution for WordPress!
  * Author: 			Bastian Fießinger & WPPedia Glossary Team
  * AuthorURI: 	https://github.com/bfiessinger/
- * Version: 		1.1.2
+ * Version: 		1.1.3
  * Text Domain: wppedia
  */