Extender &quantaplus; Christopher Hornbaker
chrishornbaker@earthlink.net
András Mantia
amantia@kde.org
Juan ManuelGarcía Molina
juanma@superiodico.net
Traductor
Extender &quantaplus; Este capítulo describe cómo personalizar &quantaplus; para sus necesidades particulares y cómo puede ayudar a que &quantaplus; sea mejor. Paquete de edición del tipo del documento (&DTEP;) Los paquetes de edición del tipo de documento (&DTEP;s) se usan en &quantaplus; para agregar soporte para lenguajes de marcas, de script y &CSS;. Permite que &quantaplus; proporcione características como terminación automática y árboles de nodos. Su simplicidad y flexibilidad convierten a &quantaplus; en un &IDE; rápido y amigable para los desarrolladores web. Son los que hacen de &quantaplus; un entorno productivo y fácil de usar. &DTEP;s viene en dos sabores. La familia 1, que son los marcadores, y la familia 2, que son los lenguajes de script y &CSS;. Los &DTEP;s se componen de dos partes, la carpeta «Tag» (etiqueta) y «Toolbars» (las barras de herramientas). Las carpetas de etiquetas se componen de dos tipos de archivos, &descriptionrc; y TagXML, que llevan la extensión tag. Las barras de herramientas son solapas de botones orientadas a iconos (por encima de la ventana de edición), que ponen texto en un documento a más velocidad de la que un usuario pueda teclearlo. Se pueden crear manualmente las &DTEP;s (puede verlo más abajo), descargarlas o crearlas automáticamente desde una DTD existente. Si quiere más detalles acerca de la conversión, puede dirigirse a . Este documento describe cómo hacer los archivos TagXML, &descriptionrc; y toolbars. En resumen, una &DTEP;. Los archivos TagXML (.tag) definen tanto los atributos específicos para una etiqueta como la disposición y contenido del cuadro de diálogo de propiedades que muestra &quantaplus; para la etiqueta. El archivo &descriptionrc; proporciona reglas e información sobre el propio &DTEP;. Toolbars proporciona una medida rápida para agregar etiquetas a un documento sin preocuparse de errores tipográficos ni similares. Empaquetado Las carpetas son sólo eso, carpetas. Se componen sólo de los archivos &descriptionrc; y TagXML. Las carpetas Tag llevan el nombre del lenguaje de marcado y la versión, si es de aplicación. (Por ejemplo, html-4.01-strict) TagXML La tabla de abajo muestra las listas de los elementos definidos en TagXML y declara si son o no necesarios. Aunque no todos sean necesarios, se recomienda que use tantos como pueda para que otros usuarios tengan una mejor experiencia y más información con la que trabajar. Elemento Uso predefinido Caso de uso TAGS necesario siempre tag necesario siempre label opcional necesario para crear un cuadro de diálogo de propiedades attr opcional necesario para definir un atributo tooltip opcional necesario para que un cuadro de diálogo de propiedades muestre un consejo whatsthis opcional necesario para que el cuadro de diálogo de propiedades muestre ¿Qué es esto? list opcional necesario cuando un attr es del tipo list item opcional necesario cuando se usa <list> textlocation opcional siempre location opcional necesario cuando se usa label text opcional necesario cuando se usa label children opcional lista de etiquetas que pueden aparecer en la etiqueta que se está definiendo child necesario una entrada hija stoppingtags opcional lista de etiquetas de le dicen a otra etiqueta que termine stoppingtag necesario una entrada que detiene las etiquetas Descripciones de elementos TagXML Las secciones siguientes describirán al detalle cada evelento. Todos los que pueden ir se disponen de una forma sencilla. TAGS Éste es el elemento raíz de un documento TagXML. Puede aparecer en un documento sólo una vez. Puede contener la definición de múltiples etiquetas. Es un elemento de tipo único. Padre(s) Hijo NINGUNO tag tag Entorno para la etiqueta que se está definiendo. Este elemento es sólo de tipo. Padre(s) Hijo TAGS label, attr, stoppingtags AtributoTipoValores PredefinidoUsoDescripción namestring necesarioEspecifica el nombre de la etiqueta que se está definiendo. singleboolean opcionalEspecifica si la etiqueta necesita o no una etiqueta de cierre </(nombreetiq)>. typestringxmltag opcionalEspecifica el tipo de la etiqueta que se está definiendo. xmltag El tipo de la etiqueta está basado en XML (sólo familia 1). entity La etiqueta que describe una entidad (solo familia 1). property El tipo de etiqueta está relacionado con &CSS; (sólo familia 2). function El tipo de la etiqueta en una función de guión. Al usarse <attr> se convierte en los argumentos de la función (sólo familia 2). class El tipo de la etiqueta es una clase de guión (sólo familia 2). method El tipo de la etiqueta es un método de la clase (sólo familia 2). returnTypestringvoid opcionalEspecifica el tipo devuelto por la etiqueta que se está definiendo (sólo familia 2). void El tipo de etiqueta devuelve void (nulo). int El tipo de la etiqueta devuelve int (entero). float El tipo de la etiqueta devuelve float (decimal). long El tipo de la etiqueta devuelve long (entero largo). string El tipo de la etiqueta devuelve string (cadena de caracteres). versionstring opcionalIndica la versión del lenguaje para la que es válida esta etiqueta. extendsstring opcionalVálida solo si el tipo de la etiqueta es «clase». El nombre de la clase base para esta clase (solo para la familia 2). classstring opcionalVálida sólo si el tipo es «método». Indica el nombre de la clase a la que pertenece este método (sólo para la familia 2). commonboolean opcionalSi es «yes» (sí), la etiqueta indica un grupo común de atributos y los atributos que haya dentro de esta etiqueta se deben adjuntar a cualquier otra etiqueta (solo en la familia 1). commentstring opcionalla cadena de comentario que aparece junto al nombre de la etiqueta en la casilla de completado. label Pone una etiqueta en el cuadro de diálogo. El texto se indica en la etiqueta <text>. Este es un elemento sólo de tipo. Padre(s) Hijo tag text, location attr Define un atributo de la etiqueta. Este elemento debe aparecer una vez para cada atributo. Define el nombre y el tipo del atributo. También tiene etiquetas adicionales que indica cómo se debe mostrar el atributo, etcétera. Este es un elemento sólo de tipo. Padre(s) Hijo tag location, list, tooltip, whatsthis, textlocation AtributoTipoValores PredefinidoUsoDescripción namestring necesarioEspecifica el nombre del atributo que se está definiendo. typestringinput necesarioEspecifica el tipo del atributo que se está definiendo. input El campo admite entradas de texto libre (campo de texto). check El valor del campo es booleano (casilla de verificación). color El valor del campo es un color. url El valor del campo es una &URL; (archivo local al que hace referencia). list El valor de campo es un elemento de una lista especificada. statusstringopcional necesarioEspecifica si se necesita o no el argumento (sólo familia 2). opcional El argumento es opcional. necesario El argumento es necesario. implied El argumento es implícito. sourcestring opcionalIndica que se usa código fuente para rellenar la entrada para el atributo en el cuadro de diálogo de edición de etiquetas y en el árbol de atributos. selection El texto seleccionado se usa como código fuente dcop El resultado de método dcop se usa como código fuente. interfacestring opcionalNecesita source="dcop". La interfaz dcop que hay dentro de &quantaplus; se usa para obtener los datos del código fuente. methodstring opcionalNecesita source="dcop" y un nombre de interfaz. El nombre para el método dcop que hay dentro de &quantaplus; se usa para obtener los datos del código fuente. argumentsstring opcionalNecesita source="dcop", una interfaz y un nombre de método. Los argumentos se pasan al método. Puede ser vacío o "%tagname%", que quiere decir el nombre de la etiqueta actual. tooltip Define el consejo del campo en el cuadro de diálogo. Este elemento es sólo de texto. Actualmente, sólo se admite texto plano (no puede usar marcado). Padre(s) Hijo attr NINGUNO whatsthis Define la ayuda de «Qué es esto» para un campo en el cuadro de diálogo. Este elemento es sólo de texto. Actualmente, sólo se admite texto plano (no puede usar marcado). Padre(s) Hijo attr NINGUNO list Una etiqueta contenedora que agrupa los elementos en una lista. Puede aparecer sólo una vez para cada descripción del atributo. Es un elemento sólo de tipo. Padre(s) Hijo attr item item Define un elemento de una lista. Este elemento es sólo de texto. Padre(s) Hijo list NINGUNO textlocation Indica la posición del atributo de texto de una etiqueta en un cuadro de diálogo. Esta etiqueta sólo puede aparecer una vez para cada atributo del cuadro de diálogo (&ie;, una para cada etiqueta <attr> tag). Este elemento está vacío. Padre(s) Hijo attr NINGUNO AtributoTipo UsoDescripción rownonNegativeInteger necesarioIndica la fila en la disposición del cuadro de diálogo de un campo o etiqueta. colnonNegativeInteger necesarioIndica la columna en la disposición del cuadro de diálogo de un campo o etiqueta. rowspannonNegativeInteger opcionalIndica el número de filas que debe ocupar un campo. colspannonNegativeInteger opcionalIndica el número de columnas que debe ocupar un campo. location Indica la posición y el tamaño de un campo en el cuadro de diálogo. Esta etiqueta sólo debe aparecer una vez en cada campo del cuadro de diálogo (&ie; una por cada etiqueta <attr> y <label> tag). Este elemento está vació. Padre(s)Hijo label, attrNINGUNO AtributoTipo UsoDescripción rownonNegativeInteger necesarioIndica la fila en la disposición del cuadro de diálogo de un campo o etiqueta. colnonNegativeInteger necesarioIndica la columna en la disposición del cuadro de diálogo de un campo o etiqueta. rowspannonNegativeInteger opcionalIndica el número de filas que debe ocupar un campo. colspannonNegativeInteger opcionalIndica el número de columnas que debe ocupar un campo. text Define el texto para una etiqueta o casilla de verificación. Este elemento es sólo de texto. Padre(s)Hijo label, attrNINGUNO children Define una lista de elementos que pueden aparecer dentro de la etiqueta que se está especificando. Este elemento es sólo de tipo. Padre(s)Hijo tagchild child Define una etiqueta de hijo. Este elemento está vacío. Padre(s)Hijo childrenNINGUNO AtributoTipoValores UsoDescripción namestring necesarioIndica una etiqueta que puede aparecer con otra cierta etiqueta. usostring opcionalIndica la relación con el padre. necesario El padre debe tener al menos un hijo con este nombre. stoppingtags Define una lista de elementos que obligan a terminar una etiqueta. Este elemento es sólo de tipo. Padre(s)Hijo tagstoppingtag stoppingtag Define una etiqueta de detención. Este elemento está vacío. Padre(s)Hijo stoppingtagsNINGUNO AtributoTipo UsoDescripción namestring necesarioIndica qué etiquetas obligan a terminar otra etiqueta. Uso de TagXML Todos los archivos TagXML deben comenzar con la declaración &XML; <?xml version="1.0" encoding="UTF-8"?> y deben estar anidados y cerrados de forma correcta. Los espacios no afectan a nada, pero tenga cuidado con los caracteres & y <. Los debería reemplazar con &amp; y &lt;, respectivamente, en elementos como <tooltip>, <whatsthis>, y <text>. Si no lo hace, provocará una caída, por eso tendrá que tener cuidado para que no desaparezca su trabajo. Validación TagXML Para validar sus archivos TagXML, simplemente haga clic en en menú Herramientas de la zona superior de &quantaplus; y elija Validar TagXML. Se le mostrará un cuadro de diálogo y sólo tendrá que seguir unas directrices sencillas. Esta característica no está presente en la actualidad. La validación sucede actualmente sólo cuando los archivos TagXML están cargados en &quantaplus;. Ejemplos de TagXML Familia 1 A continuación se mostrará un archivo TagXML válido de familia 1. Este archivo describe con éxito el elemento <schema> del esquema &XML; de &W3C;. El nombre del archivo para TagXML debería ser schema.tag. Sencillo, ¿verdad? <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE TAGS> <TAGS> <tag name="schema"> <label> <text>id</text> <location col="0" row="0"/> </label> <attr name="id" type="input"> <tooltip>A unique ID for the element.</tooltip> <whatsthis>A unique ID for the element.</whatsthis> <location col="1" row="0"/> </attr> <label> <text>version</text> <location col="0" row="1"/> </label> <attr name="version" type="input"> <tooltip>Version of the schema.</tooltip> <whatsthis>Version of the schema.</whatsthis> <location col="1" row="1"/> </attr> <label> <text>targetNamespace</text> <location col="0" row="2"/> </label> <attr name="targetNamespace" type="input"> <tooltip>&URI; reference of the namespace of this schema.</tooltip> <whatsthis>&URI; reference of the namespace of this schema.</whatsthis> <location col="1" row="2"/> </attr> <label> <text>xmlns</text> <location col="0" row="3"/> </label> <attr name="xmlns" type="input"> <tooltip>&URI; reference for one or more namespaces for use in this schema. If no prefix is used, then components of that namespace may be used unqualified.</tooltip> <whatsthis>&URI; reference for one or more namespaces for use in this schema. If no prefix is used, then components of that namespace may be used unqualified.</whatsthis> <location col="1" row="3"/> </attr> <label> <text>attributeFormDefault</text> <location col="0" row="4"/> </label> <attr name="attributeFormDefault" type="list"> <items> <item>qualified</item> <item>unqualified</item> </items> <tooltip>Default form for all attributes within this schema.</tooltip> <whatsthis>Default form for all attributes within this schema.</whatsthis> <location col="1" row="4"/> </attr> <label> <text>elementFormDefault</text> <location col="0" row="5"/> </label> <attr name="elementFormDefault" type="list"> <items> <item>qualified</item> <item>unqualified</item> </items> <tooltip>Default form for all elements within this schema.</tooltip> <whatsthis>Default form for all elements within this schema.</whatsthis> <location col="1" row="5"/> </attr> <label> <text>blockDefault</text> <location col="0" row="6"/> </label> <attr name="blockDefault" type="input"> <location col="1" row="6"/> </attr> <label> <text>finalDefault</text> <location col="0" row="7"/> </label> <attr name="finalDefault" type="input"> <location col="1" row="7"/> </attr> </tag> </TAGS> Familia 2 A continuación se le mostrará un archivo TagXML válido de familia 2. Este archivo describe con éxito la función overload de &PHP;. El nombre de archivo de este TagXML debería ser overload.tag. <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE tags> <tags> <tag name="overload" type="function" returnType="void"> <attr name="class_name" type="string" status="optional"/> </tag> </tags> &descriptionrc; El archivo &descriptionrc; es también bastante sencillo y hay un editor para este tipo de archivos en DTDEditar las opciones de la DTD. Con ello, editará el &descriptionrc; para una &DTEP; que haya seleccionado de una lista. Para editar el &descriptionrc; de una &DTEP; nueva, debería crear un &descriptionrc; sencillo con las siguientes entradas: [General] Version = Use 1 para &quantaplus; versión <=3.1.2 y 2 para una versión posterior. Name = Cadena de definición de la DTD. (-//&W3C;//DTD HTML 4.01 Transitional//EN) NickName = El nombre de la DTD, en bonito. (HTML 4.01 Transitional). Si no se define, se usa Name como NickName. Cuando lo haya creado, póngalo junto a los archiovos de etiquetas, cargue la nueva &DTEP; con DTDCargar paquete de DTD (DTEP) y, después de que se haya cargado, puede seguir adelante y editar las opciones del &DTEP;. Marque las ayudas emergentes y el texto de «qué es esto» en el cuadro de diálogo de edición para entender el significado de cada entrada. Además, puede leer quanta/data/dtep/dtd-description.txt del archivo original de fuentes, que contiene una descripción del formato. Acciones definidas por el usuario Las acciones son muy frecuentes en todas las aplicaciones. Las necesita a menudo cuando usa las aplicaciones. Al hacer clic sobre un icono de la barra de herramientas, al seleccionar un elemento del menú o al usar un acceso rápido se suele ejecutar una acción. En &quantaplus;, las acciones le llevan hasta el siguiente nivel. En lugar de acciones estáticas (las que crea el programador de la aplicación a nivel de código fuente), es posible que un usuario cualquiera cree y modifique las acciones y, de esta forma, pueda crear y modificar estas acciones, añadiendo nueva funcionalidad a &quantaplus;. Esas acciones son las definidas por el usuario, y muchas de las acciones estándar de &quantaplus; son también acciones definidas (y modificables) por el usuario. Hay tres tipos de acciones definibles por el usuario: Acciones de texto Acciones de etiqueta Acciones de guión Crear acciones Puede crear una acción si va a Preferencias Configurar acciones . Haga clic en Nueva acción y llegará a un cuadro de diálogo similar a: Tipo Especifica el tipo de acción (Texto, Etiqueta, Guión). Texto El nombre de la acción, visible para el usuario. El botón cercano a la etiqueta Texto El icono asignado a esta acción. Haga clic en él para cambiar el icono actual. Globo de ayuda Descripción breve de qué hace la acción. Acceso rápido El acceso rápido asignado a esta acción. Haga clic en Personalizar o en el botón cercano a Personalizar para asignar un acceso rápido. Haga clic sobre Ninguno para eliminar el acceso rápido que está asignado en este momento. Barras de herramientas contenedoras Las barras de herramientas definidas por el usuario en las que deba aparecer esta acción. Puede consultar . Opciones detalladas Opciones específicas para los diferentes tipos de acciones. Siga leyendo. Acciones de texto Las acciones más sencillas. Puede introducir texto en el área Opciones detalladas y, cuando se ejecute la acción, se insertará ese texto en el documento en la posición en la que esté el cursor en ese meomento. Vea el ejemplo de abajo. Acciones de etiqueta Útil para insertar etiquetas XML que, por supuesto, puede usar también para cualquier otro propósito. <etiqueta> El nombre de la etiqueta. </etiqueta> Si está marcada cuando se ejecute la acción, este texto se insertará como cierre de la etiqueta. Si hay algún área seleccionada en el documento antes de ejecutar la acción, la <etiqueta> se insertará antes del área seleccionada y </etiqueta> después. Ejecuta el cuadro de diálogo «Editar etiqueta» si está disponible Si está marcada y hay un archivo tagXML para esta etiqueta, se mostrará un cuadro de diálogo de edición de etiqueta en el documento, para que pueda hacer un ajuste fino de los atributos de la etiqueta. Se insertarán <etiqueta> y </etiqueta> cuando lo haya completado. Ni < ni > ni el signo / se añadirán automáticamente. Acciones de guión El tipo de acción más potente. Con la ayuda de esta acción puede hacer funcionar aplicaciones externas (normalmente guiones, pero no se limita únicamente a guiones), que pueden alterar el documento o usar el documento (o parte del mismo) como entrada. Los cuadros de diálogo de Inicio rápido y las diversas acciones de Ver en... para los DTEPs de (X)HTML son ejemplos de este tipo de acciones en el propio &quantaplus;. Primero tiene que introducir el nombre del guión, así como el intérprete. Ejemplo: sh /home/miDirPersonal/miGuion.sh. Aunque puede usar rutas completas, se recomienda usar la variable %scriptdir en la línea de órdenes, como sh %scriptdir/miGuion.sh. De esta forma, &quantaplus; intentará ubicar el guión en los siguientes sitios: carpeta global de guiones: $TDEDIR/share/apps/quanta/scripts carpeta local de guiones: $TDEHOME/share/apps/quanta/scripts su ruta: $PATH Hay otras variables especiales que puede usar en la línea de órdenes: %f: se reemplaza con la URL del documento actual. En el caso de los documentos locales, se omitirá file:/ del documento. %input: se reemplazará por la entrada seleccionada. Vea más abajo. %projectbase: se reemplazará con la URL del proyecto actual. Está vacío si no hay ningún proyecto cargado. %pid: se reemplazará con el PID (id. del proceso) con el que esté corriendo &quantaplus;. Si &quantaplus; está corriendo en modo único, el texto «único» se añadirá al número del PID. Útil cuando se usa DCOP para controlar &quantaplus; desde un guión externo. %userarguments: útil en el caso de los eventos. Esta entrada se reemplazará por las propiedades del evento, en este orden: Primer argumento El id. único del guión Segundo argumento el nombre del evento Tercer argumento los parámetros del evento, normalmente el nombre del archivo del documento actual, o la ruta del archivo del proyecto. Además de los métodos anteriores, el guión puede recibir la entrada de la entrada estándar de &quantaplus;. En la lista desplegable Entrada puede seleccionar qué enviar a la entrada estándar. Las opciones son: Ninguno: no se envía nada al guión. Documento actual: se envía al guión el documento completo. Texto seleccionado: se envía al guión el área seleccionada del documento. Usar la variable %input suele tener sentido sólo cuando se usa esta opción. De forma similar a Entrada, puede recoger la salida de la aplicación que se ejecuta. Hay dos tipos de salida: Salida normal, mostrada en la salida estándar. Mensajes de error, mostrados en la salida de errores. Puede especificar qué debería ocurrir con el texto que se muestra en la salida estándar. Lo puede hacer modificando el valor de la lista de selección Salida: Ninguna: se ignora la salida de la aplicación. Insertar en la posición del cursor: la salida se insertará en la posición del cursor del documento actual. Reemplazar selección: el área seleccionada del documento se reemplazará con la salida. Reemplazar selección: el área seleccionada del documento se reemplazará con la salida. Crear un documento nuevo: se creará un documento nuevo y contendrá toda la salida del guión. Reemplazar el documento actual: se reemplazará con la salida el documento completo. Ventana de mensajes: la salida aparecerá en la herramienta Mensajes. Las opciones para la salida estándar de error (Error) son las mismas que las de la salida normal. Crear barras de herramientas A continuación se le mostrará cómo crear barras de herramientas para una &DTEP;. Las barras de herramientas son elementos gráficos que se asignan a acciones. Las acciones, en &quantaplus;, son la base para casi todas las extensiones que tiene &quantaplus; y que tendrá en el futuro. El mismo mecanismo que define una acción en &quantaplus; permite también la terminación automática y los cuadros de diálogo de las etiquetas. Con las acciones, el límite de lo que quiere hacer es virtualmente ilimitado. Por medio de un ejemplo, usaremos &HTML; tidy en nuestras páginas web. De la nada a lo completo Para comenzar, necesitaremos crear una barra de herramientas de usuario. Elija Barras de herramientas Añadir barra de herramientas de usuario . Si hay demasiadas etiquetas para el lenguaje de marcado, se recomienda que divida las etiquetas en grupos lógicos. Tendrá que crear una nueva barra de herramientas de usuario para cada grupo. En este caso, no hay muchas, así que haremos una barra de herramientas y le daremos el nombre del marcado. Una vez que haya creado sus barras de herramientas, debe añadir y configurar las acciones. Para hacerlo, elija Preferencias Configurar acciones . Las partes de esta ventana son bastante sencilla. Pulse el botón Nueva acción al final de la ventana para entrar en el modo de edición. Rellene todos los campos necesarios y añada la etiqueta a la barra de herramientas adecuada. Complete el resto y, si la etiqueta tiene atributos y planea usarlos siempre, marque la casilla Lanzar el cuadro de diálogo «Editar etiqueta» si está disponible para que se muestre cada vez que se use la acción. Ahora debería tener algo parecido a lo siguiente. Pulse el botón Aplicar y se añadirá la acción a la barra de herramientas que haya seleccionado. ¡Vaya! Es un icono horrible. ¿Cómo recordaré que ese icono representa esa acción? Reemplacemos el icono antes de que surjan los problemas. Para crear un icono que describa con mayor precisión esa acción, usaremos &tdeiconedit;. Selecciónelo desde el &kmenu;, Gráficos Más programas (o allá donde lo haya colocado su distribución). &tdeiconedit; hace que el tamaño predefinido sea 32x32 píxels, pero el que necesitamos es 22x22. Para cambiarlo, elija Editar Redimensionar . Tenga en cuenta que va a acrear un icono que le ayudará no sólo a usted, sino también a otros usuarios del &DTEP;, a recordar qué acción representa. Ya que la etiqueta para la que estoy creando el icono se llama inicio, he decidido crear un símbolo de inicio. Usando el color verde (el verde se interpreta con frecuencia como ir, comenzar o seguir) debería transmitir al usuario el mensaje de que al hacer clic sobre esta acción pondré la etiqueta <inicio> en el documento actual. Ahora que he terminado de crear el icono, lo guardo. Cuando haya creado los iconos, debe asociar el icono con la acción. Para ello, vuelva a abrir Preferencias Configurar acciones (en &quantaplus;) y seleccione la acción para la que haya hecho el icono. Junto al campo Texto verá un botón. Haga clic en él. Seleccione Otros iconos y luego haga clic sobre el botón Navegar. Vaya a la carpeta en la que haya guardado el icono, selecciónelo y haga clic en Aceptar. Pulse el botón Aplicar y siga haciendo lo mismo con las demás etiquetas, si las hubiera, o bien haga clic sobre Aceptar para terminar. Pongamos que le gustaría añadir algunas funciones frecuentes de &quantaplus; a su barra de herramientas o bien que piense que la barra de herramientas podría estar mejor organizada, con separadores para agrupar las acciones. Abra el cuadro de diálogo Configurar barras de herramientas usando Preferencias Configurar barras de herramientas . Asegúrese de que está seleccionada su barra de herramientas. Elegiré el separador (arriba, en la columna izquierda) para mi barra de herramientas. Una vez que haya seleccionado el elemento que desee añadir a su barra de herramientas, pulse el botón con la flecha hacia la derecha. Con esto, se añadirá a su barra de herramientas. Suponga que le gustaría tener una forma de acceder rápidamente a la Ver con Konqueror. Selecciónelo y añádalo a la barra de herramientas, Fíjese en cómo el separador ayuda a agrupar. Alguien que tenga un primer contacto con mi barra de herramientas podría haber pensado que el botón de &konqueror; era igual u opuesto al botón de comienzo. Aplique sus cambios y, cuando lo haya hecho, pulse sobre Aceptar para finalizar. Ah, mire qué fantástica es la barra de herramientas nueva. Ahora es mucho más útil. Recuerde probar su barra de herramientas, pulsando sobre todos los botones para verificar que la salida sea la correcta. Ahora, para guardar la barra de herramientas, elegiremos Barras de herramientas Guardar barras de herramientas Guardar como barra de herramientas local . Guárdela en la carpeta adecuada. Ya que no existe NeXML, la guardaré en la carpeta principal, pero debería guardar sus barras de herramientas en la carpeta adecuada. Asegúrese de ajustar su &descriptionrc; para que cargue sus barras de herramientas cuando se cree un archivo de ese tipo. Crear su propia documentación Robert Nickel
robert@artnickel.com
Juan ManuelGarcía Molina
juanma@superiodico.net
Traductor
Crear su propia documentación Probablemente, los añadidos más notables en &quantaplus; para el usuario general sean la adición de documentación para el lenguaje de marcado o de guión que prefiera. Con este fin, este capítulo explicará cómo creé el árbol de documentación &PHP; para mi uso personal. Antes de empezar a crear su propia documentación, puede querer comprobar el repositorio de &quantaplus; para ver si alguien lo ha hecho ya. Hay dos partes en este proceso. Primero, debe obtener la documentación existente para el lenguaje de marcado/guión/&etc; que quiera. Segundo, tiene que crear el archivo docrc. Lo primero es cosa suya, lo segundo es lo que se trata aquí. La forma general del archivo docrc es la siguiente: #KDE Config File [Tree] Doc dir=path, relative to this file, of the documentation html files ⪚ php42/ #top level elements Top Element=Your description for these documentation ⪚ &PHP; 4.2 documentation Section 1=Section1.html Section 2=#Sec2.1,#Sec2.2,#Sec2.3 Sec2.1=Sec2.1.html Sec2.2=Sec2.2.html Sec2.3=Sec2.3.html ... [Context] ContextList=func1,func2,tag1,tag2,tag3 func1=func1.html func2=func2.html tag1=tag1.html tag2=tag2.html tag3=tag3.html El docrc está dividido en dos secciones: Tree (árbol) y Context (contexto). La sección Tree (árbol) define el aspecto de la presentación de la documentación en la solapa de documentación. Por ejemplo, verá que en la documentación &PHP; tiene algo parecido a esto: En relación a lo de arriba, mi docrc de &PHP; tiene esta pinta: #KDE Config File [Tree] Doc dir=php42/ #top level elements Top Element=PHP 4.2 documentation PHP 4.2 documentation=Table of Contents,#Getting Started,#Language Reference Table of Contents=index.html Getting Started=Introduction, ... Introduction=introduction.html ... Language Reference=Basic syntax, ... Basic syntax=language.basic-syntax.html ... Tenga en cuenta el # que está delante de Getting Started (Comenzar) y Language Reference (Referencia del lenguaje). Esto indica que son subcontenedores del árbol y tienen contenido propio. No creo que haya un límite de profundidad fijado (más que el que marque lo razonable) — use su buen juicio. Para la Tabla de contenido, habrá notado que se hace referencia directamente a un archivo (y por tanto, se muestra al final del árbol de vista — las carpetas primero). Los espacios no afectan negativamente a nada, pero tenga cuidado con los caracteres & y <. Los debe reemplazar con &amp; y &lt; respectivamente en todos los archivos de recursos de &quantaplus; basado en &XML;. Context (contexto) es la sección del archivo docrc que se usa para facilitar la ayuda de contexto. Por ejemplo, si está escribiendo un guión &PHP; y le gustaría ver la documentación para la función mysql_fetch_array. Simplemente resalte la función y luego pulse &Ctrl;H para acceder a la ayuda de contexto. Inmediatamente se mostrará la documentación de mysql_fetch_array. Sólo hay aquí dos tipos de entradas: ContextList y las líneas de asociación de archivos. ContextList Realmente sencillo. Es una lista separada por comas con los elementos del contexto que quiera que estén disponibles (para &PHP;, son las funciones propias de &PHP;). Líneas de asociación de archivos Son de la forma «elemento_de_contexto=página_de_doc_html». ⪚ acos=function.asoc.html Una versión desgranada de mi docrc La sección Context (contexto) es: #Claves para la ayuda contextual [Context] ContextList=abs,acos,acosh,addcslashes,addslashes,... abs=function.abs.html acos=function.acos.html acosh=function.acosh.html addcslashes=function.addcslashes.html addslashes=function.addslashes.html ... Ahora puede guardar su archivo docrc. Guárdelo en $HOME/.trinity/share/apps/quanta/doc o $TDEDIR/share/apps/quanta/doc para darle uso local o global respectivamente. Luego, cree una carpeta(la que haya indicado en su archivo docrc) en la misma carpeta que su archivo docrc y copie allí sus páginas de documentación en &HTML;. Tendrá que reiniciar &quantaplus; para ver su documentación. Una vez que esté seguro de que es lo suficientemente bueno para ser compartido, envíe el archivo docrc junto con una descripción de cualquier información pertinente sobre qué documentos usó al repositorio de &quantaplus; para que lo pueda usar la comunidad de &quantaplus;. No se hará rico, pero se sentirá genial al saber que ha contribuido al desarrollo de la mejor plataforma de desarrollo web.
Compartir recursos Con &quantaplus; no va a sentirse solo. Es posible compartir con los demás los diversos recursos (paquetes DTEP, barras de herramientas con acciones, guiones, plantillas). Hay dos formas de hacerlo: Enviar por correo-e Los recursos los puede enviar por correo-e a sus amigos, compañeros o a quienes quiera. Puede acceder a la entrada del menú Enviar por correo-e desde varios lugares, como DTDEnviar paquete de DTD (DTEP) por Email, Barras de herramientasEnviar barra de herramientas por correo-e, en el menú de contexto de los archivos y carpetas en los árboles Plantillas y Guiones. Publicar en el servidor principal Los recursos se pueden publicar en el repositorio principal, desde donde todos los demás usuarios de &quantaplus; los puedan descargar. Los envíos se revisan y se publican sólo si nuestro equipo los considera correctos y útiles. Para hacer un envío válido, se sugiere firmar las fuentes, para lo que necesita una clave GPG/PGP. Esta información se usa para que tanto nuestro equipo como aquellos que lo descarguen puedan verificar el origen. Para saber cómo obtener los recursos del servidor principal, puede ver . Cuando vaya a publicar, se le pedirá una frese de paso para su clave secreta GPG (la frase de paso no se almacenará) o, en el caso de que tenga más claves secretas, podrá elegir la que quiera usar. En el cuadro de diálogo Compartir las novedades, rellene los campos de entrada (la URL de previsualización puede permanecer vacía) y dé inicio a la publicación haciendo clic sobre Aceptar. Se puede iniciar la publicación desde DTDPublicar paquete de DTD (DTEP), Barras de herramientasPublicar barra de herramientas, en el menú de contexto de los archivos y de las carpetas de los árboles de Plantillass y de Guiones. Obtener recursos Es posible actualizar &quantaplus; sin obtener una versión nueva, y recopilando solo recursos nuevos como paquetes de DTEP, barras de herramientas con acciones, plantillas, guiones y documentación. Una posibilidad es que haya obtenido los recursos por correo-e o que los haya descargado desde un servidor web, en cuyos casos normalmente tendrá que instalarlos manualmente. En caso de que tenga suerte, también podrá obtener un guión de instalación del lugar de procedencia de los recursos. Pero &quantaplus; tiene un servidor dedicado a albergar recursos que, o bien no se han incluido en la distribución principal por su tamaño o su escaso uso, o se han proporcionado más tarde, y dichos recursos se instalan automáticamente. Para descargar esos recursos se usan las diversas entradas del menú Descargar . Puede encontrarlas en DTDDescargar paquete de DTD (DTEP), Barras de herramientasDescargar barra de herramientas, en el menú de contexto de una área vacía o de un elemento de nivel superior en los árboles de Plantillas, de Guiones y de Documentación. Después de que se haya descargado un recuros, pero antes de que se haya instalado, &quantaplus; comprueba si el recurso es válido, verificando la integridad y la firma. En caso de que haya problemas, le avisará y dejará en sus manos la decisión de continuar o no. Haga el favor de leer detenidamente los cuadros de diálogo de advertencia. En caso de que la integración sea correcta y de que el recurso esté correctamente firmado, también se mostrará un cuadro de diálogo de información, para que pueda ver quién creó el recurso. Procure instalar los recursos, especialmente las barras de herramientas y los guiones, de sitios de confianza. Convertir una DTD en un &DTEP; Es posible trabajar con lenguajes XML que aún no estén soportados por &quantaplus;, creando un paquete DTEP. Pero en la creación puede tardar bastante tiempo, ya que tendrá que crear cientos de archivos de etiquetas en formato tagXML. Por supuesto, hay una manera más agradable de hacerlo, que es convertir automáticamente la DTD en un paquete DTEP. La conversión se puede iniciar desde el menú DTDCargar y convertir DTD. Seleccione el archiov de .dtd que defina la DTD que quiera usar y después verá el siguiente cuadro de diálogo: Las entradas son: Nombre del directorio de destino: el &DTEP; creado irá con este nombre a la carpeta $TDEHOME/share/apps/quanta/dtep. Nombre: el nombre (cadena de definición) de la DTD Apodo: el nombre de usuario visible del &DTEP; Línea de definición de !DOCTYPE: la cadena que debería aparecer en la etiqueta !DOCTYPE, como «HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"» URL de la DTD: la URL que apunta al archivo de la DTD. Extensión predefinida: la extensión que se suele utilizar para los archivos que sean escritos según esta DTD. Etiquetas y atributos sensibles a mayúsculas: se explica por sí misma, normalmente es cierta para todas las variantes de lenguajes tipo XML. Ajuste fino de la DTEP después de la conversión: si está marcada, después de la conversión &quantaplus; mostrará el editor de &descriptionrc;, para que pueda hacer un ajuste detallado del &DTEP; creado. Se recomienda dejar esta opción sin marcar.