包简介

Silverstripe module for managing abbreviations and unusal words using shortcodes. Good for web accesibility.

README 文档

README

Silverstripe module for managing Abbreviations and unusal words using shortcodes. Good for web accesibility.

See https://www.wuhcag.com/abbreviations/ and https://www.wuhcag.com/unusual-words/ for the corresponding guidelines.

Requirements

Installation

Download and install manually or use composer.

composer require wernerkrauss/explainable

Configuration

Add a page of type "AbbrevationPage" or "ExplanationPage" to your CMS. There you can add new abbreviations or explanations in the gridfield.

You can link to this abbreviations in the CMS using the bundled shortcodes, use the UI for selecting the abbreviation.

The listings page lists all abbreviations or explanations in alphabetical order, grouped by first letter. You might update the templates to fit your needs.

Adding to Google Sitemap

You can add the abbreviations and explanations to google sitemap if you have the GoogleSitemap module installed. Just add to your mysite/_config.php:

GoogleSitemap::register_dataobject('Abbreviation', 'weekly', '0.5');
GoogleSitemap::register_dataobject('Explanation', 'weekly', '0.5');

TODO

create new abbreviation or explanation directly in shortcode UI? Using AddNew button this could be possible. Maybe we have to tweak shortcodable controller for that?

wernerkrauss/explainable 适用场景与选型建议

wernerkrauss/explainable 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 62 次下载、GitHub Stars 达 2，最近一次更新时间为 2015 年 07 月 14 日，在 PHP 生态内属于活跃度较高的组件。

它主要适用于以下技术方向：「silverstripe」「accessibility」等业务场景。在实际项目中，围绕这些方向常见需要落地的问题包括：接口对接、性能调优、并发安全、与既有框架（Laravel / ThinkPHP / Yii / Webman 等）的兼容适配，以及生产环境的日志埋点与稳定性保障。

我们在过去多个企业项目中使用过 wernerkrauss/explainable 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 wernerkrauss/explainable 我们能提供哪些服务？

定制开发 / 二次开发

基于 wernerkrauss/explainable 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发