2008-12-29 11 views
19

Parece que los archivos de ayuda de CHM ya no son el formato de archivo de ayuda de elección.La dirección futura de los formatos de archivo de ayuda

WinHelp
- obsoleta

HtmlHelp (CHM)
- no es compatible con Vista por defecto
- no funciona bien en un recurso compartido de red

Ayuda 2 (HXS)
- I Entender esto se utiliza en VS2005 + para mostrar la ayuda

basada en web
- Podría ser difícil administrar para múltiples versiones

¿Qué formato de archivo de ayuda usarías en una nueva aplicación (C#) que proporciona múltiples versiones de la misma base de código?

Nos gustaría usar CHM ayuda sin embargo, no parece ser la dirección que Microsoft quiere que mudarse.

¿Alguien emplean HXS por sus archivos de ayuda?

Feeback apreciado


actualización en base a los comentarios lassevk;

Parece que la ayuda de HXS no está destinada para ser utilizada en proyectos de ayuda normales.


Respuesta

4
this.Mode = Modes.Rant; 

Hay enormes problemas con casi todos los formatos de archivos de ayuda porque no parece los fabricantes (por lo general de Microsoft para un buen número de ellos) a querer hacer un trabajo más que ligeramente lo suficientemente bueno para su propio uso.

No puedo decirle cuántas veces el nuevo formato HXS ha rociado completamente mi ayuda de Visual Studio cuando los terceros se integran. Se podría decir que esto es culpa de las herramientas de instalación de terceros, pero durante bastante tiempo hubo no documentación sobre cómo hacer esto, por lo que tuvieron que elegir entre la ingeniería inversa (y hacerlo mal, a veces) o no integrando en absoluto. Todavía no sé si la integración funciona, pero en estos días solo cambio Visual Studio para usar la ayuda en línea. Simplemente funciona, en su mayoría, mientras que la ayuda integrada invariablemente cae en esa barra de progreso que bloquea Visual Studio hasta que ha reconstruido el archivo de ayuda, excepto que no lo hizo porque los archivos ahora están corruptos, por lo que siempre que golpeo F1, Visual Studio simplemente se bloquea a menos que mate el programa DEXPLORE varias veces.

Cómo esto terminó como una solución a cualquier problema, todavía no lo sé.

En segundo lugar, las herramientas deben estar presentes. El visor de CHM está presente en la vista previa, no en Vista, pero las herramientas necesarias para mostrar HXS no están presentes en la vista previa, pero creo que están en Vista. Bien, ahora puedo elegir entre usar un formato que necesita ser instalado a la medida en la computadora de los usuarios, o ... errar, otro que necesita ser instalado a la medida en las computadoras de otros usuarios. Derecha.

this.Mode = Modes.JustTicked; 

Donde trabajo enviamos archivos CHM, y una versión HTML basado en archivos para los que desplegar sus aplicaciones a través de un recurso compartido de red. En cuanto a Vista, aún no hemos visto mucho de eso, pero la versión html también funcionaría allí.

Preferiría tener una brillante ayuda archivo embargo.

Un buen resultado de la versión html es que podemos vincular en los mismos archivos en el módulo web que sigue a nuestro producto. De esta forma, solo habría una versión que el cliente necesita.

Estamos buscando actualizar la herramienta que usamos en el trabajo, así que en mi agenda para esta semana, agradable y tranquila en el trabajo, voy a ver los diversos tipos de resultados que puede producir, entre otras cosas, HXS.


Editar: Hmm, un rápido vistazo a las páginas de ayuda de ayuda y manual, el producto se utiliza, tiene this to say about HXS:

Ayuda de Visual Studio es también conocida como MS Ayuda 2.0. Originalmente, este formato de ayuda estaba destinado a ser el sucesor de la Ayuda HTML. Sin embargo, Microsoft pospuso su lanzamiento indefinidamente y ahora está claro que nunca se lanzará como un formato de ayuda para las aplicaciones de usuario normales.

Tenga en cuenta que este es un formato de ayuda especial que solo se utiliza para documentar componentes de programación de terceros diseñados para la integración en Visual Studio .NET. ¡No es adecuado para ningún otro propósito y no se puede usar para proyectos de ayuda normales para programas de aplicación!

Creo que HXS está completamente fuera de la mesa en ese momento.


Nota: basado en la web no significa necesariamente que se necesita un servidor web , sólo que usted necesita un navegador web . Ya sea que integre en su aplicación, utilizando un componente de navegador web, o si acaba de iniciar el navegador predeterminado de los usuarios, esa sería una opción que tendría que hacer, pero la mayoría de los resultados de ayuda basados ​​en web que he visto no requieren ninguna configuración del servidor en absoluto.

+0

gracias ... parece HXS es ​​totalmente fuera de los límites. – Helios

+0

Quizás solo tengamos que esperar a que Windows 7 descubra qué van a hacer allí. Y luego, nuevamente, en Windows 8. ...: D –

4

Para mí, CHM sigue siendo la respuesta. Construyo archivos CHM con el Sandcastle Help File Builder tool que está disponible en Codeplex.

Las preocupaciones sobre el acceso de CHM son válidas. Para abordar eso, produje un convertidor de CHM a la Web con bastante facilidad, con algunos hackers de IStorage, una búsqueda y reemplazo de texto y una transformación XSL. This page es un sitio web que se produjo automáticamente en aproximadamente 8 segundos. Tiene una vista de árbol expand/collapse en el navegador del lado izquierdo. Marcos basados ​​(no muy amigables para URL) pero funcionan lo suficientemente bien.

2

La única documentación de ayuda útil que he visto ha sido HTML sin formato. La mayoría, si no todos, de los proyectos de código abierto que he visto tienen páginas de ayuda HTML (para API y documentos de referencia). Todo lo que use un formato propietario o que requiera un lector propietario correrá el riesgo de quedarse obsoleto (CHM) o tener problemas de compatibilidad o hinchazón (PDF).

Por alguna razón, Microsoft es simplemente malo en los archivos de ayuda.La ayuda en línea para Visual Studio/SQL Studio/Office es terrible, MSDN es un desastre, los CHM son torpes y la búsqueda de Microsoft nunca arroja los resultados que realmente desea. (Solo mi opinión :)

+2

Los CHM son solo HTML indexados y comprimidos. Hay lectores de código abierto y (de) compresores –

1

Adobe RoboHelp puede usarse para autorizar contenido de ayuda que tiene contenido/índice/búsqueda/glosario y funciona en un navegador como HTML. Admite 35 idiomas.

Tenemos una aplicación web basada en Flex que usa esto para administrar el contenido de ayuda de la aplicación. La aplicación Flex y su sistema de ayuda funcionan en la mayoría de los navegadores en Windows/MacOSX/Linux.

10

¿Qué hace exactamente que piense que no hay un .chm viewer predeterminado en Windows Vista? (Hay sin duda es uno en mi equipo, así como en mi caja de Windows 7)

que te pueden confundir con .chm Hlp (Microsoft efectivamente cayó Hlp apoyo en Vista, a continuación, finalmente reanudado en una actualización de las ventanas)

en pocas palabras: los archivos .chm parecen estar todavía apoyado en todas las versiones de windows, y la única alternativa real a los archivos .chm que conozco es .html

1

Algunos pensamientos actualizados para cualquier persona sin dejar de leer esta pregunta ...

Según Wikipedia, Microsoft decidió Microsoft Assistance Markup Language después de abandonar una Ayuda 2.

Existe también Microsoft Help System, que es lo que se distribuye con Visual Studio 2010.

Cuestiones relacionadas