Microsoft WinHelp es un formato propietario para archivos de ayuda en línea que se pueden mostrar mediante el explorador de ayuda de Microsoft winhelp.exe o winhlp32.exe . El formato de archivo se basa en el formato de texto enriquecido (RTF). Siguió siendo una plataforma de ayuda popular desde Windows 3.0 hasta Windows XP . WinHelp se eliminó en Windows Vista supuestamente para disuadir a los desarrolladores de software de usar el formato obsoleto y alentar el uso de formatos de ayuda más nuevos. La compatibilidad con archivos WinHelp finalmente se eliminaría por completo en Windows 10 .
Un archivo WinHelp tiene un sufijo ".hlp". Puede ir acompañado de un archivo de tabla de contenidos opcional (.cnt) si el desarrollador de la ayuda creó uno. Cuando Windows abre un archivo WinHelp, crea un archivo .gid en el mismo directorio o en " %LOCALAPPDATA%\Help", que contiene información sobre el archivo .hlp, como el tamaño y la ubicación de la ventana. Si el usuario hace clic en la pestaña "Buscar" y habilita la indexación de palabras clave, Windows crea un archivo de índice con una extensión .fts (búsqueda de texto completo). Las anotaciones y los marcadores de cada archivo de ayuda de Windows tienen la extensión ".ann" y ".bmk".
Varias herramientas de software pueden descompilar un archivo WinHelp en sus documentos fuente: HPJ, CNT, RTF , BMP y SHG . Un archivo HPJ es el archivo de proyecto que se crea y edita en Help Workshop (o una herramienta de creación de ayuda de terceros). El HPJ contiene información sobre qué archivos RTF compilar en la ayuda, los identificadores de MAP y alias que proporcionan vínculos desde una aplicación que realiza la llamada al archivo de ayuda, y la apariencia del archivo de ayuda (tamaño de la ventana, botones predeterminados, esquemas de color, etc.). El archivo CNT proporciona la tabla de contenidos para el archivo de ayuda. Un archivo SHG es un archivo de gráficos "SHED" que esencialmente crea un mapa de imágenes de llamadas de ayuda para un archivo gráfico (por ejemplo, un BMP).
Existen varias herramientas que pueden leer y explorar estos archivos (consulte, por ejemplo, Ayuda de RTF y winhelpcgi).
Los archivos fuente necesarios para compilar un archivo .hlp consisten en uno o más documentos en formato de texto enriquecido y un archivo de proyecto de ayuda con la extensión .hpj, junto con cualquier archivo de imagen (. bmp , . wmf o . shg) que se utilice en el archivo de ayuda. También se puede crear un archivo de tabla de contenidos opcional con la extensión . cnt para utilizarlo con el archivo . hlp.
Dentro de los archivos .rtf, los temas están separados por saltos de página. Cada tema tiene una serie de notas al pie que contienen información para el compilador de ayuda:
Solo se requiere la nota al pie #. Todas las demás son opcionales.
El texto de cada tema puede contener un formato limitado, incluido el texto en negrita , cursiva y colores. No se permiten superíndices ni subíndices. Los saltos entre temas en el mismo archivo de Ayuda suelen aparecer en el documento de origen como texto subrayado doble (verde de forma predeterminada, aunque esto se puede anular) seguido de un ID de tema en texto oculto. Los enlaces emergentes aparecen en el documento de origen como texto con un solo subrayado (también verde de forma predeterminada) seguido de un ID de tema en texto oculto. (En el archivo .hlp, los saltos se muestran como texto verde con un solo subrayado y las ventanas emergentes se muestran como texto verde con un subrayado de puntos).
Se pueden agregar imágenes mediante códigos como {bmc image.bmp}. Los formatos de imagen admitidos incluyen .bmp , .wmf y .shg (usados para mapas de imágenes, que pueden contener saltos o ventanas emergentes que se activan al hacer clic en partes específicas de la imagen).
Una vez creados los archivos fuente, el archivo de ayuda se puede compilar utilizando un compilador WinHelp como HCW.exe o utilizando un programa de software comercial como RoboHelp o HelpBreeze, la mayoría de los cuales (incluidos los dos citados aquí) también utilizan hcw.exe como compilador backend .
Dependiendo de cómo se haya iniciado y de qué configuración haya elegido el autor de la Ayuda, un archivo WinHelp se abre en su tema predeterminado, su tabla de contenidos o su índice.
Un tema de un archivo WinHelp se abre en una ventana independiente, en un tamaño y una posición inicial que el autor de la Ayuda puede elegir. Los usuarios pueden cambiar el tamaño o la posición de la ventana. El autor de la Ayuda puede controlar si el archivo de Ayuda almacena la configuración del usuario entre sesiones o si siempre se abre en el tamaño y la posición predeterminados.
Cuando se abre un tema, una barra de título en la parte superior de la ventana de Ayuda muestra el título del tema. Debajo de eso hay una fila de menús ( Archivo , Editar , Marcador , Opciones y Ayuda ), que controlan varios aspectos del archivo. Por lo general, aparece una fila de botones debajo de los menús. El autor de la Ayuda controla qué botones aparecen, si los hay. Los botones típicos incluyen Contenido , Índice , Atrás e Imprimir , junto con los botones << y >> para explorar el archivo. Los autores de la Ayuda también pueden crear botones personalizados para saltar a temas específicos o realizar otras acciones.
Debajo de los botones se encuentra el área de texto principal de la ventana. Normalmente, el texto comienza con un encabezado, a menudo en negrita o con una fuente más grande que el resto del texto. Este encabezado puede estar a veces en una región sin desplazamiento, es decir, un área de la ventana que no se mueve hacia arriba o hacia abajo mediante la barra de desplazamiento ubicada al costado de la ventana. Las regiones sin desplazamiento solo se pueden usar al comienzo de un tema. El autor de la Ayuda puede controlar el tamaño y el color de fondo de una región sin desplazamiento.
Los autores de la ayuda también pueden controlar el color de fondo del área de texto principal, donde aparece el texto real del tema. Este texto se puede formatear y organizar de muchas maneras. Dentro del texto, los saltos aparecen como texto verde con un único subrayado . Al hacer un solo clic en un salto se abre un tema diferente. Algunos saltos pueden abrir ventanas de ayuda secundarias para mostrar información. Las ventanas emergentes aparecen en el texto como texto verde con un subrayado de puntos. Al hacer un solo clic en una ventana emergente se abre una ventana pequeña sin menús, botones ni barras de desplazamiento, cuyo tamaño se ajusta al texto. A menudo, las ventanas emergentes proporcionan definiciones breves de términos clave u otra información complementaria sobre el texto principal. La ventana emergente desaparece automáticamente la próxima vez que el usuario haga clic o presione una tecla.
Muchos temas de ayuda, aunque no todos, tienen saltos de Ver también al final del texto. Según la preferencia del autor de la Ayuda, esta función puede ser una simple lista de saltos bajo el encabezado Ver también, o puede ser un pequeño botón que, al hacer clic, abre un cuadro de diálogo que muestra todos los temas relevantes. Al hacer clic en el nombre de un tema en ese cuadro de diálogo y luego en Mostrar, se abre ese tema.
La mayoría de los archivos de Ayuda también contienen una tabla de contenidos y un índice para ayudar a los usuarios a localizar la información. Estos aparecen en una ventana separada con pestañas. Al hacer clic en la pestaña Contenido se abre la tabla de contenidos, en la que los usuarios pueden hacer clic en los encabezados para ver los temas. A menudo, los encabezados están marcados con iconos que parecen libros pequeños y los temas tienen iconos que parecen páginas. Al hacer doble clic en un tema (o hacer clic en un tema y luego hacer clic en Mostrar ) se abre ese tema. Al hacer clic en la pestaña Índice se abre el índice, que tiene un campo de escritura y una lista de palabras clave ordenadas alfabéticamente. Al escribir en el campo de escritura, se desplaza automáticamente la lista de palabras clave hasta la coincidencia más cercana. Al hacer doble clic en una palabra clave (o hacer clic en una palabra clave y luego hacer clic en Mostrar ) se muestra el tema asociado con esa palabra clave (si solo hay uno) o se abre una lista de todos los temas asociados con él. El índice es importante para ayudar a los usuarios a localizar la información. A veces, los archivos de Ayuda también tienen una pestaña Buscar , que permite al usuario buscar cualquier palabra utilizada en el texto del archivo, no solo palabras clave.
WinHelp también admite una función conocida como ayuda contextual . La ayuda contextual es una ayuda que se adapta al lugar en el que se encuentra el usuario en la aplicación de software y a lo que está intentando hacer.
Una característica bastante importante para la seguridad es que también se puede incluir un archivo DLL que contenga código personalizado y asociarlo con temas de WinHelp. En la práctica, esto hace que los archivos .HLP sean equivalentes a los ejecutables.
En la conferencia WritersUA de 2006, Microsoft anunció sus intenciones de eliminar gradualmente WinHelp como plataforma compatible. Ted Dworkin (director asociado de WinHelp Experience) afirmó: "WinHelp no cumple con los estándares de código establecidos para Vista. Estos estándares incluyen seguridad, confiabilidad y rendimiento". Continuó diciendo que WinHelp está diseñado de tal manera que "... tendríamos que reescribirlo desde cero para cumplir con los estándares de código de Vista. Y ese enfoque no tiene sentido dado que tenemos otros dos sistemas de ayuda en Vista". [ cita requerida ]
El acuerdo de licencia actualizado prohíbe a los desarrolladores de aplicaciones empaquetar las bibliotecas WinHelp con sus instaladores. Esto significa que los manuales WinHelp para aplicaciones heredadas no se pueden leer en una nueva instalación de Windows Vista (o una versión superior). Para leerlos, el usuario final debe obtener el visor WinHelp de 32 bits del sitio web de Microsoft e instalarlo manualmente. [10]
En Windows 10 y versiones posteriores, Microsoft no ofrece un visor WinHelp para el sistema operativo. La última versión de Windows en la que era posible abrir y leer archivos WinHelp, utilizando un componente descargable oficial de Microsoft, es Windows 8.1 . La versión de código abierto de winhlp32 de Wine también funciona en Windows 10. Se incluye como parte de WineVDM . También en Windows 10 WinHelp funciona con winhlp32.exe de una versión anterior de Windows.
Aunque la documentación se puede mantener íntegramente en un formato de presentación específico del proveedor, como WinHelp, es más frecuente que la documentación deba publicarse en varios formatos de presentación a la vez: Ayuda HTML compilada de Microsoft (CHM), WinHelp, páginas HTML , Ayuda de Java , PDF , etc. Sería muy costoso y propenso a errores mantener cada formato por separado.
Por este motivo, los autores suelen mantener la documentación en un formato de creación estándar de la industria y neutral respecto del proveedor (como DocBook o FrameMaker ), que se puede utilizar para generar varios formatos de presentación diferentes (incluido WinHelp). [ cita requerida ] Los diversos archivos de presentación producidos de esta manera (con WinHelp u otras herramientas) contienen contenido coherente porque se generaron a partir de la misma fuente.
.chmextensión de archivo)