问题标签 [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.

38 问题

0 投票

2 回答

1909 浏览

mediawiki - 将 Sandcastle 帮助文件生成器输出（网站）转换为 MediaWiki 格式

我需要

将作为网站 (HTML) 的 Sandcastle 帮助文件生成器 (SHFB) 输出转换为媒体 wiki 格式
找到一种方法将转换后的页面直接传输/包含到我们设置的 MediaWiki 中。

有任何想法吗？我们在网站上有超过 1000 页的 HTML 文件（SHFB 的输出）。

我想过使用 html2wiki 转换器..我可以考虑寻找一个脚本来将这 1000 个页面转换为 wiki 格式......这可以解决 (1)。

但是我仍然会在管道的最后一位中留下块 - 如何将转换后的页面直接输入 Wiki？

0 投票

1 回答

779 浏览

list - SandCastle 帮助文件生成器和 MAML，如何获得具有不同起始索引的有序列表？

我正在使用 SandCastle Help File Builder 1.8.0.1 及其 MAML 内容编辑器。

我想要一个从默认值 1 以外的值开始的有序列表。

10. Some data

11. Other data

我什至尝试了以下方法，但它不起作用，因为它来自 OL 元素的 HTML：

我怎样才能做到这一点？

有人知道我应该在沙堡样式中修改哪些文件吗？

list sandcastle maml shfb

0 投票

1 回答

1100 浏览

sandcastle - Sandcastle 帮助文件生成器的有序列表

当我使用 Sandcastle Helpfile Builder 创建 chm 时，如何将 xmldoc 块中的列表呈现为有序列表？

以下不起作用：

在我试图解决的特定情况下，列表位于 <summary/> 元素中。

sandcastle shfb

0 投票

1 回答

423 浏览

.net - 如何使用 Sandcastle 帮助文件生成器在帮助文件中显示代码示例？

我正在使用 Sandcastle Help File Builder GUI，我似乎无法在我的注释中获取代码示例以显示在帮助文件输出中。

我正在生成 Help 1.x 和 MSDN 样式的 HTML 文档。

这些示例在我的代码中如下所示：

我是否需要配置一些我不知道的项目属性？

.net documentation-generation sandcastle shfb

0 投票

1 回答

2028 浏览

documentation - 如何在不更改默认安装文件的情况下修改 Sandcastle 演示样式

我的项目使用 Sandcastle 和 Sandcastle Help File Builder 来生成文档。

我们正在使用自定义版本的 script_manifold.js，它可以跨页面保留用户的语言首选项（默认版本会重置每个页面的语言首选项）。

目前，该脚本位于 Sandcastle\presentation\VS2005\scripts 文件夹中。

有没有办法用自定义版本覆盖这个脚本，而不必弄乱 Sandcastle 安装？也就是说，我是否可以将一个文件与我的源代码一起签入源代码控制，并且以某种方式让 SHFB 使用该文件而不是默认的 Sandcastle 文件？

documentation build sandcastle shfb

0 投票

1 回答

1443 浏览

sandcastle - Sandcastle 的印刷文件

我们将 Sandcastle 用于概念文档，并且我们希望将文档以非 CHM 或 HTML 形式（即打印）提供给客户。它可以是 Word 或 PDF，可以简单地附加到电子邮件中。用例通常涉及想要发送主题的人。

我们能做的最好的事情是在查看 HTML 时从 CHM 查看器打印或从 Chrome 打印到 PDF。这些问题在于它们删除了锚元素点击，将图像变为黑白等。

关于 Codeplex 的 SHFB 讨论中有一个线程指出没有任何已知的替代方案 - http://shfb.codeplex.com/discussions/260489。我在这里重新发布这个问题，希望获得更多的意见和知名度。

sandcastle shfb

0 投票

1 回答

1365 浏览

sandcastle - 概念主题的沙堡创作

我正在为我们在 Sandcastle 制作的其他技术文档编写一些概念文档。

那里没有很多好的示例/链接，但我开始掌握 MAML 的窍门。如果有人有任何优秀的资源来查看/理解这一点，我将不胜感激。

我希望我的概念文档能够引用我的文档源中的某些类型。有没有办法把像“>类型”这样简单的东西链接到代码中的文档？

编辑：这是我的一个主要问题，因为我是新手。

链接到代码项的最佳方式是从实体窗口中获取它。要打开实体窗口，请转到窗口 > 实体引用。从这里，您可以找到适当的类型/方法/属性并将其从结果中拖到代码中。

MAML 参考指南包含在 Sandcastle Styles 下载中：http : //sandcastlestyles.codeplex.com/ 并且在学习如何格式化事物方面非常有帮助。

sandcastle maml shfb

0 投票

1 回答

785 浏览

documentation - Sandcastle/SHFB. Add platform icons and version info to help file pages

I am building help file for my library using Sandcastle Help File Builder. The library has three versions (.NET, Silverlight and Windows Phone 7) built from the same code base.

I would like to add platform icons next to method names and version information at the bottom of the help file pages. Something like on screenshots below. How can I add such information to my help file?

Platform icons next to method names enter image description here