Guía “Cómo...” de Dspace Dspace. Traducido por:
Transcription
Guía “Cómo...” de Dspace Dspace. Traducido por:
Guía “Cómo...” de Dspace Consejos y trucos para la realización de tareas comunes en Dspace. Traducción del documento: DSpace How-To Guide Tips and tricks for managing common DSpace chores Authors / Contributors (alphabetically by last name) Tim Donohue Scott Phillips Dorothea Salo Traducido por: Luis Tijera Castro Universidad de León © 2006-2007 by all Authors / Contributors (listed above) This work is licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License. To view a copy of this license, visit http://creativecommons.org/licenses/by-nc-sa/3.0/ Introducción Este pequeño documento pretende hacer una introducción a las tareas de personalización más comunes en Dspace, está dirigido a novatos en la administración de Dspace. Ha sido escrito para la actual versión estable de dspace (versión 1.4.2) y la actual versión del interfaz de usuario Manakin (versión 1.1). Hemos intentado incluir instrucciones para diferentes sistemas operativos cuando es necesario; muchas personalizaciones, sin embargo, funcionan de forma idéntica en diferentes plataformas. Antes de comenzar Hay que tener en cuenta que diferentes partes de Dspace residen en distintas zonas en el servidor de Dspace. Como cada administrador de Dspace determina donde residen algunas partes de este y además los sistemas operativos tienen diferentes conceptos sobre donde residen otras partes, utilizaremos letra cursiva para señalar rutas de fichero indefinidas. Algunos directorios, cuya localización precisa varía entre sistemas, requieren especial atención: [dspace-source] – Directorio en el cual el administrador de Dspace descomprime el código de Dspace que se ha descargado. ● [manakin-source] – Directorio en el cual el administrador de Dspace descomprime el código de Manakin que se ha descargado. ● [dspace] – Directorio en el que el comando ant deposita el código compilado de Dspace. La localización de este directorio se establece en el archivo de configuración de Dspace, dspace.cfg, en el apartado dspace.dir ● [tomcat] – Directorio donde está instalado Apache Tomcat. Si no utilizas Apache Tomcat, deberías personalizar algunos de estos documentos “Cómo...” para que encajen mejor con el contenedor de Servlets escogido. Otros recursos de DSpace Aunque esta <<Guía “Cómo...” de Dspace>> introduce muchas tareas comunes de personalización actualmente disponibles dentro de Dspace, no se debe considerar suficiente por sí sola. Debería utilizar algún otro recurso valioso de Dspace, incluyendo: ● Página principal de Dspace – http://www.dspace.org ● Wiki de Dspace – http://wiki.dspace.org/ ● FAQ técnico de Dspace - http://wiki.dspace.org/TechnicalFaq ● Listado de recursos de Dspace (incluidos la documentación del sistema y las listas de correo) - http://wiki.dspace.org/DspaceResources ● Documentación de Manakin – http://di.tamu.edu/projects/xmlui/ © 2006-2007 by all Authors/Contributors listed This work is licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License. 2 Guía “Cómo...” de D Space ● Otros recursos útiles Esta “Guía como de Dspace” introduce algunas tareas de personalización que dependen de algún conocimiento general sobre otras tecnologías, como XHTML, CSS, XML y XSLT. Si necesitas refrescar algún concepto sobre estas tecnologías, aquí tienes unos pocos recursos web que pueden ayudar (disponibles a partir de Junio de 2007): • Tutoriales /guías W3Schools (http://www.w3schools.com/) – tutoriales de introducción, referencias y ejemplos de XHTML, CSS, XML, XSLT, SQL, entre otros. • HTML Dog (http://www.htmldog.com/) – referencias HTML y CSS y tutoriales para todos los niveles de conocimiento. • Holy CSS Zeldman! (http://www.dezwozhere.com/links.html) – todo sobre CSS, con links para el buen HTML, Javascript y diseño de sitios web. • MaxDesign (http://css.maxdesign.com.au/) - Tutoriales de CSS para desarrolladores web. Personalización del diseño de página usando floats, listas y Otras aptitudes útiles Muchas tareas que son pesadas de administrar a través de la interfaz web de Dspace, se pueden administrar fácilmente en la base de datos con un poco de SQL. Por ejemplo, si queremos sacar todos los ítems de una colección en particular nos llevará mucho tiempo si lo hacemos desde el propio Dspace, sin embargo lo podemos hacer rápidamente con una sola consulta SQL. No obstante, habrá que realizar una copia de seguridad de la base de datos antes de ejecutar alguna consulta SQL que modifique o elimine un gran número de ítems. El tiempo empleado en aprender SQL cosechará beneficios de ahorro de tiempo. © 2006-2007 by all Authors/Contributors listed This work is licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License. 3 Guía “Cómo...” de D Space selectores. Índice Usar vocabularios controlados...................34 Usar vocabularios controlados...................35 Cambiar la visualización del metadato de un ítem.....................................................................36 Usar las estadísticas de DSpace..................37 Usar las estadísticas de DSpace..................38 Usar las estadísticas de DSpace..................39 Usar las estadísticas de DSpace..................40 Usar la interfaz OAI-PMH.............................41 Usar la interfaz OAI-PMH.............................42 Configurar el “RSS feed”............................... 43 Configurar la fuente RSS................................44 Configurar el “checksum checker”.............45 Configurar el “checksum checker”.............46 Configurar el “checksum checker”.............47 Configurar el “checksum checker”.............48 Localizar y solucionar un error....................49 PERSONALIZANDO MANAKIN, VERSIÓN 1.1..... 50 Recompilar Manakin........................................51 Recompilar Manakin........................................52 Instalar un tema............................................... 53 Crear un nuevo tema.....................................54 Personalizar una cabecera o pie.................. 55 Modificar la visualización del metadato de un ítem...............................................................56 Modificar la visualización del metadato de un ítem...............................................................57 Añadir logos a la visualización de items.....58 Añadir logos a la visualización de items.....59 Añadir texto a una página (i18n)................. 60 Instalar un Aspecto.........................................61 Localizar y solucionar un error....................62 © 2006-2007 by all Authors/Contributors listed This work is licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License. 4 Guía “Cómo...” de D Space Introducción........................................................2 Índice.....................................................................4 Índice de materias..............................................5 PERSONALIZANDO DSPACE, VERSIÓN 1.4.2..... 7 Recompilar DSpace...........................................8 Recompilar DSpace...........................................9 Cambiar el texto de una página...................10 Añadir nuevo texto a un JSP.........................11 Fijar un ???some.key.name???........................ 12 Cambiar la apariencia global......................... 13 Cambiar la apariencia de una página...........13 Añadir un esquema de metadatos personalizado....................................................14 Añadir un esquema de metadatos personalizado....................................................16 Añadir un nuevo campo al metadato......... 17 Mover un campo del metadato....................18 Modificar los campos de búsqueda............. 19 Modificar los campos de búsqueda............. 20 Modificar las opciones de búsqueda........... 21 Reindexar DSpace...........................................22 Configurar los “media filters”.......................23 Configurar los “media filters”.......................24 Configurar la indexación a texto completo ..............................................................................25 Modificar los campos de navegación.......... 26 Cambiar el esquema de navegación............27 Modificar los formularios de envío............. 28 Modificar los formularios de envío............. 29 Modificar los formularios de envío............. 30 Cambiar un valor de un formulario............ 31 Cambiar un valor de un formulario............ 32 Usar vocabularios controlados...................33 Índice de materias Tips generales Recompilar DSpace [8] Recompilar Manakin [51] ● Localizar y solucionar un error (DSpace) [49] ● Localizar y solucionar un error (Manakin) [62] Tips de búsqueda Modificar las opciones de búsqueda [21] Modificar los campos de búsqueda [19] ● Configurar la indexación a texto completo [25] ● Configurar los “media filters” [23] ● Reindexar DSpace [22] ● ● ● ● Tips de interfaz de usuario Tips de navegación Interfaz de usuario JSP Dspace ● Cambiar el esquema de navegación [27] ○ Cambiar la apariencia global [13] ● Modificar los campos de navegación ○ Cambiar la apariencia de una página [26] [14] ○ Cambiar el texto de una página [10] Tips de gestión ○ Añadir nuevo texto a un JSP [11] ● Configurar el “checksum checker” [45] ○ Fijar un ???some.key.name??? [12] ● Usar las estadísticas de DSpace [37] ○ (See specific DSpace functionality for additional tips) Tips de diseminación ● Interfaz de usuario XML Manakin ● Configurar el “RSS feed” [43] ○ Instalar un tema [53] ● Usar la interfaz OAI-PMH [41] ○ Crear un nuevo tema [54] ○ Personalizar una cabecera o pie [55] ○ Modificar la visualización del metadato de un ítem [56] ○ Añadir logos a la visualización de items [58] ○ Añadir texto a una página (i18n) [60] ○ Instalar un Aspecto [61] ● ● ● ● ● ● Añadir un esquema de metadatos personalizado [15] Añadir un nuevo campo al metadato [17] Mover un campo del metadato [18] Cambiar la visualización del metadato de un ítem [36] Usar vocabularios controlados [33] Tips de envío Modificar los formularios de envío [28] Cambiar un valor de un formulario [31] ● Usar vocabularios controlados [33] ● ● © 2006-2007 by all Authors/Contributors listed This work is licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License. 5 Guía “Cómo...” de D Space Tips de metadatos © 2006-2007 by all Authors/Contributors listed This work is licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License. 6 Guía “Cómo...” de D Space [Página en blanco.] © 2006-2007 by all Authors/Contributors listed This work is licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License. 7 Guía “Cómo...” de D Space Personalizando DSpace, Versión 1.4.2 Cómo... [Personalizando DSpace, Versión 1.4.2] Recompilar DSpace Directorios: ● [dspace-source] ● [dspace-source]/build/ ● [Tomcat]/webapps/ (Mac OSX Server: /library/jboss/3.2/deploy) ○ Nota: JBOSS viene pre instalado con el servidor Mac OS X. No obstante, para ambas ediciones, servidor y escritorio, se puede usar Tomcat como con otras plataformas. Reinicio rápido (Sólo reinicie el servidor web después de cambios en la configuración*) (*Excepción – ¡Los cambios en Messages.properties requieren siempre recompilar!) 1. Parar Tomcat (ADVERTENCIA: esto deshabilitará el sitio web) (Linux / OS X / Solaris) [Tomcat]/bin/shutdown.sh ● (Mac OS X Server) Usar el administrador de servidores para parar tomcat(“Servidor de aplicaciones”) ● (Windows) Utilizar el monitor del servicio Tomcat (en el área de notificación) para parar Tomcat 2. Arrancar Tomcat ● (Linux / OS X / Solaris) [Tomcat]/bin/startup.sh ● (Mac OS X Server) Usar el administrador de servidores para arrancar tomcat(“Servidor de aplicaciones”) ● (Windows) Utilizar el monitor del servicio Tomcat (en el área de notificación) para arrancar Tomcat Compilación rápida: (Compilación rápida tras pequeños cambios, usualmente cambios en JSP) 1. Conectarse al servidor donde esta ejecutándose dspace (vía ssh, por ejemplo). Asegurarse de que se ha iniciado la sesión con el usuario que instaló Dspace inicialmente 2. Abrir un terminal (si no tiene uno ya), y teclear cd [dspace-source] 3. ant update (recompila todo el código de Dspace y reinstala los archivos JAR externos) 4. Alternativamente, si no se necesita reinstalar los archivos JAR, ejecutaremos entonces ant build_wars (que solamente recompila el código de Dspace) 5. cp build/*.war [Tomcat]/webapps/ © 2006-2007 by all Authors/Contributors listed This work is licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License. 8 Guía “Cómo...” de D Space ● Cómo... [Personalizando DSpace, Versión 1.4.2] Recompilar DSpace (continuación) ● (Mac OS X Server) cp build/*.war /library/jboss/3.2/deploy 6. Probar los cambios en Dspace Recompilación completa: 1. Conectarse al servidor donde esta ejecutándose dspace (vía ssh, por ejemplo). Asegurarse que se ha iniciado la sesión con el usuario que instalo Dspace inicialmente. 2. Abrir un terminal (si no tiene uno ya), y teclear cd [dspace-source] 3. ant clean (elimina el código compilado antiguo) 4. ant update (recompila todo el código de Dspace y reinstala los archivos JAR externos) 5. Parar Tomcat (ADVERTENCIA: esto deshabilitará el sitio web) (Linux / OS X / Solaris) [Tomcat]/bin/shutdown.sh ● (Mac OS X Server) Usar el administrador de servidores para parar tomcat ● (Windows) Usar el monitor de servicio de tomcat (en el área de notificación) para parar Tomcat 6. cp build/*.war [Tomcat]/webapps/ ● (Mac OS X Server) cp build/*.war /library/jboss/3.2/deploy 7. (Opcional, pero recomendado) Eliminar completamente los directorios dspace y dspace-oai creados en [Tomcat]/webapps ( /library/jboss/3.2/deploy para Mac) - TEN CUIDADO ... ¡no queremos borrar ningún otro directorio! ● 8. Para forzar a Tomcat para que recompile todo, también debes eliminar los directorios dspace y dspace-oai creados en [Tomcat]/work/Catalina/localhost Arrancar Tomcat ● (Linux / OS X / Solaris) [Tomcat]/bin/startup.sh ● (Mac OS X Server) Usar el administrador de servidores para arrancar tomcat (“Servidor de aplicaciones”). ● (Windows) Usar el monitor de servicio de tomcat (en el área de notificación) para arrancar Tomcat 9. Probar los cambios en Dspace © 2006-2007 by all Authors/Contributors listed This work is licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License. 9 Guía “Cómo...” de D Space ● Cómo... [Personalizando DSpace, Versión 1.4.2] Cambiar el texto de una página Archivos: ● [dspace-source]/jsp/(JSP que contiene el texto que queremos cambiar) ● [dspace-source]/config/language-packs/Messages.properties Instrucciones: 1. Abrir Messages.properties y buscar el texto que queremos cambiar. • Nota: Messages.properties contiene pares clave-valor. Por ejemplo: jsp.home.search1 = Search En términos generales, la clave se refiere a la ubicación del JSP en el cual el texto reside (por ejemplo, jsp.home.search1 es el texto “search-related” mostrado en [dspace-source]/jsp/home.jsp) <fmt:message key=”jsp.home.search1” /> 3. Cambiar el texto (que corresponda a la clave) en Messages.properties. 4. Efectuar los pasos de Recompilar DSpace. Notas: 1. Cuando añadimos o modificamos texto en Messages.properties, el “word-wrap” automático de nuestro editor de texto debe estar desactivado. La clave y su correspondiente valor deben estar siempre en la misma línea dentro del Messages.properties a. (Ejemplo) Esto no es una entrada válida en Messages.properties: jsp.community-home.heading1 = This is a really long heading which actually gets wrapped automatically by my text editor so that it ends up on three separate lines. © 2006-2007 by all Authors/Contributors listed This work is licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License. 10 Guía “Cómo...” de D Space 2. Si Messages.properties contiene ese texto en más de un lugar, abrir el pertinente JSP y encontrar el atributo key del elemento <fmt:message> oportuno. Por ejemplo: Cómo... [Personalizando DSpace, Versión 1.4.2] Añadir nuevo texto a un JSP Archivos: ● [dspace-source]/jsp/(JSP que contiene el texto que queremos cambiar) ● [dspace-source]/config/language-packs/Messages.properties Instrucciones: 1. Abrir el JSP pertinente y añadir un nuevo elemento <fmt:message> donde se quiera que el nuevo texto aparezca, hay que asegurarse de que el valor del atributo key es único. Por ejemplo: <fmt:message key=”jsp.home.mynewkey” /> 2. Abrir el Message.properties y encontrar la lista de claves-valor para el JSP que se quiere modificar. Añadimos una nueva línea correspondiente a la nueva clave. jsp.home.mynewkey = Text of my new key 3. Nota: Messages.properties contiene pares clave-valor. Por ejemplo: En términos generales, la clave se refiere a la ubicación del JSP en el cual el texto reside (Por ejemplo jsp.home.search1 es el texto “search-related” mostrado en [dspace-source]/jsp/home.jsp) 4. Efectuar los pasos de Recompilar DSpace. Notas: ● Se puede, añadir texto directamente al JSP, pero será más fácil mantener texto en nuestra instalación de Dspace si esta todo ello guardado en el Messages.properties. ● Hay que tener en cuente que cuando se añade o modifica texto en el Messages.properties, el “word-wrap” automático del editor de texto debe estar desactivado. © 2006-2007 by all Authors/Contributors listed This work is licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License. 11 Guía “Cómo...” de D Space jsp.home.search1 = Search Cómo... [Personalizando DSpace, Versión 1.4.2] Fijar un ???some.key.name??? Archivos: ● [dspace-source]/config/language-packs/Messages.properties ● [dspace-source]/jsp/local/(JSP que produce el texto de un ???some.key.name???) Instrucciones: 1. Buscar la cadena de dentro de las interrogaciones en el archivo Messages.properties. 2. Buscar la misma cadena dentro del JSP; debe ser el valor de un atributo key de un elemento <fmt:message> Si tanto en el JSP como en el Messages.properties aparece la cadena, comprobar si la cadena es exactamente la misma. 3. Si el Messages.properties no contiene la cadena, añadírsela: some.key.name=Text that should appear 4. Efectuar los pasos de Recompilar DSpace. 12 Guía “Cómo...” de D Space © 2006-2007 by all Authors/Contributors listed This work is licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License. Cómo... [Personalizando DSpace, Versión 1.4.2] Cambiar la apariencia global ● [dspace-source]/jsp/local/layout/*.jsp ● [dspace-source]/jsp/local/styles.css.jsp Instrucciones: 1. Cambiar el HTML en header-default.jsp (cabecera por defecto), footer-default.jsp (pie de página por defecto), location-bar.jsp(barra que muestra la ubicación), navbar.jsp (barra de navegación por defecto) y navbar-admin.jsp (barra de navegación del administrador). 2. Cambiar el CSS en styles.css.jsp. 3. Efectuar los pasos de Recompilar DSpace. Notas: ● Hay que tener cuidado al mover el formulario de búsqueda (en la barra de navegación) en la página. Esto podría romper el selector de usuario en la interfaz de usuario de administración. Consultar el FAQ técnico de Dspace (http://wiki.dspace.org/TechnicalFaq) para ver posibles posicionamientos. © 2006-2007 by all Authors/Contributors listed This work is licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License. 13 Guía “Cómo...” de D Space Archivos: Cómo... [Personalizando DSpace, Versión 1.4.2] Cambiar la apariencia de una página Archivos: ● Algún JSP en [dspace-source]/jsp/local/ Instrucciones: 1. Encontrar la siguiente etiqueta cerca de la parte superior del JSP: <dspace:layout … > 2. Pasar a esta etiqueta alguno de los siguientes atributos, para personalizar la apariencia del JSP: • style – especifica el estilo de la cabecera/pie mostrado para este JSP o Por ejemplo, style=”myStyle” significa que header-myStyle .jsp y footer-myStyle.jsp serán usados para este JSP. • navbar – especifica la barra de navegación usada por este JSP o Por ejemplo, navbar=”myNavigation” significa que se usará navbar-myNavigation.jsp para este JSP o navbar=”off” desactiva la barra de navegación en la página. o Si no se especifica un navbar, se utilizará navbar-default.jsp. • locbar – especifica el tipo de barra “location”(barra que indica la ruta de navegación) usada: o locbar=”off” – desactiva la barra “location” en este JSP. o locbar=”noLink” – la barra “location” está activa pero no proporciona links. o locbar=”commLink” – se muestra en la barra “location”, todas las comunidades que están por encima de la actual. o Si no se especifica un locbar todas las colecciones/comunidades se muestran como links en la barra “location”. 3. Efectuar los pasos descritos en Recompilar DSpace. © 2006-2007 by all Authors/Contributors listed This work is licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License. 14 Guía “Cómo...” de D Space o Si no se especifica un style, se usará header-default.jsp y footerdefault.jsp. Cómo... [Personalizando DSpace, Versión 1.4.2] Añadir un esquema de metadatos personalizado ● http://web-address-to-my-dspace/dspace-admin (Requiere sesión de administrador) Instrucciones: 1. Entrar como administrador de dspace y visitar la página de administrador de Dspace (http://web-address-to-my-dspace/dspace-admin) 2. Pulsar en “Registro de metadatos” para visualizar los esquemas disponibles dentro de Dspace. Por defecto, sólo está el esquema Dublin Core (dc) 3. En la parte inferior de la página, se introduce el “namespace” del nuevo esquema y le ponemos también un “nombre”. (No es requisito que el “namespace” sea resoluble. Es aconsejable que el “nombre” tenga pocos caracteres, ya que servirá también de prefijo para el esquema). Pulsar “Guardar”. 4. El nuevo esquema de metadatos se añade a la base de datos subyacente. Para añadir un nuevo campo al metadato hay que seguir las instrucciones descritas en Añadir un nuevo campo al metadato. También es posible mover un campo de metadato de un esquema a otro, para ello hay que seguir las instrucciones descritas en Mover un campo del metadato. © 2006-2007 by all Authors/Contributors listed This work is licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License. 15 Guía “Cómo...” de D Space Archivos: Cómo... [Personalizando DSpace, Versión 1.4.2] Añadir un esquema de metadatos personalizado (continuación) Notas: ● Actualmente, Dspace no soporta esquemas de metadatos “flat” (no jerárquicos). 16 Guía “Cómo...” de D Space © 2006-2007 by all Authors/Contributors listed This work is licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License. Cómo... [Personalizando DSpace, Versión 1.4.2] Añadir un nuevo campo al metadato ● http://web-address-to-my-dspace/dspace-admin (Requiere sesión de administrador) Instrucciones: 1. Entrar como administrador de dspace y visitar la página de administrador de Dspace (http://web-address-to-my-dspace/dspace-admin) 2. Hacer click en “Registro de metadatos” con el fin de observar los actuales esquemas de metadato dentro de Dspace. Luego hacer clic en el “namespace” del esquema al que se quiera añadir un nuevo campo. 3. En la parte inferior de la página se encuentra el formulario “Añadir un campo de metadato”, en el cual se puede especificar el “Elemento”, el “Cualificador” y la “nota de alcance” para el nuevo campo del metadato. Solamente el apartado “Elemento” es requerido. Hacer clic en “Añadir” para añadir el nuevo campo. 4. El nuevo campo de metadato se añadirá ahora a la base de datos subyacente como miembro del actual esquema de metadatos. Si se desea, se puede convertir el campo en una opción de búsqueda (véase Modificar los campos de búsqueda), se puede añadir el campo a los formularios de envío(véase Modificar los formularios de envío), y/o se puede mostrar este campo en la visualización de ítems (véase Cambiar la visualización del metadato de un ítem). © 2006-2007 by all Authors/Contributors listed This work is licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License. 17 Guía “Cómo...” de D Space Archivos: Cómo... [Personalizando DSpace, Versión 1.4.2] Mover un campo del metadato Archivos: ● http://web-address-to-my-dspace/dspace-admin (Requiere sesión de administrador) 1. Entrar como administrador de dspace y visitar la página de administrador de Dspace (http://web-address-to-my-dspace/dspace-admin) 2. Pulsar en “Registro de metadatos” con el fin de observar los esquemas de metadatos disponibles en Dspace. Luego, pulsar en el “namespace” del esquema desde el que se quiere mover un campo de metadato. 3. En la parte inferior de la página, se encuentra el formulario “Mover campo”. Usando este formulario se puede seleccionar uno o mas campos (del esquema seleccionado), y seleccionar el esquema donde se quiere mover los campos. Pulsar “Mover”. 4. Los campos seleccionados se moverán al esquema seleccionado. Una vez movidos los campos, es probable que se necesite actualizar la forma en que son usados estos, en Dspace. Por ejemplo, se pueden convertir los campos en opciones de búsqueda (véase Modificar los campos de búsqueda), añadir los campos a los formularios de envío(véase Modificar los formularios de envío), y/o se puede mostrar este campo en la visualización de ítems (véase (see Cambiar la visualización del metadato de un ítem). Notas: ● Mover un campo también lo eliminará de su esquema de origen. No obstante, algunos ítems que previamente usaron este campo serán actualizados automáticamente (es decir, ningún metadato existente debería perderse). © 2006-2007 by all Authors/Contributors listed This work is licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License. 18 Guía “Cómo...” de D Space Instrucciones: Cómo... [Personalizando DSpace, Versión 1.4.2] Modificar los campos de búsqueda Archivos: ● [dspace]/config/dspace.cfg ● [dspace-source]/jsp/local/search/advanced.jsp ● [dspace-source]/config/language-packs/Messages.properties Instrucciones: 1. Buscar la siguiente línea en el fichero dspace.cfg: ##### Fields to Index for Search ##### 2. Debajo se pueden observar varias líneas como estas: search.index.1 = author:dc.contributor.* search.index.2 = author:dc.creator.* search.index.4 = keyword:dc.subject.* search.index.5 = abstract:dc.description.abstract 3. Añadir en la parte inferior otra línea del tipo “search.index.#”. Si solamente se quiere añadir diferentes campos del Dublin Core (dc) para un “índice nombrado” existente, usar el modelo anterior como guía. Si se desea especificar un esquema diferente, hay que reemplazar dc por el nombre del otro esquema. • El “nombre” a la izquierda de los dos puntos (ejem. author, title, keyword,etc) es importante. En el ejemplo de arriba, la búsqueda por “author” esta especificada para buscar todos lo campos contributor y creator del Dublin Core. Mientras que, la búsqueda por “abstract” busca el campo dc.description.abstract. 4. Si se quiere añadir un campo de búsqueda por completo, habrá que modificar también el Message.properties (véase Cambiar el texto de una página) para añadir una etiqueta para el campo de búsqueda que sea comprensible para el usuario. También habrá que modificar el JSP “advanced-search”(advanced.jsp) para añadir el elemento <option> apropiado, como en el siguiente ejemplo: <option value="author" <%= field1.equals("author") ? "selected=\"selected\"" : "" %>><fmt:message key="jsp.search.advanced.type.author"/></option> • El atributo “value” del elemento <option> debe corresponder con el © 2006-2007 by all Authors/Contributors listed This work is licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License. 19 Guía “Cómo...” de D Space search.index.3 = title:dc.title.* Cómo... [Personalizando DSpace, Versión 1.4.2] Modificar los campos de búsqueda (continuación) nombre de uno de lo índices de búsqueda (ejem. author, title, keyword,etc.) 5. Efectuar los pasos descritos en Reindexar DSpace. 6. Efectuar los pasos descritos en Recompilar DSpace. Notas: • En Dspace, el concepto más confuso respecto a las opciones de búsqueda es la búsqueda por palabra clave. o No obstante, para hacer las cosas un poco confusas, el índice de búsqueda por palabra clave esta listado en dspace.cfg: search.index.4 = keyword:dc.subject.* Este índice (con un nombre bastante inapropiado) se usa realmente en la búsqueda específica por tema (de ahí el subject.*). Esto no tiene ningún control sobre la búsqueda normal por palabra clave que se ejecuta desde la caja de búsqueda básica en Dspace. © 2006-2007 by all Authors/Contributors listed This work is licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License. 20 Guía “Cómo...” de D Space o En la caja de búsqueda básica (como la que se muestra abajo) algunos términos introducidos se buscan para alguna parte dentro de algún índice de búsqueda (por ejemplo, alguno de los campos search.index.# en dspace.cfg), o el texto completo del documento (si es indexable a texto completo). Esta caja de búsqueda interpreta que se refiere a una búsqueda por palabra clave o término clave. Cómo... [Personalizando DSpace, Versión 1.4.2] Modificar las opciones de búsqueda Archivos: ● [dspace]/config/dspace.cfg Instrucciones: 1. Se puede personalizar el operador booleano de búsqueda que se usa por defecto. El motor de búsqueda de Dspace usa por defecto el operador OR (requiere que al menos un termino de búsqueda este presente) cuando se introducen múltiples términos. No obstante, si se desea, se puede especificar que se use el operador AND (requiere que todos los términos estén presentes), para ello hay que modificar la siguiente linea en el archivo dspace.cfg: search.operator = OR 2. Si se quiere modificar los campos de metadatos que son opciones de búsqueda, véase Modificar los campos de búsqueda © 2006-2007 by all Authors/Contributors listed This work is licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License. 21 Guía “Cómo...” de D Space El operador de búsqueda especificado sera el operador por defecto usado cuando alguien introduzca múltiples términos en la caja de búsqueda principal Cómo... [Personalizando DSpace, Versión 1.4.2] Reindexar DSpace Archivos: ● [dspace]/bin/index-all Instrucciones: 1. Iniciar sesión en la máquina donde se ejecuta Dspace. 2. Cambiar al directorio [dspace]/bin. 3. Ejecutar el script de reindexación ● (Linux or Mac OSX) ./index-all ● (Windows) ejecutar desde el prompt de comandos ./dsrun org.dspace.browse.InitializeBrowse ./dsrun org.dspace.search.DSIndexer 4. Parar y reanudar el servidor Tomcat (véase Reinicio rápido en Recompilar DSpace). ● Este proceso regenera los índices de búsqueda de Dspace. Hay que ejecutarlo después de realizar una tarea que modifique el contenido de esos índices (ejem. cambios manuales en los metadatos, retirada de ítems). Además, hay que ejecutarlo si se modifican los índices de búsqueda (véase Modificar los campos de búsqueda). ● Si se desea se puede programar el proceso para reindexar Dspace diariamente. Si se realizan muchos pequeños cambios durante un tiempo, sin reindexar, la función de búsqueda de Dspace puede volverse errática. © 2006-2007 by all Authors/Contributors listed This work is licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License. 22 Guía “Cómo...” de D Space Notas: Cómo... [Personalizando DSpace, Versión 1.4.2] Configurar los “media filters” Archivos: ● [dspace]/bin/filter-media ● [dspace]/config/dspace.cfg ● Un sistema de programación (por ejemplo, cron en Unix o “Tareas programadas” en Windows) Instrucciones: 1. En Dspace, los “media filters” son los que controlan la indexación a texto completo y la creación automática de thumbnails de imágenes. Ambos se pueden programar llamando al script filter-media (que sucesivamente llama a la clase org.dspace.app.mediafilter.MediaFilterManager). 2. La lista de todos los “media filters” activados está disponible en el archivo de configuración dspace.cfg en la sección etiquetada como sigue: #### Media Filter plugins (through PluginManager) #### plugin.sequence.org.dspace.app.mediafilter.MediaFilter = \ org.dspace.app.mediafilter.PDFFilter, \ org.dspace.app.mediafilter.HTMLFilter, \ org.dspace.app.mediafilter.WordFilter, \ org.dspace.app.mediafilter.JPEGFilter (Asegurarse que cada línea termina con el carácter ‘\’! La lista de los “media filters” disponibles esta en la sección Notas) 4. Para Linux o Mac OSX, se puede programar la ejecución del shell script filtermedia añadiendo una entrada cron similar a la siguiente para el crontab del usuario que instaló DSpace: 0 2 * * * [dspace]/bin/filter-media (La entrada de arriba programa la ejecución del filter-media a las 2am. Es necesario cambiar [dspace] por la ruta completa del directorio de instalación de Dspace.) 5. En Windows, no se puede usar el shell script filter-media. En cambio, se pueden usar las tareas programadas de Windows para programar la ejecución del siguiente comando a una hora apropiada: [dspace]/bin/dsrun.bat org.dspace.app.mediafilter.MediaFilterManager © 2006-2007 by all Authors/Contributors listed This work is licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License. 23 Guía “Cómo...” de D Space 3. Si se desea activar o desactivar un “media filter” específico. Se puede eliminar o añadir a la lista en esta sección: Cómo... [Personalizando DSpace, Versión 1.4.2] Configurar los “media filters” (continuación) (El comando de arriba debe aparecer en una línea.) Notas: ● Abajo se muestra una lista de los “media filter” disponibles y se explica que hacen realmente: ○ HTMLFilter – extrae todo el texto de documentos HTML para la indexación a texto completo. ○ JPEGFilter – crea thumbnails de las imágenes de los archivos GIF, JPEG y PNG ○ BrandedPreviewJPEGFilter – crea una vista previa de las imágenes de los archivos GIF, JPEG y PNG (desactivado por defecto) ○ PDFFilter – extrae todo el texto de documentos Adobe PDF (sólo si esta basado en texto o OCRed) para la indexación a texto completo. WordFilter – extrae todo el texto de documentos Microsoft Word o Texto plano para la indexación a texto completo ● Hay que tener en cuenta que filter-media o MediaFilterManager actualiza automáticamente los índices de búsqueda por defecto (véase Reindexar DSpace). Esta es la forma recomendada de ejecutar estos scripts. Pero, si se desea deshabilitar, se puede pasar la opción -n en cualquiera de los scripts. ● Las siguientes opciones adicionales están disponibles también para cualquiera de los scripts filter-media o MediaFilterManager: ○ -v = modo verbose (imprime todo el texto extraído y mensajes adicionales) ○ -f = fuerza el reproceso de todos los bitstreams (por defecto este script solo procesa los bitstreams no procesados) ○ -n = no actualiza los índices de búsqueda después de la nacionalización ○ -i <handle> = solo procesa bitstreams de una comunidad/colección/ítem en particular, representada por el <handle> ○ -m <#> = sólo procesa un número máximo de bitstreams (especificado por <#>) . Esto es útil si se quiere procesar bitstreams poco a poco a fin de evitar exigir demasiado el servidor. © 2006-2007 by all Authors/Contributors listed This work is licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License. 24 Guía “Cómo...” de D Space ○ Cómo... [Personalizando DSpace, Versión 1.4.2] Configurar la indexación a texto completo Archivos: ● [dspace]/bin/filter-media ● [dspace]/config/dspace.cfg Instrucciones: 1. Primero, hay que seguir la instrucciones descritas en Configurar los “media filters”, ya que la indexación a texto completo es llevada a cabo por esos “media filters” (concretamente HTMLFilter, PDFFilter, y WordFilter) search.maxfieldlength = 10000 Si se decide modificar el campo search.maxfieldlength se debe Reindexar DSpace para que los cambios hagan efecto. Notas: ● ● La indexación a texto completo sólo esta disponible para los siguientes formatos al mismo tiempo: ○ Adobe PDF (sólo si está basado en texto o OCRed) ○ Microsoft Word ○ Plain Text ○ HTML La búsqueda a texto completo en Dspace ocurre cuando el usuario busca a través de la caja de búsqueda por defecto (véase a continuación), o cuando el usuario selecciona la opción “Palabra clave” de la pantalla de búsqueda avanzada. © 2006-2007 by all Authors/Contributors listed This work is licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License. 25 Guía “Cómo...” de D Space 2. Se puede modificar el campo search.maxfieldlength en el archivo de configuración dspace.cfg. Este campo especifica el máximo número de palabras a indexar para cada documento y por defecto el valor es las 10000 primeras palabras. (hay que asignar el valor -1,si se quiere indexar un numero ilimitado de palabras) Cómo... [Personalizando DSpace, Versión 1.4.2] Modificar los campos de navegación Archivos: ● [dspace]/config/dspace.cfg Instrucciones: 1. En dspace.cfg, se pueden descomentar las siguientes lineas para especificar que campos del metadato van a ser navegables , interfaz “Navegar por Fecha”, interfaz “Navegar por Autores”, interfaz “Navegar por Titulos” y interfaz “ Navegar por Temas”, respectivamente: # webui.browse.index.date = dc.date.issued # webui.browse.index.author = dc.contributor.* # webui.browse.index.title = dc.title # webui.browse.index.subject = dc.subject.* 1. Añadir un asterisco (*) en el lugar del cualificado permite especificar todos los posibles cualificadores. De este modo, especificar dc.subject.* significa que el índice de navegación incluye los siguientes campos: dc.subject, dc.subject.lcsh, dc.subject.custom, etc. 2. Se puede, también, no especificar un cualificador (dc.title), que significa que el índice de navegación no incluye campos con cualificadores (de este modo especificar dc.title no incluirá dc.title.alternative) 3. Si se modifica algún indice de navegación en dspace.cfg, se debe Reindexar DSpace para que los cambios hagan efecto. Notas: ● También se puede personalizar que campos del metadato se muestran cuando se navega por una lista (a través de algún interfaz de navegación). Para hacerlo, hay que consultar la sección titulada como Cambiar el esquema de navegación. © 2006-2007 by all Authors/Contributors listed This work is licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License. 26 Guía “Cómo...” de D Space 2. Las líneas comentadas de arriba, muestran los campos navegables por defecto dentro de DSpace. Actualmente, solamente se puede especificar un elemento de metadato (por ejemplo, dc.date) para cada índice, pero se puede añadir uno o mas cualificadores (por ejemplo, el cualificador issued en dc.date). Fijarse en lo siguiente sobre cualificadores: Cómo... [Personalizando DSpace, Versión 1.4.2] Cambiar el esquema de navegación ● [dspace]/config/dspace.cfg Instrucciones: 1. En dspace.cfg, se pueden cambiar los campos del metadato que se muestran para cada ítem en la lista de ítems. Para hacerlo, hay que buscar la siguiente línea en el archivo dspace.cfg y descomentarla: #webui.itemlist.columns = dc.date.issued(date), dc.title, dc.contributor.* 2. Por defecto, cuando se visualiza una lista de ítems, se ven las columnas Fecha, Titulo y Autor(es) en ese orden. No obstante, se puede usar la anterior opción de configuración para cambiar de sitio las columnas o cambiar las columnas que se quieren mostrar. Aunque no se requiere, se pueden asignar estas columnas a sus específicos índices de navegación (véase Modificar los campos de navegación). 3. Habitualmente, especificando un solo cualificador (por ejemplo, issued en dc.date) o no especificando ninguno (por ejemplo dc.title) se mostrarán valores de esos campos específicos del metadato. No obstante, si se pone un asterisco (*) como cualificador se mostrarán todos los campos para ese elemento (tenga o no cualificador). Así, especificando dc.contributor.* todos o algunos de los siguientes campos se mostraran en esa columna: dc.contributor, dc.contributor.author, dc.contributor.editer, etc. 4. Parar y reiniciar Tomcat (Véase Reinicio rápido en Recompilar DSpace). © 2006-2007 by all Authors/Contributors listed This work is licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License. 27 Guía “Cómo...” de D Space Archivos: Cómo... [Personalizando DSpace, Versión 1.4.2] Modificar los formularios de envío Archivos: ● [dspace]/config/input-forms.xml 1. Este fichero XML contiene la definición de los formularios, cada formulario está definido dentro de un elemento <form>. Cada elemento <form> contiene elementos <page> que representan, cada uno, una página de entrada de datos. Cada elemento <page> contiene elementos <field> con instrucciones para crear campos en esa página. Esta estructura se muestra debajo, para el caso de un único formulario con una sola página. <form-definitions> <form name=”traditional”> <page number=”1”> <field> ... </field> </page> </form> </form-definitions> © 2006-2007 by all Authors/Contributors listed This work is licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License. 28 Guía “Cómo...” de D Space Instrucciones: Cómo... [Personalizando DSpace, Versión 1.4.2] Modificar los formularios de envío (continuación) 2. El formulario por defecto tiene un atributo llamado name cuyo valor es “traditional”. Para cambiar todos los formularios de envío para todo Dspace, editar el XML de este formulario. 3. Para modificar el formulario de envío para una determinada colección, hay que añadir un nuevo elemento <form> con un nuevo y único valor para el atributo name que este relacionado con la colección.(se puedes copiar el XML desde el formulario por defecto y editarlo como se desee, siempre que se modifique el valor del atributo name.) • Una vez creado el nuevo elemento <form>, habrá que vincularlo a una colección específica usando la sección <form-map> situada en la parte de arriba del XML: <form-map> </form-map> • Es necesario crear un nuevo elemento <name-map> para vincular tu manejador de colección, con el nuevo <form> creado. 4. Crear todos los elementos <page> necesarios, numerándolos secuencialmente comenzando por el 1, en el atributo number. Dentro de ellos, añadir elementos <field> de acuerdo a esta plantilla: <field> <dc-schema>dc</dc-schema> <dc-element>identifier</dc-element> <dc-qualifier>citation</dc-qualifier> <repeatable>false</repeatable> <label>Citation</label> <input-type>onebox</input-type> <hint>Enter the standard citation for the previously issued instance of this item.</hint> <required></required> <vocabulary></vocabulary> </field> 5. Parar y reiniciar Tomcat (Véase Reinicio rápido en Recompilar DSpace). © 2006-2007 by all Authors/Contributors listed This work is licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License. 29 Guía “Cómo...” de D Space <name-map collection-handle="default" formname="traditional" /> Cómo... [Personalizando DSpace, Versión 1.4.2] Modificar los formularios de envío (continuación) Notas: ● El elemento <required> contiene el texto que se mostrará cuando se pulse enviar y se halla dejado en blanco un campo requerido. Irá vacío en los campos opcionales. ● El elemento <vocabulary> es opcional. Permite especificar un vocabulario controlado (véase Usar vocabularios controlados para mas información) desde el cual el campo debe seleccionar valores. Este campo tiene un atributo opcional, closed. Si closed tiene valor true, un usuario solamente puede seleccionar valores desde el vocabulario controlado. Por defecto, closed tiene valor false, que permite al usuario introducir texto libre si el/ella lo decide. Por ejemplo: <vocabulary closed=”true”>srsc</vocabulary> ● Los tipos de entrada válidos (para el elemento <input-type>) son: ● “date” ● “name” (dos cajas de texto, una para el nombre y otra para los apellidos) ● “onebox” (caja de texto de una línea) ● “twobox” (dos cajas de texto en una misma línea) ● “dropdown” (para el cual se debe especificar un atributo value-pairs-name referido a lista <value-pairs> de valores permitidos, véase Cambiar un valor de un formulario) ● “qualdrop_value” (una caja de texto, precedida por una lista eliminatoria de valores. Requiere un atributo value-pairs-name similar al del “dropdown”. También es necesario asignar valor “true” al elemento <repeatable>) ● “textarea” ● Si se asigna un valor “true” al elemento <repeatable> se creará un botón “Add more”, el cual permite añadir múltiples valores para un determinado campo. Ejemplos de esto, se pueden observar en los campos “author” y “keyword” en el proceso de envío estándar de Dspace. © 2006-2007 by all Authors/Contributors listed This work is licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License. 30 Guía “Cómo...” de D Space El nombre del vocabulario controlado debe corresponder con el nombre del archivo XML (sin el “.xml”) que contiene el vocabulario. Por lo tanto, en el ejemplo de arriba, srsc hace referencia al vocabulario especificado en el archivo [dspace]/config/controlled-vocabularies/srsc.xml Cómo... [Personalizando DSpace, Versión 1.4.2] Cambiar un valor de un formulario ● [dspace]/config/input-forms.xml Instrucciones: 1. Buscar el elemento <form-value-pairs> en el input-forms.xml. 2. Buscar el elemento <value-pairs> para el elemento Dublin Core cuyo valor queremos cambiar. 3. Añadir un elemento <pair>, donde el elemento <displayed-value> contiene lo que el usuario ve en la caja “dropdown” y el elemento <stored-value> contiene lo que Dspace debe almacenar como etiqueta de información: <pair> <displayed-value>Gov't Doc #</displayed-value> <stored-value>govdoc</stored-value> </pair> 4. Parar y reiniciar Tomcat (Véase Reinicio rápido en Recompilar DSpace). Notas: ● Este conjunto de instrucciones cambia las posibilidades existentes que hay cuando Dspace muestra una caja de opciones o un menú “dropdown”, como con © 2006-2007 by all Authors/Contributors listed This work is licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License. 31 Guía “Cómo...” de D Space Archivos: Cómo... [Personalizando DSpace, Versión 1.4.2] Cambiar un valor de un formulario (continuación) los elementos “type” y “language” del Dublin Core. Esto no añade un widget de envío a la interfaz de usuario; para hacer eso, véase Modificar los formularios de envío. 32 Guía “Cómo...” de D Space © 2006-2007 by all Authors/Contributors listed This work is licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License. Cómo... [Personalizando DSpace, Versión 1.4.2] Usar vocabularios controlados Archivos: ● [dspace]/config/controlled-vocabularies/* ● [dspace]/config/dspace.cfg Instrucciones: 1. Por defecto, la funcionalidad vocabularios controlados esta deshabilitada ya que no es compatible con WAI Guidelines. Para habilitarlo, hay descomentar la siguiente línea en dspace.cfg: 2. DSpace solamente tiene licencia para redistribuir los siguientes vocabularios controlados: ● Norwegian Science Index (nsi.xml) – Por defecto, este vocabulario no se usa ● Swedish Research Subject Categories (srsc.xml) – Cuando se permita, este vocabulario se usa con el campo Subject (dc.subject). 3. Cada vocabulario controlado de arriba está definido (en [dspace]/config/controlled-vocabularies/) a través de un XML con estructura simila a: <node id="acmccs98" label="ACMCCS98"> <isComposedBy> <node id="A." label="General Literature"> <isComposedBy> <node id="A.0" label="GENERAL"/> <node id="A.1" label="INTRODUCTORY AND SURVEY"/> ... </isComposedBy> </node> ... </isComposedBy> </node> 4. La anterior estructura XML generará un vocabulario jerárquico con la siguiente © 2006-2007 by all Authors/Contributors listed This work is licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License. 33 Guía “Cómo...” de D Space #webui.controlledvocabulary.enable = true Cómo... [Personalizando DSpace, Versión 1.4.2] Usar vocabularios controlados (continuación) estructura: ACMCCS98 General Literature GENERAL INTRODUCTORY AND SURVEY Usando esta estructura, si el submitter selecciona GENERAL en la jerarquía anterior, el ítem será asignado a un tema que es una agregación de todos los términos por encima del termino seleccionado en la jerarquía, por ejemplo ACMCCS98::General Literature::GENERAL 5. Se puede crear un vocabulario controlado a medida generando una estructura XML similar a la de arriba. Una vez creada, hay que colocar el vocabulario controlado al lado de los vocabularios existentes en [dspace]/config/controlledvocabularies/ Hay un esquema disponible en [dspacesource]/docs/controlledvocabulary.xsd. Los siguientes campos están disponibles en esta estructura XML (los atributos/campos opcional se marcan) ■ <node> - representa un sólo término en la jerarquía ● id (opcional) – un identificador único para este término ● label – una etiqueta para este término. Este es el texto controlado real mostrado en DSpace y almacenado en el metadato para un ítem. ■ <isComposedBy> (opcional)- representa la relación “composed by”(compuesto por) entre términos. Así, en el ejemplo anterior, General Literature se especifica que esta compuesto por GENERAL y INTRODUCTORY AND SURVEY ■ <isRelatedTo> (opcional) – similar a <isComposedBy>, pero representa la relacion “is related to” (esta relacionado con)entre términos. ■ <hasNote> (opcional) – especifica una nota relacionada con un término. Esta nunca se muestra pero es útil para nuestra documentación/notas. 6. Para usar vocabularios controlados con los formularios de envío (véase la imagen de la página anterior), hay que especificar el vocabulario controlado que se va a usar para un campo específico del metadato. Esto de lleva a cabo © 2006-2007 by all Authors/Contributors listed This work is licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License. 34 Guía “Cómo...” de D Space ● Cómo... [Personalizando DSpace, Versión 1.4.2] Usar vocabularios controlados (continuación) utilizando la etiqueta <vocabulary> dentro del input-forms.xml. Para más información, véanse las notas de la etiqueta <vocabulary> en la sección Modificar los formularios de envío 7. Parar y reiniciar Tomcat (Véase Reinicio rápido en Recompilar DSpace). 35 Guía “Cómo...” de D Space © 2006-2007 by all Authors/Contributors listed This work is licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License. Cómo... [Personalizando DSpace, Versión 1.4.2] Cambiar la visualización del metadato de un ítem ● [dspace]/config/dspace.cfg ● [dspace-source]/config/language-packs/Messages.properties Instrucciones: 1. Para cambiar la visualización del metadato, modificar el orden de los elementos del Dublin Core después del elemento webui.itemdisplay.default (en Dspace.cfg), o añadir nuevos elementos: webui.itemdisplay.default = dc.title, dc.title.alternative, dc.contributor.*, dc.subject, dc.date.issued(date), dc.publisher 2. Para cambiar el nombre del campo de metadato mostrado, buscar su nombre clave (que comenzara por metadata.) en Message.properties y cambiarlo: metadata.dc.title.alternative = Title (French) 3. Efectuar los pasos descritos en Recompilar DSpace. © 2006-2007 by all Authors/Contributors listed This work is licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License. 36 Guía “Cómo...” de D Space Archivos: Cómo... [Personalizando DSpace, Versión 1.4.2] Usar las estadísticas de DSpace Archivos: [dspace]/bin/stat-* (es decir, todos lo archivos que comienzan por “stat-”) ● [dspace]/config/dspace.cfg ● [dspace]/config/dstat.cfg and dstat.map ● http://web-address-to-my-dspace/statistics (URL de la página de estadisticas de DSpace) Instrucciones: 1. DSpace viene con un paquete muy básico de estadísticas web que se puede usar para reunir información de la visualización de las paginas (que no es lo mismo que la descarga de archivos) y de actividades generales realizadas dentro de DSpace (por ejemplo, búsquedas realizadas, logins, errores y advertencias). Este paquete analizará los antiguos logs de DSpace (en [dspace]/log) para generar un informe de estadísticas HTML. Consiste en un conjunto de scripts Perl que comienzan con “stat-” en tu [dspace]/bin/ directory. (Nota: Para utilizar estos scripts, hay que tener instalado Perl!) 2. Hay dos opciones básicas en dspace.cfg que permiten especificar si los informes de estadísticas serán o no accesibles públicamente (report.public), y donde se almacenarán los informes (report.dir). Es muy probable que se quieran cambiar esas opciones. No obstante, si se cambia cualquier opción, hay que reiniciar Tomcat (Véase Reinicio rápido en Recompilar DSpace) report.public = false © 2006-2007 by all Authors/Contributors listed This work is licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License. 37 Guía “Cómo...” de D Space ● Cómo... [Personalizando DSpace, Versión 1.4.2] Usar las estadísticas de DSpace (continuación) report.dir = ${dspace.dir}/reports/ 4. El paquete de estadísticas de Dspace viene con un archivo de configuración, dstat.cfg. Este archivo contiene alguno ajustes que se deben cambiar (marcados con un asterisco a continuación), y unos pocos que se deben revisar: 1. dspace.log*– ruta completa de tu directorio [dspace]/log 2. general.summary – lista de “actions” del losg de Dspaceque se quieren mostrar en la sección “Overview”. No hay que cambiarlo a menos que sea necesario. 3. exclude.word – palabras filtradas fuera de los términos de búsqueda en las estadísticas 4. exclude.type – índices de los términos de búsqueda de Lucene filtrados fuera de las estadísticas (corresponde a los índices de búsqueda, véase Modificar los campos de búsqueda). exclude.character – Caracteres especiales de Lucene filtrados fuera de las estadísticas 6. item.type – Item types to find statistics for. Corresponde a los valores de los formularios (véase Cambiar un valor de un formulario) definidos en el campo dc.type, o algún campo de metadato con un elemento llamado type. 7. item.floor y search.floor – especifica un número mínimo de accesos necesarios antes de que el ítem o término buscado se incluya en las estadísticas 8. item.lookup – especifica el número máximo de ítems de la lista con información Autor/Titulo para las estadísticas 9. user.email – especifica cuando se mostrará el email del usuario en las estadísticas de login. Por privacidad, su valor por defecto es false (es decir, no mostrar el email) 10. host.name y host.url* – El nombre y la URL de la instalación de Dspace, que será mostrado en la parte arriba en la pagina de estadificas. 3. Además, el paquete de estadísticas viene con una archivo de mapping (dstat.map), que transforma los “actions” de Dspace, que aparecen en el archivo de log (en [dspace]/log), en texto legible. De esta manera, si se desea actualizar el texto que aparece en los informes de las estadísticas, o cambiar el idioma, se puede hacer editando este archivo. 4. Primero, debes modificar ligeramente los scripts para adecuarlos a la instalación © 2006-2007 by all Authors/Contributors listed This work is licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License. 38 Guía “Cómo...” de D Space 5. Cómo... [Personalizando DSpace, Versión 1.4.2] Usar las estadísticas de DSpace (continuación) de DSpace. Hay que buscar la siguiente sección en cada archivo stat-*: # Details used ################################################ 5. En esta sección, es probable que se necesite modificar alguna variable que especifica la ruta absoluta de un directorio o archivo (por defecto, todas estas rutas comienzan con /dspace/). En particular, hay que prestar atención a estas variables: 1. $dsrun – ruta absoluta del script [dspace]/bin/dsrun 2. $in_directory – ruta absoluta del directorio de entrada (para los scripts stat-report-*) 3. $out_directory – ruta absoluta del directorio de destino de los informes de estadística. Este debe corresponder con el directorio incluido en la opción report.dir en tu dspace.cfg! Para mantener las cosas simples, hay que especificar que $in_directory y $out_directory estén en el mismo lugar (por ejemplo, [dspace]/reports/). ● También tienes que modificar las variables $start_year y $start_month en stat-initial y stat-report-initial. Estas deben corresponder con el año y el mes desde el que se desea comenzar las estadísticas. 6. Hay que asegurarse de actualizar cada uno de los scripts stat-*! Hay seis en total: stat-general, stat-initial, stat-monthly, stat-report-general, statreport-initial, stat-report-monthly 5. En primer lugar, se necesita ejecutar el script de nacionalización para reunir datos sobre todos los meses pasados (retrocede hasta el mes y el año especificado en $start_month y $start_year). Este script solamente necesita ejecutarse una vez, aunque se puede ejecutar de nuevo si se necesita (en este caso se sobrescriben los resultados anteriores). La salida es un conjunto de datos históricos de archivos que usará el stat-report-initial para generar un informe HTML histórico. [dspace]/bin/stat-initial (Nota: Para Windows, hay que ejecutar perl [dspace]/bin/stat-initial) 7. Luego, se generan una serie de informes mensuales para los últimos datos ejecutando el correspondiente script stat-report-*. De nuevo, este script solamente necesita ejecutarse una vez, aunque se puede ejecutar de nuevo si se necesitas. La salida es un informe mensual histórico en HTML. © 2006-2007 by all Authors/Contributors listed This work is licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License. 39 Guía “Cómo...” de D Space 4. Cómo... [Personalizando DSpace, Versión 1.4.2] Usar las estadísticas de DSpace (continuación) [dspace]/bin/stat-report-initial (Nota: Para Windows, perl [dspace]/bin/stat-report-initial) 8. Los otros cuatro scripts deben ejecutarse al menos una vez al mes, aunque se puede programar para que se ejecute cada noche para almacenar estadísticas actualizadas en todo momento. Estos scripts generarán un informe basado en las actividades del mes actual (stat-monthly y stat-report-monthly) y un informe general del conjunto de todas las actividades en la historia del repositorio (stat-general y stat-report-general). Como en el ejemplo anterior, el script stat-report-* siempre debe ejecutarse antes que su correspondiente script stat-*. 9. Para Linux o Mac OSX, puedes programar la ejecución de los scripts añadiendo una entrada cron similar a la siguiente para el crontab del usuario que instaló DSpace: 35 0 * * * [dspace]/bin/stat-general 30 1 * * * [dspace]/bin/stat-report-monthly 35 1 * * * [dspace]/bin/stat-report-general (La entrada cron de arriba programaría los scripts para que se ejecuten todas las noches. stat-monthly y stat-general estarían programados para las 12:30am y 12:35am respectivamente. Mientras sus correspondientes scripts de informes se ejecutarían a la 1:30am y 1:35am respectivamente. Nota: hay que cambiar [dspace] por la ruta absoluta del directorio de instalación de tu DSpace.) 10. Para Windows, hay que usar las tareas programadas de Windows para programar algunos comandos a una hora apropiada del día. Recuerda que los script stat-monthly y stat-general se tienen que ejecutar antes que sus correspondientes scripts de informes (similar al ejemplo de Linux/Mac OSX). Ademas, necesitas llamar a Perl explicitamente (por ejemplo, perl statmonthly) 11. Tras ejecutar todos los scripts de estadísticas, el sitio de informes de estadísticas estará disponible inmediatamente en http://web-address-to-mydspace/statistics © 2006-2007 by all Authors/Contributors listed This work is licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License. 40 Guía “Cómo...” de D Space 30 0 * * * [dspace]/bin/stat-monthly Cómo... [Personalizando DSpace, Versión 1.4.2] Usar la interfaz OAI-PMH Archivos: ● [dspace-source]/build/dspace-oai.war ● http://web-address-to-my-dspace/dspace-oai (URL base del OAI-PMH) Instrucciones: 1. Cuando se recompila (véase Recompilar DSpace), el interfaz OAI-PMH (http://www.openarchives.org/pmh/) se recompila automáticamente en dspace-oai.war. Para habilitar el interfaz OAI-PMH, solo hay que copiar el archivo dspace-oai.war en el directorio [Tomcat]/webapps/. (Es probable que ya este si se siguieron completamente los pasos de instalación). 2. Si nunca antes se ha usado OAI-PMH, hay un tutorial para principiantes en: http://www.oaforum.org/tutorial/ 1. Identify – se usa para obtener información sobre el repositorio http://web-address-to-my-dspace/dspaceoai/request?verb=Identify 2. ListMetadataFormats – devuelve una lista de los formatos de metadatos que soporta el OAI-PMH http://web-address-to-my-dspace/dspaceoai/request?verb=ListMetadataFormats 3. ListRecords – permite la recopilación de metadatos de todos los ítems o de una selección de ítems http://web-address-to-my-dspace/dspaceoai/request?verb=ListRecords&metadataPrefix=oai_dc 4. ListSets – devuelve una lista de “sets” (es decir, de colecciones de DSpace) disponibles en el repositorio http://web-address-to-my-dspace/dspaceoai/request?verb=ListSets 4. Hay que registrar la URL Base (véase arriba el apartado Archivos) en los siguientes sitios, para que otros puedan recopilar los metadatos y enlazar el sitio: 1. Lista DSpace OAI: http://wiki.dspace.org/index.php/OaiInstallations 2. Registro de proveedores de datos OAI-PMH: http://www.openarchives.org/data/registerasprovider.html © 2006-2007 by all Authors/Contributors listed This work is licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License. 41 Guía “Cómo...” de D Space 3. Abajo se muestran los “verbs” básicos del OAI-PMH (es decir, los comandos) para familiarizarte con ellos ( todos los ejemplos de URLs deben ir en una misma línea): Cómo... [Personalizando DSpace, Versión 1.4.2] Usar la interfaz OAI-PMH (continuación) 3. Directorio de repositorios Open Access: http://www.opendoar.org/ 4. Registro de repositorios of Open Access: http://roar.eprints.org/ 5. OAIster: http://www.oaister.org/ 42 Guía “Cómo...” de D Space © 2006-2007 by all Authors/Contributors listed This work is licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License. Cómo... [Personalizando DSpace, Versión 1.4.2] Configurar el “RSS feed” Archivos: ● [dspace]/config/dspace.cfg ● http://web-address-to-my-dspace/dspace-oai (URL base del OAI-PMH ) Instrucciones: 1. Todas las opciones del RSS están disponibles en dspace.cfg bajo la sección de cabecera: #### Syndication Feed Settings ###### 2. Para habilitar el “RSS feed” para un ítem nuevo/actualizado en la instalación de DSpace , se necesita asignar a la siguiente variable valor true: webui.feed.enable = false 3. Se puede modificar el número máximo de ítems mostrados en tu “RSS feed”: webui.feed.items = 4 webui.feed.cache.size = 100 webui.feed.cache.age = 48 5. Se puedes elegir el formato RSS que se quiere ofrecer. Se recomienda elegir cualquiera de estos, RSS 1.0 o RSS 2.0 (o ambos): webui.feed.formats = rss_1.0,rss_2.0 6. Hay decidir si se quiere que el “RSS feed” haga referencia a los ítems a través de su handle (por ejemplo, http://hdl.handle.net/123456789/1) o a través de su URL local de Dspace. Por defecto, el “RSS feed” contiene el handle del ítem (se muestra con valor false a continuación). Pero, se puede cambiar para que haga referencia a las URL local de dspace ajustándolo a true webui.feed.localresolve = false 7. También puedes personalizar que campos del metadato se mostraran en el “RSS feed” para todos los ítems. La información sobre un ítem en RSS generalmente consiste en un Titulo, una Fecha y una Descripción. Se puede mapear el Título y la Fecha usando las siguientes dos opciones: webui.feed.item.title = dc.title webui.feed.item.date = dc.date.issued Cada una de estas opciones solo acepta un único campo de metadato. Aunque, se puede poner un asterisco (*) como cualificador, para incluir todos los © 2006-2007 by all Authors/Contributors listed This work is licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License. 43 Guía “Cómo...” de D Space 4. Para ayudar al rendimiento, puede elegir el número de “feed” en cache (size) y el número de horas del “feed” en cache (age): Cómo... [Personalizando DSpace, Versión 1.4.2] Configurar la fuente RSS (continuación) cualificadores del campo (así, dc.title.* incluirá dc.title, dc.title.alternative, etc.) 8. Para la “RSS Description,” se puede especificar la lista de campos (todos se mostraran como parte de la descripción de un ítem). El formato es el mismo que el mencionado para el “RSS Title” y “Date above”, pero ahora se puede proporcionar múltiples campos separados por comas. (RECUERDA: si expandes esta opción a lo largo de múltiples líneas, se debe incluir un backslash (\) al final de cada línea, como en el ejemplo siguiente) webui.feed.item.description = dc.title, \ dc.contributor.author, dc.contributor.editor, \ dc.description.abstract, dc.description 9. Una vez especificadas todas las opciones del feed, hay que reiniciar Tomcat (Véase Reinicio rápido en Recompilar DSpace) para que los cambio hagan efecto. © 2006-2007 by all Authors/Contributors listed This work is licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License. 44 Guía “Cómo...” de D Space 6. Verás uno o mas botones de “RSS feed” (similares a los de abajo) aparecer en la página de inicio de tu Dspace, y en cada página de inicio de las Comunidades y Colecciones. Hacer click sobre uno de esos botones propociona un “feed” de los envíos recientes de cualquie nivel del sitio (en la página de inicio de DSpace) o en a nivel de Comunidad o Colección. Cómo... [Personalizando DSpace, Versión 1.4.2] Configurar el “checksum checker” Archivos: ● [dspace]/bin/checker ● [dspace]/config/dspace.cfg Instrucciones: 2. Hay algunas opciones de configuración para el “Checksum Checker” en la siguiente sección del dspace.cfg: #### Checksum Checker Settings #### 3. Hay que prestar atención a las opciones relacionadas con la retención de historia del checksum (se muestran a continuación). Estas dos opciones especifican cuanto tiempo es almacenada una única acción de verificación del checksum dentro de la base de datos de Dspace. Más información a continuación: # check history retention checker.retention.default=10y checker.retention.CHECKSUM_MATCH=8w 1. La opción checker.retention.CHECKSUM_MATCH especifica el periodo de tiempos tras el cual las comparaciones completadas serán eliminadas de la base de datos de DSpace (por defecto 8 semanas). Esto significa que tras 8 semanas, todas las comparaciones completadas serán automáticamente eliminadas de la base de datos (para evitar que la tabla de la base de datos crezca demasiado). 2. La opción checker.retention.default especifica el periodo de de tiempo tras el cual todos “checksum checks” serán eliminados de la base de datos (por defecto, 10 años). Esto significa que tras 10 años, todos las comparaciones completadas o no son eliminadas de la base de datos. © 2006-2007 by all Authors/Contributors listed This work is licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License. 45 Guía “Cómo...” de D Space 1. DSpace ahora viene con el script “Checksum Checker” ([dspace]/bin/checker) que puede programar la verificación del checksum de todos los ítems dentro de DSpace. Ya que DSpace calcula y registra el checksum de todos los archivos enviados, este script es capaz de determinar si el archivo a sido o no cambiado (ya sea manualmente o por algún tipo de corrupción o virus). La idea es que entre más pronto se pueda identificar que el archivo a cambiado, mas probabilidades se tienen de recuperarlo (asumiendo que no se quiere que cambie). Cómo... [Personalizando DSpace, Versión 1.4.2] Configurar el “checksum checker” (continuación) 3. Se puedes especificar cualquier periodo de tiempo para cualquiera de las opciones. Los periodos de tiempo válidos son: segundos (s), minutos (m), horas (h), dias (d), semanas (w), años (y) 4. Hay que tener en cuenta que estos ajustes de retención solamente se usarán si se especifica la opción -p para el checker (véase a continuación). De lo contrario, serán ignorados! 4. Si se modifica alguna opción en dspace.cfg, es necesario reiniciar Tomcat (Véase Reinicio rápido en Recompilar DSpace) para que los cambios hagan efecto. 5. El script Checksum Checker ([dspace]/bin/checker) también tiene varias opciones de la línea de comandos, a saber: -c 10 = Modo Limited Count (-c). Esto limita al check a solo los 10 bitstreams siguientes (el checker comenzará donde los dejo). (Recomendado para repositorios grandes que quieran comprobar solamente una porción del repositorio cada noche) 2. -d 2h = Modo Duracion (-d). Este llama al checker para ejecutarse durante 2 horas. Los periodos de tiempo disponibles se mencionaron anteriormente para las opciones del dspace.cfg. (Recomendado para repositorios grandes que quieran comprobar solamente una porción del repositorio cada noche) 3. -b 111 112 = Modo Bitstreams especificos (-b). Este llama al checker para comprobar solamente los bitstreams con Ids interno 111 y 112. 4. -a 1234/12 = Modo Handle específico (-a). Este llama al checker para comprobar solamente los bitstreams del Item/Collection/Community especificado por ese handle. 5. -l = Modo Looping (-l o -L). La L minúscula (-l) especifica la comprobación de todos los bitstream en el repositorio una vez. (Recomendado para repositorios pequeños que son capaces de procesar todo su contenido en solo unas pocas horas) . La L mayúscula (-L) especifica el continuo proceso de los elementos del repositorio (no recomendado para la mayoría de los repositorios) 6. -p = pruning habilitado (-p). llama al checker para eliminar los antiguos resultados de la base de datos basándose en los ajustes de retención especificados dentro de dspace.cfg. Sin esta opción, los ajustes de retención serán © 2006-2007 by all Authors/Contributors listed This work is licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License. 46 Guía “Cómo...” de D Space 1. Cómo... [Personalizando DSpace, Versión 1.4.2] Configurar el “checksum checker” (continuación) ignorados y la tabla de la base de datos puede crecer demasiado! 6. Se debe programar el Checksum Checker para que se ejecute automáticamente, basándose en la frecuencia de copias de seguridad en tu instancia de Dspace. El tamaño de tu repositorio también es un factor. Para repositorios muy grandes, se necesitara programar la ejecución para una hora (por ejemplo, opción -d 1h) cada noche. 1. Para Linux o Mac OSX, se puede programar añadiendo una entrada cron similar a la siguiente para crontab del usuario que instal DSpace: 0 4 * * 0 [dspace]/bin/checker -d2h -p 2. Para Windows, no se puede utilizar el shell script checker. En cambio, se deben usar las Tareas Programadas de Windows para programar la ejecución del siguiente comando en el momento apropiado: [dspace]/bin/dsrun.bat org.dspace.app.checker.ChecksumChecker -d2h -p (El comando de arriba debe aparecer en una sola linea.) 7. Opcionalmente, se puede elegir la opción de recibir email automáticos con los resultados del Checksum Checkers. Hay que asegurarse de programar su ejecución después de que el checker haya completado el proceso (de lo contrario el email no contendrá todos los resultados). 1. Hay unas pocas opciones que se pueden especificar al este script de email : ○ -a = enviar todos los resultados (todo especificado a continuación) ○ -d = solo un informe con los bitstreams eliminados ○ -m = solo un informe de los bitstreams perdidos © 2006-2007 by all Authors/Contributors listed This work is licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License. 47 Guía “Cómo...” de D Space (La entrada cron anterior programa la ejecución del scritp cada Domingo a las 4am por 2 horas. Nota: hay que cambiar [dspace] por la ruta absoluta del directorio de instalación de DSpace.) Cómo... [Personalizando DSpace, Versión 1.4.2] Configurar el “checksum checker” (continuación) 2. ○ -c = solo un informe con los bitstreams cuyos checksums han cambiado ○ -u = solo un informe con los bitstreams no comprobados ○ También puedes combinas opciones ( -m -c) para obtener informes combinados Para Linux o Mac OSX, puedes añadir otra entrada cron similar a la siguiente para el crontab del usuarios que instalo DSpace: 0 8 * * 0 [dspace]/bin/dsrun org.dspace.checker.DailyReportEmailer -a 3. Para Windows, puedes usar algún comando general. No obstante, evidentemente debes usar las Tareas Programadas de Windows para programarlo: [dspace]/bin/dsrun.bat org.dspace.checker.DailyReportEmailer -a (El anterior comando debe aparecer en una sola linea.) © 2006-2007 by all Authors/Contributors listed This work is licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License. 48 Guía “Cómo...” de D Space (La entrada cron de arriba progrmara el envío del email para las 8am cada Domingo, informando de todos los resultados. El comando de arriba debe aparecer en una sola linea.) Cómo... [Personalizando DSpace, Versión 1.4.2] Localizar y solucionar un error Directorios/Archivos: ● DSpace log file: [dspace]/log/dspace.log (normalmente) ● Tomcat log directory: [Tomcat]/logs (normalmente) ● [dspace-source]/jsp/local/ ● Servlet directory: [dspace-source]/src/org/dspace/app/webui/servlet Sitios web: ● FAQ técnico de DSpace: http://wiki.dspace.org/TechnicalFaq ● Página de DSpace en Sourceforge: http://sourceforge.net/projects/dspace/ ● Buscar en la lista de correo dspace-tech: http://sourceforge.net/mailarchive/forum.php?forum=dspace-tech Instrucciones: 2. Si recibimos un Error Interno en el Servidor, un JSP o algún código fuente puede tener problemas. Si tu email esta configurado en dspace.cfg como administrador de Dspace, revisa tu mail pare ver el listado de errores. Si no, haz una conexión ssh con la máquina de Dspace, cambia al directorio de logs y ejecuta tail -100 dspace.log. ● (Windows) Ir al directorio de log de Dspace y abrir dspace.log en tu editor de texto favorito. Mirar cerca del final el mensaje de error. 3. Normalmente, el archivo causante de error esta en las primeras cinco líneas de las diez del listado de error. La pila de error comienza con una línea similar a: yyyy-mm-dd time WARN … (OR) yyyy-mm-dd time ERROR … 4. Buscar en el FAQ técnico y la lista de correo dspace-tech información sobre el error. Para que las búsquedas resulten útiles, incluye ciertas palabras claves del error. 5. Si todo esto falla, escribe un email a dspace-tech@lists.sourceforge.net describiendo el error e incluye la pila del error © 2006-2007 by all Authors/Contributors listed This work is licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License. 49 Guía “Cómo...” de D Space 1. Si la información esperada simplemente no aparece, saliendo una pantalla en blanco en el navegador, el problema es casi seguro con un servlet. El mensaje de error debe estar en [dspace]/log/dspace.log o bien en [Tomcat]/logs/ © 2006-2007 by all Authors/Contributors listed This work is licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License. 50 Guía “Cómo...” de D Space Personalizando Manakin, Versión 1.1 Cómo... [Personalizando Manakin, Versión 1.1] Recompilar Manakin Directorios: ● [dspace-source] ● [manakin-source] ● [Tomcat]/webapps/ (Mac OS X Server: /library/jboss/3.2/deploy) ○ Nota: JBOSS viene preinstalado con el servidor Mac OS X. No obstante, para ambas ediciones, servidor y escritorio, se puede usar Tomcat como con otras plataformas. Reinicio rápido (Sólo reinicie el servidor web después de cambios en la configuración) 1. Parar Tomcat (ADVERTENCIA: esto deshabilitara el sitio web) (Linux / OS X / Solaris) [Tomcat]/bin/shutdown.sh ● (Mac OS X Server) Usar el administrador de servidores para parar tomcat(“Servidor de aplicaciones”) ● (Windows) Utilizar el monitor del servicio Tomcat (en el área de notificación) para parar Tomcat 2. Iniciar Tomcat ● (Linux / OS X / Solaris) [Tomcat]/bin/startup.sh ● (Mac OS X Server) Usar el administrador de servidores para iniciar tomcat(“Servidor de aplicaciones”) ● (Windows) Utilizar el monitor del servicio Tomcat (en el área de notificación) para iniciar Tomcat Compilación rápida: (Compilación rápida tras pequeños cambios) 1. Conectarse al servidor donde esta ejecutándose dspace / manakin (vía ssh, por ejemplo). Asegurarse de que se ha iniciado la sesión con el usuario que instaló Dspace / manakin inicialmente. 2. Abrir un terminal (si no tiene uno ya), y teclear cd [manakin-source] 3. ant -Ddspace=[manakin-source] build_wars (recompila todo el código de manakin y construye un nuevo archivo .war) 4. cp build/*.war [Tomcat]/webapps/ ● (Mac OS X Server) cp build/*.war /library/jboss/3.2/deploy 5. Probar los cambios en Dspace / manakin © 2006-2007 by all Authors/Contributors listed This work is licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License. 51 Guía “Cómo...” de D Space ● Cómo... [Personalizando Manakin, Versión 1.1] Recompilar Manakin (continuación) Recompilación completa: (recompilación completa de todo manakin) 1. Conectarse al servidor donde esta ejecutándose dspace / manakin (vía ssh, por ejemplo). Asegurarse que se ha iniciado la sesión con el usuario que instalo Dspace / manakin inicialmente 2. Abrir un terminal (si no tiene uno ya), y teclear cd [manakin-source] 3. ant clean (elimina el código compilado anteriormente) 4. ant -Ddspace=[dspace-source] build_wars (recompila todo el código de manakin y crea un nuevo archivo .war) 5. Parar Tomcat (ADVERTENCIA: esto deshabilitara el sitio web) (Linux / OS X / Solaris) [Tomcat]/bin/shutdown.sh ● (Mac OS X Server) Usar el administrador de servidores para parar tomcat ● (Windows) Usar el monitor de servicio de tomcat (en el área de notificación) para parar Tomcat 6. cp build/*.war [Tomcat]/webapps/ ● (Mac OS X Server) cp build/*.war /library/jboss/3.2/deploy 7. (Opcional, pero recomendado) Eliminar completamente los directorios manakin y dspace creados en [Tomcat]/webapps ( /library/jboss/3.2/deploy for Mac OS X Server) – TEN CUIDADO… ¡no queremos borrar ningún otro directorio! ● Para forzar a Tomcat para que recompile todo, también debes eliminar los directorios manakin y dspace creado en [Tomcat]/work/Catalina/localhost 8. Iniciar Tomcat ● (Linux / OS X / Solaris) [Tomcat]/bin/startup.sh ● (Mac OS X Server) Usar el administrador de servidores para arrancar tomcat (“Servidor de aplicaciones”) ● (Windows) Usar el monitor de servicio de tomcat (en el área de notificación) para arrancar Tomcat 9. Probar los cambios en Dspace / manakin © 2006-2007 by all Authors/Contributors listed This work is licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License. 52 Guía “Cómo...” de D Space ● Cómo... [Personalizando Manakin, Versión 1.1] Instalar un tema Archivos: ● [new-theme-source] (Directorio donde se encuentra el codigo del nuevo tema) ● [manakin-source]/themes/[theme-dir] tema) ● [dspace]/config/xmlui.xconf (Nueva localización para el código del Instrucciones: 1. Si se va a instalar un tema completamente nuevo que no se distribuye con Manakin, hay que realizar las siguientes operaciones, si el tema se distribuye con Manakin, este paso se puede saltar. cp [new-theme-source] [manakin-source]/themes/[theme-dir] 2. Abrir el archivo de configuración de Manakin, [dspace]/config/xmlui.xconf, ir a la parte inferior y localizar el elemento <themes>. <theme name=”My new theme” path=”[theme-dir]”/> 4. Si se desea instalar este tema para una comunidad o colección en particular, hay que modifica la etiqueta <theme> de la siguiente manera: <theme name=”My new theme” handle=”123/1” path=”[themedir]”/> 5. Si se desea instalar este tema como tema por defecto, modifica la etiqueta <theme> (Asegurarse de que esta etiqueta es la última definida): <theme name=”My new theme” regex=”.*” path=”[theme-dir]”/> 6. Reiniciar Tomcat (Véase Reinicio rápido en Recompilar Manakin) Notas: ● Los temas se evalúan por el orden de aparición en el archivo xmlui.xconf. Así, si el tema por defecto se define antes que otros temas, esos otros temas no se usarán. © 2006-2007 by all Authors/Contributors listed This work is licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License. 53 Guía “Cómo...” de D Space 3. Añadir una nueva etiqueta <theme> dentro del elemento <themes> como sigue: Cómo... [Personalizando Manakin, Versión 1.1] Crear un nuevo tema Archivos: ● [manakin-source] /themes/[theme-dir]/sitemap.xmap (Archivo de configuración del tema) ● [manakin-source] /themes/[theme-dir]/style.css (Hoja de estilo CSS) ● [manakin-source] /themes/[theme-dir]/style-ie.css (Hoja de estilo CSS para IE) Instrucciones: 1. En primer lugar hay que determinar un nombre de directorio para el nuevo tema dentro del directorio [manakin-source]/themes. En estas instrucciones, se hace referencia a este directorio con [theme-dir] . 2. En vez de empezar el nuevo tema desde cero, se hace una copia de la plantilla del tema estándar en el nuevo directorio, [theme-dir] . cd [manakin-source]/themes ● cp -R template [theme-dir] 5. Luego, se personaliza el sitemap del tema, especificando el directorio del tema y su nombre. Abrir, [manakin-source]/themes/[theme-dir]/sitemap.xmap, y editar las variables globales como se muestra a continuación: <map:component-configurations> <global-variables> <theme-path>[theme-dir]</theme-path> <theme-name>[the name of your theme]</theme-name> </global-variables> </map:component-configurations> 6. Después, personalizar la hoja de estilos CSS, por defecto se usan dos hojas de estilo – una versión base para todos los navegadores y luego una versión adicional sólo para Internet Explorer. [manakin-source]/themes/[theme-dir]/style.css [manakin-source]/themes/[theme-dir]/style-ie.css 7. Realizar los pasos descritos en Instalar un tema 8. Realizar los pasos descritos en Recompilar Manakin © 2006-2007 by all Authors/Contributors listed This work is licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License. 54 Guía “Cómo...” de D Space ● Cómo... [Personalizando Manakin, Versión 1.1] Personalizar una cabecera o pie Archivos: ● [manakin-source]/themes/[theme-dir]/template.xsl ● [manakin-source]/themes/dri2xhtml/structural.xsl (Hoja de estilo del tema) Instrucciones: 1. Si no se tiene ya, se necesita Crear un nuevo tema 2. Para modificar la cabecera, localizar la plantilla denominada “buildHeader” dentro del archivo structural.xsl. Copiar esta plantilla dentro del template.xsl de tu tema y modificar el XSLT según las necesidades. <xsl:template name="buildHeader"> .... </xsl:template> <xsl:template name="buildFooter"> .... </xsl:template> © 2006-2007 by all Authors/Contributors listed This work is licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License. 55 Guía “Cómo...” de D Space 3. Para modificar el pie, localizar la plantilla denominada “buildFooter” dentro del archivo structural.xsl. Copiar esta plantilla dentro del template.xsl de tu tema y modificar el XSLT según las necesidades. Cómo... [Personalizando Manakin, Versión 1.1] Modificar la visualización del metadato de un ítem Archivos: (Hojas de estilo del tema) ● [manakin-source]/themes/[theme-dir]/template.xsl ● [manakin-source]/themes/dri2xhtml/DS-METS-1.0-DIM.xsl (DIM metadata handler) Instrucciones: 1. Si no se tiene ya, se necesita Crear un nuevo tema 2. Localizamos la plantilla denominada “itemSummaryView_DS-METS-1.0-DIM” dentro del DIM (DSpace Intermediate Metadata) handler base. Esta es la plantilla que se utiliza cuando se visualiza un ítem directamente (Se utiliza otra plantilla cuando el usuario pulsa en “show full item record”). <xsl:template name="itemSummaryView_DS-METS-1.0-DIM"> </xsl:template> 3. Copiar la plantilla identificada arriba en la hoja de estilo (template.xsl) del tema. Esto permitirá anular el funcionamiento por defecto. 4. Para modificar la plantilla añadiendo un nuevo campo del Dublin Core, añadimos una fila a la siguiente tabla dentro del elemento <table class="dsincludeSet-table"> en la posición deseada. Aquí se muestra un ejemplo: <tr class="ds-table-row"> <td><span class="bold">[Your label]:</span></td> <td> <xsl:copy-of select=" $data/dim:field[@element='[ dc element]' and @qualifier='[dc qualifier]']/child::node()" /> </td> </tr> 5. Para modificar la plantilla eliminado un campo del Dublin Core, elimina (o comenta) la fila de la tabla, <tr>, que contiene el campo. © 2006-2007 by all Authors/Contributors listed This work is licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License. 56 Guía “Cómo...” de D Space .... Cómo... [Personalizando Manakin, Versión 1.1] Modificar la visualización del metadato de un ítem (continuación) Notas: ● Si el campo del dublin core que se quiere añadir no tiene cualificador, como dc.type, entonces hay que reemplazar “@qualifier='[dc qualifier]'” por “not(@qualifier)” para que la regla no compare los campos con un cualificador. 57 Guía “Cómo...” de D Space © 2006-2007 by all Authors/Contributors listed This work is licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License. Cómo... [Personalizando Manakin, Versión 1.1] Añadir logos a la visualización de items Archivos: (Hoja de estilo del tema) ● [manakin-source]/themes/[theme-dir]/template.xsl ● [manakin-source]/themes/dri2xhtml/DS-METS-1.0-DIM.xsl (DIM metadata handler) Instrucciones: 1. Si no se tiene ya, se necesita Crear un nuevo tema 2. Localizar la plantilla denominada “itemSummaryList_DS-METS-1.0-DIM” dentro del DIM (DSpace Intermediate Metadata) handler base. Esta es la plantilla que se usa para mostrar un ítem individual con una lista amplia, como en la navegación por páginas o los resultados de búsqueda. <xsl:template name="itemSummaryList_DS-METS-1.0-DIM"> </xsl:template> 3. Copiar la plantilla identificada arriba en la hoja de estilo del tema, template.xsl. Esto permitirá anular el comportamiento por defecto. 4. Modificar la plantilla añadiendo un elemento <img> para el logo. La imagen usada estará basada en el campo del Dublin Core, en el siguiente ejemplo se usa dc.type. <img class=”item-logo”> <xsl:choose> <xsl:when test="$data/dim:field[@element='type']='image'"> <xsl:attribute name="src"> <xsl:value-of select="$theme-path"/> <xsl:text>/images/image.jpg</xsl:text> </xsl:attribute> </xsl:when> ... add other icon cases ... <xsl:otherwise> <xsl:attribute name="src"> <xsl:value-of select="$theme-path"/> <xsl:text>/images/unknown.jpg</xsl:text> </xsl:attribute> © 2006-2007 by all Authors/Contributors listed This work is licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License. 58 Guía “Cómo...” de D Space .... Cómo... [Personalizando Manakin, Versión 1.1] Añadir logos a la visualización de items (continuación) </xsl:otherwise> </xsl:choose> </img> 59 Guía “Cómo...” de D Space © 2006-2007 by all Authors/Contributors listed This work is licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License. Cómo... [Personalizando Manakin, Versión 1.1] Añadir texto a una página (i18n) Archivos: (catálogo i18n en ingles) ● [manakin-source]/config/i18n/messages.xml ● [manakin-source]/config/i18n/messages[language & locale].xml (catálogo i18n para idiomas distintos al ingles) Instrucciones: 1. Abrir la plantilla XSL del tema y modificar las plantillas apropiadas (es decir, la plantilla de la cabecera o del pie) añadiendo un elemento <i18n:text> donde se quiera que el nuevo texto aparezca. Asegurarse de que el valor de la clave es única, por ejemplo: <i18n:text> xmlui.yourtheme.mynewkey </i18n:text> 2. Abrir el catálogo de mensajes, config/i18n/messages.xml, y encuentra los valores de clave que comiencen con el mismo prefijo de tu nueva clave. Añade una nueva línea correspondiente a tu nueva clave: Text of my new key! </message> 3. Efectuar los pasos descritos en Recompilar Manakin. Notas: ● i18n = internacionalización ● Se puede añadir texto directamente en el XSL, pero será mas fácil de encontrarlo, para traducirlo a otros idiomas, si se usa el catálogo i18n. ● Hay que tener en cuenta que cuando añadimos o modificamos texto en el catálogo messages.xml hay qie asegurase de usar las “XML escaping rules”, como sigue: & se convierte en & ” se convierte en "e; ' se convierte en ' < se convierte en < > se convierte en > © 2006-2007 by all Authors/Contributors listed This work is licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License. 60 Guía “Cómo...” de D Space <message key="xmlui.yourtheme.mynewkey"> Cómo... [Personalizando Manakin, Versión 1.1] Instalar un Aspecto Archivos: (Directorio donde se encuentra el código del nuevo ● [new-aspect-source] aspecto) ● [manakin-source]/aspects/[aspect-dir] (Nueva localización para el código del aspecto) ● [dspace]/config/xmlui.xconf Instrucciones: 1. Si se va a instalar un aspecto completamente nuevo que no se distribuye con Manakin, hay que realiza las siguientes operaciones, si el tema se distribuye con Manakin, este paso se puede saltar. cp [new-aspect-source] [manakin-source]/aspects/[aspectdir] (el anterior comando de copia debe ir en una sola línea) 3. Añadir un nuevo elemento <aspect> dentro del elemento <aspects> como sigue: <aspect name="My new Aspect" path="[aspect-dir]/"/> 4. Reiniciar Tomcat (véase Reinicio rápido en Recompilar Manakin) © 2006-2007 by all Authors/Contributors listed This work is licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License. 61 Guía “Cómo...” de D Space 2. Abrir el archivo de configuración de Manakin, [dspace]/config/xmlui.xconf, ir a la parte inferior y localizar el elemento <aspects>. Cómo... [Personalizando Manakin, Versión 1.1] Localizar y solucionar un error Directorios/Archivos: ● Log de DSpace: [dspace]/log/dspace.log (normalmente) ● Directorio de log de Tomcat: [Tomcat]/logs (normalmente) ● Logs de Cocoon: [tomcat]/webapps/[webapp]/WEB-INF/logs/(necesario para encenderse) Sitios web: ● Web de Manakin: http://di.tamu.edu/projects/xmlui/ ● Buscador de la lista de correo dspace-manakin: http://sourceforge.net/mailarchive/forum.php?forum=dspace-manakin Instrucciones: 2. Si recibes un error “Invalid Continuation ID”significa que tienes que reiniciar Tomcat e intentar reanudar tu sesión en el servidor. Vuelve a iniciar sesión en DSpace / Manakin 3. Si necesitas mas información de log, puede activar el log de Cocoon, edita el archivo logkit.xconf . Cambia el nivel de log a DEBUG en sitemap, como sigue: <category name="sitemap" log-level="DEBUG"> 4. Si todo esto falla, escribe un email, describiendo el error junto con la pila de error, a dspace-manakin@lists.sourceforge.net. © 2006-2007 by all Authors/Contributors listed This work is licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License. 62 Guía “Cómo...” de D Space 1. Si la información esperada simplemente no aparece, mostrando una pantalla blanca en el navegador, entonces el problema, probablemente estará en la configuración de Tomcat. El mensaje de error debería estar en [Tomcat]/logs/