SEO Glossary Documentation

Introduction

The main goal of SEO Glossary is to create alphabetical lists of terms with their definitions along with tooltips in content.

SEO-Glossary

 

I. SEO GLOSSARY INSTALL

1.1 Install

Our component is Joomla 3.x compatible. All the features and 3rd party integrations are included in all memberships.
In order to install our component you have to download the extension .zip file and use standard Joomla installer.

image7

 

Then click on Browse > Upload and Install button, component, modules and plugins will be installed activated by default.

 

1.2 Update & automatic updater

In order to update the extension you can install a new version over the old one by downloading the ZIP file from JoomUnited or use the automatic updater (recommended).

update

 

The automatic updater, which push the update notification, is embedded in the Joomla extension you've installed. So you'll get notified like any other extension in the dashboard or using the menu: Extension > Manage > Update menu.

 

Login to your account to update

You need to login to your JoomUnited account to update all your JoomUnited Joomla extensions. In order to login access the main configuration of the component then click on the Live update tab. At the bottom, you'll find a login button. 

image10

 

Enter your JoomUnited credentials, the same you use to login here @ www.joomunited.com

image11

 

The button will turn orange, congrats! you can now update all the JoomUnited extensions on this website! If your membership is expired you'll get a renew link and a text that explain that.

image12

 

Note: one single login will allow you to update all the JoomUnited extensions (regarding your membership). Login won't expire unless you disconnect it. 

 

II. EXTENSION COMMON USE

2.1 Create a glossary

The SEO Glossary content is organized with glossaries that contain definitions entries. Glossaries are multilingual and unlimited regarding definitions.

In order to add a glossary just go on Component > SEO Glossary then click on Manage glossaries.

add-glossary


 

You’ll find some standard Joomla control buttons, hit New to add a new glossary.

glossary-list


Several elements can be edited like:

  • The glossary title and alias (used in URL of the glossary and its entries)
  • The description: can be displayed as an option
  • The language: Uses Joomla multilingual native system
  • The publication status
  • The alphabet: Can be any alphabet, including numbers and special characters

 

alphabet

 

You have now the possibility to add a custom alphabet to each glossary. It means that for example you can have an alphabet with only numbers and one with only 3 letters. Finally, of you have several glossaries, they can be listed on a single page or be separated on different pages on frontend.

glossary-list-frontend

 

 

 
2.2 Add definitions entries

In order to add definition terms in your glossary, on the panel click on “Manage Entries”

add-definitions

You’ll be redirected to the definitions terms listing. You can use 2 tools to filter your entries if they’re numerous: the Search & the Sort tools.

filter-definitions

 

 

To add a new definition, use the standard Joomla button New on the top right of your screen.

The definition fields are the following:

  • The glossary: which the definition belong
  • The definition term (title): use the hint button to fill automatically the definition from an online dictionary
  • The definition alias: used in the URL of the definition page
  • Use a Custom Link: override the link to the detail of the location by a custom URL
  • Custom Link: if enabling, it could link to a Link, Menu or K2 link.
  • The synonyms: comma-separated list of synonyms. Add some synonyms to the entry
  • The definition itself and read more field

definition1

 


Then on the right side you can edit additional settings:

  • Entry icon: used to identify an entry by an image
  • Hits: If set to Show, the number of Hits on a particular Article will be displayed.
  • Rel No Follow: Set rel no follow to block search engines from following links
  • URL Target window: When opening a link from your content, chose the target (same window or new window)
  • Meta description and keywords: Meta information used by search engine in the definition page

 

definition2

 

Finally, at the bottom right you can setup:

  • The definition tags: Use the Joomla native tag system but on definitions: as an option can be used on frontend
  • The definition author
  • The author name override: as an option can be displayed on frontend
  • The publication status and dates

 

definition3

 

Now your definition is automatically detected and, by default, a link to its definition and a tooltip is added.

definition-activated

Note: From the component settings, you can enable only link to definition, only tooltip, both tooltip and links or disable both

 


III. CONTROL THE FRONTEND DISPLAY

3.1 Display a glossary using a menu

To display a complete glossary with all its definitions, please create a Joomla standard menu choosing as type Glossaries then select the glossary you want.

menu-type



Then you have the possibility to display a complete glossary with all definitions terms.

glossary-from-menu

 

From the menu configuration, you can also setup:

  • The definition order: by date, name, custom ordering
  • The ordering direction
  • The definition listing layout: as list, as masonry wall or alphabetical list
  • The display of the definition icons

 

menu-configuration

 

3.2 Display Options & Settings

General Settings

With SEO Glossary component you get a complete configuration settings to control the display of all the frontend elements. On the first tab you can can configure the following elements:

  • Template: Select one the 3 template available to list your definitions
  • Use entry image: Display the definition icon in masonry wall layouts
  • Call content plugins for definitions: Add a link for glossary entries on the website
  • Show the alphabet above the list: Display or hide alphabet letters above the list of entries
  • Pagination above the list: Pagination control above the list
  • Show the alphabet below list: Display or hide alphabet letters below the list of entries
  • Pagination below the list: Pagination control below the list
  • Show glossary search: Display the search block above the list of entries
  • Show count of terms: Display count of terms below title. Example: There are 1 entries in this glossary
  • Hide Your: Display the author name below definitions if field is filled
  • Show Hits: If set to Show, the number of Hits (clicks) on a particular Article will be displayed

 

settings1

 

  • Default search mode: The search type for the SEO Glossary search engine
  • Show search options: Show search options (Begin with, Contains, Exact Term)
  • Allow sounds like for searches: Display sounds like option for searches on search block
  • Entries per page: Entries per page number to display by default in the drop-down list
  • Autopublish entries: Autopublish user submissions from front-end
  • Show Glossaries: Display Glossary name above definition if field is filled
  • Show Glossaries Descriptions: Display Glossary description above definition if field is filled
  • Display the list of all the glossaries: Display the list of all the glossaries on the front-end page, when there are several glossaries available
  • Add new entry link URL: SEO URL of the Add New Entry link
  • Glossary name as title: Show the name of the glossary at the top of the glossary page
  • Term as title: Show the term on top of the term page
  • Helper Override: Generate a Joomla standard layout override file that won't be affected by extension updates (in /html folder)

settings2

 

Email Settings

The Email parameters tab is about Email notification and thank you message for administrator and user. You can notify both in case of frontend submission.

settings3

 

Permission Settings

The permission tab is the Joomla ACL that controls the glossary edition permissions. You can allow/disallow some action on the glossaries for certain Joomla user group.
For example, if you want to allow the author user group to add definitions (frontend and even backend), allow the create action for authors. Then from frontend, you'll see a create/edit button appear.

add-definition-frontend

 

Tooltip Settings

Tooltip settings tab is used to control the tooltips displayed in content when a definition is found. There are 3 modes: the regular, advanced tooltips and bootstrap. Regular tooltips are CSS based and advanced jQuery based (allows more configuration)
You can also control the HTML display in tooltips it can be interesting for a definition with image.

tooltip-settings

 

All 3 tooltip modes include some same parameters:

  • Don't link to the glossary: The word won't have a link to its glossary
  • Tooltip on mouse leave: Tooltip stay or vanished on mouse leave
  • Show Close Button: Show close button
  • Tooltip delay: Tooltip delay in milliseconds
  • Occurences: Number of times a word must be detected in the same article
  • HTML tags to ignore: HTML tags in which we shouldn't create tooltips (ex: a, abbr, h1, h2, h3).
  • Disable tooltips globally: No tooltip will be generated by the component
  • Do not inject SEO Glossary Javascript: No tooltip will be generated by the component, but the title of the links will still contain the definition
  • Show a link to more: Will add a (...) link at the end of the tooltip if there is more to read
  • More link text: Text of the more link. eg. Read more, ..., etc

tooltip-general


The Search Settings 

The search settings tab is the integration with Joomla search. You can activate the Joomla search through definition names, definition content and glossary name.

search-definition

 

Social and Comments Settings

The social settings are the social networks buttons integration in definitions. You can add share/like buttons on glossaries.

The Disqus integration is the comment system integration. You just need to add your ID and you'll be able to comment definitions.

social-share

 

 

SEO Glossary activation

The component restriction is the settings to enable SEO Glossary to detect and load tooltip link and definition in content. You can Enable/Disable the detection by:

  • Joomla menu items
  • Joomla component
  • Joomla article category
  • Custom content

disable-seo-glossary

 

Advanced settings

Finally the advanced parameters allows you to:

  • Activate meta descriptions in definition
  • Activate meta titles in definition
  • Choose the tag to use in order to disable definitions highlight in content: For example if you add {seog:disable} in a Joomla article the definition won’t be shown in this article.
  • Letter regular expression prefix: this is php expression used to determine your definition prefix
  • Content detection regex: This is php expression used to detect your definition in the text
    More information can be finding here: http://www.catswhocode.com/blog/15-php-regular-expressions-for-web-developers
  • ​Apply content plugin: Load SEO Glossary definition detection in all content plugin

advanced

 

3.3 SEO Glossary module

A SEO Glossary module is available and installed with the main package. The module will get glossaries content and display entries the way you want. Setup is the following:

  • Theme: display the definitions as a masonry wall or a slideshow
  • Number of columns: is case of masonry wall you can define a number pf column
  • Number of entries: number of definitions to load
  • Numbers of intro characters: numbers of character for cropping the definition text
  • Ordering and direction of the definitions

slideshow-definition