This page is also available in

Documentation

Below documentation is part of the BeeBase dictribution and is also available in PDF.

Table of Contents

1. BeeBase Copying Conditions

1.1 License
1.2 Donation
1.3 Mailing List
1.4 Disclaimer
1.5 Third Party Material

1.5.1 Windows, Mac OS and Linux Versions
1.5.2 Amiga Version

2. Welcome to BeeBase
3. Getting Started

3.1 Installing BeeBase on Windows
3.2 Installing BeeBase on Mac OS
3.3 Installing BeeBase on Linux
3.4 Installing BeeBase on Amiga
3.5 Updating from a Previous Version
3.6 Starting BeeBase
3.7 Quitting BeeBase
3.8 Filename Conventions on Windows, Mac OS and Linux

4. Tutorial

4.1 How BeeBase Works
4.2 Starting with a Project, the Structure Editor
4.3 Adding a Table
4.4 Adding a Field
4.5 Displaying the Project
4.6 Adding two Reference Fields
4.7 Adding Records
4.8 Filter
4.9 Queries
4.10 Adding a Table with a Memo and a Button Field
4.11 Programming BeeBase to do a Pedigree
4.12 Programming BeeBase to List a Person's Children

5. Basic Concepts

5.1 Projects
5.2 Tables
5.3 Records
5.4 Fields
5.5 Field Types

5.5.1 String Fields
5.5.2 Integer Fields
5.5.3 Real Fields
5.5.4 Boolean Fields
5.5.5 Choice Fields
5.5.6 Date Fields
5.5.7 Time Fields
5.5.8 Memo Fields
5.5.9 Reference Fields
5.5.10 Virtual Fields
5.5.11 Buttons

5.6 Table of Field Types
5.7 Relationships

5.7.1 One to one Relationships
5.7.2 One to many Relationships
5.7.3 Many to many Relationships

5.8 User Interface

5.8.1 Windows
5.8.2 Masks
5.8.3 Panels
5.8.4 Field Objects
5.8.5 Text Objects
5.8.6 Images
5.8.7 Space Objects
5.8.8 Groups
5.8.9 Balance Objects
5.8.10 Register Groups

6. Managing Projects

6.1 File Format
6.2 Info
6.3 New Project
6.4 Clear Project
6.5 Open Project
6.6 Save Project
6.7 Export as SQLite3 Database
6.8 Admin and User Mode
6.9 Swap Records
6.10 Close Project

7. Preferences

7.1 User Settings

7.1.1 Formats
7.1.2 External Editor
7.1.3 External Viewer
7.1.4 Extra Buttons in Tab Chain
7.1.5 Advance on Enter
7.1.6 Confirm Quit
7.1.7 MUI

7.2 Project Settings

7.2.1 Record Memory
7.2.2 Confirm Delete Record
7.2.3 Paths Relative to Project
7.2.4 Confirm Auto Reload
7.2.5 Confirm Save & Reorg
7.2.6 Vacuum After Reorg
7.2.7 Program Source
7.2.8 Cleanup External Program Source
7.2.9 Program Debug Information
7.2.10 Obsolete Functions
7.2.11 Sort Trigger Functions
7.2.12 Program Include Directory
7.2.13 Program Output File

7.3 Save as Default

8. Log

8.1 Log Table
8.2 Activate Logging
8.3 Logging Mode
8.4 Set Log File
8.5 Set Log Label
8.6 Import Log
8.7 Export Log
8.8 Clear Log
8.9 Apply Changes
8.10 View Log

9. Record-Editing

9.1 Active Object
9.2 Adding Records
9.3 Changing Records

9.3.1 String Fields with Pop-up Button
9.3.2 Entering Integer Values
9.3.3 Entering Boolean Values
9.3.4 Entering Choice Values
9.3.5 Entering Date Values
9.3.6 Entering Time Values
9.3.7 Memo Context Menu
9.3.8 Select-from-where List Context Menu
9.3.9 Entering Reference Values
9.3.10 Entering NIL Value

9.4 Deleting Records
9.5 Browsing Records
9.6 View all Records

10. Filter

10.1 Record Filter

10.1.1 Filter Expression
10.1.2 Changing Filters
10.1.3 Filter Examples

10.2 Reference Filter

11. Order

11.1 Empty Order
11.2 Order by Fields
11.3 Order by a Function
11.4 Changing Orders
11.5 Reorder all Records

12. Search For

12.1 Search Dialog
12.2 Forward/Backward Search
12.3 Search Pattern Examples

13. Import and Export

13.1 File Format
13.2 Sample Import File
13.3 Importing Records
13.4 Exporting Records

14. Data Retrieval

14.1 Select-From-Where Queries
14.2 Query Editor
14.3 Exporting Queries as Text
14.4 Exporting Queries as PDF
14.5 Printing Queries
14.6 Query Examples

15. Structure Editor

15.1 Table Management

15.1.1 Creating Tables
15.1.2 Changing Tables
15.1.3 Deleting Tables
15.1.4 Sorting Tables

15.2 Field Management

15.2.1 Creating Fields
15.2.2 Type Specific Settings
15.2.3 Label Editor
15.2.4 Copying Fields
15.2.5 Changing Fields
15.2.6 Deleting Fields
15.2.7 Sorting Fields

15.3 Display Management

15.3.1 Display Field
15.3.2 Table Object Editor
15.3.3 Field Object Editor
15.3.4 Type Specific Settings
15.3.5 Text Editor
15.3.6 Image Editor
15.3.7 Space Editor
15.3.8 Group Editor
15.3.9 Register Group Editor
15.3.10 Window Editor

15.4 Export Structure

16. Programming BeeBase

16.1 Program Editor
16.2 External program source
16.3 Preprocessing

16.3.1 #define
16.3.2 #undef
16.3.3 #include
16.3.4 #if
16.3.5 #ifdef
16.3.6 #ifndef
16.3.7 #elif
16.3.8 #else
16.3.9 #endif

16.4 Programming Language

16.4.1 Why Lisp?
16.4.2 Lisp Syntax
16.4.3 Kinds of Programs
16.4.4 Name Conventions
16.4.5 Accessing Record Contents
16.4.6 Data Types for Programming
16.4.7 Constants
16.4.8 Command Syntax

16.5 Defining Commands

16.5.1 DEFUN
16.5.2 DEFUN*
16.5.3 DEFVAR
16.5.4 DEFVAR*

16.6 Program Control Functions

16.6.1 PROGN
16.6.2 PROG1
16.6.3 LET
16.6.4 SETQ
16.6.5 SETQ*
16.6.6 SETQLIST
16.6.7 SETQLIST*
16.6.8 FUNCALL
16.6.9 APPLY
16.6.10 IF
16.6.11 CASE
16.6.12 COND
16.6.13 DOTIMES
16.6.14 DOLIST
16.6.15 DO
16.6.16 FOR ALL
16.6.17 NEXT
16.6.18 EXIT
16.6.19 RETURN
16.6.20 HALT
16.6.21 ERROR

16.7 Type Predicates
16.8 Type Conversion Functions

16.8.1 STR
16.8.2 MEMO
16.8.3 INT
16.8.4 REAL
16.8.5 DATE
16.8.6 TIME

16.9 Boolean Functions

16.9.1 AND
16.9.2 OR
16.9.3 NOT

16.10 Comparison Functions

16.10.1 Relational Operators
16.10.2 CMP
16.10.3 CMP*
16.10.4 MAX
16.10.5 MAX*
16.10.6 MIN
16.10.7 MIN*

16.11 Mathematical Functions

16.11.1 Adding Values
16.11.2 Subtracting Values
16.11.3 1+
16.11.4 1-
16.11.5 Multiplying Values
16.11.6 Dividing Values
16.11.7 DIV
16.11.8 MOD
16.11.9 ABS
16.11.10 TRUNC
16.11.11 ROUND
16.11.12 RANDOM
16.11.13 POW
16.11.14 SQRT
16.11.15 EXP
16.11.16 LOG

16.12 String Functions

16.12.1 LEN
16.12.2 LEFTSTR
16.12.3 RIGHTSTR
16.12.4 MIDSTR
16.12.5 SETMIDSTR
16.12.6 INSMIDSTR
16.12.7 INDEXSTR
16.12.8 INDEXSTR*
16.12.9 INDEXBRK
16.12.10 INDEXBRK*
16.12.11 RINDEXSTR
16.12.12 RINDEXSTR*
16.12.13 RINDEXBRK
16.12.14 RINDEXBRK*
16.12.15 REPLACESTR
16.12.16 REPLACESTR*
16.12.17 REMCHARS
16.12.18 TRIMSTR
16.12.19 WORD
16.12.20 WORDS
16.12.21 FIELD
16.12.22 FIELDS
16.12.23 STRTOLIST
16.12.24 LISTTOSTR
16.12.25 CONCAT
16.12.26 CONCAT2
16.12.27 COPYSTR
16.12.28 SHA1SUM
16.12.29 UPPER
16.12.30 LOWER
16.12.31 ASC
16.12.32 CHR
16.12.33 LIKE
16.12.34 SPRINTF

16.13 Memo Functions

16.13.1 LINE
16.13.2 LINES
16.13.3 MEMOTOLIST
16.13.4 LISTTOMEMO
16.13.5 FILLMEMO
16.13.6 FORMATMEMO
16.13.7 INDENTMEMO

16.14 Date and Time Functions

16.14.1 DAY
16.14.2 MONTH
16.14.3 YEAR
16.14.4 DATEDMY
16.14.5 MONTHDAYS
16.14.6 YEARDAYS
16.14.7 ADDMONTH
16.14.8 ADDYEAR
16.14.9 TODAY
16.14.10 NOW

16.15 List Functions

16.15.1 CONS
16.15.2 LIST
16.15.3 LENGTH
16.15.4 FIRST
16.15.5 REST
16.15.6 LAST
16.15.7 NTH
16.15.8 REPLACENTH
16.15.9 REPLACENTH*
16.15.10 MOVENTH
16.15.11 MOVENTH*
16.15.12 REMOVENTH
16.15.13 REMOVENTH*
16.15.14 APPEND
16.15.15 REVERSE
16.15.16 MAPFIRST
16.15.17 SORTLIST
16.15.18 SORTLISTGT

16.16 Input Requesting Functions

16.16.1 ASKFILE
16.16.2 ASKDIR
16.16.3 ASKSTR
16.16.4 ASKINT
16.16.5 ASKCHOICE
16.16.6 ASKCHOICESTR
16.16.7 ASKOPTIONS
16.16.8 ASKBUTTON
16.16.9 ASKMULTI

16.17 I/O Functions

16.17.1 FOPEN
16.17.2 FCLOSE
16.17.3 stdout
16.17.4 PRINT
16.17.5 PRINTF
16.17.6 FPRINTF
16.17.7 FERROR
16.17.8 FEOF
16.17.9 FSEEK
16.17.10 FTELL
16.17.11 FGETCHAR
16.17.12 FGETCHARS
16.17.13 FGETSTR
16.17.14 FGETMEMO
16.17.15 FPUTCHAR
16.17.16 FPUTSTR
16.17.17 FPUTMEMO
16.17.18 FFLUSH

16.18 Record Functions

16.18.1 NEW
16.18.2 NEW*
16.18.3 DELETE
16.18.4 DELETE*
16.18.5 DELETEALL
16.18.6 GETMATCHFILTER
16.18.7 SETMATCHFILTER
16.18.8 GETISSORTED
16.18.9 SETISSORTED
16.18.10 GETREC
16.18.11 SETREC
16.18.12 RECNUM
16.18.13 MOVEREC
16.18.14 COPYREC

16.19 Field Functions

16.19.1 FIELDNAME
16.19.2 MAXLEN
16.19.3 GETLABELS
16.19.4 SETLABELS

16.20 Table Functions

16.20.1 TABLENAME
16.20.2 GETORDERSTR
16.20.3 SETORDERSTR
16.20.4 REORDER
16.20.5 REORDERALL
16.20.6 GETFILTERACTIVE
16.20.7 SETFILTERACTIVE
16.20.8 GETFILTERSTR
16.20.9 SETFILTERSTR
16.20.10 RECORDS
16.20.11 RECORD
16.20.12 SELECT

16.21 GUI Functions

16.21.1 SETCURSOR
16.21.2 SETBGPEN
16.21.3 GETWINDOWOPEN
16.21.4 SETWINDOWOPEN
16.21.5 GETVIRTUALLISTACTIVE
16.21.6 SETVIRTUALLISTACTIVE

16.22 Project Functions

16.22.1 PROJECTNAME
16.22.2 PREPARECHANGE
16.22.3 CHANGES
16.22.4 GETADMINMODE
16.22.5 SETADMINMODE
16.22.6 ADMINPASSWORD

16.23 System Functions

16.23.1 EDIT
16.23.2 EDIT*
16.23.3 VIEW
16.23.4 VIEW*
16.23.5 SYSTEM
16.23.6 SYSTEM*
16.23.7 STAT
16.23.8 TACKON
16.23.9 FILENAME
16.23.10 DIRNAME
16.23.11 MESSAGE
16.23.12 COMPLETEMAX
16.23.13 COMPLETEADD
16.23.14 COMPLETE
16.23.15 GC
16.23.16 PUBSCREEN

16.24 Pre-Defined Variables
16.25 Pre-Defined Constants
16.26 Functional Parameters
16.27 Type Specifiers
16.28 Semantics of Expressions
16.29 Function Triggering

16.29.1 onOpen
16.29.2 onReload
16.29.3 onClose
16.29.4 onAdminMode
16.29.5 onChange
16.29.6 logLabel
16.29.7 mainWindowTitle
16.29.8 New Trigger
16.29.9 Delete Trigger
16.29.10 Comparison Function
16.29.11 Field Trigger
16.29.12 Programming Virtual Fields
16.29.13 Compute Enabled Function
16.29.14 Compute Record Description
16.29.15 Double Click Trigger
16.29.16 URL Drop Trigger
16.29.17 Sort Drop Trigger
16.29.18 Compute Listview Labels
16.29.19 Compute Reference Records

16.30 List of Obsolete Functions

17. ARexx Interface

17.1 Port Name
17.2 Command Syntax
17.3 Return Codes
17.4 Quit
17.5 Hide
17.6 Show
17.7 Info
17.8 Help
17.9 Compile
17.10 Connect
17.11 Disconnect
17.12 Connections
17.13 Eval
17.14 Transaction
17.15 Commit
17.16 Rollback

Menus

Menu Project
Menu Preferences
Menu Log
Menu Table
Menu Program
Menu Help

Acknowledgments
Author
Function Index
Concept Index

This document was generated on August, 22 2022 using texi2html