目录
目录功能允许您插入一个小部件,其中包含反映文档结构的标题(部分标题)列表。该列表会随着用户在文档中工作而自动更新。单击列表项会将用户导航到相应的文档部分。
此高级功能是 生产力包 的一部分。生产力包包含在我们的商业许可证中。如果您拥有有效的 CKEditor 5 许可证,请联系您的客户经理以查看您的资格。即使某些旧版许可证有效,也不符合独家生产力包的资格。 联系我们 以了解更多详情。
您也可以注册 CKEditor 高级功能 30 天免费试用 以测试该功能。
# 演示
在编辑器中创建几个标题,然后单击工具栏中的目录按钮
。更改标题文本或级别以查看目录实时更新。植物界
植物界是一个多样化的生物群,包括微小的藻类和巨大的红杉。尽管有这种多样性,但所有植物都有一些共同点。
植物是
- 具有多细胞体的生物。
- 能够通过称为光合作用的过程合成食物。
- 通常无法移动。
- 细胞壁由纤维素构成。
植物可以分为两类:产生种子的和不产生种子的。
无种子植物
这组植物被称为隐花植物,不产生种子。
淡水和海洋藻类
绿藻不形成真正的根、茎或叶。这个群体在数亿年前产生了所有陆地植物。
苔藓和地钱
苔藓和地钱是最古老的陆地植物。它们有茎和类似叶和根的结构。与其他陆地植物不同,它们没有维管系统(一种特殊的组织,用于运输水和营养物质)。
蕨类植物和木贼
蕨类植物和木贼有明显的茎、叶和根。它们是最古老的维管植物。这意味着与苔藓和地钱不同,它们确实有一个维管系统,可以将水和营养物质通过其身体运输。
种子植物
这组植物被称为显花植物,可以产生种子。
非开花植物
这个群体中的成员被称为裸子植物,是第一个产生种子的维管植物。与开花植物不同,种子没有外层覆盖物。
针叶树
这组植物中的大多数是常绿树木和灌木。它们以针叶(特化的叶子)和球果(种子存放的地方)而闻名。
银杏和苏铁
银杏和苏铁都是非常古老的植物群。唯一存活的银杏物种是银杏树(Ginkgo biloba)。苏铁类似于棕榈树,但两者之间没有关系。后者属于开花植物。
开花植物
当您听到“植物”这个词时,您可能会想到这个群体中的成员。它们被称为被子植物,构成了植物界最多样化和丰富的门。这组植物可以开花结果,并包裹着种子。
# 安装
在安装编辑器之后,将功能添加到您的插件列表和工具栏配置中。
import { ClassicEditor } from 'ckeditor5';
import { TableOfContents } from 'ckeditor5-premium-features';
ClassicEditor
.create( document.querySelector( '#editor' ), {
plugins: [ TableOfContents, /* ... */ ],
// Provide the licence key (see explanation below).
licenseKey: '<YOUR_LICENSE_KEY>',
toolbar: [ 'tableOfContents', /* ... */ ]
// ...
} )
.then( /* ... */ )
.catch( /* ... */ );
默认情况下,目录功能负责管理标题 ID 并使用专用 href
属性创建适当的链接。此功能生成的数据确保单击目录中的链接将滚动到内容中相应的标题。
# 激活功能
要使用此高级功能,您需要使用适当的凭据激活它。有关详细信息,请参阅许可证密钥和激活指南。
# 相关功能
以下是一些可以帮助您浏览编辑器内容的 CKEditor 5 功能。
# 通用 API
TableOfContents
插件注册
'tableOfContents'
UI 按钮组件。- 由
TableOfContentsCommand
实现的'insertTableOfContents'
命令。
您可以使用editor.execute()
方法执行命令。
// Insert the table of contents.
editor.execute( 'insertTableOfContents' );
我们建议使用官方的CKEditor 5 检查器 进行开发和调试。它将为您提供有关编辑器状态的许多有用信息,例如内部数据结构、选择、命令等等。
我们每天都在努力使我们的文档保持完整。您是否发现过时信息?是否缺少某些内容?请通过我们的问题跟踪器 报告。
随着版本 42.0.0 的发布,我们重写了大部分文档以反映新的导入路径和功能。感谢您的反馈,帮助我们确保文档的准确性和完整性。