Base guide structure (TOC)

Hi all,

I know that I am the "new" guy here, but I have been thinking about a Base
guide for awhile now. The current layout looks vague to me and doesn't seem
to address the basic idea of a user guide; to show how to use the software.
Database concepts are not simple and we should focus on how to use Base and
leave tutorials and concepts for the appendices. With too much basic (or
remedial) instruction on design theory and such, we lose the attention of
users who know about databases at various levels. I don't think this is how
a guide should be written. Below you can see how we worked out the Calc
guide. It has minimal explanations of spreadsheet concepts and design.

Showing how to plan and design the database which is used as an example
throughout the guide is a very good idea.

I have included my ideas (Proposed TOC) at the bottom just below the current
layout.

Chapter 1 - Introducing Calc

Chapter 2 - Entering, Editing, and Formatting Data

Chapter 3 - Using Charts and Graphs

Chapter 4 - Using Styles and Template

Chapter 5 - Using Graphics in Calc

Chapter 6 - Printing, Exporting, and E-mailing

Chapter 7 - Formulas and Functions

Chapter 8 - Using the DataPilot

Chapter 9 - Data Analysis

Chapter 10 - Linking Calc Data

Chapter 11 - Sharing and Reviewing

Chapter 12 - Calc Macros

Chapter 13 - Calc as a Simple Database

Chapter 14 - Setting Up and Customizing Calc

Appendix A - Keyboard Shortcuts

Appendix B - Calc Functions

Appendix C - Calc Error Codes

1 Introducing Base

2 Planning/Designing your Database

3 Data Input and removal

4 Data Output

5 Exchanging Data

6 Customizing your Database Design

7 More Customization

8 Using Base at Work

Appendix I Build the Example Database

Appendix II Overview of a Database

Appendix III Further Reading on Database Design

Appendix IV Editing the Base Document File

Proposed TOC

Chapter 1 - Introducing Base

Obvious, but omit the tutorial on database concepts and stick to the working
environment. This should be in an appendix.

Chapter 2 - Opening existing Datasources

Explain how to connect to the various types of Datasources including setting
up JDBC and ODBC connectors

Chapter 3 - Creating a new Database

Explain how to use a native base database and the features (or lack of them)
of the current version of HSQLDB. Maybe a portion on the Base Document File

Chapter 4 - Tables

Designing, creating, and viewing with Base

Chapter 5 - Relationships

Managing relationships. Maybe a portion on types of relationships, but not a
tutorial

Chapter 6 - Queries

How to query Datasources using Base. Refer to appendix C for "How-to SQL"

Chapter 7 - Forms

Designing, creating and using Forms

Chapter 8 - Reports

Report writing using Base

Chapter 9 - Importing and Exporting Data

Self-explanatory?

Appendix A - Basic Database Concepts

Here you could place some of the text from the current "Introducing Base"
which does not address how to use Base, but rather database design and
theory.

Appendix B - Tutorial - Creating a database

Here you could place the current chapter "Planning/Designing your Database
". This database could be used for examples throughout the guide...or we
could have another?

Appendix C - SQL Statements and Functions

A chart of SQL Statements and Functions which are compatible with Base

Appendix D - (Feature) Comparison of Compatible Databases

Maybe a short listing to show what might be the most acceptable Datasource
for a user by way of the feature set?

Rick

Particularly because it's the cause of so much trouble, I'd suggest
it would be good not to focus on the "native" HSQLDB setup, though I
agree it would be good to show it.

I'd suggest using all sorts of example backends. A "Here's how you'd
do x with the native HSQLDB and here's how you'd do it with"
a.n.other engine. A couple "side-by-side" like that, and then just
vary engines in the examples.

Mark Stanton
One small step for mankind...

My opinion:
There is no reason (other than lack of people to do the work) why we
can't have two guides to Base, taking different approaches and aimed
at different audiences. (I have thought the same about some of the
other components as well.)

So I suggest that Rick pursue his outline, and Dan continue with his.
People are going to contribute, if at all, to the one that they feel
comfortable with, so I don't think it takes away from one to do two.
And in the end, users will benefit. Of course, we'll need to give one
book a slightly different title, to avoid total confusion for the
users.

I am available and happy to review Rick's writing as well as Dan's.
Having worked with Rick on the OOo Calc Guide several years ago, I
have a good idea what to expect. :wink:

--Jean

Jean,

I would prefer not to "fork" the work and do it all on my own. Nor do I want
to add chaos here.

Regards,

Rick Barnes

Mark,

This is another problem with using HSQLDB as an example that I overlooked.
It is cumbersome. And to be honest I would use a MySQL DB on "localhost" if
I wanted to create a database. Although PHPmyAdmin is better, Base is more
visual and seems to work well. Of course anyone with DB experience will want
to use their preferred DB.

And, there has been some discussion of losing much of the Java dependancies,
especially since Sun and Oracle aren't in the picture any longer. So HSQLDB
may someday be replaced with something like SQLite.

Rick B

Hi :slight_smile:
I think Dan's plan is a good one and it's very ambitious.  it's good to have input from new people but would it be possible to complete the 1st Base Guide according to Dan's plan first.  After that would be the ideal time to discuss restructuring it and perhaps add in an "Advanced" guide.

From discussions on the Users List it seems there is a gap in the market for an extremely simplistic and single purpose guide to help people create a contacts database and/or read a Thunderbird one.  I think linking to an Evolution/Outlook one would make it too complex.

I agree that the Base Guide that Dan has planned needs to avoid using the embedded back-end.  When we first discussed the plan for the Base Guide most of us didn't realise quite how appalling the embedded one is.  Using HSqlDb as an external back-end after downloading the proper HSqlDb from their website is a huge improvement but the embedded one seems to create too many weird problems.

I think we have to avoid to much "mission creep" or the guide will never get done.  It might be best to to keep comparisons between the various different back-ends to a reasonable minimum.  The work Dan has done seems to have kick-started greater interest in work on Base generally.  A completed Guide might draw more new people in.
Regards from
Tom :slight_smile:

Hi Rick,

Personally I agree with you on the HSQLDB front, but not everyone is
of the same opinion.

Seems to me the main job is to entice people over to the idea of
using databases, because a too-large number don't. For those people
making it easy is the key thing, and there the inbuilt HSQLDB has
some value I'd say.

Regards
Mark Stanton
One small step for mankind...

Or may be to create a separate document explaining those details about
databases back-ends?

Is just an idea...