Skip to content
Snippets Groups Projects
Commit 22f1df85 authored by ressa's avatar ressa Committed by Stefan Auditor
Browse files

Issue #3315451 by ressa: Update README, add required steps under "Configuration"

parent 381a9344
No related branches found
No related tags found
1 merge request!14Resolve #3315451 "Update readme"
Pipeline #44784 passed with warnings
CONTENTS OF THIS FILE
---------------------
# Glossify
* Introduction
* Requirements
* Installation
* Configuration
* Maintainers
The Glossify module provides filters that scans and parses content and
terms in the text and allows adding links and tooltips to them.
It consists of 2 filters, one for taxonomy and one for content.
INTRODUCTION
------------
For a full description of the module, visit the
[project page](https://www.drupal.org/project/glossify).
The Glossify module provides filters that scan and parse content and adhance
terms in the text with tooltips and optionally add links to their pages.
Currently it consists of 2 filters:
Submit bug reports and feature suggestions, or track changes in the
[issue queue](https://www.drupal.org/project/issues/glossify).
Glossify with taxonomy
links taxonomy terms appearing in content to their taxonomy term page.
select which taxonomy vocabularies to use as the source for the terms.
indicate whether or not matching is case sensitive.
indicate whether or not every match should be linked or just the first
occurrence. display the term definition as a tooltip while hovering the
glossified link.
## Table of contents
Glossify with content
- Requirements
- Installation
- Configuration
- Maintainers
links node titles of content appearing in other content to their node page.
select which content types to use as the source for the terms.
indicate whether or not matching is case sensitive.
indicate whether or not every match should be linked or just the first
occurrence. display the text from a selected field on the linked node as a
tooltip while hovering the glossified link.
* For a full description of the module, visit the project page:
https://www.drupal.org/project/glossify
## Requirements
* To submit bug reports and feature suggestions, or track changes:
https://www.drupal.org/project/issues/admin_menu
This module requires no modules outside of Drupal core.
REQUIREMENTS
------------
This module requires no modules outside of Drupal core.
## Installation
You need to install both the Glossify module itself, but also Glossify Node
Tooltips or Glossify Taxonomy Tooltips.
Install as you would normally install a contributed Drupal module. For further
information, see
[Installing Drupal Modules](https://www.drupal.org/docs/extending-drupal/installing-drupal-modules).
INSTALLATION
------------
## Configuration
* Install as you would normally install a contributed Drupal module. Visit
https://www.drupal.org/node/1897420 for further information.
The filters included in the module can work on content or terms.
CONFIGURATION
-------------
### Glossify with taxonomy
* Configure the user permissions in Administration » Configuration »
Text formats and editors:
Links taxonomy terms appearing in content to their taxonomy term page.
select which taxonomy vocabularies to use as the source for the terms.
indicate whether or not matching is case sensitive.
indicate whether or not every match should be linked or just the first
occurrence. display the term definition as a tooltip while hovering the
glossified link.
Configure the text format and enable the desired filter.
### Glossify with content
MAINTAINERS
-----------
Links node titles of content appearing in other content to their node page.
select which content types to use as the source for the terms.
indicate whether or not matching is case sensitive.
indicate whether or not every match should be linked or just the first
occurrence. display the text from a selected field on the linked node as a
tooltip while hovering the glossified link.
### Enable term or content filter
1. Go to Administration » Configuration » Content authoring » Text formats
and editors
1. Edit a text format, for example "Basic HTML"
1. Enable a Glossify filter and configure it under "Filter settings"
## Maintainers
Current maintainers:
* Stefan Auditor (sanduhrs) - https://www.drupal.org/u/sanduhrs
- Stefan Auditor - [sanduhrs](https://www.drupal.org/u/sanduhrs)
- Julian Pustkuchen - [Anybody](https://www.drupal.org/u/Anybody)
- keesje - [keesje](https://www.drupal.org/u/keesje)
- WorldFallz - [worldfallz](https://www.drupal.org/u/worldfallz)
- Kobus Beljaars - [beljaako](https://www.drupal.org/u/beljaako)
- Joshua Sedler - [Grevil](https://www.drupal.org/u/Grevil)
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment