<!ATTLIST extension
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED>
<!ELEMENT index EMPTY>
<!ATTLIST index
file CDATA #REQUIRED>
Código de configuración para el archivo de índice:
<!ELEMENT index (entry)* >
<!ELEMENT entry (entry | topic)* >
<!ATTLIST entry keyword CDATA #REQUIRED >
<!ELEMENT topic EMPTY >
<!ATTLIST topic href CDATA #REQUIRED >
<!ATTLIST topic title CDATA #IMPLIED >
El elemento index
El elemento index representa una instancia de index. El índice consta de entradas, cada una de las cuales corresponde a una palabra clave determinada. Todos los índices proporcionados se fusionan en un índice maestro que el Sistema de ayuda proporciona al usuario. Cuando se construye el índice, las entradas se añaden por orden alfabético.
El elemento entry
El elemento entry representa una palabra clave del índice. Cada entrada puede contener varios enlaces a temas de ayuda asociados a la palabra clave. La entrada también puede ser un contenedor para otras entradas (subentradas) para formar una jerarquía de palabras clave. Está permitido que una entrada sea un contenedor para subentradas y que tenga elementos al mismo tiempo.
El elemento topic
El elemento topic proporciona una referencia al contenido de la ayuda relacionado con la palabra clave. El atributo href es relativo al plug-in al que pertenece el archivo de manifiesto. Si necesita acceder a un archivo en otro plug-in, puede utilizar la sintaxis.
<topic label="tema situado en otro plug-in" href="../other.plugin.id/concepts/some_other_file.html" />
El atributo de título se utiliza para denominar el enlace al contenido de la ayuda cuando hay varios temas asociados a una sola palabra clave. Si no se especifica el atributo, el título viene de una TOC propietaria del enlace. Si el enlace no pertenece a ninguna TOC, debe especificarse el atributo o de lo contrario el título quedará sin definir.
(en el archivo plugin.xml)
<extension point=
"org.eclipse.help.index"
>
<index file=
"index.xml"
/>
</extension>
(en el archivo index.xml)
<index>
<entry keyword="Vehículo">
<topic href="invento_de_rueda.html"/>
<entry keyword="Coche">
<topic href="coche.html"/>
</entry>
<entry keyword="Barco">
<topic href="barco.html"/>
</entry>
<entry keyword="Avión">
<topic href="avión.html" title="Historia de la aviación"/>
<topic href="reactor.html" title="Motor a reacción"/>
</entry>
</entry>
<entry keyword="Motor">
<entry keyword="Caballo">
<topic href="caballo.html"/>
</entry>
<entry keyword="Vapor">
<topic href="vapor.html"/>
</entry>
<entry keyword="Motor Wankel">
<topic href="wankel.html"/>
</entry>
<entry keyword="Motor a reacción">
<topic href="reactor.html"/>
</entry>
</entry>
<entry keyword="Electricidad">
<topic href="electricidad.html"/>
</entry>
</index>
Internacionalización Los archivos XML pueden traducirse y la copia resultante (con las palabras clave traducidas) debe colocarse en el directorio nl/<idioma>/<país> o nl/<idioma>. <idioma> y <país> corresponden a códigos de idioma y país de dos letras utilizados en los códigos de entorno local. Por ejemplo, las traducciones al Chino tradicional deben colocarse en el directorio nl/zh/TW. El directorio nl/<idioma>/<país> tiene una prioridad más alta que el directorio nl/<idioma>. Sólo se utilizará el archivo que resida en el directorio nl/<idioma> si no se encuentra ningún archivo en el directorio nl/<idioma>/<país>. En último lugar, se buscará en el directorio raíz de un plug-in.
Copyright (c) 2006 Intel Corporation y otros.
Reservados todos los derechos. Este programa y sus materiales adjuntos están
disponibles bajo los términos de la licencia pública común (Eclipse Public
License) v1.0 que acompaña a esta distribución, y está disponible en http://www.eclipse.org/legal/epl-v10.html