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
"Ayuda en Ayuda".
\help\docinfo\bi\nls\%LANG%.bi
Almacena archivos de estanter¡a, para usar con la herramienta de
estanteria de Aitor, para crear el indice de idioma (\help\index.htm).
Crear archivos de ayuda comprimidos:
Debe utilizar para su archivo comprimido establecer un nombre como:
\help\...\[nombre]\[nombre].zip
Si desea comprimir sus archvos de ayuda, debe estar en formato zip.
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
estructuras de directorio est n permitidas dentro del archivo sip. Sin
embargo, el cifrado y algunos de los m‚todos de compresi¢n m s antiguos
y oscuros no son compatibles.
Crear versiones modificadas de los archivos de ayuda:
Use un t¡tulo distinto en p gina de t¡tulo (a menudo index.htm) en
cualquier versi¢n modificada. Esto es para evitar confusiones o
conflictos, y los m s importante, es necesario seg£n la Parte 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 de documentaci¢n libre de GNU 1.1. 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 \ayuda". 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 de 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 carga
sus archivos de ayuda en un sitio web, las direcciones de correo
electr¢nico pueden estar sujutas a spam. 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 una versi¢n aditada y sin comprimir de un archivo,
debe reemplazar o eliminar la versi¢n original dentro de ese archivo
zip.
Prueba de 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 cromo.
Crear tablas:
Lamentablemente, la ayuda no admite etiquetas de tablas. Utilice las
etiquetas de formato previo <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.
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 relacionado con la carpeta /HELP:
help /L[subdirectorio]nombre_archivo[.htm]
Ver tambi‚n:
Etiquetas compatibles con la Ayuda HTML
Recursos de autor¡a
Copyright © 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