Guía de estilo
De Mozilla Hispano - Documentación
Este documento es una pequeña guía de estilo para escribir documentación en Mozilla Hispano.
Índice de contenido |
[editar] Diferencias idiomáticas
Mozilla Hispano es una comunidad supranacional, que recoge usuarios de todas las variantes es-*. Puesto que las distintas variantes utilizan terminología en ocasiones diferentes, es necesario, cuando se haga uso de un término con distintas acepciones en cada variante mencionar en su primera aparición las demás acepciones. El estilo de citado será:
término usado en el documento (término1 en es-AR, término2 en en es-ES y es-MX, etc.)
Es decir, si un documento está escrito con la terminología es-AR y hace referencia a la funcionalidad conocida en inglés como add-on, se citará así:
...instalar un nuevo agregado (agregado en es-AR, complemento en es-ES)...
[editar] Invocación de teclas
Las menciones a pulsaciones de teclas se harán encerrando entre corchetes el carácter correspondiente a cada tecla. Las teclas modificadores y teclas especiales se nombran de la siguiente forma:
- Alternativa: [Alt]
- Alternativa gráfica: [AltGr]
- Control: [Ctrl]
- Mayúsculas: [Mayús]
- Bloqueo de mayúsculas: [BloqMayús]
- Impresión de pantalla: [ImprPant]
- Bloqueo de desplazamiento: [BloqDespl]
- Pausa: [Pausa]
- Inserción: [Insert]
- Suprimir: [Supr]
- Inicio: [Inicio] (o [Ini])
- Fin: [Fin]
- Retroceso de página: [RePág]
- Avance de página: [AvPág]
- Tabulador: [Tab]
- Borrar: [Borr]
- Bloqueo numérico: [BloqNum]
- Cursor izquierda, derecha, arriba, abajo: [Izda], [Dcha], [Arriba], [Abajo]
- Tecla Windows: [Win]
- Tecla menú: [Menú]
[editar] Rutas de menú
Las rutas de menú en aplicaciones se describirán con una expresión que las preceda indicando que lo son, marcadas en negrita y usando como separador el carácter UTF-8 →, representado por la entidad HTML → (puedes obtener el carácter Unicode correspondiente en Linux pulsando [AltGr]+[i]). Por ejemplo:
...Para abrir un archivo local, elija la opción de menú Archivo → Abrir archivo... y escoja el archivo que desee.
[editar] Botones
Si tienes que indicar la pulsación de un botón, puedes usar la plantilla Boton. Escribe {{Boton|nombre del botón}} para conseguir un estilo CSS de caja que simula un botón. Por ejemplo:
...Para borrar los datos privados debe elegirse la opción de menú
Herramientas → Limpiar datos privados... y, una vez allí, pulsar el botón
Limpiar datos privados.
