sitegeist/nomenclator

此包的最新版本(v1.0.0)没有可用的许可证信息。

Neos 术语表

v1.0.0 2021-08-20 11:37 UTC

This package is auto-updated.

Last update: 2024-09-20 17:58:11 UTC


README

Neos 的术语表包

此包为网站提供术语表页面,让网站编辑有机会添加术语和定义作为术语表条目。条目列表由术语或短语组成,这些术语或短语出现在网站不同页面的某个地方。在术语表中添加术语后,其在所有绑定内容中的出现都会链接到术语表,并附带一个模态框,提供关于术语或短语的简要说明。点击模态框中的链接将访问者带到术语表页面中定义术语的地方。

作者与赞助商

此包的开发和公开发布得到了我们雇主http://www.sitegeist.de的慷慨赞助。

安装

Sitegeist.Nomenclator 通过 Packagist 提供。 composer require sitegeist/nomenclator

用法

术语表页面作为节点类型

安装包后,术语表页面将作为 'Sitegeist.Nomenclator:Content.Glossary' 节点类型提供。每个网站必须只包含一个术语表页面。作为最佳实践,建议将 'Sitegeist.Nomenclator:Content.Glossary' 添加为自动创建的首页子节点,并防止编辑创建页面。

CSS 和 JavaScript

Resources/Public/Styles/main.cssResources/Public/JavaScript/main.js 负责术语表页面的布局和处理术语的点击事件。它们必须由网站集成者手动链接。

将内容绑定到术语表条目

为了在内容中搜索术语并将它们链接到术语表,必须应用 Sitegeist.Nomenclator:LinkTermsToGlossary 处理器。例如

renderer = Customer.Site:Component.Test.Text {
    content = ${props.content}
    content.@process.linkToGlossary = Sitegeist.Nomenclator:LinkTermsToGlossary
}