如何在Sandcastle文档中添加彩色HTML代码段？

| 我正在使用Sandcastle帮助文件生成器，并希望在\“概念性内容\”中包括彩色的HTML代码段。这可能吗？如果可以，怎么办？我尝试了

，和。

到目前为止，最好的结果是对示例HTML进行HTML编码，然后将其放置在.snippets文件中。

<?xml version=\"1.0\" encoding=\"utf-8\" ?>
<examples>
   <item id=\"htmlSnippet\">
      <sampleCode language=\"HTML\">
         &lt;span&gt;My Html&lt;/span&gt;
      </sampleCode>
   </item>
</examples>


然后在.aml文件中引用它。

<codeReference>htmlSnippet</codeReference>


我希望将其着色，但是我找不到一种添加格式的方法。



										
						
							
								
								3 个回复
							
						
						
															
									
																				
										
																				
										
											
																									靛取糕奖穿
																																																																																					
											
												
																							
										
									
									
										
										
											
根据MAML指南，执行此操作的正确方法是使用带有CDATA部分的<code>标签：

<code language=\"xml\" title=\"Example Configuration\">
<![CDATA[
    <span>My Html</span>]]>
</code>


CDATA节的内容将被视为文字字符串，并且缩进将保留。
    										

										
																				
									
									
										
										
											2020-01-24
																						
											
												 0
																							
											
											
												 0
											
											
											
												
																								
													
														 分享													
                                    
                                        
                                             微信
                                             QQ
                                             微博
                                             空间
                                        
                                    
												
												
											
											

										
										
									
								
																
									
																				
										
																				
										
											
																									伐教爸
																																																																																					
											
												
																							
										
									
									
										
										
											
我知道这很旧，但是Sandcastle支持html格式为xml。我想我应该发表评论，以防其他人像我一样看到这篇文章。

这应该工作：

<?xml version=\"1.0\" encoding=\"utf-8\" ?>
<examples>
   <item id=\"htmlSnippet\">
      <sampleCode language=\"xml\"><!CDATA[[
         <span>My Html</span>
       ]]>
      </sampleCode>
   </item>
</examples>


如果您使用的是Sandcastle帮助文件生成器，则可以按此处和此处所述创建自己的语法解析器，尽管默认情况下xml是可用的...使用XAML过滤器的生成器（如果要在此处定义）看一下配置：

<generator type=\"Microsoft.Ddue.Tools.XamlUsageSyntaxGenerator\"
    assembly=\"{@SandcastlePath}ProductionTools\\SyntaxComponents.dll\">
    <filter files=\"{@SandcastlePath}Presentation\\Shared\\configuration\\xamlSyntax.config\" />
</generator>

    										

										
																				
									
									
										
										
											2020-01-24
																						
											
												 0
																							
											
											
												 0
											
											
											
												
																								
													
														 分享													
                                    
                                        
                                             微信
                                             QQ
                                             微博
                                             空间
                                        
                                    
												
												
											
											

										
										
									
								
																
									
																				
										
																				
										
											
																									羔磺
																																																																																					
											
												
																							
										
									
									
										
										
											
根据代码块组件的SHFB文档，您应该只能使用<code>。

我让它正常工作。这是我所做的：

test.html

<html>
    <head>Something!</head>
    <body>
        <h1>Heading</h1>
<!-- #region myhtml -->
        <p>Paragraph</p>
        <div>Div for <strong>Good</strong> <em>measure</em>.</div>
<!-- #endregion -->
    </body>
</html>


SomethingorOther.aml

<code language=\"html\" source=\"../Examples/test.html\" region=\"myhtml\" />


结果：



请注意，在预览中，您的示例将显示为未突出显示的XML，但是在构建文档时，一切都会很好。
    										

										
																				
									
									
										
										
											2020-01-24
																						
											
												 0
																							
											
											
												 0
											
											
											
												
																								
													
														 分享													
                                    
                                        
                                             微信
                                             QQ
                                             微博
                                             空间
                                        
                                    
												
												
											
											

										
										
									
								
																					
						
															
									为什么被折叠?
									0 个回复被折叠
								

								
													

											
										

										
					
						
												要回复问题请先登录或注册

如何在Sandcastle文档中添加彩色HTML代码段？

3 个回复

发起人

sandcastle

maml

问题状态