管理外部同事撰写的帮助内容的工作流程

时间:2016-03-09 18:07:58

标签: xaml version-control external context-sensitive-help

我们开发了一个类似上下文敏感帮助的WPF应用程序。帮助页面的内容目前由外部同事(比如生物学家)写成word文档,然后由开发人员翻译成xaml代码。这个过程繁琐且容易出错,因为生物学家没有看到xaml代码,文档这个词很容易在版本控制系统中被分解和跟踪。

因此,我们希望改进此流程并将内容保存在一个地方,格式为

  • 很容易编辑(最好使用所见即所得的编辑器),
  • 以简单的ascii格式存储(用于差异/版本控制)和
  • 可以作为资源自动包含在我们的C#应用​​程序中。

解决方案可以是框架,外部工具或任何其他想法。 格式应该支持简单的html渲染,如粗体和斜体,上标等和图像。

1 个答案:

答案 0 :(得分:2)

我建议使用Flow Documents

  • 这是一种WPF技术,因此您将使用众所周知的工具。
  • 可以在RichTextBox WPF控件中编辑流文档。您可以通过RichTextBox.Document属性访问已编辑的流文档。然后,您可以使用XamlWriter将其保存到XAML文件中。考虑到所有这些因素,您可以轻松快速地为外部同事创建一个简单的应用程序。
  • 最后,您可以将已保存的XAML文件加载到FlowDocumentReader控件中以显示它们。它被描述为here

我不仅确定流文档是否可以嵌入资源中。如果不可能,我认为帮助文件可以单独分发。这似乎不是一个大问题。

您也可以使用RTF格式代替流文档。 RichTextBox也可用于编辑此类文档。