Actualizado el 14-01-2007
versión para imprimir
Bienvenido al Plugin Generator
Una de las cosas que separa al editor html-kit del resto es la posibilidad de extender su funcionalidad mediante un lenguaje de programación propio, hk-script.
Para facilitar esta programación, los usuarios de este programa disponemos de una herramienta de excepción, el generador de plugins, con el que podemos fácilmente añadir nuevas opciones que luego tendremos disponibles desde el menu principal del editor.
Gracias a esta herramienta, hay disponibles para su descarga mas de un centenar de plugins, y tu puedes fácilmente crear menus personalizados con las acciones que realices mas frecuentemente.
obtener el plugins generator
El generador de plugins es un programa independiente, que tienes que descargar de forma autónoma. Puedes obtenerlo pulsando el icono. Se instalará en una carpeta propia, junto a la carpeta del html-kit.
Se trata de una herramienta visual, asi que no te desanimes por el uso de hkscript ya que podrás realizar plugins básicos sin necesidad de ningun nuevo lenguaje.
ejemplo básico
El plugin mas básico es aquel que crea una nueva acción en la "actions bar" de html-kit, con un menu desplegable que nos permite insertar etiquetas en el texto.
Nosotros haremos una prueba creando un plugin para insertar distintos tipos de links. Además de explicarlo paso a paso, también puedes ver una pequeña demostración gráfica para que veas rápidamente lo sencillo que es.
Arrancamos el HKPGEN, y elegimos en el menu
principal File | New, como puedes ver en la
imagen de la derecha.
Hacemos click sobre el primer icono en el panel de la izquierda, que es una flecha amarilla con el nombre por defecto de MyPlugin: 
. Podrás ver entonces en el panel de la derecha las propiedades del plugin, con una serie de campos para rellenar:
- name: nombre del plugin. Por defecto es MyPlugin. Tendrás opción de cambiarlo por otro nombre cuando grabes el resultado.
- Datos del autor (nombre, email, copyright, web, etc.) Si es un plugin para tu uso personal, puedes dejarlo en blanco.
- options: por defecto estan escogidas las opciones (L_HKS) (REM), es decir, que se genere el código necesario en el lenguaje propio HKS y que dicho código incluya comentarios. Como veremos mas adelante, el HKPGEN te permite realizar tus plugins en varios lenguajes
Si pulsas sobre el lápiz 
que hay a la derecha del campo donde escoges las opciones, te sale un listado de las disponibles. Ahi puedes escoger el lenguaje de programación (de momento HKS) aunque ahora nos limitaremos a las dos que aparecen preseleccionadas
Vamos a dotar de funcionalidad a nuestro plugin. Haz click ahora en el segundo icono del panel izquierdo, que aparece rotulado por defecto como button1: 
Como verás, cambia el panel de la derecha, con nuevas opciones para este botón.
Panel correspondiente a MyPlugin
Panel correspondiente a Button1
Ya puedes hacerte una idea del esquema de cada plugin: cada plugin puede tener varios botones, y cada botón puede realizar varias acciones, y debes asignar las propiedades a cada una de ellas.
En el campo name introduciremos el nombre de nuestro botón. En nuestro ejemplo lo llamaremos "links" (sin comillas). Dentro de cada plugin, los nombres de cada botón deben ser únicos.
En el campo Section podemos especificar en que pestaña de la barra de acciones de HTML-KIT aparecerá nuestro plugin. Por ejemplo, podriamos poner aqui Tools o Objects y apareceria en dichas pestañas. Nosotros vamos a dejar el nombre que aparece por defecto (MyPlugins) y aparecerá una nueva pestaña con ese nombre, y dentro de ella, cuando lo hayamos terminado, nuestro plugin.
El campo description es opcional, pero nos permite incluir una descripcion del botón (que solo se leerá accediendo al código del plugin)
Options nos permite acceder a una serie de opciones (generalmente solo necesarias cuando tengamos un plugin con varios botones(. En este caso no necesitamos indicar nada aqui.
Hint sirve para introducir un texto que aparecerá, como explicación, cuando posemos nuestro puntero de ratón sobre ese botón.
Pasamos a continuación a la pestaña icon, donde podremos elaborar un icono para nuestro botón. Tenemos aqui tres opciones; la primera, Load icon or bitmap from file ... nos permitiría crear el icono desde un archivo gráfico. La segunda, import image from the clipboard, sirve para crear el icono desde una imagen que tengas en el portapapeles. Es la forma mas sencilla, simplemente copias o cortas la imagen que desees utilizar, y pulsas este botón. Y la tercera opción permite eliminar el icono que hayas creado.
Vamos a hacer una prueba; copia con el botón derecho del ratón esta imagen: 
y luego, en el HKPGEN pulsa en el segundo boton (import image from the clipboard).
Como puedes ver, el icono genérico ha sido sustituido:
Bien, hasta ahora solo hemos definido parte de la estructura del plugin: básicamente hemos declarado que tendrá un botón y le hemos asignado un icono. Es el momento de dotarle de funcionalidad.
A cada botón debemos asignar al menos una acción. Por diseño, la primera acción se ejecutará cuando una vez instalado, presionemos sobre el icono o etiqueta del plugin. Si añadimos dos o mas acciones, se accede a ellas a traves de un menu desplegable, pulsando el triangulo que aparece a su lado. Recuerda: acción 1, corresponde al botón del plugin en el menu. Accion 2 corresponderá al primer item del menú desplegable. Acción 3 al segundo item del menú, y así sucesivamente. Si solo defines una acción, esta se asigna al botón principal, y no se creará el menu desplegable.
Bien, volvemos al menu superior y escogemos el botón add new action
.
Vemos que aparece un nuevo elemento en el panel de la izquierda. También que cambia el panel de la derecha. En la pestaña llamada Default Action Properties escribimos el nombre de la accion (debe ser unico) y seleccionamos una de las acciones que hay disponibles. En este caso Enclose Selection [ES]. Con esta acción lo que consequimos es que al usar nuestro plugin sobre un texto seleccionado en el editor, quedará rodeado antes y despues por el texto que especifiquemos.
Vamos a verlo: en Before text escribe <a target "_blank" href="|">. Como ves, es la primera parte de una etiqueta de enlace con el atributo _blank. A continuación, en After Text escribe </a>.
Fijate que en el espacio destinado a la url hemos escrito el signo pipe o barra vertical, entre comillas: "|". Cuando ejecutemos nuestro plugin, html-kit rodeara el texto seleccionado en el editor colocandole las etiquetas de enlace, y dejará el cursor en la posición marcada con el signo | para que podamos a continuación teclear la url.
La función Enclose Selection [ES] es una de las muchas disponibles. El plugins generator creará automáticamente el código necesario para que pueda ejecutarse. Pero también puedes insertar tu propio código escogiendo la "función" custom code [CC].
Guardando el plugin
Podemos ya guardar el plugin. Por defecto el generator guarda los archivos con el formato .hpd (htmlkit plugin definition) que solamente el plugins generator puede entender. La utilidad de este formato es que en cuanlquier momento podemos cargar la definición de nestro plugin y ampliarlo o modificarlo.
Para usar el plugin, sin embargo, debemos guardarlo con formato .hks, correspondiente al lenguaje que hemos elegido, en la carpeta plugins de html-kit. Puedes hacerlo desde File | save plugin Code in Html-kit's plugins directory. Recuerda que al grabar es cuando puedes asignar nombre al plugin desde el panel correspondiente a My Plugin.
Bien, ya está. Cierra el Html-Kit si lo tienes abierto, y reinicialo. Aparecerá en la actions bar una nueva pestaña, My Plugins y en ella un botón con nuestro nuevo plugin. Para usarlo, simplemente selecciona en el editor el texto visible del futuro enlace, y haz click en el nuevo icono (búscalo en MyPlugins). Enhorabuena:
