KnowledgeBook User Documentation

kbookTOC.html
TOC PREV NEXT INDEX

Links

View or print PDF file of chapter
 
KBook Document Home Page
KBook Product Home Page
Control Room Logbook Home Page
CD Home Page
Fermilab at Work
Fermilab Home


Chapter 1: Overview

1.1 About the KnowledgeBook

1.1.1 A Collaborative Notebook

1.1.2 Hierarchical Information Storage

1.1.3 Making Notes (called "Entries")

1.1.4 Finding and Reviewing Notes (Entries)

1.2 About the HEPBook

Chapter 2: Quick Start Guide

2.1 Open a Container and Make an Entry

2.2 List Entries in a Container

2.3 Retrieve an Entry from Storage

2.3.1 Search by Date/Time

2.3.2 Use Advanced Search

2.4 Switch Active Container

Chapter 3: The HEPBook Application Window

3.1 The Look and Feel

3.2 The Organizational Building Blocks used for Storing Entries

3.3 Overview of the KBook Window

3.4 The Explorer

3.4.1 Open a Desktop or Container

3.4.2 Access the Menu of Actions to Perform on a Node

3.5 The Open Window Navigator

3.6 The Search Pane

3.7 The Working Area

3.7.1 A Multi-Container Desktop

3.7.2 A Single-Container Desktop

Chapter 4: About Containers

4.1 Features Common to all Containers

4.1.1 Display of Path to Container

4.1.2 Menus

4.1.3 Toggle Toolbar??? Display -- NOT YET IMPLEM.

4.1.4 Entries

4.1.5 Status Bar

4.2 Single Container Desktops

Chapter 5: Entry Format and Features

5.1 Entry Format

5.2 Entry Features

Chapter 6: Getting Started with Entries

6.1 About Entry Data Types

6.2 Creating Entries

6.2.1 Create a New Container

6.2.2 Open an Existing Container and Start an Entry

6.2.3 Select Data Type and Add Data

6.3 Retrieving Entries via the Entry Explorer

6.4 Manipulating Entries

6.4.1 Container Menus

6.4.2 Container Toolbar

Chapter 7: Entering Text and Images

7.1 About Text in Entries

7.2 Text from Keyboard

7.3 Plain Text from File

7.3.1 Plain Text Toolbutton

7.3.2 Insert Menu

7.4 Formattable Text from File

7.4.1 Styled Text Toolbutton

7.4.2 Insert Menu

7.5 OS Command with Text Output

7.6 Spell Checking

7.7 Online Image Entry

7.7.1 The Insert Image Menu Option

7.7.2 The Insert Image Toolbutton

7.7.3 Image Display in an Entry

Chapter 8: Attaching Files to Entries

8.1 Attach a File

8.2 Export an Attached File

8.3 Associate a Program with an Attached File

8.3.1 Make the Association

8.3.2 Run the Program on the Attached File

Chapter 9: Entering Program Output

Chapter 10: About Forms

10.1 Simple, Standard Form Functionality

10.2 Tables in Forms

10.3 Composite Forms

10.4 Documents and Scripts in Forms

10.5 Execution of an External Program

Chapter 11: Using Forms in Entries

11.1 Adding a Form to an Entry

11.2 Overview of Form Elements

11.3 External Program Execution within Forms

11.4 Tables within Forms

11.5 Reloading Data into Form

11.6 Scripts within Forms

11.6.1 Variable Substitution

Chapter 12: Form Configuration Files

12.1 Introduction

12.1.1 Form Definition Files -- no longer used

12.1.2 XML Elements Allowed in Forms

12.1.3 Summary of Form Features

12.2 Creating a Basic Form with a Variety of Features

12.3 Including a Table in a Form

12.4 Enabling Automatic Electronic Mailing of Form Entries

12.5 Assigning Field Names

12.6 Using Scripts

12.6.1 Running an External Script or Command

12.6.2 Embedding a Script in a Form

12.6.3 Inserting a Script into a Form by Reference

12.7 Grouping Form Fields and Styled Text Field??

12.8 Creating Composite Forms with Selected Reloadable Fields

12.8.1 Overview Composite Forms

12.8.2 The Concept of "Reloading" Data

12.8.3 Create Field with Constant Default Value

12.8.4 Helpful Hints

12.9 Embedding Forms within a Form

12.9.1 Form A (The End Form)

12.9.2 Form B (b.xml)

12.9.3 Form C (c.xml)

12.9.4 Form D (d.xml)

12.9.5 Form E (e.xml)

12.9.6 How does this look to the user?

12.10 Dynamic Insertion of One Form inside Another

Chapter 13: Searching For and Retrieving Entries

13.1 The KnowledgeBook Search Panels

13.2 Search by Date and Time

13.3 Search by Sequence Number

13.4 Search by Filters

13.4.1 About Queries

13.4.2 Terms

13.4.3 Field Name-specific Criteria

13.4.4 Term Modifiers (e.g., Wildcard Characters)

13.4.5 Boolean Operators

13.5 Search by Repository


TOC PREV NEXT INDEX

The KnowledgeBook was developed by Corporate Computer Services, Inc. in cooperation with Fermilab under the DOE's SBIR program.


View/print PDF file | KBook Document Home Page | KBook Product Home Page | Control Room Logbook Home Page | Computing Division | Fermilab at Work | Fermilab Home