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

Question

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

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

Я пробовал <?xml version="1.0" encoding="utf-8" ?> <examples> <item id="htmlSnippet"> <sampleCode language="HTML"> <span>My Html</span> </sampleCode> </item> </examples>

Затем укажите это в файле.aml.

<codeReference>htmlSnippet</codeReference>

Я бы предпочел раскрасить его, но не могу найти способ добавить форматирование.

3

sandcastle maml

Источник

user2582 24 май '11 в 04:17

3 ответа

Другие вопросы по тегам sandcastle maml

user857807 12 май '14 в 12:08 2014-05-12 12:08 · Answer 1 · 2014-05-12 12:08

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

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

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

user996592 08 янв '13 в 01:41 2013-01-08 01:41 · Answer 2 · 2013-01-08 01:41

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

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

user151445 11 апр '12 в 15:45 2012-04-11 15:45 · Answer 3 · 2012-04-11 15:45

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