标签: sandcastle

我需要

1. 将我的Sandcastle帮助文件生成器(SHFB)输出(即Web站点(HTML))转换为Media wiki格式
2. 找到一种方法将转换后的页面直接传输/包含到我们设置的MediaWiki中.

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

我想过使用一个html2wiki转换器..我可以考虑寻找一个脚本来将这1000个页面转换成维基格式......这可以照顾(1).

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

有没有办法在XML文档中包含多种语言的示例(例如C#和Visual Basic)？

我正在使用SandCastle来构建MSDN样式的文档,并希望包含几种.NET语言的用法示例.

我正在尝试使用SandCastle为WCF服务生成外部文档.如何告诉SandCastle使用WCF属性,比如ServiceContract命名函数和实体而不是它们在程序集中的名称？

我们是一家微软商店,专注于使用C#.我们有几个项目,包括网站,Windows服务和类库,它们包含XML注释.

我希望为每个项目生成MSDN样式的HTML文档,并将其部署到一个所有开发人员都可以轻松访问的集中位置.我还希望自动化这些步骤,以便它们可以定期运行,因此我和其他开发人员无需担心在进行更改时记住生成和部署新文档.我看过Sandcastle和Doxygen,它们看起来都是生成我想要的文档的好选择,但是我需要一个很好的方法来自动生成它,比如夜间工作或其他什么.

有人这样做吗？我不是最终结果是HTML出售; 特别是如果有更好的主意.

编辑:

我很欣赏所有好主意.现在我可以调查一些路线了,但是直到弄脏我才知道哪条路线效果最好.Sandcastle帮助文件生成器似乎为我提供了我想要做的最佳选择,所以我会对这个建议表示赞同.但是,如果我有更多时间研究XSLT和CSS解决方案以使XML数据看起来恰到好处,那么我首先会追求这个建议.

再次感谢大家!

我正在构建包含以下内容的C#API文档:

1. 作为doc/pdf文件的当前状态的一般概述和描述.
2. 使用Sandcastle的.chm文件中的类库API.

问题:

1. 我应该将这两个合并到同一个.chm文件中吗？合并它们的好方法是什么？
2. 我需要排除某些类/包.如何在SandCastle中指定？
3. 它生成VB代码和Visual C++代码的文档.我怎么能改变这个？或者我应该离开它,知道我只使用安全代码？
4. 我在哪里可以找到我的系统上的HTML Help 2.x Viewer Path？

编辑:

我在方法,字段和类上面做出的注释不会在文档中生成.

我该怎么办？

我在Visual Studio 2008 Team System中为我的项目制作了类图,我想将这些图嵌入到我的Sandcastle .chm文件中.我一直在寻找Sandcastle 的Drawbridge组件,但他们显然是在处理旧版的Sandcastle; 这并不奇怪,因为看起来Drawbridge最后一次更新是在2008年.使用当前版本的Sandcastle我在Vista中,它安装在C:\ Program Files\Sandcastle帮助文件生成器.安装Drawbridge后,它创建了以下目录结构:C:\ Program Files\EWSoftware\Sandcastle帮助文件生成器\ BuildComponents.然后它在那里放了一个XML组件配置文件,但当然这对我安装的Sandcastle版本没有任何意义,因为它不在其路径的任何地方.

我希望只是将XML配置文件复制到Sandcastle的当前安装目录,但那里没有BuildComponents目录.那么,有没有人知道Drawbridge是否仍然适用于Sandcastle？如果有,我该如何安装？如果没有,我如何在我的Sandcastle .chm帮助文件中嵌入VS2008类图？

这与此问题略有关系.

我一直在使用Sandcastle和Sandcastle帮助文件生成器,默认情况下它提供三种呈现方式:hana,prototype和vs2005.

虽然vs2005风格看起来不错,但我特别喜欢最新的轻量级MSDN风格.有没有办法配置Sandcastle以便生成具有此样式的文档？

我正在使用 Sandcastle 帮助文件生成器来记录 C# 解决方案中的项目。我让它生成 HTML 帮助 1 以及网站

生成的 HTML 帮助 1 文件 (.chm) 很好，所以我知道基本文档构建过程正在运行，我可以看到我的所有类。该网站大部分都很好，但它有一个严重的问题：index.html 只引用一个项目（第一个项目，按字母顺序）。您可以从 index.html 文件访问解决方案中其他项目的任何文档。

有人知道如何修复 index.html 文件吗？

我现在正在使用Sandcastle一段时间,我也习惯在.Net Source Reference中找到xml内联注释.它们通常与msdn上的描述完全匹配.
从.Net 4.6和.Net Core开始,似乎微软以不同的方式创建了他们的评论.
(不能再在.Net Source Reference中找到它们)

一个例子:
https ://msdn.microsoft.com/de-de/library/system.string.padright(v =
vs.110).aspx这个方法在msdn中有一个注释,但我无法在来源:http:
//referencesource.microsoft.com/#mscorlib/system/string.cs,56cb688f4f1dc9e4

我想知道他们现在如何使用.Net 4.6以及他们将如何/正在使用.NET Core.任何人都可以向我确认并解释这个吗？

编辑:由于.Net Core是开源的,我们应该能够解决这个问题.但我找不到任何有关它的信息.

EDIT2:由于.Net Core是开源的,我认为我们应该可以访问或者至少能够访问其内部的"秘密"文档工具.我们还能如何进一步开发.Net Core并编写文档.有谁知道该工具或在哪里找到它？

我刚刚下载了最新版本的 Sancastle Help File Builder 2017.1.28.0。根据这篇文章的答案和评论，我希望搜索能够正常工作，但它没有。无论我要搜索什么，我都会收到“未找到”消息。顺便说一句，我没有生成任何 aspx 文件。

我尝试使用 Google Chrome 浏览器

我是否错过了任何项目配置？

我怎样才能使搜索工作？