问题标签 [shfb]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票
2 回答
21249 浏览

.net - $(SolutionDir) 通过 CMD 运行 Sandcastle 帮助文件生成器时 MSBuild 属性不正确

当我使用 Windows CMD 运行Sandcastle Help File Builder 项目文件(例如,myproject.shfbproj)时,我遇到了一个烦人的问题:$(SolutionDir)$(ProjectDir)已经使用的目标$(SolutionDir)

如果我从 Visual Studio 构建整个 Sandcastle 帮助文件生成器,它将成功构建。

我正在使用以下命令(从存储项目的目录执行):

有解决方法吗?

0 投票
2 回答
900 浏览

c# - 沙堡 developerHowToDocument 上的 codeEntityReference 方法

我正在尝试使用<codeEntityReference>MAML 元素创建指向自定义扩展方法的链接,并且在构建文档后,我将获取整个<codeEntityReference>标记内容,而不是指向整个方法的链接。

该方法的一个示例是:

<codeEntityReference>看起来像<codeEntityReference>M:SampleProject.ExtensionMethods.SomeExtension{T}(TObject)</codeEntityReference>

上面的链接将产生类似M:SampleProject.ExtensionMethods.SomeExtension{T}(T)的输出。

实际上,我在文档构建期间收到以下错误:

警告:BuildAssembler:警告:ResolveReferenceLinksComponent:[52e40f26-3dfe-47e0-adf1-09233e98f42e] 未知参考链接目标'M:SampleProject.ExtensionMethods.SomeExtension{T}(T)'

我错过了什么吗?那里有什么问题?我试图提供方法参考:

...但它并没有解决问题。

0 投票
1 回答
134 浏览

sandcastle - 将 Sandcastle 装配文档分成多个导航目录

我维护多个 .NET 程序集,每个程序集都有自己独立的发布周期。我的目的是为所有这些程序集生成一个帮助网站,但同时也将概念内容和命名空间文档分成不同的组。

这是我希望完成的简化结构:

Overview Library A --Overview --Release notes --**Library A generated Namespace/Assembly documentation** Library B --Overview --Release notes --**Library B generated Namespace/Assembly documentation** Library C --Overview --Release notes --**Library C generated Namespace/Assembly documentation**

就目前而言,这就是我能够成功制作的全部内容:

Overview Library A --Overview --Release notes Library B --Overview --Release notes Library C --Overview --Release notes **Library A, B, and C generated Namespace/Assembly documentation**

我已经有一个自定义的表示样式(基于现有的 VS2013),所以表示层的自定义是一个选项。我也不反对编写自定义组件/插件,但到目前为止还无法理解如何更改默认行为。

提前感谢您的任何见解。

0 投票
1 回答
537 浏览

c# - SHFB Conceptual topic to include other HTML content in documentation project

In my Sandcastle Help File Builder project I have an HTML folder under the Content folder. It only contains HTML files! None are type of .AML (Application Markup Language File). How do I get these files to show up after compiling my SHFB project?

enter image description here

Each HTML file in that folder is set to the build action of content

enter image description here

If I try to reference these files using a conceptual topic file using the External Link xml tag... I have the problem of not knowing the relative path.

enter image description here

But better yet, shouldn't I be able to automatically include these from the content layout file (directly)? It allows for individual new HTML files but these were already created...

enter image description here

Would an Iframe work to show all html content in that HTML folder?

Thanks for suggestions!

0 投票
0 回答
30 浏览

.net - Sandcastle 中术语定义中其他术语的链接

我正在使用 MAML 编写词汇表。例如:

这会起作用,但我想知道我是否可以像使用<relatedEntry termId="[some term id]" />元素作为定义的一部分不是使用常规<link>元素那样引用术语。

0 投票
0 回答
641 浏览

c# - Sandcastle 未解决的装配参考

我正在尝试使用 Sandcastle Help File Builder 从我的方法中获取 XML 并为我的项目创建文档。我将 XML 和 DLL 添加为文档源,并配置了通配符程序集引用插件以添加我的 bin,在构建时添加了许多引用,包括:

但我仍然会因为这个错误而导致构建失败:

为什么 Sandcastle 找不到引用,如果我使用 Assembly Binding Redirection 忽略此引用,则缺少另一个 Owin 引用,如果我忽略它,则它丢失了Newtonsoft.JSON

编辑 -

我验证了版本号不匹配,但是当我尝试重定向到我拥有的版本时,我仍然收到错误

虽然忽略错误确实允许我构建帮助文件,但它确实在文档中创建了漏洞,而不是链接到那些被忽略的文件的 MSDN 文章。我正在寻找解决我遇到的问题,而不是忽略它们或绕过它们。

0 投票
0 回答
69 浏览

c# - Sandcastle - 结合 RoutePrefix 和 Route 以获得完整的 URI

我正在使用 Sandcastle Help File Builder 来记录 API。我想尽可能多地自动化这个过程,不仅让开发人员更容易在添加新路线时添加它们,而且还可以更新文档。到目前为止,我的评论如下所示:

我的问题是,有没有办法获得每个 API 路由的完整路由?

0 投票
2 回答
217 浏览

c# - 有什么方法可以在 SHFB 中导入外部项目或主题文件?

我想生成许多单独的输出 CHM 文件(对于单独的库,所以我有一个单独shfbproj的),但它们有许多共同的概念主题。

我希望能够将.aml这些主题的文件放在一个地方,然后将它们导入到每个项目中,以避免重复。

理想情况下,我希望.content在这个中心位置也有一个公共文件,并将其作为“真实”项目文件中特定父主题节点的子节点导入.content,以避免重复。

有没有办法做到这一点?尝试将现有文件添加到项目会导致创建文件的副本,或者如果手动编辑以指向项目文件夹之外的文件,则使项目无法加载。

(我也尝试shfbproj为公共内容制作一个,然后在“真实”项目中引用它,但这似乎没有效果。)