JetBrains IDE Writerside(文档撰写软件)

　　JetBrains IDE Writerside提供文档编辑功能，可以通过这款软件编辑开发技术文档，可以编辑API文档，可以编辑测试文档，很多应用程序开发相关的文档资源都可以尝试在这款软件上写作，新建一个项目就可以开始写作内容，也可以通过markdown导入到软件上生成文档，可以创建目录内容，可以创建多个升级版本文档，可以对内容维护和清理，可以将文档输出为PDF，可以在独立的应用程序中或使用Writerside插件在IDE中编写、预览、构建、测试和发布技术文档。

软件功能

　　可下载资源

　　将文件与已发布的文档一起添加为可下载资源，例如，如果您需要提供带有一些示例数据的文件以配合教程，或者提供带有某些可安装实用程序的 ZIP 存档。

　　自定义搜索服务

　　现在，可以使用终结点运行自己的服务，用于来自已发布帮助的搜索请求。您可以创建处理搜索请求并使用适当的搜索结果进行响应的自定义服务，也可以尝试使用收集的搜索索引的示例服务。与其将索引发送给第三方（如 Algolia），不如将它们提供给您自己托管和拥有的搜索服务。

　　文档即代码管道

　　使用单一创作环境，免除对多种工具的需求。借助内置 Git UI、集成式构建工具、自动化测试以及现成和可自定义的布局，专注于您的内容。

　　结合 Markdown 和 XML

　　现在，您可以将 Markdown 与语义标记的优势相结合。选择一种格式，或使用语义特性和元素、Mermaid 图和 LaTeX 数学公式丰富 Markdown。

　　文档质量自动化

　　通过编辑器中的超过 100 项即时检查以及实时预览和构建期间的测试确保文档质量和完整性。

　　实时预览

　　预览显示的文档与读者将看到的完全相同。在 IDE 中预览单个页面，或在浏览器中打开整个帮助网站而不运行构建。

　　单一来源

　　从较小的内容块到整个主题或目录部分，重用一切。灵活使用筛选器和变量。为复杂标记元素使用预定义模板，或者配置您自己的模板。

软件特色

　　您可以要求AI助理为所选内容片段建议替代措辞。它将生成语气和含义相似的文本，并尝试尽可能保留标记。

　　此版本引入了与 JetBrains AI Assistant 的集成，以提供特定于文档创作的 AI 驱动功能。我们鼓励您尝试一下，并通过 Writerside Slack 告诉我们您的想法。

　　您可以请求Al助手改进您的内容并重写以使其更具可读性、清晰、简洁和语法正确。

　　您可以让Al Assistant 将任何选定的内容片段翻译成Enlgish。因此，您可以用您的母语创作文档，然后翻译它，保留标记。

　　您可以要求Al Assistant 为冗长的主题或章节生成TLDR块。此元素的目标是为您的读者提供有关您所描述的主题的最基本信息的摘录，以使他们无需阅读详细信息。

　　链接摘要用于在将鼠标悬停在链接上时在弹出窗口中显示主题或锚点的简短摘要。它们可以帮助您的读者在点击链接之前了解链接的内容。

　　Writerside用元素生成帮助网站中页面的元描述。这些对你的读者是不可见的，搜索引擎用它来更好地索引你的内容。

使用方法

　　1、将JetBrains IDE Writerside直接安装到电脑，点击下一步

　　2、软件首页界面如图所示，可以选择点击新的项目

　　3、提供视频教程，可以在软件播放当前的视频学习Writerside

　　4、支持屏幕阅读器需要重新启动

　　Ctrl+Tab和Ctrl+Shift+Tab将在对话框中导航UI控件，不可用于切换编辑器选项卡或其他IDE操作。鼠标悬停时的工具提示将被禁用。

　　5、编辑

　　在没有选择的情况下调用“复制”或“剪切”操作时，不要复制/剪切当前行

　　在没有选择的情况下调用“复制”操作后，不要选择复制的行

　　粘贴未经选择而复制的行时：

　　粘贴到插入符号行上方

　　使用Unicode名称缩写呈现特殊字符，如控制代码

　　6、在行长度超过100000个字符的文档中强制软包装

　　增加此限制将对编辑器性能产生负面影响

　　使用“扩展选择”选择空白字符

　　使用“行注释”操作在“注释”后下移插入符号

　　隐藏代码编辑的浮动工具栏

　　7、编辑器选项卡

　　导航到文件时，首选在非活动拆分窗格中选择现有选项卡

　　在同一选项卡中打开声明源

　　当导航到方法/类/变量声明时，如果没有更改，则包含该声明的源文件将替换当前选项卡

　　打开从主IDE窗口中分离的窗口调用的声明源

　　从分离窗口中的选项卡导航到方法/类/变量声明时，将在IDE主窗口中打开新的选项卡。覆盖“在同一选项卡中打开声明源”。

　　双击编辑器选项卡执行“隐藏所有工具窗口”/“恢复窗口”

　　双击编辑器选项卡执行“最大化编辑器”/“规格化分割”

　　在嵌套拆分中均衡比例

　　调整拆分器以在拆分/取消拆分后保持空间均匀分布。

　　8、在文件中查找/显示用法预览中显示的最大结果数：100

　　增加此限制会显著增加IDE内存的使用量

　　IDE

　　最近项目的最大数量：50

　　最近文件的最大数量：50

　　最近位置的最大数量：25

　　在本地历史中存储更改的持续时间：5天

　　不要将本地历史记录用作主要版本控制系统，因为如果IDE挂起，它可能会损坏

　　9、运行/调试

　　临时配置限制：5

　　确认重新运行并终止进程

　　默认情况下固定配置

　　新UI中最近运行配置的最大数量：5

　　10、到处搜索

　　在“到处搜索”中显示文本搜索结果

　　在“全部”选项卡中显示文本搜索结果，并在“到处搜索”中显示“文本”选项卡

　　等待所有贡献者完成后再显示结果

　　启用此选项将停止搜索项目以更改其在显示的搜索结果中的位置。此过程可能会导致延迟。

　　参与者等待超时（毫秒）：2000

　　在结果列表的顶部显示最近的文件

　　启用后，最近的文件总是显示在结果列表的顶部。

　　因此，即使这些文件与搜索模式的匹配不如其他结果精确，它们也会保持在顶部。

　　11、用户界面

　　在IDE框架标题中显示文件类型图标

　　在macOS上，该图标可用于将文件拖动到不同的应用程序

　　使用单词而不是符号作为macOS键盘快捷键

　　将快捷方式符号、、<和其他更改为Esc、Backspace、Option等

　　在列表和树中循环滚动

　　在第一个图元上按Up键时选择最后一个图元，反之亦然

　　将鼠标光标放在对话框中的默认按钮上

　　禁用双修改键快捷键

　　Shift-Shift表示“到处搜索”，Ctrl-Ctrl表示“运行任何内容”

更新日志

　　API 文档

　　我们继续改进对生成 API 文档的支持：

　　Writerside 现在除了生成请求示例外，还会生成响应示例。

　　现在，您可以为请求和响应示例提供自定义标题。默认情况下，对应的选项卡名称取决于语言，例如 JSON 示例和 Java 示例。

　　如果您选择为架构对象生成单独的页面，Writerside 还将创建指向它们的方便链接。

　　PDF 导出

　　生成的 API 文档现在可在 PDF 输出中找到。此外，我们还修复了提示、注释和警告中的表格、选项卡、图像和截断文本的各种渲染问题。

　　其他修复和改进

　　改进了“新建项目”向导并修复了其中的几个问题。现在，您可以选择是要创建一个空文档项目，还是添加初始实例和第一个主题并指定它们的名称。

　　现在，在 git 分支之间切换时，项目会正确重新加载，正确更新 TOC，并保留所选实例。

　　修复了解析、突出显示和重命名图像引用的各种问题。

　　添加了对深色版本的视频预览图像的支持。

　　已发布输出中的几个修复包括：正确滚动链接锚点、展开折叠元素、卡片和工具提示中的自动换行。

　　改进了对变量的处理：正确突出显示和转义变量的操作。

　　一些检查现在更加可靠和用户友好：宽代码块可以正确处理前导缩进，除了删除未使用的主题文件外，未使用的主题检查还建议将其添加到当前实例中。

　　修复了 XML 架构和标记验证不正确的小问题。各种 XML 文件中的元素现在已完全注释和记录：主题文件、树文件、writerside.cfg 和 buildprofiles.xml。

　　修复了多个异常和性能问题。