typo3/cms-documentation

为TYPO3提供的后端模块，用于列出和显示已加载扩展的文档以及自定义文档。

维护者

详细信息

github.com/TYPO3-CMS/documentation

主页

源代码

安装数: 74,130

依赖者: 1

建议者: 0

安全: 0

星标: 2

关注者: 9

分支: 0

类型：typo3-cms-framework

v9.3.3 2018-07-31 08:20 UTC

Requires

Conflicts

Replaces

GPL-2.0-or-later d69ed675f76cfba676588b1f358ca4dc0d9af377

  • TYPO3 Core Team <typo3cms.woop@typo3.org>

This package is auto-updated.

Last update: 2024-08-29 04:20:04 UTC

README

本扩展为TYPO3提供了一个后端模块，用于显示本地扩展的文档以及自定义文档。

后端模块具有两个功能

  1. 显示文档
  2. 下载文档

显示文档

此视图显示可用文档的列表

  • 以html或pdf格式渲染的手册的扩展；
  • 以sxw格式渲染的OpenOffice手册；
  • 本地可用的官方TYPO3文档（教程、参考等）；
  • 自定义文档，以html或pdf格式渲染。

要列出，文档应存储在typo3conf/Documentation/<documentation-key>/<language>/<format>/中

文档密钥
扩展使用文档密钥typo3cms.extensions.<extension-key>。
语言
可以是“默认”（英语）或适当的区域设置，用于标识您的翻译文档。例如，fr_FR、fr_CA、de_DE ...
格式
可以是html或pdf。第三方扩展（如EXT:sphinx）可能支持其他格式。

注册自定义文档

  1. 选择一个文档密钥，例如<company>.<document-name>

  2. 将您的文档作为HTML（主文件必须是 Index.html）放置在typo3conf/Documentation/<documentation-key>/default/html/中，或作为PDF（任何名称都合适）放置在typo3conf/Documentation/<documentation-key>/default/pdf/中

  3. 创建一个包含文档标题和描述的文本描述文件composer.json，并将其放置在typo3conf/Documentation/<documentation-key>/default/中

    {
    "name": "Put some title here",
    "type": "documentation",
    "description": "Put some description here."
}

  4. [可选] 将自定义图标（icon.png或icon.gif）放置在目录typo3conf/Documentation/<documentation-key>/中

下载文档

此视图仅对TYPO3管理员可见。它显示一个表单，用于检索已加载扩展的渲染文档，并从https://docs.typo3.org获取官方TYPO3手册、指南和参考的副本。

配置

有两个User TSconfig选项可用

mod.help_DocumentationDocumentation.documents.hide
逗号分隔的文档密钥列表，这些文档应从用户隐藏。
mod.help_DocumentationDocumentation.documents.show
逗号分隔的文档密钥列表，这些文档应向用户显示（其他文档隐式隐藏）。