DocumentaciónAyuda

Mostrar el centro de ayuda dentro de otro sitio

Autoriza a tu producto o tu sitio web a mostrar el centro de ayuda dentro de su propia página, en un iframe y sin la marca ni el pie.

En esta página

Por seguridad, el centro de ayuda no se puede mostrar dentro de la página de otro sitio. Si quieres que tu producto muestre un espacio en un panel o una ventana (un iframe), autoriza la dirección de tu producto en ese espacio.

La autorización es por espacio: si tu centro de ayuda tiene varios espacios (por ejemplo, uno por producto), cada producto puede mostrar solo el suyo. La portada del centro de ayuda y los demás espacios no se pueden mostrar desde ese sitio.

Antes de empezar

Autorizar un sitio en un espacio

  1. Entra a Configuración → Centro de ayuda y abre la pestaña Sitio.

  2. En la tarjeta Espacios incluidos, busca la fila del espacio.

  3. En la columna Mostrar en iframe desde, escribe la dirección de tu producto, por ejemplo https://app.miproducto.cl. Una por línea, hasta 10.

  4. Presiona Guardar espacios.

Escribe solo el comienzo de la dirección: https:// y el dominio, sin rutas. Los sitios que no estén en la lista del espacio no pueden mostrarlo.

Mostrar solo el contenido

Agrega ?embed=1 a la dirección del iframe, por ejemplo https://ayuda.miempresa.cl/manual/primeros-pasos?embed=1. Dentro del iframe:

  • se ve solo el contenido y el menú de ese espacio, sin el logo, el pie ni los otros espacios;

  • la búsqueda busca solo en ese espacio;

  • si una página enlaza a otro espacio o a la portada, se abre en una pestaña nueva, fuera de tu producto.

Tema e idioma

  • Tema: agrega &theme=dark o &theme=light a la dirección para que el centro de ayuda use el mismo tema que tu producto. Si el usuario cambia el tema con la ayuda abierta, tu producto puede avisarle al iframe con iframe.contentWindow.postMessage({ type: 'ultrion-help-theme', theme: 'dark' }, 'https://<tu centro de ayuda>') y cambia sin recargar.

  • Idioma: si tienes el manual en varios idiomas, cada idioma es un espacio (por ejemplo, /manual, /manual-en, /manual-pt). Elige el Idioma de cada espacio en Espacios incluidos: el menú, la búsqueda y los textos del centro de ayuda se muestran en ese idioma. Tu producto abre el espacio del idioma del usuario.

  • Cualquier sitio: si tu producto se instala en direcciones que no conoces (por ejemplo, instalaciones en los servidores de tus clientes), escribe https: en Mostrar en iframe desde: cualquier sitio https podrá mostrar ese espacio.

Agrega fuera del iframe un enlace Abrir en otra pestaña con la misma dirección sin ?embed=1, para quien quiera leer con más espacio.

Qué pasa después

Los cambios valen para todas las páginas del centro de ayuda en unos minutos.

Relacionado

Buscar en Elion ITSM

Escribe al menos 2 letras para buscar en Elion ITSM.

↑↓ moverse · Enter abrir · Esc cerrar