# Browsing the Local Collection (BC)
# Gerald Banon, 2000 - 2024

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

# ----------------------------------------------------------------------
# Example:
# BCHelp .window.main.bc {} bc(result1)

proc BCHelp {entryWidget entryName varName} {
# runs with start
# entryName and varName not used in BCHelp (used in XXDirectory)
#	regexp ".*\.bc" $entryWidget win	;# .window.main.bc
#	set win $entryWidget
	regsub {.bc} $entryWidget {} win	;# .window.main
	set t .bchelp.f.t
	$t delete 1.0 end
	set font [lindex [lindex [$t configure -font] end] 0]
	$t configure -font {$font 10}
	set pwd [pwd]
	regexp {(^.*)/col/} $pwd m homePath
	TextStyles $t
	Insert $t insert \
{Browsing the Local Collection}
	TagAdd $t bold12 {Browsing the Local Collection}
	$t insert insert "\n\n"
	Insert $t insert \
"In the URLib collection the documents are deposited in repositories,\
one repository for each document."
	TagAdd $t italic {Lib}
	TagAdd $t italic {documents}
	TagAdd $t green {documents}
	TagAdd $t underline {documents}
	TagAdd $t {document} {documents}
	TagBind $t {document} $win.definition
	TagAdd $t italic repositories
	TagAdd $t green {repositories}
	TagAdd $t underline {repositories}
	TagAdd $t {repository} {repositories}
	TagBind $t {repository} $win.definition
	$t insert insert "\n\n"
	Insert $t insert \
"You browse the local collection by filling the white field\
with a repository name and by clicking the C Button (C for Check)."
	TagAdd $t current9 C
	TagAdd $t blue {C Button}
	TagAdd $t {C Button} {C Button}
	TagBind $t {C Button} $entryWidget.rep.h2.entry.button4.4
	$t insert insert "\n\n"
	Insert $t insert \
"You enter the repository name by using the\
keyboard or alternatively the two Buttons < and >."
	TagAdd $t courier11 <
	TagAdd $t courier11 >
	TagAdd $t blue {Buttons < and >}
	TagAdd $t {Buttons < and >2} {Buttons < and >}
	TagBind $t {Buttons < and >2} "$entryWidget.rep.h2.entry.button1.1 \
		$entryWidget.rep.h2.entry.button2.2"
	$t insert insert "\n\n"
	Insert $t insert \
"The > Button is a menu button which gives you all the possible\
entries."
	TagAdd $t courier11 >
	TagAdd $t blue {> Button}
	TagAdd $t {> Button} {> Button}
	TagBind $t {> Button} $entryWidget.rep.h2.entry.button2.2
	$t insert insert " "
	Insert $t insert \
"The < Button allows you to return to the previous entry."
	TagAdd $t courier11 <
	TagAdd $t blue {< Button}
	TagAdd $t {< Button} {< Button}
	TagBind $t {< Button} $entryWidget.rep.h2.entry.button1.1
	$t insert insert "\n\n"
	Insert $t insert \
"You can use the Back Space Key in place of the < Button to get\
a backward similar effect."
	TagAdd $t italic {Back Space Key}
	TagAdd $t courier11 <
	$t insert insert "\n\n"
	Insert $t insert \
"A click on the < Button by using the mouse right button clears the entry."
	TagAdd $t courier11 <
	TagAdd $t blue {< Button}
	TagAdd $t {< Button} {< Button}
	TagBind $t {< Button} $entryWidget.rep.h2.entry.button1.1
	TagAdd $t italic right
	$t insert insert "\n\n"
	Insert $t insert \
"The S Menu Button (S for Select) may be used to re-enter one of the\
most recent entries."
	TagAdd $t current9 S
	TagAdd $t blue {S Menu Button}
	TagAdd $t {S Menu Button} {S Menu Button}
	TagBind $t {S Menu Button} $entryWidget.rep.h2.entry.button3.3
	$t insert insert "\n\n"
	Insert $t insert \
"A click on the S Menu Button by using the mouse right button\
selects the previous entry."
	TagAdd $t current9 S
	TagAdd $t blue {S Menu Button}
	TagAdd $t {S Menu Button} {S Menu Button}
	TagBind $t {S Menu Button} $entryWidget.rep.h2.entry.button3.3
	TagAdd $t italic right
	$t insert insert "\n\n"
	Insert $t insert \
"There are two possible options for entering the repository name."
	TagAdd $t italic two
	$t insert insert "\n\n"
	Insert $t insert \
"The default one is called Identification Key First."
	TagAdd $t italic {Identification Key First}
	$t insert insert " "
	Insert $t insert \
"This is the simplest option, instead of the\
repository name, you enter (first) the identification\
key associated with it. If there is only one repository having\
that identification key, then the repository name is\
automatically added."
	TagAdd $t italic {identification key}
	TagAdd $t green {identification key}
	TagAdd $t underline {identification key}
	TagAdd $t {identification key} {identification key}
	TagBind $t {identification key} $win.definition
 	$t insert insert "\n\n"
	Insert $t insert \
"The second option is called Repository First."
	TagAdd $t italic {Repository First}
	$t insert insert " "
	Insert $t insert \
"With this option, you enter first the repository name and the\
identification key is automatically added."
	$t insert insert "\n\n"
	Insert $t insert \
"In both cases, when the entry is complete, the background color\
becomes  magenta ."
	TagAdd $t magenta { magenta }
	$t insert insert "\n\n"
	Insert $t insert \
"You can then switch from one option to the other, just by pressing\
the R Button (R for Reverse)."
	TagAdd $t current9 R
	TagAdd $t blue {R Button}
	TagAdd $t {R Button} {R Button}
	TagBind $t {R Button} $entryWidget.rep.h2.entry.button5.5
	$t insert insert "\n\n"
	Insert $t insert \
"Finally, you can fill the entry with the result of a repository\
search based on keywords."
	$t insert insert "\n\n"
	Insert $t insert \
"By pressing the Find Button (F for Find) the background color\
becomes  cyan  and you can enter a search expression."
	TagAdd $t current9 Find
	TagAdd $t blue {Find Button}
	TagAdd $t {F Button} {Find Button}
	TagBind $t {F Button} $entryWidget.rep.h2.entry.button6.6
	TagAdd $t cyan { cyan }
	TagAdd $t italic {search expression}
	TagAdd $t green {search expression}
	TagAdd $t underline {search expression}
	TagAdd $t {search expression} {search expression}
	$t tag bind {search expression} <1> "Link {} {} mirror.cgi/Help?returnbutton=no"
	$t tag bind {search expression} <Enter> "$t config -cursor hand2"
	$t tag bind {search expression}  <Leave> "$t config -cursor double_arrow"
	$t insert insert "\n\n"
	Insert $t insert \
"You submit your search by pressing the Find Button or the\
Return Key."
	TagAdd $t current9 Find
	TagAdd $t blue {Find Button}
	TagAdd $t {F Button} {Find Button}
	TagBind $t {F Button} $entryWidget.rep.h2.entry.button6.6
	$t insert insert "\n\n"
	Insert $t insert \
"If just one repository was found, then its name is displayed over\
a  magenta  backgroung, otherwise you can use the Buttons < and >\
to browse the search result."
	TagAdd $t magenta { magenta }
	TagAdd $t courier11 <
	TagAdd $t courier11 >
	TagAdd $t blue {Buttons < and >}
	TagAdd $t {Buttons < and >2} {Buttons < and >}
	TagBind $t {Buttons < and >2} "$entryWidget.rep.h2.entry.button1.1 \
		$entryWidget.rep.h2.entry.button2.2"
	$t insert insert "\n\n"
	Insert $t insert \
{Creating a New Document Version}
	TagAdd $t bold {Creating a New Document Version}
	$t insert insert "\n\n"
	Insert $t insert \
"Any document changes will result in the warning message:\
modified version, when opening the document cover on the Web\
unless you create a new version number for that document."
	TagAdd $t italic {modified version}
	$t insert insert "\n\n"
	Insert $t insert \
"When you browse the local collection using the URLibService,\
any document changes turn the Reload button name into red\
and the out-of-date document warning into black."
	TagAdd $t italic {Lib}
	TagAdd $t current9 Reload
	TagAdd $t blue {Reload}
	TagAdd $t {Reload} {Reload}
	TagBind $t {Reload} $entryWidget.button.reload.reload {} 0
	TagAdd $t blue {out-of-date document}
	TagAdd $t {out-of-date document} {out-of-date document}
	TagBind $t {out-of-date document} $entryWidget.rep.label.lb1.lb1 {} 0 #000000 #999999
	$t insert insert "\n\n"
	Insert $t insert \
"After any changes, to create a new document version,\
you just click (using the mouse left button)\
the Reload Button. This action will update\
the URLibService data base as well as the contain of\
the <download> directory."
	TagAdd $t italic {Lib}
	TagAdd $t current9 Reload
	TagAdd $t blue {Reload Button}
	TagAdd $t {Reload Button} {Reload Button}
	TagBind $t {Reload Button} $entryWidget.button.reload.reload
	TagAdd $t fixed {<download>}
	$t insert insert "\n\n"
	Insert $t insert \
{Registering the Last Document Version}
	TagAdd $t bold {Registering the Last Document Version}
	$t insert insert "\n\n"
	Insert $t insert \
"Besides creating a new document version, if you click the\
Reload Button using the mouse right button, you will be asked\
to register remotely the last document version in an independent data base,\
and back it up permanently."
	TagAdd $t current9 Reload
	TagAdd $t blue {Reload Button}
	TagAdd $t {Reload Button} {Reload Button}
#	TagBind $t {Reload Button} $entryWidget.button.reload.reload
	$t insert insert "\n\n"
	Insert $t insert \
"The document backup is the <doc.zip> file in the <download>\
directory of the current repository. Any registered backup will be\
automatically moved into the <backup> directory of the current\
repository next time a new document version creation occurs."
	TagAdd $t fixed {<doc.zip>}
	TagAdd $t fixed {<download>}
	TagAdd $t fixed {<backup>}
	$t insert insert "\n\n"
	Insert $t insert \
"The Reload button name will remain coloured and\
the not registered document warning\
black, as long as the communication with the\
independent data base cannot be completed.\
You can try later to complete the remote registration\
by pressing the Reload Button again."
	TagAdd $t current9 Reload
	TagAdd $t blue {Reload}
	TagAdd $t {Reload} {Reload}
	TagAdd $t blue {not registered document}
	TagAdd $t {not registered document} {not registered document}
	TagBind $t {not registered document} $entryWidget.rep.label.lb3.lb3 {} 0 #000000 #999999
	TagAdd $t current9 Reload -backward
	TagAdd $t blue {Reload Button} -backward
	TagAdd $t {Reload Button} {Reload Button} -backward
#	TagBind $t {Reload Button} $entryWidget.button.reload.reload
	$t insert insert "\n\n"
	Insert $t insert \
"Registering a document is important to prove\
which document comes first."
	$t insert insert "\n\n"
	Insert $t insert \
{Editing Metadata}
	TagAdd $t bold {Editing Metadata}
	$t insert insert "\n\n"
	Insert $t insert \
"When browsing the local collection, you can edit the metadata\
of the repository whose name is displayed in the  magenta  field,\
by pressing the Edit Menu Button."
	TagAdd $t italic {metadata}
	TagAdd $t green {metadata}
	TagAdd $t underline {metadata}
	TagAdd $t {metadata} {metadata}
	TagBind $t {metadata} $win.definition
	TagAdd $t magenta { magenta }
	TagAdd $t current9 Edit
	TagAdd $t blue {Edit Menu Button}
	TagAdd $t {Edit Menu Button} {Edit Menu Button}
	TagBind $t {Edit Menu Button} $entryWidget.button.edit.edit
	$t insert insert "\n\n"
	Insert $t insert \
"The menu of the Edit Button displays one entry for each of\
possible reference types plus an empty entry at the top.\
By clicking this top entry, an Edit Window will open showing the\
metadada for the selected repository."
	$t insert insert "\n\n"
	Insert $t insert \
"All the changes you have made in the Edit Window are saved\
in the URLib bibliographic data base when you leave this window\
by clicking the OK Button (you don't need to press the\
Reload Button afterward to update this data base)."
	TagAdd $t italic {Lib}
	TagAdd $t current9 OK
	TagAdd $t current9 Reload
	TagAdd $t blue {Reload Button}
	TagAdd $t {Reload Button} {Reload Button}
#	TagBind $t {Reload Button} $entryWidget.button.reload.reload
	$t insert insert "\n\n"
	Insert $t insert \
"If you want to change the reference type of a set of metadata,\
instead of selecting the top empty entry of the Edit Menu Button,\
you just select the desired reference type entry."
	TagAdd $t current9 Edit
	TagAdd $t blue {Edit Menu Button}
	TagAdd $t {Edit Menu Button} {Edit Menu Button}
	TagBind $t {Edit Menu Button} $entryWidget.button.edit.edit
	$t insert insert "\n\n"
	Insert $t insert \
{Deleting a Repository}
	TagAdd $t bold {Deleting a Repository}
	$t insert insert "\n\n"
	Insert $t insert \
"To delete a repository from the URLib local collection, press\
the Delete Button. The Delete Button is disabled whenever the\
repository has non empty <auxdoc> and/or <source> directories\
or has at least one child repository or has at least one citing item\
or when the repository has not been captured after a copyright transfer."
	TagAdd $t italic {Lib}
	TagAdd $t current9 Delete
	TagAdd $t blue {Delete Button}
	TagAdd $t {Delete Button} {Delete Button}
	TagBind $t {Delete Button} $entryWidget.button.delete.delete
	TagAdd $t fixed {<auxdoc>}
	TagAdd $t fixed {<source>}
	$t insert insert "\n"

	$t configure -state disabled
}