Escribir para el sistema de ayuda HTML:
Las contribuciones son muy bienvenidas. Si desea hacer una contribución
al sistema de ayuda HTML, póngase en contacto con el responsable de
mantenimiento:
fritzdotmuelleratmaildotcom
La estructura del directorio \help:
\help\index.htm
Enumera los idiomas de ayuda instalados en el sistema. Se carga
automáticamente si LANG no está configurado en un idioma disponible
y el inglés (EN) no está instalado.
\help\%LANG%\index.htm
HELP cargará esto por defecto. %LANG% es el idioma seleccionado al
configurar la variable de entorno LANG. Si LANG no está configurado,
se supone EN.
\help\%LANG%\help.htm
HELP cargará esto cuando el usuario presione F1 o haga clic en
"Sobre la Ayuda".
\help\docinfo\bi\nls\%LANG%.bi
Almacena archivos de estantería, para usar con la herramienta de
estanteria «bookshlf» de Aitor, para crear el indice de idioma (\help\index.htm).
Crear archivos de ayuda comprimidos:
El formato del conjunto de archivos comprimidos debe ser:
\help\...\[nombre]\[nombre].zip
Si desea comprimir sus archvos de ayuda, deben estar en formato zip.
También debe tener el mismo nombre de archivo que el directorio en el que están
almacenados y la extensión zip. Por ejemplo:
\help\en\mi_ayuda\mi_ayuda.zip
Index.htm puede estar dentro del archivo zip, pero la ayuda y la
herramienta de estantería funcionarán mejor si no lo está. Las
subcarpetas están permitidas dentro del archivo zip. Sin
embargo, el cifrado y algunos de los métodos de compresión más antiguos
y ofuscados no son compatibles.
Crear versiones modificadas de los archivos de ayuda:
Use un título distinto en la página inicial (a menudo index.htm) en
cualquier versión modificada. Esto es para evitar confusiones o
conflictos, y lo más importante, es necesario según la Sección 4A de la
Licencia de Documentación Libre de GNU 1.1. Además de cambiar el título,
actualice el historial, la lista de autores, etc., de acuerdo con la
sección 4 de la licencia. Si el
conjunto de archivos está destinado a describir un paquete nuevo o
modificado, o si el conjunto de archivos sufre un cambio fundamental
(por ejemplo, una traducción), entonces es mejor usar un nombre de
subdirectorios distinto, como se explica arriba en
«La estructura del directorio \help:». Esto es simplemente una cuestión
de buscar y reemplazar el nombre del subdirectorio en index.htm, y vale la pena.
Por ejemplo, una versión simplificada del conjunto de archivos "hhstndrd"
podría llamarse "hhmicro". Este sería el nombre del subdirectorio, y el
título en index.htm podría ser:
FreeDOS Hilfe (hhmicro 1.0)
Es razonable cambiar solo el número de versión (en lugar del nombre y
el directorio "hhmicro") al publicar actualizaciones.
Crear o agregar nuevos archivos:
Se recomienda que el siguiente mensaje de licencia se coloque al final
de cualquier archivo de ayuda nuevo (a menos que sea un archivo
independiente, no incluido en un conjunto de archivos de ayuda):
...
<hr>
<address>
<b>Copyright © 2008
<a href="mailto:miemail@address.com">Mi nombre</a></b><br>
Este archivo forma parte de la documentación de ayuda HTML de FreeDOS
y está cubierto por sus términos, consulte:
<a href="../index.htm">index.htm</a>
</address>
</body>
</html>
Proporcionar un correo electrónico es completamente opcional; Si sube
sus archivos de ayuda en un sitio web, las direcciones de correo
electrónico pueden estar sufrir ataques. Los términos son la Licencia
de Documentación Libre de GNU 1.1.
Edición de un archivo almacenado en un zip:
Es posible que desee descomprimir los archivos html para que puedan
leerse con otro navegador o editarlos. Los archivos zip generalmente
tienen prioridad sobre los archivos sin comprimir; Si desea asegurarse
de que la ayuda lea su versión modificada y sin comprimir de un archivo,
debe reemplazar o eliminar la versión original dentro del archivo zip.
Probar los archivos de ayuda:
Los navegadores de referencia para probar los archivos de ayuda son:
* el visor de ayuda HTML de FreeDOS (help.exe)
* un derivado de Chrome.
Crear tablas:
Lamentablemente, la ayuda no admite etiquetas de tablas. Utilice las
etiquetas de formato <pre> </pre> para las tablas de
información.
Consejos generales:
Presione F5 o Ctrl+R para actualizar el archivo que muestra la ayuda.
Los efectos de los cambios en el archivo se pueden ver de inmediato.
Es util al editar archivos de ayuda en un entorno de tipo Windows. Para
usar el Visor de ayuda HTML para ver archivos que aún no estén
integrados en el conjunto de archivos, se puede usar el interruptor de
anulación de ruta de ayuda:
help /O[unidad:][ruta]nombre_archivo[.htm]
o si está dentro de la carpeta /HELP:
help /L[subdirectorio]nombre_archivo[.htm]
Véase también:
Etiquetas compatibles con la Ayuda HTML
Recursos de autoría
------------------------------------------------------------------------------
Copyright (C) 2003-4 Robert Platt, Modificado en 2008 por W. Spiegl.
Traducido en 2020 por Lorenzo del Toro Saravia.
Este archivo forma parte de la documentación de ayuda HTML de FreeDOS y
está cubierto bajo sus términos: ver index.htm