TUTORIAL HELPNDOC VERSION (VERSION GRATUITA)

Transcripción

1 TUTORIAL HELPNDOC VERSION (VERSION GRATUITA) BIENVENIDOS A HELPNDOC HelpNDoc es una herramienta fácil de usar pero poderosa e intuitiva, que permite la creación de archivos Html Help. HelpNDoc provee una clara y eficiente interfaz para construir los mas sorprendentes archivos Html Help sin la necesidad de preocuparnos el trabajar internamente la generación de archivos de ayuda. Solamente tenemos que colocar nuestro texto en el procesador de palabras interno y golpear el botón Compile (Compilar) para obtener un archivo de ayuda completamente funcional, el cual se ve exactamente igual como el que hemos diseñado. CARACTERISTICAS Fácil de usar : No necesita conocimiento previo de HTML o de generación de Ayudas Interfaz de usuario clara y poderosa. 1

2 Procesar de palabras incorporado : Procesador de palabras con características completas, incluido hyperlinks, tablas, imágenes, viñetas y numeración... Poderoso administrador de tópicos Generación automática de tópicos ID. Drag and Drop Administrador de palabras claves Rápido y fácil administrador de palabras claves. Ver todas las palabras claves del proyecto, agregar ellos a tópicos, filtrar ellos... Gratuito para uso personal HelpNDoc es gratuito para uso personal No contiene adware ni spyware Leer la licencia para mas información. ARRANCANDO LA APLICACIÓN ARRANCANDO HELPNDOC Para comenzar la aplicación hacer doble clic sobre el icono en la carpeta de Windows o desde el menú de inicio, seleccionar todos los programas y HelpNDoc OBTENIENDO AYUDA Para acceder al archivo de ayuda desde el programa : Desde el menú Ayuda (Help), hacer clic sobre HelpNDoc o presionar F1 Recursos en linea : Pagina de Inicio de HelpNDoc Version en linea del archivo de ayuda SISTEMA REQUERIDO : 2

3 Configuración Mínima Windows 2000, Windows XP, Windows Vista o Windows 7 10 MB de espacio libre en disco Compilador de Ayuda : Microsoft HTML Help Workshop (requerido en todos los sistemas) Configuración Recomendada Windows 2000, XP, Vista o de memoria RAM Resolución de pantalla 1024X768 o mas alta Compilador de Ayuda : Microsoft HTML Help Workshop (Requerido en todos los sistemas) INTERFAZ DE HELPNDOC Pagina de Bienvenida : Al aperturar HelpNDoc, la primera pagina que aparece es una pagina de Bienvenida. 3

4 En esta pagina podemos realizar las siguientes acciones : Tareas Comunes (Common Tasks) : Podemos crear un nuevo proyecto HelpNDoc con New Proyect (Proyecto Nuevo) o abrir un proyecto existente con Open an existing HelpNDoc proyect (Abrir un proyecto HelpNDoc existente) Recent Proyects (Proyectos recientes) : Nos muestra los proyectos últimamente creados. Recursos en linea (on-line):nos permite acceder a recursos en linea de HelpNDoc. Home Page, nos permite a través de Internet ir a la pagina inicial de la web de HelpNDoc. Tutorial Articles (Articulos Tutoriales) nos permite ir a la parte de artículos de la web del programa Check for Updates (Chequear por actualizaciones) Noticias RSS sobre HelpNDoc En la parte de la derecha de la pagina de bienvenida podemos leerla ultimas noticias acerca de HelpNDoc tal como nuevas versiones, descuentos y otras. Tabla de Contenido (Table of content) Barra de Herramientas (Tool Bar) de la Tabla de Contenidos Insertar un nuevo tópico (Insert a new topic) Tópicos pueden tener texto e imágenes. Ver el editor de tópicos para mayor información. Insertar un nuevo campo de enlace (Insert a new link item) Campos de enlace contienen un enlace a una dirección URL. Ver el editor de enlaces para mayor información. Borrar campo (Delete Item) Borra los campos seleccionados Renombrar campo (Rename item) Renombra el campo seleccionado o proyecto Cambiar Icono (Change Icon) Selecciona un icono desde un menú emergente para asignarlo al campo seleccionado. 4

5 Mover campo (Move Item) Cambia la posición de campos seleccionados en el árbol Campo del proyecto (Proyect item) Este es un campo especial que representa todo el proyecto. Si seleccionamos este botón la opción proyecto es mostrada. El nombre de este campo sera generado del rotulo del archivo de ayuda. Campos (Items) Los campos son una organización jerárquica, Podemos mover ellos como hijos (Child) de otros campos o cambiar su posición por arrastrar y soltar (Drag and drop) o vía del botón mover campo en la barra de herramientas. Seleccionar un campo mostrara un editor basado en el tipo de campo. 5

6 OPCIONES DEL PROYECTO GENERAL Titulo del Proyecto (Proyect Title) Esto define el titulo de la ventana de ayuda, una vez que el archivo HTML ha sido exportado. Derecho de Autor (Copyright) El derecho de autor esta insertado como pie de pagina en cada pagina que genera el archivo de ayuda. Tópico por Defecto (Default Topic) Define cual tópico sera primero insertado cuando se genere el archivo de ayuda. Tipo de letra por defecto (Default font) Define el tipo de letra por defecto el cual sera usado para cada tópico nuevo usado Variables de texto (Text Variables) Muestra y personaliza las variable que pueden ser incrustadas en los tópicos. Ver el editor de variables para mayor información de la configuración de la ventana y la sección Variable para mas información sobre las variables y su uso. 6

7 VENTANA CHM Personalizar la ventana (Windows) CHM, la barra de herramientas y sus atributos. La ventana CHM que se genera puede ser personalizada desde este panel. Tamaño y posición de la ventana (Window size and position) La posición de la pantalla es especificada desde los bordes de la pantalla en pixeles. Por ejemplo, una ventana la cual debería estar centrada en la ventana horizontalmente, pero en la parte alta de la ventana, tendrá igual valor tanto a la izquierda (left) como a la derecha (right), pero el valor del tope (Top) cera de 0. Botones visibles en la barra de herramientas (Toolbar visible buttons) Los botones de la barra de herramientas pueden estar ocultos o visibles. Esta sección define cuales botones serán mostrados. Las funciones de los botones son las siguientes : Show/Hide (Mostrar/Ocultar) : Cambiara la visibilidad del panel de la tabla de contenido Back (Regresar) : El usuario podrá regresar a la pagina de ayuda previamente explorada. Forward (Adelantar) : El usuario podrá avanzar una pagina en el explorador de ayuda. Stop (Parar) : Permite al usuario cancelar la actual carga del tópico de ayuda. Esto es útil en los tópicos en línea (on line). Refresh (Refrescar) : Permite recargar el tópico actual. 7

8 Home (Inicio) : El usuario sera enviado de regreso al tópico por defecto. Options (Opciones) : El usuario podrá personalizar parte de la interfaz de Windows. Print (Imprimir) : Se podrá imprimir el tópico actual, con o sin sus tópicos hijos. Opciones del panel de navegación (Navegation Pane) El panel de navegación tendrá opcionalmente varios paneles: La tabla de contenido, panel de Buscar (Search) y favoritos (Favorites). También podremos definir el tamaño del panel de navegación en pixeles. Opciones Varias (Other Options) Esta sección presenta varias opciones sin categorizar tales como : Show text on toolbar button (Mostrar texto en el botón de la barra de herramientas) : Cada botón de la barra de herramientas mostrara su correspondiente texto referido a su acción especifica. Si no esta chequeada, solamente el icono sera mostrado. Save user-defined size and position (Salvar tamaño y posición definidas por el usuario) : Cuando el usuario cambia el tamaño y posición de la ventana, esta opción automáticamente guarda esta opción para usarse mas tarde. HTML 8

9 Aquí podemos definir la características que tendrá nuestro archivo HTML. Modificar propiedades para... (Modify properties for...) Este panel tiene cuatro sub divisiones : Table of Content-TOC- (Tabla de Contenido) Header (Cabecera) Content (Contenido) Footer (Pie de pagina) Podemos hacer clic sobre los sub paneles Header y Footer para definir su apariencia para el nivel actual. Podemos seleccionar Background color (Color de fondo), Text Font (Tipo de letra) y si en el nivel se muestra o no la cabecera ( Show Header) Al hacer clic sobre el sub panel Table of Content -TOC (Tabla de Contenido), podemos definir si esta se mostrara expandida o no. (Casilla Expanded (Expandir)). Definir niveles (Define levels) En este panel podemos definir el número de niveles con el cual vamos a trabajar Podemos usar los niveles para definir la apariencia de la cabecera y pie de pagina de cada nivel de la tabla de contenido. Nivel 1 corresponde a la raíz del contenido, nivel 2 corresponde a los hijos del nivel raíz, nivel 3 corresponde a los nietos del nivel raíz. Podemos definir tantos niveles como deseemos. Si un nivel especifico no esta definido,las propiedades del nivel por defecto sera usado.(default Level). 9

10 Al hacer clic sobre este botón se muestra o oculta la barra Level Number (Número de nivel). Al hacer clic sobre este botón se crea un nuevo nivel Al seleccionar un nivel y hacer clic sobre este botón el nivel se borrará. PDF Preferencias del Visor (Viewer preferences) 10

11 Presentación de pagina (Page Layout) Aquí podemos seleccionar : Single Page (Pagina simple) : Muestra una pagina a la vez. One Column (Una columna) : Muestra la pagina en una columna. Two columns left (Dos columnas izquierda) : Muestra la pagina en dos columnas con la pagina impar a la izquierda Two columns right (Dos columnas derecha) : Muestra la pagina en dos columnas con la pagina impar a la derecha. Otra opciones Center window (Centrar ventana) Hide Menú bar (Ocultar barra de menú) Estas preferencias serán guardadas dentro del documento PDF generado. El usuario final vera la documentación tal como la hemos especificado, sin embargo el usuario puede ajustar la presentación a su gusto. Niveles de comprensión y encriptacion Esta sección nos permite afinar nuestra documentación PDF al poder definir los niveles de compresión y seguridad. Usando el nivel de compresión máxima (maximum compression) generara una documentación PDF lo mas pequeña posible. Encriptar la documentación lo protegerá de usuarios no deseados. 11

12 Podemos especificar un Password tanto para el propietario (Owner Password) como para el usuario User Password). Por ejemplo al quitar el check sobre Copy (Copiar), Modify (Modificar) y Print (Imprimir), no permitiremos que el usuario final copie, modifica o imprima la documentación PDF resultante. EDITOR DE VARIABLES Para aperturar la ventana del editor de variables, hacemos clic sobre el botón Var, situado en la barra de herramientas, esto apertura un menu emergente desde donde dando clic sobre Var, aperturaremos la ventana variables. 12

13 Aquí se mostraran todas las variables disponibles, haciendo clic sobre Var Define... (Definir Var...), se nos apertura un cuadro desde donde podremos agregar una nueva variable Add a variable (Agregar una variable) Las variables serán reemplazadas por sus valores asociados en el archivo exportado. Para agregar una nueva variable debemos colocar su nombre (name) y su valor asociado (Value). Custom Variables (Variables personalizadas) Las variables pueden ser agregadas, borradas y sus valores pueden ser cambiados. Podemos agregar tantas variables personales como deseemos. System Variables (Variables del sistema) Estas variables no pueden ser modificadas ni borradas al igual que sus valores. Esta son variables de fechas, tiempo y otros. More information (Mayor información) Para comprender las variables y conocer como usarlas, ver la sección variables EDITOR DE TOPICOS 13

14 EDITOR El editor de los tópicos es un procesador de palabras standard. Sus características incluye soporte a tablas, hiperenlaces, imágenes, corrector gramatical, características avanzadas de formateo de texto y párrafo... PROPIEDADES DEL TÓPICO Esta barra de herramientas ofrece una fácil manera de definir las propiedades del tópico corriente : Empty Topic (Tópico vació)- Cuando hacemos clic sobre el botón el tópico no podrá tener ningún texto. Se cuidadoso cuando utilices un tópico vació, ya que sino tiene hijos, no sera visible a la hora de exportar el archivo de ayuda a HTML. External File (Archivo externo)- Cuando hagamos clic sobre este botón un archivo externo podrá ser insertado en el tiempo de generación. Topic Tittle (Título del tópico)- Define el título el cual aparecerá en la cabecera del tópico exportado. Esto no tienen nada que ver con el nombre del tópico el cual es definido en la tabla de contenido. Topic ID (ID del tópico)- Es el único identificador del tópico. Este ID es frecuentemente usado por algún proceso externo que quiera acceder a este tópico en particular. Context Number (Número contextual)- Único número entero identificador del tópico corriente. 14

15 Keywords (Palabras claves) Administra la asociación de palabras claves dentro del proyecto. Para mas información ver la sección Keyboards Editor (Editor de palabras claves) EDITOR DE PALABRAS CLAVES Para abrir u ocultar el editor de palabras claves hay que hacer clic sobre el botón Keyboards situado en la parte derecha de la barra de herramientas. Add a Keyboard (Agregar una palabra clave) La palabra clave agregada sera automáticamente asociada al tópico corriente. Keyword List (lista de palabras claves) Cada palabra clave presente sera listada en la pestaña indice de el archivo de ayuda HTML. Significado del formato del texto : Check negro en la palabra clave : Esta palabra clave esta asociada con este tópico. Palabra clave en gris : Esta palabra clave no esta asociada con este tópico, pero esta asociada con al menos un tópico. Palabra clave en gris y subrayada : Esta palabra clave no esta asociada con ningún tópico y puede ser borrada de la lista. 15

16 VISTA DE ARCHIVO CHM VARIABLES Variables Una variable es un identificador cuyo valor puede modificarse en cualquier momento- El editor de tópicos muestra los identificadores variables con una línea morada en forma de onda debajo de ellos. Cada identificador puede ser usado tantas veces como sea necesario y en el tópico en el cual se requieran. El identificador sera sustituido por el valor correcto cuando el tópico sea exportado. Los valores son definidos utilizando el editor de variables. Ejemplo : Agrego como una variable un correo electrónico. 16

17 Nota : En el Manage Variables (Administrador de variables) se aprecia un cuadrado rojo al lado de las variables que no se pueden modificar o eliminar, mientras la que 17

18 tienen un cuadrado verde a su lado son aquella que si se pueden modificar o eliminar. texto en el editor : mi correo electrónico es : correo electronico. INSERTAR HIPERENLACE TIPOS DE ENLACE Define los tipos de enlace a crear. Internal Topic (Tópico interno) representa un enlace a otro tópico desde un archivo de ayuda., Navegation (Navegación) enlazara un tópico relativo a el actual tópico, Internet/ representa un enlace a una dirección en Internet o a un correo electrónico y File (Archivo enlazara a un archivo disponible en el sistema. Internal Topic (Topico interno) 18

19 Internal Topic (Tópico Interno) Crea un enlace a otro tópico dentro del mismo archivo de ayuda Anchor (Ancla) Si el tópico contiene anclas (Anchor) entonces aparecerán en la lista de anclas. Cuando un ancla es seleccionada, el tópico sera posicionado donde el ancla es colocada cuando se hace clic sobre su enlace Navegation (Navegacion) 19

20 Navegacion - Crea fácilmente enlaces para navegar en el archivo de ayuda corriente. Default, First, Last (Defecto, Prinero, Último) - Representa enlaces a el tópico por defecto, primero o último del proyecto. Ellos son independientes del tópico corriente mostrado. Parent, Previous, Next (Padre, Previo, Siguiente) - Estos enlaces son dependientes del tópico corriente mostrado. Sibling - Los tópicos previo y siguiente incluyen a los hijos excepto si sibling es chequeado. En este caso solamente los tópicos del mismo nivel que el corriente serán afectados INTERNET/E MAIL Internet/ Crea un enlace a una dirección de internet o a un correo electrónico. Internet Link (Enlace a Internet) : Especifica la dirección en Internet para lanzarla en la ventana de ayuda corriente. Si chequeamos Open link in new window (Abrir el enlace en una ventana nueva) La dirección en Internet sera abierta en una nueva ventana del explorador web. 20

21 adress (Dirección de correo electrónico) : Especifica la dirección a la cual enviar un .opcionalmente podemos definir el tema del mensaje, en el campo Tema (Subject). Internet/ Crea un enlace a una dirección de internet o a un correo electrónico. Internet Link (Enlace a Internet) : Especifica la dirección en Internet para lanzarla en la ventana de ayuda corriente. Si chequeamos Open link in new window (Abrir el enlace en una ventana nueva) La dirección en Internet sera abierta en una nueva ventana del explorador web. adress (Dirección de correo electrónico) : Especifica la dirección a la cual enviar un .opcionalmente podemos definir el tema del mensaje, en el campo Tema (Subject). ARCHIVO File (Archivo) : Crea un enlace a un archivo, para descargarlo o mostrarlo en la ventana de ayuda. Relative Path (Ruta relativa) : Si la opción relative path, esta seleccionada, entonces la ruta del archivo debe ser relativa a la compilación final del archivo indice de CHM, PDF, Word o HTML. Esto significa que si el archivo de ayuda es movido, el archivo 21

22 de enlace deberá ser movido también. Los enlaces relativos son relativos a el directorio del documento exportado. ENCONTRAR Y REEMPLAZAR Find and Replace (Encontrar y reemplazar) Find in (Encontrar en) : Current document (Documento corriente) - Restringe la búsqueda a el tópico corriente Entire proyect (proyecto entero) - Amplia la búsqueda a todo el proyecto. Find (Encontrar) Use Find Next (Encontrar siguiente) para encontrar la siguiente ocurrencia de el campo especifico. Use Find All (Encontrar todos) para listar todas las ocurrencias del campo especificado. Replace (Reemplazar) Use Replace para reemplazar el campo especifico siguiente por el actual. Use Replace all para reemplazar todas las ocurrencias del campo especificado. Options (Opciones) La funcionalidad encontrar y reemplazar trabajara acorde a la opción especificada. COMO HACER PARA? Instalar diccionarios : 22

23 Desde la barra de herramientas : Hacer clic sobre Download dictionaries (Descargar diccionarios). También podemos dirigirnos a la siguiente dirección Para instalar el diccionario : Descomprimir el diccionario en el folder de instalación de HelpNDoc Este es usualmente, C:/Program Files/IBE Software/HelpNDoc. El diccionario quedara disponible para chequear la gramática. Compilar el proyecto : Para compilar el proyecto, hacer clic sobre Herramientas/Compilar proyecto... 23

24 Esto nos apertura la siguiente ventana : Desde aquí podemos seleccionar el tipo de documento que deseamos compilar. Nota : Es mejor si queremos exportar el proyecto a varios formatos, ir compilando uno por uno, asi mismo es util antes de empezar cualquier compilacion guardar el archivo con el cual hemos trabajado. Obtener la ultima versión : Para obtener la ultima versión de nuestro programa, por favor chequear nuestro sitio web : Para obtener informacion general o soporte técnico, por favor contactanos aquí. Si tienes alguna idea, pregunta o critica, no dudes en contactarnos. Nosotros estaremos deseosos de escucharlo. Puede obtener la ultima informacion de como comprar HelpNDoc en : 24

25 Restricciones de la versión libre : La versión libre de HelpNdoc no tiene limitación alguna respecto a la versión de paga. La única diferencia entre ambas versiones es un pequeño texto agregado en la parte baja de cada pagina para la versión libre. Ademas, la licencia de HelpNDoc, no permite usar la versión libre para usos comerciales o de negocios. Finalmente, la versión libre no tiene ningún tipo de soporte. El soporte vía es para los usuarios registrados. HelpNDoc, no contiene spy-ware o ad-ware de ningún tipo. Politica de actualización : Por comprar ahora HelpNDoc,se hará acreedor a actualizaciones gratuitas por al menos un año y una versión de ciclo completo. Esto significa que: Ud. recibira actualizaciones gratis por un año garantizado. Si al final de ese año el ciclo completo de la versión no ha sido alcanzado, continuara recibiendo actualizaciones hasta que este ciclo se cumpla. mepgkun@hotmail.com 7 de Abril del 2010 Lima - Perú 25