qué - xml desventajas
XML para documentación-Estándares? (6)
¿Qué lenguaje de programación estás usando? En el caso de .NET, existen herramientas (como sandcastle) que transforman la documentación XML creada por visual studio. Si está usando Java, creo que hay grandes herramientas que hacen lo mismo (Doxygen).
La mayoría de esas herramientas crean el sitio web chm y html de su documentación.
Necesito crear Documentación para una herramienta (Documentación de usuario escrita manualmente, sin Documentación de desarrollador / API de los Archivos de origen). Ahora, hay alrededor de mil millones de maneras diferentes de hacerlo, pero tengo los siguientes requisitos:
- Necesita ser un archivo físico, para que pueda ir a SVN
- Necesita ser imprimible
- Necesita ser legible y buscar desde la Web
- Necesita poder incluir Imágenes y formato básico (Titulares)
- Opcional: Necesita admitir enlaces en línea (Tabla de contenido => Encabezado)
Los documentos Word o PDF cumplen la mayoría de los parámetros, pero no son realmente legibles desde la web. Una solución basada en web no es realmente imprimible.
Así que mi idea es tener un archivo central que solo incluya contenido, y luego alguna herramienta que pueda generar resultados en PDF y adicionalmente en HTML.
Ahora, LaTeX viene a la mente, pero esto es un poco exagerado. Pensé en tal vez algún XML y luego el procesamiento XSLT? La razón para querer XSLT también se debe a que puedo usar el elemento web XML Viewer dentro de Sharepoint para mostrarlo.
Como no tengo mucha experiencia y no quiero reinventar la rueda, me pregunto si ya hay algún tipo de esquema XML "estándar" para documentos y XSLT estándar. y como bonificación, una conversión de PDF?
Sé que puedo construirlo solo, pero ¿quizás uno de los mil millones de Estándares XML ya especifica un "Esquema XML de Documentación"?
Fop te permitirá pasar de xml a pdf con un poco de trabajo
http://xmlgraphics.apache.org/fop/
un ejemplo del uso de fop dado aquí http://alistapart.com/articles/usingxml/ Busque la sección "Conversión a impresión".
Para mí, HTML se siente como una mejor solución, ¿cuán complejo es el diseño de estas cosas?
Puede usar CSS para diseñar específicamente para imprimir, no solo para mostrar la pantalla.
html? (.chm si quieres)
docbook es probablemente lo que quieres.
DocBook XML y cadenas de herramientas de código abierto
Acabo de publicar una respuesta a una consulta similar que describe cómo usamos DocBook XML como parte de nuestra cadena de herramientas de código abierto.
Enlace: DITA vs Wiki vs CMS vs?
Para sus necesidades, este estilo de cadena de herramientas sería una opción. Aunque ya no uso Subversion para el control de versiones, y me he mudado a un CCMS interno , definitivamente es un estándar para controlar el contenido de DocBook XML en todos los equipos. Del mismo modo, el uso de una herramienta como Publican para sus esfuerzos de abastecimiento único resuelve el problema de crear resultados web, impresos y PDF.