Message de ccornell - OpenOffice.org date 2008-10-07 12:02 :
-------- Original Message --------
Subject: [documentation-dev] Move from Developer's Guide to Basic Guide
Date: Mon, 06 Oct 2008 19:08:06 -0500
From: cking
Reply-To: [EMAIL PROTECTED]
To: [EMAIL PROTECTED]
Greetings,
The "Developer's Guide" contains a section called OpenOffice.org Basic.
That section, in turn, contains two other sections (their subsections are
also shown):
* First Steps with OpenOffice.org Basic
- Creating a Module in a Standard Library
- Writing and Debugging a Basic UNO program
- Calling a Sub from the User Interface
- Creating Dialogs
- Adding Event Handlers
- AutoPilot Dialogs
* OpenOffice.org Basic IDE
- Managing Basic and Dialog Libraries
-- OpenOffice.org Basic Macros Dialog
-- Displayed Information
-- Buttons
- OpenOffice.org Basic Macro Organizer Dialog
-- Modules
-- Dialogs
-- Libraries
- Basic IDE Window
-- Basic Source Editor and Debugger
-- Dialog Editor
- Assigning Macros to GUI Events
- Dialog Localization
-- Technical Background
This material seems more appropriate to be in the "Basic Programmer's
Guide". It is readily understood by Basic programmers. It really seems
inappropriate for the "Developer's Guide", since it gives detailed
directions on how to use menus and dialog boxes, rather than how to design
software.
What would people think of moving these sections from the "Developer's
Guide" to the "Basic Programmer's Guide"? It would take some work to get
the new material to flow with the old, to take care of the changed links,
and to reword the "Developer's Guide" so it doesn't look like there is a
hole in the discussion.
Hi,
Some thoughts...
Having some redundancy in documentation is not a problem, IMHO. And the
Dev'Guide is an overview of OpenOffice from the programming point of
view, so I think these chapters should stay here.
The real problem is the uncompleteness of documentation (Dev'Guide and
Basic Guide). And some errors in the Basic Programmer's Guide.
The Developer's Guide is very difficult to read for a Basic programmer,
notably because nearly all examples are in Java. Finding some Basic
description is a relief!
In fact the title "Developer's Guide" is misleading. Although there are
part oriented towards a developer of the API, most of the Dev'Guide is
essential for any application programmer. Whatever the language used,
you need to know how to use the API services.
Having all the fundamental information on using OOo Basic in one place will
make it easier for developers to get started. Eventually, some of the
other
material on Basic should probably be transferred as well, but we have to
start somewhere.
There are important Basic aspects in other chapters of the Developers's
Guide: Binding, and Scripting Framework. They should be kept here.
Bernard
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
