Как настроить HTML-сборку HelpNDoc для использования Microsoft Clarity?

Question

Как настроить HTML-сборку HelpNDoc для использования Microsoft Clarity?

Answer 1

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

Начните с редактирования файла:

Найдите этот бит в файле:

      <!-- Content style -->
<link href="css/hnd.content.css" rel="stylesheet" />

Вам нужно добавить новый бит кода непосредственно перед этим. Например:

      <!-- Microsoft Clarity -->
<script type="text/javascript">
  (function(c,l,a,r,i,t,y){
      c[a]=c[a]||function(){(c[a].q=c[a].q||[]).push(arguments)};
      t=l.createElement(r);t.async=1;t.src="https://www.clarity.ms/tag/"+i;
      y=l.getElementsByTagName(r)[0];y.parentNode.insertBefore(t,y);
  })(window, document, "clarity", "script", "~~~~~~~~~~");
</script>

Microsoft Clarity предоставит вам фактический код для использования. Это будет похоже на приведенный выше код, за исключением "~~~~~~~~~~"будет значением вашего личного идентификатора.

Сохраните свой сценарий, и теперь ваша сборка HTML будет поддерживать Microsoft Clarity.

---

Использование переменных шаблона

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

Это обсуждается здесь (Альтернатива: добавьте переменную шаблона, чтобы определить значение метатега Robots по умолчанию ).

Шаг 1

Добавьте новую переменную в свой шаблон. я назвал это MSClarityID:

Шаг 2

Изменить topics.pas.htmlфайл:

        <!-- Microsoft Clarity -->
  <script type="text/javascript">
    (function(c,l,a,r,i,t,y){
        c[a]=c[a]||function(){(c[a].q=c[a].q||[]).push(arguments)};
        t=l.createElement(r);t.async=1;t.src="https://www.clarity.ms/tag/"+i;
        y=l.getElementsByTagName(r)[0];y.parentNode.insertBefore(t,y);
    })(window, document, "clarity", "script", "<% Print(HndGeneratorInfo.GetCustomSettingValue('MSClarityID')); %>");
  </script>

Мы изменили жестко заданный идентификатор проекта на:

      <% Print(HndGeneratorInfo.GetCustomSettingValue('MSClarityID')); %>

Шаг 3

Наконец, укажите значение переменной на вкладке настроек шаблона проектов HelpNDoc: