silverstripe / accessibility
dev-master
2016-02-16 03:05 UTC
Requires
- silverstripe/cms: ~3.1
- silverstripe/framework: ~3.1
This package is not auto-updated.
Last update: 2024-07-10 21:43:21 UTC
README
无障碍访问
概述
该模块允许编辑指定页面的访问键,并将它们全部列在访问键目录中。
要求
- SilverStripe 3.0+
安装
通过在 SilverStripe 项目的根目录下运行 composer 安装
composer require silverstripe/accessibility:*
在你的 SilverStripe 项目根目录下。
或者只需将 git 仓库克隆/下载到你的 SilverStripe 项目的子文件夹(通常称为 "accessibility")中。
使用任何一种安装方法后,您都需要运行 dev/build。
使用方法
添加访问键
在每页的“设置”选项卡中,您会找到一个访问键文本框。您可以在其中输入任意单个字符。这将在模板中作为 $AccessKey 提供。为了使访问键可用,它们必须被定义为所有页面的链接。一种方法是将在页脚中的隐藏 div 内
<div class="hidden accesskeys">
<% loop AccessKeys %>
<a href="$Link" accesskey="$AccessKey">$AccessKey = $Title</a>
<% end_loop %>
</div>
此标记可以在 AccessKey.ss 中找到,并可以包含在您的页脚中
<% include AccessKeys %>
如果您没有为隐藏类定义样式,您应该在布局 css(或 scss)文件中放入此内容
.hidden{
display:none;
}
这已经在 express 主题中实现。
添加无障碍页面
该模块添加了一个无障碍页面页面类型。此页面的模板可以使用 $AccessKeys 列出所有设置了访问键的网站页面。例如
<% if AccessKeys %>
<table class="table">
<thead>
<tr>
<th>Key</th>
<th>Page</th>
</tr>
</thead>
<tbody>
<% loop AccessKeys %>
<tr>
<td>$AccessKey</td>
<td><a href="$Link">$Title</a></td>
</tr>
<% end_loop %>
</tbody>
</table>
<% end_if %>
此页面类型的模板可以在 templates/AccessibilityPage.ss 中找到。