# Definition
# Gerald Banon, 1998

package provide dpi.inpe.br/banon/1998/08.02.08.56 2.1

# ----------------------------------------------------------------------
# identification key

proc {identification key} {t} {
	global commonWords
	global citationKeyRepository
	set r $citationKeyRepository
	$t delete 1.0 end
	TextStyles $t
	Insert $t insert Definition
	TagAdd $t bold {Definition}
	$t insert insert "\n\n"
	Insert $t insert \
{The identification key of a document is a short string\
which helps the visual identification of the document.}
	TagAdd $t italic {identification key of a document}
	TagAdd $t italic {helps}
	$t insert insert "\n\n"
	Insert $t insert \
{If the document has a metadata, then the string is\
divided into three parts capturing the author names,\
the publishing year and the title of the document.\
Each part is separated by a colon (:).}
	TagAdd $t fixed {colon}
	$t insert insert "\n\n"
	set key [${r}::CreateKey \
		{{Oppenheim, Alan V.,} {Schafer, Ronald W.,}} 1975 \
		{Digital Signal Processing} $commonWords]
	Insert $t insert \
{For example, the identification key of the book by Alan V. Oppenheim\
and Ronald W. Schafer, entitled Digital Signal Processing and\
published in 1975, is:}
	TagAdd $t italic {Alan V. Oppenheim}
	TagAdd $t italic {Ronald W. Schafer}
	TagAdd $t italic {Digital Signal Processing}
	TagAdd $t italic {1975}
	$t insert insert "\n"
	Insert $t insert \
{<$var1>.} \
{} $key
	TagAdd $t fixed {<$var1>} -forward $key
	$t insert insert "\n\n"
	Insert $t insert \
{The identification key is not necessarily unique. Two different\
documents may have the same identification key.\
Ultimately, two documents with the same\
identification key will be differentiated by the name of their\
repositories.}
	$t insert insert "\n\n"
	Insert $t insert \
{If the document has no metadata, then the string\
is simply the target file name enclosed by colons (:).}
	TagAdd $t fixed {colon}
}

# identification key - end
# ----------------------------------------------------------------------
# target file
# not used

proc {target file} {t} {
	$t delete 1.0 end
	TextStyles $t
	Insert $t insert Definition
	TagAdd $t bold {Definition}
	$t insert insert "\n\n"
	Insert $t insert \
{The target file of a document is the first file to be open\
at access time.}
	TagAdd $t italic {target file of a document}
	$t insert insert "\n\n"
	Insert $t insert \
{For example, if a book is stored as a set of files,\
one file for each chapter and one file for the book content with links\
to the chapters, then the target file will be the book content file.}
}

# target file - end
# ----------------------------------------------------------------------
# document

proc {document} {t} {
	$t delete 1.0 end
	TextStyles $t
	Insert $t insert Definition
	TagAdd $t bold {Definition}
	$t insert insert "\n\n"
	Insert $t insert \
"A document is any collection of files and directories under\
a same directory called document folder."
	TagAdd $t italic document
	TagAdd $t italic "document folder"
}

# document - end
# ----------------------------------------------------------------------
# repository

proc {repository} {t} {
	$t delete 1.0 end
	TextStyles $t
	$t insert insert "\n"
	Insert $t insert Definition
	TagAdd $t bold {Definition}
	$t insert insert "\n\n"
	Insert $t insert \
{A repository is a sequence of four successive directories whose\
names are respectively, a domaine name, a user name, a year and\
a month.day.hour.minute\[.second\].}
	TagAdd $t italic repository
	$t insert insert "\n\n"
	Insert $t insert \
"Here is an example of a repository name: \
<dpi.inpe.br/banon/1995/08.08.00.00>."
	TagAdd $t fixed <dpi.inpe.br/banon/1995/08.08.00.00>
}

# repository - end
# ----------------------------------------------------------------------
# metadata

proc {metadata} {t} {
	$t delete 1.0 end
	TextStyles $t
	$t insert insert "\n"
	Insert $t insert Definition
	TagAdd $t bold {Definition}
	$t insert insert "\n\n"
	Insert $t insert \
{Metadata are information about data. For the URLibService,\
Metadata are elements of a bibliographic reference about\
a document deposited in the collection. Associated\
with a document there may be one or more pieces of metadata\
(for example, one for each language), each of them being deposited\
in its own repository.}
	TagAdd $t italic Metadata
	TagAdd $t italic {Lib}
	TagAdd $t italic Metadata backward
}

# metadata - end
# ----------------------------------------------------------------------
