readme.txt

=== Glossary by WPPedia - Best Glossary plugin for WordPress ===
Contributors: steinrein, bastianfiessinger, wppedia
Tested up to: 6.0.0
Stable tag: 1.3.0
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 glossary (aka encyclopedia, or lexicon) with all the features you need! 📖

== Description ==

**WPPedia - The best Glossary Plugin for WordPress**

With WPPedia you can build a Glossary / Encyclopedia / Lexicon in WordPress with ease.

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.

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
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 / 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 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. By the way: Glossary by WPPedia free offers you 4 different tooltip styles in the free version.

So you may ask, when Glossary by WPPedia renders the tooltips with their regarding excerpts on every post, isn't it possible that Google recognizes this as duplicate content?
No! The tooltips content is not visible to search engines on page load. It get's fetched asynchronous only when hovering an automatic generated link.

Sounds great? It is!

#### 🔎 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! Glossary by WPPedia 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.
Have a feature request? Don't hesitate and [contact us](https://wordpress.org/support/plugin/wppedia/)!

### What is a glossary?
A glossary, often called encyclopedia or lexicon 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?
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.
It is a win-win situation for everyone involved: The user finds everything in one place and does not have to pull information "externally", you, the website owner, keep your visitors on your page.
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
* Extended Permalink settings for the glossary
* 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.
* **2** additional Shortcodes
* **more coming soon**

### PRO Features
* All the features in the free version
* Unlimited glossary terms
* Let WPPedia create a crosslink index for each post. This ensures faster loading times.
* Allow crosslinking to other post types (not just glossary terms)
* Glossary categories widget
* Visual assistance about all crosslinks that will be created while editing a glossary term (*in work*)
* Version histories (*planned*)
* Glossary term attributes for filtering and displaying in special lists (*planned*)
* **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.

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 ==

= Where can I get the PRO version? =

WPPedia **PRO** is still in beta and will be available soon. But first we try to give you the best possible glossary experience in the free version.

= Will WPPedia work with my theme? =

most likely, yes. However we cannot guarantee this for every theme out there (there are so many).

If you encounter any problems with WPPedia and your theme do not hesitate and contact us!

= Can I setup my glossary with Gutenberg? =

Of course you can! In fact, WPPedia works great in addition with Gutenberg.

= How do I get support? =

If you have trouble with the WPPedia WordPress plugin, you can get help on the support forums here at [wordpress.org](https://wordpress.org/support/plugin/wppedia/) or on [GitHub](https://github.com/bfiessinger/wppedia/).

== Installation ==

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...

== Changelog ==

= 1.3.0 =
##### New
- the static frontpage now acts like a glossary archive with additional content
- added a page title to the glossary archive
- added a page title to glossary taxonomies
- added a content section to glossary taxonomies
- added a customizer section for WPPedia

##### Bug fixes
- fixed a bug where automated crosslinking was not working if the link phrase was paranthesed
- fixed a bug where automated crosslinking was not working if the link phrase was in quotes
- removed typecasting on class properties to avoid fatal errors prior php 7.4
- fixed a bug where it was unable for theme and plugin developers to update WPPedia's inline styles
- fixed a bug where the page title was wrong for the glossary archive

##### Enhancements
- implemented php-scoper for composer dependencies to avoid namespace issues with other themes / plugins
- [⚠️ BREAKING] improvements to wp_options, options are now stored as serialized data to avoid multiple requests to the WordPress database
- minor styling improvements
- enhanced WPPedia database upgrade logic
- implemented select2 for select menus in the admin area

##### Template Updates
- The following templates have been updated:
	- `archive.php`
	- `nav/char-navigation.php`

##### Theme Compatibility
- enhanced support for the Twenty Twenty One theme

##### Translations
- added translations for the following languages:
	- German

##### Code Quality
- updated comments
- fixed several code style issues
- strict use of [wpcs naming conventions](https://developer.wordpress.org/coding-standards/wordpress-coding-standards/php/#naming-conventions) for file names

= 1.2.4 =
##### Bug fixes
- remove typecasting on class properties to avoid fatal errors prior php 7.4 (https://wordpress.org/support/topic/fatal-error-3905/)

= 1.2.3 =
##### Bug fixes
- fixed alphabetical index redirect does not respect the permalink base (since 1.2.2)

##### Enhancements
- more robust regex for alphabetical index rewrite rules

= 1.2.2 =
##### Bug fixes
- fixed alphabetical index redirect for non paged archives

= 1.2.1 =
##### Bug fixes
- fixed a redirection issue when `use initial character in URL` is not active

##### Enhancements
- enhanced UX on admin pages
- automatically update version constant
- added trailing slashes to the post URL's

= 1.2.0 =
##### New
- option `use initial character in URL` is now available in the free version
- new taxonomy for glossary categorization

##### Bug fixes
- fixed some styling issues
- fixed an issue where edit scripts where not enqueued for new posts
- fixed a template issue where 2 loop wrapper elements exists

##### Enhancements
- better theme compatibility with default WordPress themes
- stabilized templates
- added more editable template parts

##### Breaking ⚠️
- switch classNames to camel case
- rename plugin constants
- rename plugin namespaces

= 1.1.6 =
##### Bug fixes
- fixed permalink base setting had no effect on the actual permalinks
- fixed could not dismiss admin notices

##### Enhancements
- stabilized query functions

= 1.1.5 =
##### Bug fixes
- fixed a bug where fresh glossary terms would often result in 404 Errors and needed manual saving of permalinks

##### Enhancements
- enhanced default styles

##### Code Quality
- removed unused dependencies

= 1.1.4 =
##### Enhancements
- fixed minor styling issues

= 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

##### Enhancements
- **We are glad to announce that WPPedia now allows 500 glossary articles in the free plan! 🎉🎉🎉**

= 1.1.1 =
##### Bug fixes
- fixed posts per page was unable to change on glossary archives
- fixed orderby was set wrong in some situations

= 1.1.0 =
##### New Features
- allow up to 3 seperate alternative post terms (in addition to the post's title) that can be used for crosslinking and searching
- added plugin version upgrade mechanism for deprecations

##### Enhancements
- added a plugin action link to the edit screen of WPPedia
- added a plugin action link to the settings screen of WPPedia
- added a helper message to notify users if their glossary frontpage slug does not match the glossaries permalink base setting
- enhanced accessability for tooltips
- enabled hash navigation for options page tabs
- enhanced default glossary styling
- restructured options pages

##### Bug fixes
- fixed a styling issue with disabled switch buttons in wp-admin
- fixed a bug where crosslinks could not be created case insensitive
- fixed a bug where crosslinks could not be created at the start of the content
- fixed a bug where crosslinks could not be created inside HTML tags
- fixed a bug where conditional page functions would give wrong results in some situations

##### Code Quality
- added some missing comments
- applied more consistency in usage of internal methods

##### Various
- change default primary color

= 1.0.0 =
- Initial Realease