¿Cómo crear un archivo de ayuda CHM para la aplicación WPF?

Question

Para una aplicación WPF UI, se debe crear un archivo de Ayuda CHM.

¿Cómo crear un archivo de ayuda chm?

Primero cree el documento en ms word y conviértalo en un archivo de ayuda chm? o cualquier otro método?

Por favor ayuda

Gracias

Ramm

Answer 1

Utilicé Sandcastle Help File Builder (SHFB) para generar el CHM.

Para escribir el contenido, seguí la guía y el ejemplo en la Guía MAML de Sandcastle, disponible en codeplex . Esto me implicó escribir un documento en un formato llamado "MAML", que es un dialecto XML para describir los archivos de ayuda.

Se ve así:

<?xml version="1.0" encoding="utf-8"?>
<topic id="4e9fd731-fc2f-4bdf-9ca2-3a8755411b2f" revisionNumber="1">
  <developerConceptualDocument
     xmlns       ="http://ddue.schemas.microsoft.com/authoring/2003/5"
     xmlns:xlink ="http://www.w3.org/1999/xlink">
    <!--
        <summary>
          <para>Optional summary abstract</para>
        </summary>
        -->
    <introduction>
      <!-- Uncomment this to generate an outline of the section and sub-section
           titles.  Specify a numeric value as the inner text to limit it to
           a specific number of sub-topics when creating the outline.  Specify
           zero (0) to limit it to top-level sections only.  -->
      <!-- <autoOutline /> -->
      <para>
      </para>
    </introduction>
    <!-- Add one or more top-level section elements.  These are collapsible.
         If using <autoOutline />, add an address attribute to identify it
         and specify a title so that it can be jumped to with a hyperlink. -->
    <section address="Section1">
      <title>Section Title</title>
      <content>
        <!-- Uncomment this to create a sub-section outline
             <autoOutline /> -->
        <para>
          Lorem ipsum dolor sit amet, consectetuer adipiscing
          elit. Integer vulputate, nibh non rhoncus euismod, erat odio
          pellentesque lacus, sit amet convallis mi augue et
          odio. Phasellus cursus urna facilisis quam. Suspendisse nec
          metus et sapien scelerisque

        </para>
        <para>
          Quisque pharetra lacus quis sapien. Duis id est
          <externalLink>
            <linkText>dictum sed, sapien</linkText>
            <linkAlternateText>alt text</linkAlternateText>
            <linkUri>http://stackoverflow.com/questions/tagged/chm</linkUri>
          </externalLink>
        </para>
      </content>
    </section>
    <relatedTopics/>
  </developerConceptualDocument>
</topic>

Además de crear el contenido en varias páginas, debe especificar el esquema: cómo encajan todas las páginas. Una vez que lo configura, es bastante fácil. Luego, generar el CHM solo requiere ejecutar SHFB.

No se deje intimidar por el nombre de etiqueta " developerConceptualContent " ;. No hay nada sobre el .chm generado que lo haga útil solo para desarrolladores.

La herramienta SHFB es gratuita.

Answer 2

Usar Word para crear sus archivos de ayuda es una opción. Para hacer esto, necesitaría obtener la Ayuda HTML SDK de Microsoft (gratis) y luego convierta sus documentos a HTML y compílelos usando el compilador de Ayuda HTML.

Sin embargo, hay algunas buenas herramientas integradas que podrían ayudarlo a acelerar enormemente este proceso. De lo que he oído cosas buenas es HelpScribbler de JGSoft. No es gratuito, pero ahorraría el tiempo de hacer las cosas manualmente.