文件列表:

LICENSE (34382, 2023-12-13)
composer.json (1604, 2023-12-13)
config/ (0, 2023-12-13)
config/listener.yaml (682, 2023-12-13)
config/routes.yaml (61, 2023-12-13)
config/services.yaml (644, 2023-12-13)
contao/ (0, 2023-12-13)
contao/classes/ (0, 2023-12-13)
contao/classes/Glossary.php (12334, 2023-12-13)
contao/config/ (0, 2023-12-13)
contao/config/config.php (1186, 2023-12-13)
contao/dca/ (0, 2023-12-13)
contao/dca/tl_content.php (4775, 2023-12-13)
contao/dca/tl_glossary.php (7356, 2023-12-13)
contao/dca/tl_glossary_item.php (24863, 2023-12-13)
contao/dca/tl_module.php (6396, 2023-12-13)
contao/dca/tl_page.php (4452, 2023-12-13)
contao/dca/tl_user.php (1560, 2023-12-13)
contao/dca/tl_user_group.php (1554, 2023-12-13)
contao/languages/ (0, 2023-12-13)
contao/languages/de/ (0, 2023-12-13)
contao/languages/de/default.xlf (488, 2023-12-13)
contao/languages/de/modules.xlf (1316, 2023-12-13)
contao/languages/de/tl_glossary.xlf (4782, 2023-12-13)
contao/languages/de/tl_glossary_item.xlf (12246, 2023-12-13)
contao/languages/de/tl_module.xlf (3810, 2023-12-13)
contao/languages/de/tl_page.xlf (2741, 2023-12-13)
contao/languages/de/tl_user.xlf (1091, 2023-12-13)
contao/languages/de/tl_user_group.xlf (361, 2023-12-13)
contao/languages/en/ (0, 2023-12-13)
contao/languages/en/default.xlf (382, 2023-12-13)
contao/languages/en/modules.xlf (970, 2023-12-13)
contao/languages/en/tl_glossary.xlf (3289, 2023-12-13)
contao/languages/en/tl_glossary_item.xlf (8142, 2023-12-13)
contao/languages/en/tl_module.xlf (2554, 2023-12-13)
contao/languages/en/tl_page.xlf (1865, 2023-12-13)
... ...

Contao Glossary Bundle

A glossary extension for the Contao Open Source CMS. Glossaries are organized in archives similar to news and events and can be displayed via a list and reader module.

 --- > Working with **Contao 4.13** and **Contao 5.1** (PHP ^8.1) --- With the Contao Glossary Bundle, you can manage glossary terms in the backend and display them using frontend modules. Each glossary entry can be individually modified and structured with content elements. Terms appearing on your website can be automatically replaced links (or another markup) and a hovercard preview. + [Features](#features) + [Installation](#installation) + [Upgrading](#upgrading-to-version-2) + [Composer](#via-composer) + [Contao Manager](#via-contao-manager) + [Setup](#setup) + [Glossaries](#creating-glossaries-and-terms) + [Modules & Settings](#publishing-your-glossaries-to-your-website) + [Glossary overview](#glossary-overview) + [Reader/Detailpage](#glossary-reader) + [Automatic keyword conversion & hovercards](#automatic-keyword-conversion-and-hovercards) + [Front end modules](#front-end-modules) + [Glossary](#glossary) + [Glossary reader](#glossaryreader) + [Page & Glossary settings](#page--glossary-settings) + [Root page](#root-page-settings) + [Regular page](#regular-page-settings) + [Glossary archive](#glossary-archive-settings) + [Glossary items](#glossary-item-settings) + [Creating links in Contao](#creating-links-in-contao) + [Insert tags](#insert-tags) + [TinyMCE/Link picker](#tinymce--link-picker) + [Limitation](#known-limitations) + [Glossary JavaScript](#glossary-javascript) + [Browser Support (JavaScript)](#browser-support) + [Frequently asked Questions](#frequently-asked-questions) + [Support](#support) + [License](#license) + [Sponsoring](#sponsoring) ## Features - Compatible with Contao 4.9 and higher versions (PHP 8 Support) - Possibility to create multiple glossaries - Frontend- and Backend permissions for glossaries and terms - Access protection for modules - Paginated glossary lists - Quick-links - Navigation/Pagination grouping for umlauts (UTF8 to ASCII conversion) - Automatic keyword conversion of glossary terms (markup or link) - Case sensitivity for keyword conversion - Hover-card-preview for glossary terms - Loading animation for hover-cards - Insert tags - Link-picker - Meta title and description for detail pages - Sitemap-Integration - Cache invalidation - Caching for hover-card content (session-storage) - Caching for abbr descriptions (session-storage) - can be enabled using the markup feature with 'abbr' ## Installation #### Upgrading to version 2 > After upgrading from version 1 to version 2, make sure to edit your modules (glossary and glossary-reader) and set up the new templates. #### Via composer ``` composer require oveleon/contao-glossary-bundle ``` #### Via contao-manager ``` Search for contao glossary bundle and add it to your extensions. ``` After installing the contao-glossary-bundle, you need to run a **contao install**. ## Setup ### Creating glossaries and terms The Contao Glossary Bundle uses archives (glossaries) and glossary items (terms) similar to the Contao-News-Bundle. 1. Set up a redirect page for glossary items 2. Create a new glossary archive in **Glossaries**  3. Edit the new glossary to add new glossary items (terms)  4. Create a new glossary item: - Title = Glossary term - (Search terms = keywords for automatic conversion) - Glossary item teaser = teaser text for glossary overview etc. - Publish item  5. (Additionally, you are able to create content elements for detail pages - Similar to contao news)  ### Publishing your glossaries to your website To display your glossaries and glossary terms, you have to create two front end modules: #### Glossary overview 1. Create the front end module *Glossary* 2. Select your glossary/glossaries and configure the module 3. Embed the module in a page  #### Glossary reader 1. Create the front-end module *Glossary-reader* 2. Select your glossary/glossaries 3. Embed the module in your redirect-page (for your archive)  ### Automatic keyword conversion and hovercards 1. Go to your ***website root*** and "activate glossary" under glossary settings 2. Select your glossary/glossaries 3. (Enable hovercards if needed)  > **Only [search terms](#glossary-item-settings) within glossary items are taken into account. Not the keyword itself** > > **You are able to add multiple keywords to a term. The glossary JavaScript does an exact search; thus spaces are allowed as well.** > **Hint:** > > You can disable automatic keyword conversion and hovercards within "Expert settings" on regular pages. This option is recommended for glossary pages. > >  ## Front end modules ### Glossary The glossary displays published glossary items from selected glossaries.  #### Settings

Glossary
Option	Description
Glossaries	Here you can select one or more glossaries whose glossary terms should be displayed.
Glossary reader	Automatically switch to the glossary reader if an item has been selected.
Hide empty groups	Do not show navigation links for letters that do not exist.
Glossary pagination	Activates pagination for glossary terms. Other glossary entries can be accessed via glossary navigation.
Default letter	Defaul letter when glossary pagination is activated.
Convert special characters	Converts UTF8-characters to ASCII for the glossary navigation/pagination.
Glossary quicklinks	Adds additional quicklinks to the glossary module.
Glossary entry template	Template for glossary items (simple, short, latest, full).
Module template	The modules template that is being used.
Image settings	Image size for teaser images.
Access protection	Show the module for certain member groups only

### Glossaryreader The glossary displays published glossary items from selected glossaries.   #### Settings

Glossary reader
Option	Description
Glossaries	Here you can select one or more glossaries that the reader should display.
Glossary entry template	Template for the glossary item (simple, short, latest, full).
Module template	The modules template that is being used.
Image settings	Image size for the teaser image.
Access protection	Show the module for certain member groups only

## Page & Glossary settings ### Root page settings The contao glossary bundle extends the > **Root page** with additional ***Glossary Settings***. The settings will work for all subpages for this root page.

Glossary settings
Option	Description
Activate glossary	Enable replacing of keywords for this and its subpages.
Glossaries	Keywords (within glossary items) for these glossaries will be converted to links or a chosen markup.
Hovercards	Disable/Enables the teaser hovercards for glossary links/markup.
Configuration template	The JavaScript configuration template for the Glossary Javascript

 *All keywords within glossary items are converted to links by default (You are able to change the markup within the glossary configuration template, see [JavaScript Settings](#glossary-javascript))*  *The hovercard shows a preview of the glossary item* ### Regular page settings The **Expert settings** for regular pages are extended with the following option:

Expert settings
Option	Description
Disable glossary	Disables glossary hovercards and keyword conversion for this page.

### Glossary archive settings The Glossaries under **Glossaries** contain extra options for hovercards

Glossary settings
Option	Description
Redirect page	The glossary reader page to which visitors will be redirected when clicking a glossary item.
Glossary hovercard template	The template that is used for glossary hovercards.
Hovercard image size	Image size for glossary hovercards.

 *The teaser images within glossary items are shown in the hovercard* ### Glossary item settings Glossary items are terms within your glossaries.

Glossary item settings
Option	Description
Title	The title/keyword of your glossary entry.
Glossary item alias	The alias and unique reference for a glossary item. It is used for created pages and insert-tags.
Search terms	Here you can enter search terms that are included in automatic cross-references (automatic keyword conversion).
Case-sensitive markup	Here you can select if the search for keywords should be case-sensitive.
Redirect target	The redirect of a glossary item Use default page: Creates a page Page: Redirects to a page within your Contao instance Article: Redirects to an article within your Contao instance Custom URL: Redirects to a custom url
Meta title	Here you can add a custom meta title to overwrite the default page title.
Robots tag	Here you can overwrite how search engines handle the glossary item. index,follow index,nofollow noindex,follow noindex,nofollow
Meta description	Here you can add a custom meta description to overwrite the default page description.
Subheadline	A subheadline within glossary items (Templates: glossary_full)
Glossary item teaser	The glossary item teaser can be used in a hovercard or can be shown in a glossary list instead of the full content.
Add an image	Adds an image to the glossary item (Templates: glossary_latest, glossary_full, hovercard_glossary_default)
CSS class	CSS classes for the glossary item
Publish item	Make the glossary item publicly visible on the website.

## Creating links in Contao Automatic conversion creates links (or another markup) when entering the page through JavaScript. For SEO purposes, you are able to create real links within Contao using the following options: ### Using Insert tags > For more information on *Insert tags*, please visit the official Contao documentation. #### Insert tags You can use insert tags with the glossary id or its alias (aliases are generated and unique). **Example** ``` {{glossaryitem::430}} {{glossaryitem::website}} ```

Insert tags
Insert tag	Description
{{glossaryitem::*}}	This tag is replaced with a link to a glossary item (replace * with the ID or alias).
{{glossaryitem_open::*}}	Is replaced with the opening tag of a link to a glossary item: {{glossaryitem_open::430}}Check out doishub on GitHub{{link_close}}.
{{glossaryitem_url::*}}	This tag will be replaced with the URL of a glossary item: <a href="{{glossaryitem_url::430}}">He's an awesome mentor</a>.
{{glossaryitem_keyword::*}}	This tag is replaced with the keyword of a glossary item: <a title="{{glossaryitem_keyword::430}}">Follow him :)</a>.
{{glossaryitem_teaser::*}}	This tag is replaced with the teaser of a glossary item: {{glossaryitem_teaser::430}}.

### TinyMCE / Link picker When creating links in TinyMCE in the backend of Contao CMS, you are able to choose a new source "Glossary" in the link picker.  #### Known limitations > It is currently **not possible** to add **hovercard-events** to a **link created via link picker through tinyMCE** due to security reasons. > > To apply a hovercard event to a link, edit the html within your tinymce, and add > > data-glossary-id: "your glossary item id" > > to your link. > > **Example** > ><a href="{{glossaryitem_url::430}}" target="_blank" rel="noopener" **data-glossary-id="430"**>Domain name</a> > ## Glossary JavaScript > Markup of glossary keywords and behavior for hovercards can be changed by parsing options into the glossary initialization. > The Glossary object can be found within the config_glossary_default template. > Developers can create a new template with the following prefix: > 'config_glossary_', > and choose it in the root page settings. #### Settings

Glossary JavaScript
Option	Default	Description
entrySelector	'#wrapper'	Selectors for glossary-term search
markup 近期下载者： 相关文件： 评论：[我要评论] [举报此文件] 收藏者： © 联合开发网 from 2004 | 联系站长 | 湘ICP备2023001425号 | 网安备43010502000604 |