CM Tooltip Glossary User Guide

<< Back to Tooltip Pro Page    ||      << Back to WordPress plugin site>       CM Tooltip Glossary Pro – Buy Now

For the new and updated version of the user guide please visit http://tooltip.cminds.com/cm-tooltip-user-guide/

 

Initial Installation Instructions

Installing the Super Tooltip Glossary plugin should be easy to install like any other WP plugin. If you are unfamiliar with plugin installation you can use this step-by-step guide

 

How it Works

Based on customizable plugin settings, the Super Tooltip Glossary plugin parses all posts and pages looking for terms that are defined in your glossary, with the exception of custom defined protected tags (you can define protected tags in the settings panel) and user defined excluded areas (see shortcodes). Parsing happens in “the_content” filter every time it is loaded before information is sent to the browser.

The output links appear inside posts and pages, that when hovered over, they show the Tooltip with the term’s definition. You may apply filters over the  tooltip content or define that it is taking the content from the Excerpt instead (All definitions are in settings). Once a user clicks on the term, they are directed to the Term Page. For each term, a post with a unique ID and permalink is created . An index page with a list of all the terms in the glossary is automatically generated.

List of terms as defined in glossary. Each term is a WP post

How tooltip appears in post

 

Updating Versions or Upgrading to the Pro Version

If you are reinstalling the plugin, don’t worry about losing any of your previous data (glossary terms), they will not be erased and you can safely update plugin version or upgrade to the Pro version without loss of any of your existing glossary terms

When upgrading to Pro please remember to deactivate first the regular version before activating the Pro version, because they would then overlap each other and can not work simultaneously.

 

Defining the Index Page (The List of Terms page)

A Glossary index page is automatically created upon plugin installation. You can manually change this page ID in the plugin settings panel or leave it blank to prevent an index page being created.  To set the ID manually, you first need to define the page ID of the Glossary index page. (This can be a page you create and make up your own ID in the settings). Having an index page is optional and Terms will still be highlighted as a mouse-over in the relevant posts and pages you designate.

Glossary Permalink – The Glossary permalink is the part of the URL for glossary terms (http://mydomain.com/glossary/term-name). The index page (http://mydomain.com/glossary) is a name of the page which ID is given in “Main Glossary Page ID”, so if you custom create a page name like “Dictionary” and fill in its ID, the index page would then be http://mydomain.com/dictionary, however the Term page would still be http://mydomain.com/glossary/term-name (or whatever is specified in “Glossary Permalink”)

Index page ID and permalink as appear in settings

 

Adding Terms to your Glossary

The initial step after installing the plugin should be to add terms to the Glossary. Add terms by clicking on the Add New link in the left side admin menu of CM Tooltip Glossary

Each glossary term should include a Title and description. Descriptions can be long or short and can include pictures, and media as well as text.

In the settings you can limit the amount of  character  that the Tooltip displays when the term is hovered over by the cursor.

 

Accessing the Term Page

A term is treated like any other WP post. Each term has its own unique URL that can be accessed in the following ways.

  • Directly by entering the URL
  • From each post once the term is clicked on (this can be changed in Glossary setting).
  • From the Glossary index page (this can be changed in Glossary setting)

 

Controlling where Term Tooltip Appears

There are several setting options that control where and how the Tooltip appears. Consider the different ways of changing them to customize the glossary behavior.

 

Embed Video Files

As an example try hovering the cursor over Taxonomy.

The best way to embed video in your tooltip is to use a smaller video frame size – for example width=”300? height=”169?

and Add the video source ?rel=0&autoplay=1 (Youtube) in the settings.

For example

src=”http://www.youtube.com/embed/e-1x994PCqQ?rel=0&autoplay=1?

 

Using Term Excerpts

If you want to the Tooltip to show only some of the information, you can set up an Excerpt of the term. All you need to do is specify this custom setting in the control panel.

 

Manage Comments

Like any other WP post, a Glossary term can accommodate comments. Comments will not be displayed in the Tooltip but they will show up in the Term page

 

Cleaning Tooltip Content

To avoid line breaks, extra spaces, and special characters from distorting your Tooltip text, check the “Clean tooltip text” in box in the control panel settings.

 

Controlling the Index Appearance

The index page contains the List of Terms in the Glossary database.

The index page of terms can also be shown as tiles

 

How to show the Terms AND the Tooltip Definitions together in the Index   (Pro Version Only)

Terms and Definitions can be shown together when you check the box in the ”Show main glossary page with definition”. The definition that is shown is the definition which was initially supposed to be shown in Tooltip, this means that it may be short and concise, according to your custom setting options.

 

Controlling Letters in the Alphabetic index   (Pro Version Only)

In the Pro version of CM Tooltip you can control which letters should be shown in alphabetic index. This can be customized to support non-English alphabets that include additional characters.

 

Controlling the Numeric Index   (Pro Version Only)

In the Pro version of CM Tooltip, you can custom show numeric characters [0-9] in the alphabetic index. Settings can  remove [0-9]  from Glossary index

 

Adding Pagination to the Index Page   (Pro Version Only)

In the CM Tooltips Pro version you can add Paginations to the index page and specify how many terms should appear on each page

There are two different types of Paginations

    • Client-side: Longer loading times but have a fast page switch (this will also include the alphabetical index)

    • Server-side: Faster loading, but have a slower page switch (no alphabetical index)

 

Adding Links from Term Page to the Index Page   (Pro Version Only)

In the CM Tooltips Pro version, you can check in the settings if the term page should include a link back to index page, each setting is localized according to the Term that appears in the page link.

 

Custom Styling the Index Page

The Glossary index page is controlled by several classes which can be changed within the CSS definitions of your theme.

class=”glossaryLink” – This is the default glossary link style. The Glossary page link can be change so that it looks different then other links on the site.

In the settings control panel, check the box entitled  ”Style main glossary page differently”. This setting changes the class of the Glossary page link only on the index page to direct clicks to the glossaryLinkMain setting, which gives you the option to make the Glossary links in the index to look different than the glossary links that appear on posts and pages.

 

Styling the Tooltip Link   (Pro Version Only)

In the Pro version you can style the Glossary link in the settings. You can control the link style, color, text color and more.

 

Styling the Tooltip Box   (Pro Version Only)

In the Pro version of CM Tooltips you can style your Glossary Tooltip in the settings, Control the Tooltip background color, text color and more

 

Exclude List from Glossary

Since the Glossary parses all pages and posts on the site, in some cases you may choose not to let the Glossary to parse sections of the page or post.  . To avoid parsing parts of pages or posts, wrap the term with glossary_exclude shortcode. For example – glossary_exclude —paragraph text== /glossary_exclude (remember to wrap each shortcode with [])

Another option is to check the box in settings “Avoid parsing protected tags” which prevents the Tooltip from parsing Script, A, H1, H2, H3, PRE, Object. tags content

 

Exclude from Glossary Editor Button   (Pro Version Only)

In the Pro version of CM Tooltips there is an Editor button that wraps content with glossary_exclude shortcode.

 

Synonyms   (Pro Version Only)

In the Pro version there are added options to add synonyms for each glossary term. Synonyms are parsed by the glossary the same way like  terms that appear in posts or pages and are linked like any other Term upon hover-over to show the Tooltip. Synonyms will not appear in the Glossary index as an entry but will be indicated on the List of Terms page.

 

Adding Synonyms   (Pro Version Only)

Adding synonyms is done individually on each term page

You can add several synonyms and separate them with commas between.

 

Controlling the Synonyms Appearance   (Pro Version Only)

The Pro version of the plugin has options where you can control the appearance of synonyms in the Tooltip and on each term page.

 

Variations Singular or Plural   (Pro Version Only)

In the Pro version there is the added option to add variations to each Glossary term. Variations are customized according to the different ways of writing the Term. It may help to refer to Singular / Plural variations of Terms or other similar variations. Variations that appear in posts or pages will be linked like any other Term and will NOT  show in the Tooltip once hovered-over. They will not appear on the Glossary index page as an entry and will not be indicated in Term page or Term Tooltip in the way that synonyms do.

 

Adding Related Articles   (Pro Version Only)

Related Articles are links back to your posts and pages from your Glossary Term pages. Related articles links create a connection between Terms in your Glossary and posts or pages where these terms are used on your site. From an SEO perspective, this demonstrably increases the internal links inside the site. Related articles appear in two sections: one for relations between Glossary terms (terms that are relationally connected) and the other section for related posts and pages.

 

How it Works   (Pro Version Only)

A background process (cron) is continuously indexing all your pages and posts and building them into a table that contains all your related posts, pages and Glossary Terms. Each time a term post is displayed. the related articles information is retrieved from the last time the table was created. It is also possible to refresh this table and control this process manually from the plugin setting control panel.

 

Controlling the Process and the Display   (Pro Version Only)

In the Pro version the plugin includes settings where you can control several options with Related articles. These include: what pages go into the index, how many links are displayed and how to localize the titles with language preferences.

 

Opening Terms in a New Tab

In the settings control panel you can define whether the link to the Term page will open a new tab or window.

 

Adding Title Parameters to the Term page link

In the settings, you can define if the Title parameter once a Term is hovered-over will show. For example.

 

Widget   (Pro Version Only)

The widget option allows you to post random Terms from your Glossary in your site theme widgets area.

 

Importing / Exporting Terms   (Pro Version Only)

In Pro version Importing and exporting Terms is supported, giving you the ability to replicate your Glossary terms database easily and migrate them across several sites and even import external large dictionaries into the plugin. Exported files are saved in .CSV format which can then be opened by MS-Excel or OpenOffice.

If you have troubles exporting your data to a .CSV file, a simple workaround is to use Google Spreadsheet. Paste the values (only if you have complex formulas) or import the sheet first and then download the data to .CSV.

If a Term already exists in the database, only the content is updated. Otherwise, a new term is always added.

Important!! All files should be UTF-8 encoded and, if you use MSExcel, please remember that by default Excel can’t save in proper CSV format (comma-delimited)

Imported file Format example:

Id,Title,Excerpt,Description,Synonyms,Variations

100,”Example Term”,”Example term excerpt text”,”Description, if multiline then uses HTML element”,”synonym1,synonym2″,”variation1,variation2″

101,”Another”,,”Excerpt can be empty”,,

 

Multisite Support   (Pro Version Only)

The Plugin Pro version Support WP Multisite.  Using the Glossary plugin in a Multisite environment means that The Glossary Terms table is different for each site within separate installation folders.

 

Localization   (Pro Version Only)

All plugin labels and titles appear in setting making it easy for localize the plugin appearance.

On top of the Tooltip Index page  there are language alphabet characters that can be specified in settings and be included in the Glossary index. Glossary supports UTF8 (read more about this in troubleshooting)

 

Problem: The Tooltip appears as Undefined

If your site contains JS errors, the tooltip may not appear as it should and you will receive upon hover-over an ”Undefined” value in the Tooltips or no Tooltip will show at all.

To fix this problem, use your web console In FF, where you can right-click and choose “inspect element”.

When the console opens, select the Web Console and under JS you will see what JS errors you have. These need to be fixed before the Tooltip will work

 

Permalink Issues

Permalinks must be setup in order for the plugin to work properly. Please go to Admin panel Setting->Permalinks and set permalinks to Post- name or any other custom name

Some themes may not support the plugin. If you have problems using the plugin please first check if it is coming from your theme by choosing the WP default theme (twentyten / twentyeleven ) and trying if the tooltip plugin is working properly. Another conflict may be with other plugins which are insttaled in your site, to fix this and you should first  deactivating all plugins to see if the Tooltip plugins functions as expected and then by activating them one by one detect which plugin is inteferying the the tooltip plugin operation

 

Characters in non-English languages that do not appear correctly

The CM Tooltip plugin works in UTF. This means that your MySQL DB table should also be defined as UTF8

Make sure, you have proper db, table and column charset/collation in your database. When table is created in database, it relies on environmental settings, so if you have charset/collation set for DB that doesn’t allow special characters by default (utf8 characters), then the results will be wrong.

Should be: charset – utf8, collation – utf8_general_ci.

Try following SQL Queries (replace your_wp_db_name with the database name you have set in your WordPress installation):

ALTER DATABASE your_wp_db_name DEFAULT CHARACTER SET utf8 DEFAULT COLLATE utf8_general_ci;

ALTER TABLE your_wp_db_name.wp_glossary_synonyms DEFAULT CHARACTER SET utf8 COLLATE utf8_general_ci;

ALTER TABLE your_wp_db_name.wp_glossary_synonyms MODIFY synonym VARCHAR(145) CHARACTER SET utf8 COLLATE utf8_general_ci;

 

Some Terms which are not Parsed

Make sure the Terms are defined to not be case-sensitive in setting page.

 

Glossary parsing is not working properly?

In some cases your theme or other conflicting plugins may prevent the CM Tooltip to upload properly. You can always invoke each Tooltip manually in your theme by adding the following code to your template.

// include glossary script and stylesheet since it is not loading by itself in search results

$glossary_path = WP_PLUGIN_URL . ‘/’ . ‘tooltipglossary/’;

wp_enqueue_script(‘tooltip-js’, $glossary_path . ‘tooltip.js’);

wp_enqueue_style(‘tooltip-css’, $glossary_path . ‘tooltip.css’);

To parse terms inside shortcodes of your theme, you will need to use red_glossary_parse($content, true) function (PRO version only) inside a shortcode function.

In regular version, only raw content is parsed and this happens before any of the custom shortcodes are replaced by their equivalents. You can also try to modify add_filter(‘the_content’, ‘red_glossary_parse) with far priority index:

add_filter(‘the_content’, ‘red_glossary_parse’, 99);

Filters could be parsed AFTER shortcodes are first evaluated (need to try which number will be enough, could be 99, could be 999, depending on other filters)

 

Related Articles link does not work   (Pro Version Only)

Here is some debug info you need to check

    • Please try manually rebuilding the related articles index from the admin setting panel, making sure related articles are set to appear
    • Please change line #43 in related.php (set_time_limit) to 2000 instead of 300 and check if this helps to index the files
    • Try to edit an article which has a glossary term and save it without making any changes. This should trigger the index to be rebuilt for this article. Then check again to see if the Glossary terms from the article has articles related to it.
    • If all the above does not work, please send us the error.log of the server (if you are running Apache it should be located in /var/log/)
    • Last thing, if none of the above works – Please check to see if your database already contains a wp_glossary_related and let us know so that we can instruct you how to deal with it.

 

On the Glossary index page, the Terms are not sorted alphabetically

Please check if the Terms are out of order. Look to find any white-space in the beginning of the title of the term which is out of order. Likely mistakes happen when copy-pasting, sometimes causing white-spaces to be added. WordPress does not trim any characters from the title, and this is a default WP behavior, we’re not able to override this flaw.

 

Is it possible to change the first letter saying “ALL” to A in the automatically generated index on the main glossary page

In the plugin directory you will find a file named jquery.listnav.glossary.js this is a JavaScript file On line 56 change look for a class=”ln-all” href=”#”>ALL and change it to anything you would like to have – for example All Terms a class=”ln-all” href=”#”>All Terms

 

Term is defined in glossary BUT it is not showing highlighted on the page

Please check one of the following:

  • The term page (glossary entry) has a leading space or character in the title or between the words if it has more than one word (I suggest to try to rewrite one of the terms title again and check if this help)
  • In the post page where the term appears before the term you sometime will find nbsp; instead of blank or if the term contains two – three words between them you may find characters which does not appear on the page but exist in the code and You need to remove them
  • Please check the page where the term should appear for JS errors (right click on the mouse and choose inspect element in chrome. Then go to the console to look for errors
  • In Plugin settings check that Terms case-sensitive is not checked
  • If all above does not work please check if this is a Theme issue but applying another theme (best is WordPress default theme )on your site and checking if tooltip works with new theme
  • Another rare issue is when the site theme does not use the_content (a technical term from WordPress). The _content means that your content comes from the main text area in the page / post and not custom fields. The plugin does know what custom fields you are using and therefor the tooltip although uploaded does not find any words on the page/post. Solution is to adjust your theme to use content filters (another WP terms which means that all content filters that are applied on the main text area should be applied also on custom fields)