README

#TYPO3 术语表扩展

定义一个要跨TYPO3网站突出显示的词汇表。

##安装

$ composer require "3ev/tev_glossary"

###依赖项

术语表扩展需要您的网站上存在jQuery和Bootstrap，因为术语条目将使用Bootstrap popovers突出显示。

##使用

通过扩展管理器安装TYPO3扩展。然后您可以从列表视图添加术语条目。您可以将术语条目添加到任何存储文件夹或页面 - 它们将在全局范围内被找到。

一旦添加了您的术语条目，您需要将术语javascript文件添加到您希望突出显示条目的任何页面上。您可以通过Typoscript、Fluid或VHS来完成此操作。以下是一个使用VHS的示例

<v:asset.script name="tev-glossary" path="EXT:tev_glossary/Resources/Public/js/tev-glossary.js" standalone="1" />

此文件需要在jQuery和Bootstrapjavascript之后包含，最好在页脚中。

还提供了一个术语表浏览器插件，它按首字母分组显示所有术语。您可以将此插件添加到任何页面以显示术语表的索引。有关此插件生成的标记的更多信息，请参阅样式部分。

##样式

###突出显示

每个突出显示的术语表条目都将包裹在一个具有类tev-glossary-highlight的<span/>中。每个popover都使用默认的Bootstrap标记，但额外赋予一个类tev-glossary-popover。您可以根据需要对这些元素进行样式设计，不包含默认样式。

###浏览器插件

术语表浏览器插件生成以下标记

<ul class="tev-glossary__key">
    <li class="tev-glossary__key__item">
        <span class="tev-glossary__key__item__content--nolink">A</span>
    </li>

    <li class="tev-glossary__key__item tev-glossary__key__item--linked">
        <a href="#index-B" class="tev-glossary__key__item__content--link">B</a>
    </li>
    ...
</ul>

<ul class="tev-glossary__index">
    <li class="tev-glossary__index__group">
        <h2 id="index-B" class="tev-glossary__index__group__letter">B</h2>

        <dl class="tev-glossary__index__group__entries">
            <dt class="tev-glossary__index__group__entries__term">Example term</dt>
            <dd class="tev-glossary__index__group__entries__definition">Example definition</dd>
        </dl>

        <a href="#" class="tev-glossary__index__group__back-to-top">Back to top</a>
    </li>
</ul>

每个元素都设置了CSS类，因此标记很容易进行样式设计。

###覆盖模板

您可以通过添加以下Typoscript以正常Extbase方式完全覆盖此扩展中的任何模板

plugin.tx_tevglossary {
    view {
        templateRootPaths {
            # The default index is 0, so use any index from 1 upwards

            1 = EXT:your_ext/Path/To/Template/Overrides/
        }
    }
}

您也可以对partialRootPaths或layoutRootPaths做同样的处理。添加到配置目录中的任何模板都将优先于默认模板。

##配置

以下Typoscript常量可用于您配置插件

plugin.tx_tevglossary.config.enable

1默认值。启用术语表突出显示。您可以使用此功能在某些页面上禁用术语表突出显示。

plugin.tx_tevglossary.config.selector

p默认值。用于在页面上搜索突出显示文本的CSS选择器。

plugin.tx_tevglossary.config.popover_position

top默认值。Bootstrap popover显示位置。

plugin.tx_tevglossary.config.popover_toggle

hover默认值。Bootstrap popover显示触发器。

plugin.tx_tevglossary.config.first_occurence_only

0默认值。仅在页面上术语表项目的第一次出现处显示定义。

##许可证

3ev / tev_glossary

维护者

详细信息

README