elementos-comunes
— Elementos y atributos comunes a varios DTDs de repasa
Diversos documentos XML de repasa
emplean algunos elementos
de forma reiterada: desc
para descripciones,
anota
para agregar anotaciones,
derechos
para indicar derechos de reproducción
de una porción del documento; autor
para indicar
autor o autores de una porción del documento y
biblio
para indicar bibliografía. Por otra
parte algunos elementos de diversos DTDs emplean los atributos
formato
y longitud
.
Con los elementos derechos
,
autor
y biblio
se supone
que "cubren" todos los subelementos que no indiquen algo contrario.
Considere por ejemplo el siguiente archivo de clasificaciones (ver
clasif(5)):
<?xml version="1.0" encoding="ISO-8859-1"?> <!DOCTYPE clasificacion PUBLIC "-//Structio//DTD clasificacion 1.0" "clasif.dtd"> <clasificacion formato="tex" longitud="80" tipos="Logro;Indicador"> <desc>Ejemplo de clasificación con varios autores</desc> <biblio>Bibliografía 1</biblio> <derechos tipo="Dominio público" tiempo="2003">Liberado al dominio público. No se ofrece garantías.</derechos> <autor fecha="2003">Andrés Ramirez</autor> <autor fecha="2003">Felipe Buitrago</autor> <clasif tipo="Logro" id="A"><desc>Logro A</desc> <clasif tipo="Indicador" id="A.x"><desc>Indicador x de logro A</desc> </clasif> </clasif> <clasif tipo="Logro" id="B"><desc>Logro B</desc> <clasif tipo="Indicador" id="B.x"><desc>Indicador x de logro B</desc> </clasif> </clasif> <clasif tipo="Logro" id="C"><desc>Logro C</desc> <autor fecha="2003">Camila Rodriguez</autor> <clasif tipo="Indicador" id="C.x"><desc>Indicador x de logro C</desc> </clasif> </clasif> </clasificacion>
Tiene tres clasificaciones tipo Logro
(A
, B
y C
) ,
cada una con una subclasificación tipo Indicador
(A.x
, B.x
y C.x
).
Todas comparten los mismos derechos de
reproducción y bibliografía, pero los autores de los logros A y B
(así como sus indicadores) son "Andrés Ramirez" y "Felipe Buitrago",
mientras que la autora del logro C es "Camila Rodriguez".
desc
- Una descripciónEs una descripción arbitraria en el formato del documento
(i.e DocBook, TeX o texto).
El formato del documento se especifica en el atributo
formato
del elemento raíz
(ver por ejemplo detalle del elemento clasificacion
en clasif(5)).
anota
- Una anotaciónEs una anotación arbitraria en el formato del documento
(i.e DocBook, TeX o texto), podría haber más de
una en un mismo elemento.
Cada anotación debe tener un tipo que no contengan el
caracter ';' especificado
en el atributo tipo
y puede tener bien una
identificación única especificada en el atributo
id
o un dato en el atributo
valor
. El dato del atributo
valor
debe ser único dentro del elemento
en el que esté la anotación.
El tipo de las anotaciones
es arbitrario y NO tiene relación con otros tipos (por ejemplo
en clasificaciones o secuencias).
derechos
- Especifica derechos de
reproducciónSe aplica a todos los subelementos que no tenga otros derechos
de reproducción (ver Introducción).
Puede tener un atributo tipo
,
con un valor arbitrario que le permitirá al autor organizar
diversas clases de licencias y derechos de reproducción.
Un valor posible es
Dominio público
que indica que no se reserva
derecho patrimonial alguno. Además del tipo debe indicarse el
año o años de publicación en el atributo
tiempo
.
En caso de reservar algún derecho patrimonial debe emplearse
el atributo titular
cuyo valor debe
ser el/los titular(es) de los derechos patrimoniales
(también pueden especificarse varios
titulares con diversos derechos en varios elementos
derechos
).
Como cuerpo de este elemento deben escribirse los términos
de los derechos de reproducción de ser el caso, o una nota
de cesión de derechos en el caso de dominio público, cualquiera
de estos en el formato del documento (ver elemento
desc
).
Por ejemplo, suponiendo que hay una entidad mit.txt
con el texto de una licencia (ver
xmlintro(5)):
<derechos tipo="Dominio público" tiempo="2003"> Los autores de este documento, renunciamos a todos los derechos patrimoniales y lo cedemos al dominio público. Apreciamos que se cite la fuente. No ofrecemos garantía de tipo alguno. </derechos> <derechos tipo="MIT" tiempo="2003"> titular="Gerardo Arrieta"> &mit.txt; </derechos>
El tipo de los derechos es arbitrario (fije las posibilidades en su institución) y NO tiene relación con tipos de clasificaciones o secuencias.
biblio
- Especifica bibliografíaSe aplica a todos los subelementos que no tenga otra
bibliografía.
El contenido es una cadena arbitraria en el formato del
documento (ver elemento
desc
).
Sugerimos acordar y emplear una convención en su institución.
autor
- Especifica un autorSe aplica a todos los subelementos que no tenga otro(s)
autor(es).
El contenido es una cadena arbitraria en el formato del
documento (ver elemento
desc
).
Sugerimos acordar y emplear una convención en su institución
(por ejemplo nombres completos seguidos de apellidos completos).
Pueden emplearse los siguientes atributos:
Fecha de la edición más reciente que el autor hizo al documento. Puede ser un año, o un mes seguido de '/' y el año, o una fecha completa que consta de día, mes y año separados uno de otro con '/'.
Organización a la que pertenece el autor.
Dirección electrónica del autor.
Si no se emplea dirección electrónica, información para contactar al autor (e.g dirección postal del sitio de trabajo).
formato
y longitud
Algunos elementos como la raíz de un archivo de clasificaciones
clasificacion
, la raíz de un archivo de
definiciones def
y la raíz de un archivo de
secuencia secuencia
emplean los atributos
formato
y longitud
para
definir el formato que emplearán las descripción del
archivo y
la longitud máxima que se espera de cada descripción
(longitud
que será chequeada con el programa de chequeo
repchq).
Los formatos posibles son: texto
,
tex
y docbook
,
aunque de los formatos diferentes a texto, sólo un
subconjunto de cada uno es soportado.
Por ejemplo en una clasificación podría emplearse en
el elemento raíz:
<clasificacion formato="tex" longitud="80">
que indicaría que las descripciones que haya en el archivo
estarán
escritas en TeX (excepto por las convenciones de XML, ver
xmlintro(5))
y se espera que al convertirlas
a texto plano no sobrepasen 80 caracteres. Ambas convenciones
pueden ser cambiadas o establecidas por los programas de chequeo
con las opciones -f
y -l
.