ClickHelp速览—导航,分类法,微型TOC,FTS

随着3月ClickHelp版本的临近,由于我们希望与您分享过去几个月来我们一直在努力的所有令人敬畏的事情,因此ClickHelp团队变得越来越兴奋。 这篇先睹为快的博客文章专门介绍了分类法,全文本搜索和导航的重大功能改进。 继续阅读以了解这些功能在此产品更新中将变得更好。

使用分类法

我们的客户已成功利用分类法功能在其在线文档门户上设置FTS。 分类法或索引关键字的思想是,您可以为主题指定它们,这将影响FTS结果。 这些关键字将被认为与所讨论的主题高度相关。

当读者有机会使用过时的术语寻找主题时,这里的常见用例是将过时的术语用作关键字。 主题本身可能缺少此类术语,但是索引关键字会将其推到搜索结果的顶部。

可以将索引关键字添加到帮助主题,如以下屏幕截图所示:

每个主题可以具有一组唯一的关键字。 以下是帮助主题的分类列表:

基本上,索引关键字既可以用作搜索参数,又可以帮助主题导航过滤器。 要浏览项目,读者需要在目录中打开索引关键字列表:

单击“ 显示索引”按钮将打开此项目的分类列表:

另外,您可以用逗号分隔关键字,索引将如下所示:

选择其中一个关键字将显示相关的帮助主题。 自3月产品更新以来,您将能够选择是使用分类法进行导航还是仅对全文搜索进行微调。 可以在项目设置>阅读器界面>索引关键字中使索引关键字不可见。 您只需要取消选中“ 显示索引关键字” ,就不会在目录中为读者显示它们了。

现在,我们的客户也将能够从索引中手动排除某些主题。 此功能对于创建上下文帮助的技术作者特别有用,以防他们不希望其帮助主题显示在上下文帮助之外的任何地方。

全文搜索的改进

自从我们开始使用ClickHelp以来,我们一直优先考虑倾听客户的意见,并将他们的反馈转化为推动进一步工具开发的动力。 我们的FTS引擎在即将发布的版本中进行的改进是一个很好的例子,说明与客户的协作如何可以带来令人赞叹的结果。

首先,我们要提到的是,从三月份的发布开始,搜索结果在整体上将变得更加相关。 由于搜索算法的变化,这成为可能。

而且,这是一项迫切需要的全新功能-通配符支持。 全文搜索将在今年3月变得更加灵活。 在搜索查询中添加通配符将如下所示:“ tool *”将匹配,例如,搜索结果中的“ tools”和“ toolbar”都将匹配。

更好的视觉导航

March ClickHelp版本将展示该工具的视觉导航选项的巨大潜力。 导航工具集最大的补充之一是可以将导航元素插入母版页页脚/页眉中。

母版页使您可以为帮助主题创建布局。 现在,可以在项目帮助主题的页眉/页脚中添加各种导航元素,例如微型TOC,另请参阅列表,面包屑等。 您只需复制所需元素的HTML代码,然后将其插入到“母版页”设置的页眉/页脚部分即可。

保存更改,并查看此项目中的所有帮助主题,在顶部获得一个整洁的导航栏导航项:

提供链接到帮助主题也变得非常方便。 只需单击主题标题旁边的链链接图标,该链接就会显示出来,可用于快速复制。

另外,所有标题都立即分配了锚,因此,现在也更容易引用它们。

另一个令人振奋的改进是自动更新的mini-TOC,它经过重新设计以使其看起来更好。 您将不再需要手动更新主题标题!

结论

如果您认为今天的先睹为快,其中包含许多重大改进,请等到下周! 我们有更多选择,March ClickHelp版本使您感到非常兴奋。 一如既往,敬请期待!

祝您技术上写好运!
ClickHelp小组
跨平台和设备编写,托管和交付文档