WordPress Gutenberg编辑器文档大纲功能解析与优化建议

背景介绍

WordPress Gutenberg编辑器中的文档大纲功能是一个重要的辅助工具，它能够显示当前页面或文章中的标题层级结构。这个功能对于内容创作者和开发者来说非常实用，可以帮助他们快速了解文档结构并确保标题层级的合理性。

当前问题分析

在Gutenberg编辑器中，当用户启用"显示模板"选项时，文档大纲功能仅显示模板中的标题块，而忽略了内容区域中的标题。这种行为导致了几个显著的问题：

1. 功能完整性受损：用户可以看到内容区域中的标题，但大纲却不显示，这给用户造成了功能不完整的错觉。

2. 可访问性检查失效：大纲的一个重要功能是检查标题层级是否正确（如避免重复的H1标题），但当前实现无法检测完整页面的标题结构。

3. 用户体验混乱：用户在编辑内容区域标题时，大纲没有任何变化，这种不一致性增加了认知负担。

技术实现分析

通过代码审查发现，问题根源在于getBlocks函数在获取块内容时的行为差异。当"显示模板"选项启用时：

• 列表视图可以正确显示内容区域中的内部块
• 但getBlocks函数返回的post-content块的innerBlocks却为空数组
• 尝试使用getBlocksByClientId获取内部块同样失败

解决方案探讨

社区成员提出了几种可能的解决方案：

1. 使用useEntityBlockEditor替代getBlocks：这种方法可以从核心数据中获取块内容，但只能获取文章内容中的块，无法包含模板中的标题。

2. 合并模板和内容区域的块：更全面的解决方案是同时获取模板和内容区域的块数据，然后合并处理。这需要：

   • 从模板获取标题块
   • 从内容区域获取标题块
   • 合并两者并正确排序

3. 交互行为优化：对于模板中的标题，由于用户无法直接编辑，应考虑：

   • 禁用点击功能
   • 或提供视觉提示表明这些标题来自模板

设计原则思考

在考虑解决方案时，需要遵循几个核心原则：

1. 文档级工具定位：大纲应该反映最终页面的完整标题结构，而不仅仅是当前编辑的部分。

2. 一致性：与列表视图等其他文档级工具保持行为一致。

3. 可预测性：用户操作（如添加标题）应该在大纲中有即时的反馈。

实施建议

基于讨论，推荐采用以下优化方案：

1. 完整标题显示：无论"显示模板"选项是否启用，大纲都应显示模板和内容区域中的所有标题。

2. 区分来源：通过视觉设计区分模板标题和内容标题，帮助用户理解结构。

3. 交互优化：对于不可编辑的模板标题，提供适当的交互反馈。

4. 信息展示分离：考虑将字符数、字数等元信息与大纲分离，保持功能的纯粹性。

总结

Gutenberg编辑器的文档大纲功能优化不仅是一个技术问题，更关乎用户体验和内容创作效率。通过全面显示文档标题结构，并合理区分不同来源的标题，可以显著提升编辑器的实用性和易用性。这一改进将使得标题层级检查更加准确，帮助用户创建结构更合理的网页内容。