7elix/styleguide

展示TYPO3后端功能的TYPO3扩展

安装: 27,288

依赖项: 0

建议者: 0

安全: 0

星标: 102

关注者: 19

分支: 61

类型:typo3-cms-framework


README

这是什么?

Styleguide是一个TYPO3扩展。它在后端的“系统”部分提供了一个后端模块。它可以创建一个页面树来展示示例。

当TYPO3核心添加或废弃了这个扩展涵盖的功能时,核心开发者会努力保持其更新,反映这些变化。

Styleguide是一个参考,展示了大量的TYPO3后端功能,通常对自定义扩展很有用

  • 一组片段,展示了如何使用默认的后端功能,如表格、按钮、框或通知。
  • 大量的'TCA'示例,展示了后端编辑表单的所有功能。

用法

  • 该扩展对后端扩展开发者来说很有趣,可以作为参考,了解如何在后端解决或使用像按钮这样的普通问题,并复制粘贴解决方案。此外,TCA示例几乎展示了FormEngine(后端中的记录编辑)的近完整展示。开发者将看到他们以前不知道的新事物。保证!

  • 该扩展对技术项目经理来说可能很有趣,可以了解后端编辑的能力,并确定哪些部分可以卖给客户,而无需给开发者增加昂贵的实施负担。

  • 核心开发者使用Styleguide来测试和验证JavaScript、HTML和PHP代码的更改不会破坏后端模块的布局或功能。该扩展还用于核心后端验收测试,以验证在开发核心补丁时FormEngine细节不会破坏。

  • Styleguide用于官方核心文档中,以提供核心功能的示例、截图和可能的用法。特别是TCA参考严重依赖于它。

安装

Styleguide作为TYPO3后端的扩展提供。在初始安装后,建议让styleguide通过点击“TCA / records -> 创建带数据的styleguide页面树”,等待系统处理数据几秒钟。

初始化

使用styleguide,可以自动创建示例页面和内容,用于以下两个目的

  1. "styleguide TCA演示"以展示各种TCA功能
  2. "styleguide前端演示"以创建可用于前端测试的页面

这些页面可以在后端或命令行中创建

# show help
bin/typo3 styleguide:generate -h

# create pages
bin/typo3 styleguide:generate -c

或者,可以在TYPO3后端中创建页面

  1. 通过点击顶部栏中的问号访问styleguide模块:? | Styleguide | TCA / Records / 前端
  2. 点击可用的按钮

用法

通过点击顶部栏中的问号可以访问styleguide模块:? | Styleguide。

您也可以通过选择页面树中的页面来浏览TCA演示。使用列表模块来访问记录。

TYPO3 TCA参考文档经常使用styleguide的示例。

法律

本项目发布在GPLv2许可下。有关详细信息,请参阅LICENSE.txt。