Los artículos de ayuda, no son otra cosa que instancias de una extensión del tipo de contenido página, con taxonomía externa a la taxonomía general y con bloqueos de software que las separan del sistema de contenidos, para evitar que hagan ruido. Pero, brindan un ejemplo de lo que se puede hacer con los tipos de contenido y los componentes más simples del conjunto ofrecido. Debe entrar al formulario de preferencias de ayuda para configurar su presentación
Establecer la página de inicio de la ayuda
Se ofrece un grupo de 4 opciones mutuamente excluyentes para establecer qué página es mostrada cuando un usuario hace click en el enlace de menú que invoca el sistema de ayudas. Cuando se elige alguna de ellas aparecen o se ocultan algunos juegos de campos complementarios para hacer ajustes a la preferencia electa.
- Tópicos de ayuda
Esta es la página por defecto. Muestra la lista de tópicos definidos, con enlaces a las páginas de artículos vinculados con ellos. (No tiene opciones complementarias)
- Página específica
Permite establecer alguna de las páginas de ayuda creadas como página inicial. Al elegirla se muestra un campo explorador de ayudas que permite elegirla. La página electa se muestra a todos los usuarios que abran las ayudas.
- Página por Rol
Permite establecer una página diferente para cada rol definido. Esto hace posible que los usuarios recorran secciones limitadas de las ayudas, manteniendo la atención en lo que necesitan y sin sentirse invitados a entrar dónde no deben. Es la opción ideal. Abre un juego de campos exploradores para elegir una página para cada rol.
En caso de que un usuario haga parte de dos o más grupos, la ayuda se abrirá mostrando enlaces a las páginas de ayuda electas para todos ellos.
- Artículos accesables
Es la versión barata de caso anterior pero, sin preparar y enlazar secciones y artículos. Cada usuario podrá recorrer, usando la lista de artículos, sólo aquellos que pertenezcan a tópicos vinculados con los grupos a los que pertenece. (No muestra opciones complementarias).
Cuando el sitio esté debidamente configurado y documentado se recomienda que active la opción de página por rol. Debe tener cuidado de asignar una página de ayuda a cada rol. Si algún rol carece de página de ayuda, los usuarios asignados a ese rol recibirán un mensaje de error, si no están asignados a otros grupos.
Preferencias de presentación
Este grupo de opciones le permite fijar algunas de las características usadas para mostrar los listados y artículos de ayuda. Debe probar cambiando sus valores hasta encontrar el formato que se ajuste a sus necesidades.
- Longitud del cuerpo de texto en listados El valor sugerido es 384 caracteres. Determina la posición de recorte de resúmenes en las listas de ayudas, cuando el usuario tiene acceso a ellas.
- Cantidad de ítems en listados de ayudas
Fija la longitud de los listados de consulta de ayudas en las páginas. Determina la paginación de las consultas. El valor por defecto es 15.
Nota Si un grupo de usuarios tiene privilegios de acceso de lectura a las ayudas, sus miembros pueden consultarlas usando enlaces como:
- Altura del bloque que despliega el elemento de ayuda En los listados de artículos vinculados con un tópico, propósito, o tipo, este último se muestra antes que el listado. Se debe limitar la altura de su caja contenedora para evitar que "se robe" el show y quite importancia a la lista. Se sugiere usar valores entre 150 y 300 pixels.
- Modo de presentación de los listados
El modo de presentación de los listados de ayuda impacta su legibilidad. Es un juego de opciones mutuamente excluyentes que determina la apariencia de los ítems de ayuda presentados en los listados de consulta de ayudas. Cada modo tiene algunas opciones asociadas que se ofrecen para ser configuradas en caso de que sea electo.
Debe ensayarlos, navegar las ayudas y finalmente decidir cual se acomoda mejor a su sitio.
- Grilla de paneles
Los items se ofrecen en una grilla de paneles bootstrap ( 1, 2, 3, 4 o 6 columnas ), mostrando títulos en los encabezados, descripción o contenido en las secciones pannel-body y acciones en el footer. Si elige esta opción debe ajustar la longitud de listado a un múltiplo entero de la cantidad de columnas.
- Cantidad de columnas en la grilla Al elegir el modo de grilla se debe establecer la cantidad de columnas. (los valores 1 y 12 se excluyen por no tener mucho sentido).
- Lista de bloques de resumen
Los ítems se presentan en una secuencia de bloques (uno en cada línea) con o sin separador (hr) utilizando el modelo de vistas de resumen de los contenidos. Si elige esta opción debe establecer también:
- Separar los bloques con reglas horizontales (si o no) Marcar si se inserta una regla entre cada par de ítems en el listado (se recomienda marcar la opción).
- Enlazar desde los títulos Al marcar esta opción hace que los enlaces para ver el contenido del elemento de ayuda estén en sus títulos (nombres). Si no lo marca se agregará un enlace del tipo ver más al final del resumen.
- Presentación tabular
Los ítems son mostrados en una tabla, uno en cada línea, con columnas encabezadoras y con una columna para lanzar acciones asociadas con el índice del elemento en su línea, cuando el usuario puede administrar ayudas. Al elegir esta opción se debe establecer también:
- Enlazar desde los títulos Al marcar esta opción hace que los enlaces para ver el contenido del elemento de ayuda estén en sus títulos (nombres). Si no lo marca se agregará un enlace del tipo ver más al final del resumen, que en este caso particular no es muy vistoso ni pertinente.
- Vista de índice
Los ítems son mostrados en una lista, (ordenada, con viñetas o de definiciones) Con su título en la línea principal, y opcionalmente seguido de su resumen. Al elegir esta opción se debe establecer:
- Tipo de lista Se muestra un selector para que elija la que le conviene.
- Incluir resúmenes en la lista Debe decidir si la lista es o no analítica. Si lo es debe marcar la opción.
- Elija cuando se muestran tabs del sistema con las ayudas
Los tabs primarios del sistema de ayudas son el grupo de cuatro pestañas: [Tópicos], [Artículos], [Propósitos] y [Tipos de objeto] que se muestran (por defecto)sobre la zona de encabezado de todas las páginas de ayuda. Aparecen allí para ofrecer un mecanismo de filtrado y búsqueda de ayudas durante las fase de puesta a punto de aplicaciones. Momento, a partir del cual introducen ruido pues dan acceso a ayudas innecesarias para visitantes y usuarios no comprometidos con tareas sensibles.
Estas opciones le permiten quitarlas, dejarlas para tareas de administración o permitir que se muestren a algunos grupos de usuarios. Se recomienda limitarlas a los administradores y desarrolladores si crea grupos para estos últimos.
Si elige la opción Sólo a roles autorizados se mostrará un campo selector de roles para que los elija.
Preferencias de edición de ayudas
Esta sección del formulario le ofrece un grupo de campos para que configure algunos aspectos del formulario editor de ayudas:
- Alternador de ayuda visible por defecto
Debe marcar esta opción para que las ayudas en los campos de entrada sólo se muestren por acción del usuario.
- Cantidad de líneas en el editor del cuerpo de ayuda
Determina la altura inicial de la caja de entrada del cuerpo de la ayuda al abrir el editor. El valor sugerido es 18 líneas. No es muy grande pero tampoco tan pequeño que fastidie la edición.
- Cantidad de líneas en el editor del resumen de ayuda
Se sugiere un valor entre 3 y 7 líneas. El resumen debe ser pequeño y solo dar idea del contenido.
Artículos relacionados