ryanshrum / hacksaw
此包已被 废弃 且不再维护。未建议替代包。
此包最新版本(2.0.1)没有可用的许可证信息。
一个简单的 Craft CMS 文本截断插件。
2.0.1
2017-06-26 13:03 UTC
Requires
- composer/installers: ~1.0
This package is not auto-updated.
Last update: 2023-06-10 12:45:31 UTC
README
通知(2018年4月17日)
遗憾的是,由于不再与 Craft 合作以及时间不足,我无法将 Hacksaw 更新为 Craft 3。我建议使用 NY Studio 的 Tyopgrify 或 Top Shelf Craft 的 Wordsmith(它包括对 Hacksaw 的原生向后兼容性)。
此外,如果您希望接管 Hacksaw 的维护工作,请告知我,我将移交管理权。
Hacksaw for Craft CMS
Hacksaw 是一个 Craft CMS 的简单文本截断插件,可以将您的内容截断到更易于管理的尺寸。
安装
要安装 Hacksaw,请按照以下步骤操作
- 下载并解压缩文件,将
hacksaw
目录放置到您的craft/plugins
目录中
- 或 -
直接在craft/plugins
文件夹中执行git clone https://github.com/ryanshrum/hacksaw.git
。然后可以使用git pull
更新它
- 或 -
通过 Composer 安装composer require ryanshrum/hacksaw
- 在 Craft 控制面板的设置 > 插件中安装插件
- 插件文件夹应命名为
hacksaw
,以便 Craft 能够识别它。GitHub 最近开始在下载压缩文件的文件夹名称中附加-master
(分支名称)。
用法
Hacksaw 是一个接受以下参数的 Twig 过滤器
参数 | 类型 | 默认 | 描述 |
---|---|---|---|
hack | 字符串 | 'p' |
您想要截断的内容('characters' ,'words' 或 'paragraphs' - 也可以使用首字母作为缩写 'c' ,'w' 或 'p' ) |
limit | 整数 | 1 |
字符限制的起始点(与 chars 参数一起使用) |
allow | 字符串 | 空值 |
有时内容中会有您没有移除的 HTML 标签,请在此处传递它们 |
append | 字符串 | 空值 |
要附加到摘录末尾的字符串 |
注意: 截断已从 Hackasw 中弃用。
示例
按段落截断是默认的,因此如果要将文本限制为 5 个段落,则只需设置限制参数
{{ entry.richTextField|hacksaw(limit='5') }}
如果要将限制为 50 个字符或单词,则必须同时使用 hack 和 limit 参数
{{ entry.richTextField|hacksaw(hack='characters', limit='50') }}
{{ entry.richTextField|hacksaw(hack='words', limit='50') }}
Hacksaw 默认会从摘录中删除所有 HTML。如果您想保留一些基本 HTML,可以使用 allow
参数保留特定 HTML 标签。例如,假设您想保留 <a>
和 <b>
标签
注意: 在按段落截断时,<p>
标签是自动允许的。
{{ entry.richTextField|hacksaw(limit='10', allow='<a><b>') }}
注意:如果您在append参数中包含HTML,这些元素必须在allow
参数中存在。如果您在任一参数中包含Craft变量,必须使用Twig连接运算符~
进行添加。以下是两个示例
{{ entry.richTextField|hacksaw(hack='w', limit='100', allow='<a>', append='<a href="' ~ entry.url ~ '">Continue...</a>') }}
由Ryan Shrum提供