“WP Glossary - Encyclopedia / Lexicon / Knowledge Base / Wiki / Dictionary”
Documentation by “WP Instinct”
Thanks for purchasing our plugin.
If you have any questions that are beyond the scope of this help file, feel free to email wpinstinct@gmail.com.
Thanks again
User Guide
Add New Glossary Term
- Click on Add New under Glossary Terms menu.
- Fill out the required details for term:
- Glossary Term Title
- Full Description through editor
- Post Title under Custom Attributes section: This option allows you to use custom title all-over the website for current glossary term.
- Custom URL under Custom Attributes section: This option allows you to use external/custom URL for current glossary term. This option is useful when you want user to redirect on wikipedia or some other dictionary URL for this particular term rather than having complete description on your website.
- Excerpt: This option is good in case if you are using Short Description as Content Type for tooltip.
- Featured Image
- Once done with these details, click on Publish button from the right side area.
Edit Glossary Term
- Click on All Glossary Terms under Glossary Terms menu.
- Click Edit against glossary term you need to edit.
- Next screen is same of Add New Glossary Term screen so refer to Add New Glossary Term section for further steps.
- In this case, you will see Update button over Publish button.
Create Glossary Index Page
- Go to Pages/Posts menu under WordPress dashboard.
- Create a new page/post.
- Add the [wpg_list] shortcode in page/post content. You can find more about shortcode on the same user guide under Shortcode section.
- Note down this page/post ID.
- Visit Plugin Settings and enter the ID from previous step under Glossary Page/Post ID setting.
- Checkout the other settings from Plugin Settings page as per your requirement.
Shortcode
- Basic shortcode: [wpg_list]
Use this shortcode anywhere in your page or post and it will start showing glossary terms in the same style you are expecting plugin to do. There are some attributes available with the same shortcode and you can find those in next step. Not all of those attributes are required to add with the shortcode and add only as per your need. If you don't use those attributes, shortcode uses Plugin Settings for the purpose.
- Full Shortcode: [wpg_list title="" layout="one_column/two_column/three_column/four_column/five_column" alphabet_set="A,B,C,D,E,..." hide_empty="yes/no" hide_all="yes/no" hide_numeric="yes/no" post_type="glossary" template="alphabet/category" taxonomy="glossary_cat" taxonomy_terms_to_include="optional/1,2,3.." taxonomy_terms_to_exclude="optional/1,2,3.." uncategorized_term_name=""]
- title: This option is for nothing at the time with the plugin and is here just for future references/updates.
- layout: Select the number of columns you want per row on Glossary Index Page. By default, it shows three columns per row but you can change it to any from one to five columns. This option allows you to choose one from following five options:
- one_column
- two_column
- three_column
- four_column
- five_column
- alphabet_set: By default, plugin uses A to Z alphabet set for filter on Glossary Index Page. Suppose you want to:
- change the order of the alphabets
- show only few alphabets
- show a different set of characters
- show characters list for other language (eg: Hebrew, Greek )
- show multiple rows rather than all the alphabets in single row or all English alphabets in first row and Hebrew in next row
You can use this option for all these. Use comma (,) for multiple alphabets. For multiple rows, simply use new line (ENTER from keyboard).
EG:
A,B,C,D,E,F,G,H,I,J,K,L,M,N,O,P,Q,R,S,T,U,V,W,X,Y,Z
А,Б,В,Г,Д,Е,Ж,З,И,К,Л,М,Н,О,П,Р,С,Т,У,Ф,Х,Ц,Ч,Ш,Щ,Э,Ю,Я
- hide_empty: In case, some of the alphabets from filter list, on Glossary Index Page, doesn't have any glossary term/phrase. These alphabets will show as disabled in the list. Selecting this option will remove these disabled alphabets from the list completely. This option allows you to choose one from following two options:
- hide_all: Plugin, by default, shows ALL at the starting of the filter list on Glossary Index Page which shows all the glossary terms/phrases when clicked. For example, you click on alphabet A from the filter list, it will come up with all the glossary terms starting with A. Now you want to see back the whole list of terms. Clicking ALL does this for you. If you want to show it no more in the filter list, you can enable this option. This option allows you to choose one from following two options:
- hide_numeric: This option works almost in the same way Hide "All" Filter works but for the glossary terms starting with number. Plugin shows 0-9 just after All in the filter list on Glossary Index Page and you can remove it by enabling this option. This option allows you to choose one from following two options:
- post_type: Plugin uses its own custom post type for Glossary Index Page. In case if you want to show WordPress's default post type ( Page, Post ) or any other custom post type you can choose under this option.
- template: Plugin comes up with two type of glossaries: Alphabet Glossary and Taxonomy/Category Glossary. Few times, you want to list all the categories with their posts in glossary style and this option does it for you. By default, template uses alphabet to works as Alphabet Glossary and you can change it to category in case you need to show Taxonomy/Category Glossary. This option allows you to choose one from following two options:
- taxonomy: This option works better with template="category" from previous option. That way you can decide which taxonomy you want to load the posts for.
EG: You want to list all the products with WooCommerce categories, you can set it like taxonomy="product_cat".
- taxonomy_terms_to_include: By default, Previous option ( taxonomy ) loads posts for all the categories. This option allows you to include only specific categories to load the posts for. For this you have to enter comma separated category ID's with this option.
- taxonomy_terms_to_exclude: By default, Previous option ( taxonomy ) loads posts for all the categories. This option allows you to exclude specific categories to load the posts from rest of the categories. For this you have to enter comma separated category ID's with this option.
- uncategorized_term_name: Its not necessary that all the posts will be categorized properly and few of those can still be without having any category assigned. Using template="category" and it shows only those posts which have at-least one category assigned. This option allows you to show uncategorized posts as well under same name category you pass with this option.
Thanks, once again, for purchasing our plugin. We'll be glad to help and answer all questions and clarify all doubts.
If you have a more general question relating to the plugins on Envato, you may consider visiting the forums and asking your question in the "Item Discussion" thread.