versiones - Archivos de Ayuda de Windows: ¿cuáles son las opciones?

windows xp microsoft (10)

Ya en los viejos tiempos, la Ayuda no era trivial sino posible: generaba un archivo funky .rtf con etiquetas especiales, ejecútalo a través de un compilador, y obtenías un archivo WinHelp (.hlp) que realmente funcionaba muy bien.

Luego, Microsoft decidió que WinHelp ya no estaba de moda y se cambió a CHM, hasta el punto que en realidad cortaron WinHelp de Vista.

Ahora, CHM puede ser agradable, pero todos los que intentaron abrir un archivo .chm en la red sabrán la buena pantalla de "Se canceló la navegación a la página web" causada por restricciones de seguridad.

Si bien hay formas de hacer que CHM funcione fuera de la red, esta no es una buena opción, ya que cuando un usuario presiona el botón Ayuda, quiere ayuda y no tiene que realizar algunas configuraciones funky.

Conclusión: considero que CHM es absolutamente inutilizable. Pero como WinHelp ya no es una opción, me pregunto cuáles son las alternativas, especialmente cuando se trata de integrar con mi aplicación (es decir, para WinHelp y CHM hay funciones que le permiten pasar directamente a un tema).

PDF tiene la desventaja de requerir Adobe Reader (o uno de los más ligeros que no mucha gente usa). Podría vivir con eso, ya que esto es una especie de estándar hoy en día, pero ¿puedes decir de manera confiable que saltes a una página / ancla determinada?

Los archivos HTML parecen ser la mejor opción, entonces solo tienes que lidiar con diferentes navegadores (CSS y demás).

Editar: Estoy buscando crear mis propios archivos de ayuda. Como soy fanático de la filosofía "Sin configuración, solo extraer y ejecutar", tuve ese problema muchas veces en el pasado porque muchos de mis usuarios lo ejecutarán fuera de la red, lo que causa exactamente este problema.

Así que estoy buscando una forma más robusta y a prueba de futuro para proporcionar ayuda a mis usuarios sin tener que codificar un sistema de ayuda diferente para cada aplicación que hago.

CHM es un formato realmente agradable, pero Security Stuff lo hace inutilizable, ya que se supone que un sistema de Ayuda brinda ayuda al usuario, no para generar aún más problemas.

¿La pregunta es cómo generar sus propios archivos de ayuda, o cuál es el mejor formato de archivo de ayuda?

Personalmente, considero que CHM es excelente. Una de las primeras cosas que hago al configurar una máquina es descargar el Manual de PHP en formato CHM ( http://www.php.net/download-docs.php ) y agregarle una tecla de acceso directo en Crimson Editor . Así que cuando presiono F1, carga el CHM y realiza una búsqueda de la palabra en la que está mi cursor (ideal para una función de referencia rápida).

HTML sería la siguiente mejor opción, SOLAMENTE SI los atenderías desde un servidor web público. Si trataste de agruparlo con tu aplicación, todos los archivos (e imágenes (y hojas de estilo (y ...))) harían que CHM parezca un regalo de los dioses.

Dicho esto, cuando en realidad estaba incluido en el paquete de instalación, (en lugar de ser servido en la red), encontré que los archivos CHM funcionan bien.

OTOH, otra trampa sobre los archivos CHM: incluso si intenta abrir un archivo CHM en un disco local , puede toparse con el bloque de seguridad si lo descargó inicialmente de alguna parte, porque el archivo podría marcarse como "proviene de una fuente externa" cuando fue obtenido.

Nuestro software se distribuye localmente a los clientes y se sirve desde un recurso compartido de red. Optamos por generar un archivo CHM y un conjunto de archivos HTML para servir desde la red. Los usuarios que inician el programa de forma local utilizan el archivo CHM, y los usuarios que reciben su programa desde un recurso compartido de red deben usar los archivos HTML.

Usamos Ayuda y Manual y podemos producir fácilmente ambos tipos de resultados desde el mismo proyecto fuente. Los archivos HTML también contienen capacidades de búsqueda y no requieren un servidor web, por lo que aunque no es una solución óptima, funciona bien.

Hasta ahora, todos los tipos de archivos únicos para Windows parecen estar rotos de una forma u otra:

WinHelp - obsoleto
HtmlHelp (CHM): obsoleto en Vista, no funciona desde la red compartida, aparte de eso funciona muy bien
Microsoft Help 2 (HXS): parece funcionar hasta el momento en que no funciona, los índices dañados o similares, esto es utilizado por Visual Studio 2005 y versiones posteriores, como ejemplo

Si está haciendo "solo extraer y ejecutar", se ejecutará en problemas de seguridad. Esto es especialmente cierto si sus usuarios ejecutan Vista (o posterior). ¿Hay alguna razón por la cual quisiera evitar empaquetar sus aplicaciones dentro de un instalador? Usar un instalador aliviaría el problema de la "fuente externa". Podrías usar archivos .chm sin ningún problema.

Usamos InstallAware para crear nuestros paquetes de instalación. No es barato, pero es muy bueno. Si el costo es su preocupación, WIX es de código abierto y bastante robusto. WIX tiene una curva de aprendizaje, pero es fácil trabajar con ella.

Si no desea utilizar un instalador y no desea que el usuario realice ningún paso adicional para permitir archivos CHM a través de la red, ¿por qué no recurrir a WinHelp? Vista no incluye WinHlp32.exe de fábrica, pero está disponible como descarga para Vista y Server 2008.

PDF tiene la desventaja de requerir Adobe Reader

Uso Foxit Reader en Windows en casa y en el trabajo. Mucho más pequeño y muy rápido para abrir. Muy útil cuando te preguntas qué es exactamente a80000326.pdf y por qué está obstruyendo tu carpeta de documentos.

Utilizo un paquete comercial llamado AuthorIT que puede generar varios formatos diferentes, como chm, html, pdf, word, windows help, xml, xhtml y algunos otros que nunca he escuchado (¿suena el timbre de dita?). Es un sistema de gestión de contenidos orientado a las necesidades de los redactores de documentación técnica. La ventaja es que puede usar y reutilizar el mismo contenido para compilar un conjunto de guías y luego generarlas en diferentes formatos.

Entonces, la cuestión fundamental de elegir chm o html o lo que sea es que si está utilizando esto no está bloqueado en un formato determinado, pero puede proporcionar varios entre los que el usuario puede elegir e incluso puede agregar más formatos a medida que avanzas, sin costo adicional.

Si solo tienes una guía para crear, no valdrá la pena, pero si tienes una documentación configurada para administrar, es lo mejor que yo sepa. Su apoyo es muy útil también.

Depende de la importancia de la importación de la documentación en línea para su producto, una buena infraestructura de documentación puede ser compleja de establecer, pero una vez que se realiza, vale la pena. Así es como lo hacemos -

Fuente de ayuda DITA compilant XML, almacenado en SCC (ClearCase).
Ayuda a editar XMetal
Compilación de ayuda, personalizado Open DITA Toolkit , con preprocesamiento Perl / Java personalizado
El recurso de la ayuda hace referencias cruzadas a los recursos de las aplicaciones en tiempo de compilación, archivos .RC, etc.
Entregables de ayuda de fuente única, PDF, CHM, Ayuda de Eclipse , HTML.
El repositorio de origen único produce ayuda para múltiples productos 10+ con miles de temas compartidos.

De lo que describes, miraría Eclipse Help, no es fácil de integrar en aplicaciones .NET o MFC, básicamente tienes que hacer el mapeo de ayuda para resolver la solicitud a una URL y luego abrir la URL a la envoltura de Ayuda de Eclipse o a un navegador.

Creo que la solución con la que vamos a terminar nuestra aplicación es alojar los archivos de ayuda nosotros mismos. Esto nos da acceso inmediato a los archivos y la capacidad de mantenerlos actualizados.

Lo que planeo es cargar el contenido en una gran serie de archivos XML, cada uno de los cuales contiene ayuda para un elemento específico. Este XML contendría enlaces a otros archivos XML. Utilizaríamos XSLT para mostrar los contenidos según sea necesario.

Dependiendo de la licencia, podemos construir un archivo XSLT específico del cliente para adaptar la apariencia a lo que necesitan. Es posible que necesitemos poder mostrar solo ayuda para versiones particulares de nuestro producto y eso se puede hacer filtrando cosas en el XSLT.

No me gusta la opción html, y de hecho se movió de HTML simple a CHM al comprimirlos e indexarlos. Incluso úselas en un puñado de clientes que no sean de Windows, incluso. Simplemente resolvió la constante y pequeña rotura de gente poniéndola en la red (profundidad de anidamiento, efectos de bloqueo extraños), antivirus que murió en directorios con archivos de 30000 html y 20 minutos de tiempo de descompresión mientras se instalaba en un sistema anterior, zonas de seguridad del navegador y características, errores de cálculo del espacio necesario en el instalador, etc.

Y luego ni siquiera incluyo a las personas que comienzan a "corregirlas", productos de terceros con intentos de "integración" defectuosos, etc., quejas sobre la lentitud (inicio del navegador)

Todos habíamos esperado años para que los problemas desaparecieran a medida que los sistemas operativos y el hardware mejoraban, pero los problemas seguían repitiéndose en un número deslumbrante de variedades y ya era suficiente. Encontramos chmlib, y decidimos que podríamos utilizar algo basado en esto como escape con un simple lector externo, si el sistema operativo provisto dejó de funcionar y cambió.

Mientras tanto, también tenemos un compilador propio, por lo que estamos libres de MS a prueba de futuro. Eso no significa que nunca cambiaremos (las soluciones con servidores web locales parecen ser las favoritas hoy en día), pero al menos tenemos una opción.