Escribir una guía de aplicación
Objetivo
Dé a su aplicación su propia ayuda. Este sitio de ayuda explica la plataforma: cómo funciona una vista y cómo se guarda un formulario. No puede explicar su aplicación, por ejemplo cómo registra su club una reserva. Una guía de aplicación es un documento breve en markdown que usted escribe en la solución. Se importa junto con la aplicación, aparece en el menú Ayuda de la aplicación y un botón de una pantalla puede abrirla.
Requisitos previos
- Ha iniciado sesión como creador y ha seleccionado una solución y un entorno.
- La aplicación para la que es la guía está en el entorno. Puede ser una aplicación basada en modelos o una aplicación de Studio.
Pasos
- Abra su solución y elija Guías de la aplicación.
- Seleccione Nuevo. El diseñador se abre con un ejemplo breve.
- Escriba un Título, por ejemplo Registrar una reserva. El Nombre se rellena mientras escribe. Las pantallas y los comandos abren la guía por este nombre, así que no se puede cambiar después de guardar.
- En Aplicación, elija la aplicación cuyo menú Ayuda debe incluir la guía. Déjelo vacío para una guía que solo se abre por su nombre.
- Orden fija el lugar de la guía en ese menú. Los números más bajos van primero.
- Escriba la guía en el editor. La vista previa junto a él es exactamente lo que verá el lector.
- Seleccione Guardar.
Escribir en markdown
| Usted escribe | El lector ve |
|---|---|
## Section | Un encabezado |
**bold**, *italic* | negrita, cursiva |
1. Step | Una lista numerada |
- Item | Una lista con viñetas |
`code` | code |
[text](https://example.com) | Un enlace que se abre en una pestaña nueva |
[text](guide:psl_guide_bookings) | Un enlace a otra guía |
 | Una imagen de la web |
También funcionan las tablas, las citas y los bloques de código.
El HTML se muestra como texto. Una guía nunca puede ejecutar scripts, y un enlace solo se abre si
empieza por http, https, mailto o guide:.
Otros idiomas
El inglés es obligatorio. Cada otro idioma de la plataforma tiene una pestaña al lado, y todos son opcionales. Un idioma sin texto muestra un punto tras su nombre. Sus lectores ven la guía en inglés, con una nota que dice que no se ha traducido. Puede dar a una traducción su propio título, o dejarlo vacío para usar el inglés.
Abrir una guía desde una pantalla o un comando
-
Una pantalla de Studio dibujada. Dé a un botón este controlador de clic:
openGuide("psl_guide_bookings");La guía se abre en un panel junto a la pantalla, para que el lector la siga y siga trabajando.
-
Un formulario o una vista. Añada un comando. En Al pulsarlo, elija Abrir una guía y seleccione la guía.
-
Otra guía. Enlácela:
[how to cancel](guide:psl_guide_cancel).
Si una pantalla nombra una guía que no existe, no se abre nada. La lista de problemas de la pantalla y el mensaje del comando nombran la guía que se buscó.
Viaja con la solución
Una guía es un componente de la solución, como una tabla o un script. Al exportar la solución se exporta la guía en todos sus idiomas. Al importarla, la guía aparece en el menú Ayuda del entorno de destino, y al desinstalar la solución se elimina.
Resultado esperado
En el Shell, al abrir la aplicación, Ayuda en la barra superior se convierte en un menú. Primero aparecen las guías de la aplicación y después la ayuda de la plataforma. Al elegir una guía, se abre junto a la página.