Как добавить цветной код HTML-кода в документацию Sandcastle? - PullRequest
Новая
       49

Как добавить цветной код HTML-кода в документацию Sandcastle?

3 голосов
/ 24 мая 2011

Я использую конструктор файлов справки Sandcastle и хотел бы включить цветные фрагменты HTML-кода в «Концептуальное содержимое».Возможно ли это и если да, то как?

Я пробовал , <codeExample>, and <sampleCode language="HTML" />. </p> <p>The best result so far is to HTML-encode the sample HTML and place it in a .snippets file like so.</p> <pre><code><?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 ]

2 голосов
/ 12 мая 2014

Согласно Руководству *1002* * MAML, правильный способ сделать это - использовать тег <code> с секцией CDATA: 

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

Содержимое раздела CDATA будет обрабатываться как буквенная строка, а отступ будет сохранен.

1 голос
/ 08 января 2013

Согласно документации 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" />

Результат:

HTML Highlighting in SHFB

Обратите внимание, что в предварительном просмотре ваш образец будет выглядеть как невыделенный XML, но когда вы создаете документацию, все должно быть хорошо.

1 голос
/ 11 апреля 2012

Я знаю, что это старый, но 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>
...