Cómo pueden los escritores técnicos incluir código PHP en su documentación online

El PHP(preprocesador de hipertexto) es un potente lenguaje de creación de scripts del lado del servidor que lleva décadas siendo una herramienta esencial para el desarrollo web. Con su capacidad para generar contenido dinámicamente, mejorar la experiencia de usuario, gestionar restricciones de seguridad, aumentar la interactividad o recopilar datos de usuario, se trata de una gran adición para la documentación de usuario online. Gracias al potente y versátil sistema de plantillas de HelpNDoc, ahora es fácil sacar partido a todas estas ventajas: exploremos cómo la incorporación de PHP a la documentación de usuario online puede ayudar a mejorar la experiencia de usuario y ofrecer más participación y mejor retroalimentación. Ya seas un desarrollador web, un escritor técnico o alguien que busca mejorar su documentación online, en este artículo encontrarás información estratégica y consejos valiosos para utilizar HelpNDoc sacando el máximo partido al PHP en tu documentación online.

⚡ Ventajas de añadir código PHP a recursos de ayuda online

Al contrario que el contenido HTML estático, la documentación impulsada con PHP puede proporcionar una experiencia de usuario más segura, dinámica e interactiva, permitiendo a los escritores técnicos satisfacer mejor las necesidades de sus usuarios.

Incorporar PHP a la documentación de usuario online ofrece una mejora considerable por comparación con el contenido HTML estático producido por la mayoría de los programas de creación de documentación de ayuda. Mientras el HTML ofrece una estructura básica para mostrar información, el PHP ofrece funciones dinámicas al permitir generar contenido dinámico, lo que hace la experiencia de usuario más interactiva e interesante. Al contrario que el HTML estático, la documentación de usuario online impulsada con PHP es capaz de recopilar datos de usuario, ofrecer restricciones de acceso del lado del servidor y facilitar una mejor retroalimentación, permitiendo su personalización y adaptación a las necesidades de los usuarios.
Incorporar PHP a documentación de usuario online suele ser una tarea muy desafiante, pero con el software de creación de documentación de ayuda adecuado, se vuelve mucho más fácil: HelpNDoc destaca por su sistema de plantillas potente y versátil, que hace increíblemente fácil añadir código PHP a documentación de usuario online.

🤔 Cómo crear una plantilla HTML personalizada para producir archivos PHP

El software de creación de documentación de ayuda HelpNDoc puede producir múltiples formatos de documentación a partir de un solo proyecto, incluyendo páginas web HTML estáticas completamente operativas. Las plantillas personalizadas permiten personalizar por completo los documentos HTML generados con HelpNDoc para que también incluyan código PHP.

Estos son los sencillos pasos necesarios para crear una nueva plantilla:

1. En la pestaña de HelpNDoc Herramientas, en el grupo Plantillas, haz clic en Editor de Plantillas para abrir la ventana del editor de plantillas
2. Haz clic en el botón + verde y luego en Crear plantilla HTML para crear una nueva plantilla HTML, que inicialmente es una copia exacta de la predeterminada
3. Elige un nombre de plantilla como “Plantilla PHP”

La nueva plantilla ya está creada. Debemos hacer algunas modificaciones para que funcione con código PHP, en la sección Ajustes generales de la plantilla recién creada:

1. Cambia la Extensión predeterminada de archivo a “php”
2. Cambia el Formato de enlace a temas a “%helpid%.php”
3. Cambia el Formato de enlace a marcadores a “%helpid%.php#%anchorname%”

¡Y ya está! Ahora HelpNDoc podrá utilizar la nueva plantilla para producir una página web PHP completamente funcional. Descubre cómo puedes elegir una plantilla para tus disposiciones en HelpNDoc.

😍 Cómo sacar partido al código PHP para crear mejor ayuda online: algunos ejemplos

Ahora que podemos crear una página web PHP dinámica con la herramienta de creación de documentación de ayuda HelpNDoc, vamos a sacar partido a este potente lenguaje de creación de scripts añadiendo scripts PHP personalizados a nuestra documentación online.

🔑 Temas de documentación protegidos con contraseña

Al restringir el acceso a temas delicados o confidenciales, los escritores técnicos pueden asegurarse de que esta información solo pueda ser vista por los usuarios autorizados. Esto ayuda a mantener la privacidad y proteger información delicada.

Ahora que podemos producir una página web PHP completamente funcional, vamos a restringir el acceso a algunas páginas de documentación pidiendo primero una contraseña. Gracias al sistema de biblioteca de HelpNDoc, podemos crear un script PHP reutilizable y ponerlo en cualquier tema para restringir el acceso al mismo. Esta es la manera de hacerlo:

1. En la pestaña Inicio de HelpNDoc, en el grupo Biblioteca, haz clic en Añadir ítem y luego en Añadir código HTML
2. Especifica un Nombre de ítem de biblioteca como “Acceso restringido”
3. Introduce el código HTML/PHP siguiente:

<hr>
<div style="margin:1em">
    <?php
        if(!isset($_GET["pass"]) || $_GET["pass"]!="secret") {
    ?>
        <p>No puedes acceder a esta página.</p>
        <form>
            <div class="form-group">
                <label for="pass">Contraseña:</label>
                <input class="form-control" id='pass' name='pass'></input>
            </div>
            <button type="submit" class="btn btn-primary">Inicio de sesión</button>
        </form>
    <?php
            exit;
        }
    ?>
</div>

4. Haz clic en OK: el ítem de biblioteca ya estará disponible en la biblioteca del proyecto
5. Arrastra y suelta ese ítem de biblioteca en la parte superior de cada tema que necesite ser protegido

¡Y ya está! Vuelve a generar tu documentación y pruébala en un servidor PHP: los visitantes no podrán acceder a las páginas restringidas sin introducir antes la contraseña “secreta”.

💬 Recopila comentarios de los usuarios para mejorar la documentación

Al reunir opiniones de usuarios reales, los escritores técnicos pueden entender mejor los puntos fuertes y débiles de su documentación, así como las áreas que necesitan mejoras.

Está bien poder añadir código PHP personalizado solo a ciertas páginas, pero sería todavía mejor poder añadir automáticamente código PHP a todas las páginas. Vamos a actualizar nuestra plantilla para que haga justo eso y a incluir un sistema de introducción de comentarios en la parte inferior de cada tema:

1. En la pestaña Herramientas de HelpNDoc, en el grupo Plantillas, haz clic en Editor de Plantillas para abrir la ventana del editor de plantillas
2. Selecciona tu plantilla PHP en la lista
3. Navega hasta la sección Archivos de script
4. Selecciona el archivo de script “topics.pas.html” y haz clic en Editar script para abrir el editor de scripts integrado de HelpNDoc
5. Localiza la cadena <footer> en ese archivo y añade el código siguiente justo a continuación:

<hr>
<div style="margin:1em">
    <?php
        if(isset($_POST["feedback"])) {	
            $from = "support@example.com";
            $to = "support@example.com";
            $headers = "De: $from";
            $subject = "Nuevo comentario ";
            $message = "Nuevo comentario para el tema: <% print(aTopicList[nCurTopic].caption); %>\n\n" . $_POST["feedback"];
            mail($to,$subject,$message,$headers);
            echo("<p>¡Gracias por tu comentario!</p>");
        }
        else {
    ?>
            <form method="POST">
                <div class="form-group">
                    <label for="feedback">Comentario:</label>	
                    <textarea class="form-control" id="feedback" name="feedback" rows="3"></textarea>
                    <small class="form-text text-muted">Comparte con nosotros cualquier comentario que tengas sobre este tema</small>
                </div>
                <button type="submit" class="btn btn-primary">Enviar comentario</button>
            </form>
    <?php
        }
    ?>
</div>

Genera tu documentación y pruébala: ¡ahora incluye un sistema básico pero funcional de envío de comentarios! 🤯

Añadir código PHP a documentación de usuario en línea puede tener muchísimas ventajas, incluyendo la capacidad para añadir contenido dinámico, proteger con contraseña los temas delicados y recopilar comentarios de los usuarios. El potente y versátil sistema de plantillas de la herramienta de creación de documentación de ayuda HelpNDoc hace muy fácil lograr estos objetivos, permitiendo a los escritores técnicos crear documentación de alta calidad e interesante que satisface las necesidades de sus usuarios. Ya estés buscando mejorar la experiencia general de usuario, optimizar procesos o proteger información delicada, descargar la edición personal gratuita de HelpNDoc es el primer paso para aprovechar las muchas ventajas que puede ofrecer el PHP a tu documentación. ¡Así que aprovecha esta oportunidad y empieza hoy a sacar el máximo partido a tu documentación de usuario en línea!

Ver también...

Domina las actualizaciones de contenido con las herramientas de búsqueda y sustitución para escritores técnicos de HelpNDoc

¿Estás cansado de la lucha constante para mantener la documentación consistente, actualizada y sin errores? Para los escritores técnicos y autores de contenido, gestionar estas dificultades puede ser …

Lee Mas →

Transforma tu clase con HelpNDoc: la mejor herramienta de vuelta a clase para profesores y alumnos

A medida que se acerca la temporada de la vuelta a clase, educadores y estudiantes buscan herramientas que les permitan simplificar la creación de contenido, mejorar la colaboración y optimizar la …

Lee Mas →

Cómo personalizar la posición y tamaño iniciales de los archivos CHM Help

Con HelpNDoc, crear archivos CHM (Compiled HTML Help) es muy rápido gracias a su interfaz fácil de usar y sus potentes funciones. En este artículo, exploraremos cómo configurar el tamaño y la posición …

Lee Mas →

Equilibrio entre seguridad y usabilidad: los mejores formatos de documentación para compartir a nivel interno

Compartir documentación de manera eficaz y segura es fundamental en el entorno laboral actual. Ya se trate de la distribución interna de manuales, documentación de proyectos o políticas de empresa, la …

Lee Mas →