Logbook help

Help

How to navigate:

select a folder with the year from the tree view on the left side
then select a folder with the week
finally select one shift from the tree view

the three shifts per day are named with the date (MM.DD_) and
- M: Morning
- A: Afternoon
- N: Night
if the actual shift does not appear in the list: press SHIFT + Reload button (force a reload of the cache)

How to insert and change an item:

select the icon to insert a new text
or select the icon to change a text or meta info of a picture
fill the form: add your name, set the severity, keywords and type the text in the text field
set the date and time field: the logbook entries are sorted by this date and time
the time should be specified like: 08:12 (the leading zero is important for the search!)
do a spell check if needed
click the "SAVE the file" button
click on the shift icon in the tree view to refresh the page
rules for the SEVERITY selection in the form:

	NONE	for normal logbook entries
	FATAL	for failures that prevent from operation of the machine for more than one hour
	ERROR	for errors in a device/subsystem/program etc.
	FIXED	error that has been fixed
	WARN	for warnings to other users or operators (don't forget, check this...)
	INFO	for hints to other users or operators
	MEASURE	message about a measurement (beam parameter, radiation ..)
	IDEA	extra ideas and communication ("would be nice to have"..)
	DOCU	documentation of some subsystem
	TODO	work to be done
	DONE	work that has been done
	DELETE	marks an entry as deleted: the item is then no more visible in the eLogBook
	WOW	to announce some (big) success

How to insert a graphic or picture:

create a your graphic with any program
print the graphic to the printer named "xxxlog" as Postscript
if possible use Postscript vector graphics and not raster files converted into Postscript
e.g. in ddd use the print command and not snapshot (sometimes snapshot is better)
wait a few seconds for the print to be processed and to appear in the logbook directory
do a refresh of the page by clicking on the shift icon in the tree view
click on the icon below the picture to add info that explains your graphic

all programs from all computers/users are allowed to print (for the moment)
the print is inserted into the actual shift
select the printer named "xxxlogprev" to add items to the previous shift log
example text inserted from UNIX: echo "my text" | lp -d ttflog

How to get a graphic or picture to your local hard disk:

to get the orignal Postscript graphics (as it has been send to the logbook printer), simply click (left button) on the graphics. This will (mostly) result in two different behaviours depending to your local browser settings:
1. You are asked to select a option from a menu (including "Save as").
2. The picture is shown in a Postscript viewer. To save it choose "Save as" from the viewers "File" menu.
To get the JPEG graphics that is shown in the browser, just do a right click on that graphic and choose "Save Image as" (Netscape) or "Save Picture as" (IExplorer).

How to add style to the an entry:

The elogbook supports the use of "Wiki style" markup. This means that one can use some simple markup to e.g. let a word appear in bold letters. The following table lists all possible markup supported by the elogbook.

Function	Markup
unnumbered list	* as the first character of a line
numbered list	# as the first character of a line
table	\| as the first character of a line and before a new column
bold	two times _ before and after the bold string
italic	two times ` before and after the italic string
heading 1	! as the first character of a line
heading 2	!! as the first character of a line
horizontal line	---- at the beginning of a line
URLs	strings starting with: http: ,https: ,file: ,mailto:

Rules for the logbook:

never delete a message (add corrections only)
graphics and text items can be deleted from the logbook by the administrator only

Some explanations of the technology used for the logbook:

The user programs:

any program that allows to print PostScript as the source for the logbook entries
a standard browser (e.g.Netscape) to display the logbook
an applet for the dynamic tree view of the shifts
an applet to do the spell checking

The server:

a daemon (shell script) that listens to the print queues
the UNIX file system to store the entries (one file per entry)
Apache web server with XALAN and XERCES runnning in a tomcat engine
JAVA servlets to create the dynamic HTML pages
XML files to store the meta information
XSL files to define the translation of the dynamic content into the HTML pages
JAVA server pages are used as a further step to display dynamic content in HTML pages
JAVA taglibs are used to take the parameters from configuration files

The DOOCS team, DESY -MVP-