SLAC PEP-II
BABAR
SLAC<->RAL
Babar logo
Workbook HEPIC Databases PDG HEP preprints
Organization Detector Computing Physics Documentation
Personnel Glossary Sitemap Search Hypernews
Unwrap page!
Wkbk. Search
Wkbk. Sitemap
Introduction
Non SLAC
HOWTO's
Introduction
Logging In
QuickTour
Detector
Info Resources
Software Infrastructure
CM2 Introduction
Unix
OO
SRT
Objectivity
Event Store
Framework
Beta
Modifying Code
Writing and Editing
Compiling
Debugging
Analysis
Framework II
Analysis
Find Data
Batch Processing
PAW
PAW II
ROOT I
ROOT II
ROOT III
Advanced Infrastructure
New Releases
Workdir
Main Packages
Event Displays
Gen/Sim/Reco
Contributing Software
SRT and CVS
Coding
Advanced Topics
Make CM2 Ntuples
New Packages
New Packages 2
Persistent Classes
Java
Site Installation
Check this page for HTML 4.01 Transitional compliance with the
W3C Validator
(More checks...)

Workbook for BaBar Offline Users - Automatic Method to Extract a Glossary

Consult the BaBar Glossary Author Before Replicating this Project

The following document was written before the BaBar Glossary was actually created. Subsequently, the actual BaBar Glossary was created. The design principles are essentially the same as are discussed here, but it would be worthwhile to contact the Glossary's creator, Tracey Marsh, before an actual attempt to replicate this project.

The Workbook's Relationship to the Glossary

Because the Workbook is structured to introduce BaBar terms in an orderly manner, it can serve as source material for at least part of a BaBar Glossary.

To accomplish this, each Workbook sentence that serves to introduce a new term needs only to be bracketed by a set of special symbols hidden in html comments. A script can then be written to extract these definitions into a BaBar Glossary relational database (probably Oracle, but one could insulate against dependence on any one particular relational database by using the Java database interface).

For example, the Workbook could contain the following definitions (taken from the BaBar Users Guide):

Modules can be associated into sequences. A sequence of modules is a list of one or more modules that will be executed in the order with which they appear in the list. Several standard sequences might be setup, dealing with common sequences of operations (e.g. drift chamber hit finding followed by tracking).

Finally Modules and Sequences can be combined into Paths. A Path is a complete execution sequence, commencing at the input module and terminating at the output module.

The HTML source for this could contain glossary tags as follows:

Modules can be associated into sequences.
<!-- begin_glossary: sequence>
A sequence of modules is a list of one or more modules that
will be executed in the order with which they appear in the list.
<!-- end_glossary>
Several standard sequences might be setup, dealing with common sequences of operations
(e.g. drift chamber hit finding followed by tracking). 
<P>
Finally Modules and Sequences can be combined into Paths.
<!-- begin_glossary: path>
A Path is a complete execution sequence,
commencing at the input module and terminating at the output module.
<!-- end_glossary>
This would then yield the following two glossary entries:

Sequence
A sequence of modules is a list of one or more modules that will be executed in the order with which they appear in the list.

Path
A Path is a complete execution sequence, commencing at the input module and terminating at the output module.

The Rest of the Glossary Interface

Users browse the Glossary database through a web interface. This interface will use the Java database interface to insulate against dependence on any one particular database vendor.

An additional web interface will let BaBar collaborators insert additional terms into this database. Terms inserted in this way will not actually be visible until they have been approved by a Glossary moderator (protects against incorrect or inappropriate entries).

If the user asks for the definition of a term that is not yet in the Glossary, this term will be added to a list of terms for which the moderator should solicit a definition.

The Structure of the Glossary Database

For each entry, the database would contain the following columns:
  • term
  • definition
  • reference
  • approved
  • For terms from the Workbook, the reference would be a link to the relevant Workbook location
  • For terms from the Workbook, approved would already be set to YES.
  • For terms submitted through the web, approved would be set to NO until reviewed by the moderator.
  • For terms entered in the user interface but for which there was no definition, definition and reference would remain undefined, approved would be set to NO until reviewed by the moderator.

Back to Workbook Front Page

Author:
Joseph Perl
Last edited by:
Jenny Williams

Last modification: 11 Mar 2001
Last significant update: 30 August 1999