[![Version](https://img.shields.io/wordpress/plugin/v/wppedia?logo=wordpress&style=for-the-badge)](https://wordpress.org/plugins/wppedia/)

<img src="https://raw.githubusercontent.com/bfiessinger/wppedia/master/assets/img/wppedia-logo.svg?sanitize=true" alt="WPPedia" width="150">

# WPPedia - The WordPress Wiki Solution

## Description
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.

If you are searching for a feature rich Glossary plugin for Wordpress you just found it.

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!*

### What can this Glossary plugin do for you?

#### 🅰️ Alphabetical Index / archive
WPPedia creates glossary archives with post 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.

#### ℹ️ 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. 

#### 🔎 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.

#### ✍️ 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.

#### 💖 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!

### Template System/Structure
WPPedia template files contain the markup and template structure for the frontend of your glossary. All template files contain several actions you can use to add/move/remove parts of the WPPedia Template or even restructure it completely.

Just copy files from /plugins/wppedia/templates/x.php to /themes/yourtheme/wppedia/x.php and give it your own look.
They might also left completely untouched.

Another way to restructure WPPedia is to use it's actions and filters to modify content. More about this will be available soon in the Documentation.

### What is a glossary?
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?
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.

## 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.
* beautiful accessible tooltips for autogenerated links.
* 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**

<h2>PRO Features <img src="https://raw.githubusercontent.com/bfiessinger/wppedia/master/assets/img/pro-badge.svg?sanitize=true" width="35" /></h2>

* All the features in the free version
* 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
* Allow crosslinking to other post types (not just glossary terms)
* **more coming soon**

## Getting started
### Installation
#### via Download
1. [Download](https://github.com/bfiessinger/wppedia/archive/master.zip) this repository and upload it to your WordPress plugins folder.
2. Open your terminal and switch to the `root` folder of the plugin.
3. Run `composer install -o`.
4. Optional: Run `npm install`.
5. Activate the plugin.

#### via the WordPress Plugin Repository
1. go to https://wordpress.org/plugins/wppedia/ or search for WPPedia in the WordPress plugin directory
2. Download and reupload the plugin to `wp-content/plugins/wppedia`
3. Install and activate

### Documentation
*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. 

## Sponsors
<a href="https://www.steinrein.com/" target="_blank">
	<img src="https://raw.githubusercontent.com/bfiessinger/wppedia/master/assets/img/steinrein-logo.svg?sanitize=true" alt="SteinRein" width="150">
</a>
