44
Guía general de estilo, Versión 1 Febrero 1999
necesario. La tabla siguiente es un ejemplo de las convenciones tipográficas
utilizadas, generalmente, en la documentación de Sun:
Verificación del código SGML
Hay dos métodos para verificar el código SGML.
1.
Mediante Check Completeness en Adept.
Es muy sencillo; sólo tiene que abrir el archivo Book e ir a Tools -> Check
Completeness. Esto verificará que todo el manual posea SGML válido. Cuando
termine, aparece un cuadro de diálogo en pantalla. Los posibles errores se
muestran bajo los títulos Object in error y Nature of error. Haga doble clic
en el error subrayado si quiere ir a la línea que está provocando el problema.
2.
Mediante una herramienta de Sun denominada doclint.sgml.
Es mucho más rápida que utilizar Adept para verificar el código y debe
ejecutarse en todas las entregas de Sun. En la línea de comandos (asegúrese de
que estén cerrados todos los archivos en Adept) escriba:
doclint.sgml nombremanual.book
Se crea un archivo de registro automáticamente, que contiene los resultados
generados desde doclint y le proporciona una calificación: aprobado
Tipo de letra o
símbolo
Significado
Ejemplo
AaBbCc123
Nombres de los comandos,
archivos y directorios; -salida
por pantalla del computador
Edite su archivo .login.
Utilice ls -a para ver una lista de
todos los archivos.
nombre_máquina% Tiene
correo.
AaBbCc123
Lo que usted escribe,
contrastado con la salida por
pantalla del computador
nombre_máquina% su
Contraseña:
AaBbCc123
Plantilla de línea de
comandos:
sustitúyala por un nombre o
valor real
Para eliminar un archivo, escriba
rm nombre-archivo.
AaBbCc123
Títulos de los manuales,
palabras o términos nuevos o
palabras destacables
Lea el Capítulo 6 de la Guía del
usuario. Estas opciones se
denominan opciones de clase.
Para hacer esto debe ser el usuario
root.