BaseDocumenter, to document your Base applications

7 1

BaseDocumenter is a software tool producing a full documentation of a LibreOffice Base application.

Project Description

The documentation produced by BaseDocumenter is bundled as one set of static HTML pages.
The layout of the produced HTML pages is highly customizable.

The documentation describes in detail all the items (tables, queries, Basic procedures, ...) being part of the Base application.

Additionally it identifies all the dependencies between items. E.g. a query might use one or more tables. Knowing exhaustively which items are used by other items is invaluable for the developer of the application. This knowledge allows for example a detailed impact analysis of design changes.

Dependencies are of 2 types:

  • parent/child: e.g. a field is the child of a table.
  • uses/used by: e.g. a query uses a table or a table is used by a query. In BaseDocumenter, such dependencies are very simply revealed by the use of hyperlinks. Clicking on one of them makes the browser jump to the description of the linked item.

The software includes also

  • a Basic parser to identify a.o. which procedures are called by which ones
  • a SQL beautifier to make simple or complex SQL statements much more readable

Full documentation of the software HERE.

Striking examples HERE and HERE.

The minimal release is LibreOffice 6.0. The recommended release is LibreOffice 6.1.

Category/Categories

Macro, Base Extension

Homepage of the Project

http://www.access2base.com/basedocumenter

Current Release

No stable release available yet.

Latest Not Stable Release

BaseDocumenter, to document your Base applications - 0.6.0

tested with:

LibreOffice 6.0, LibreOffice 6.1,

BaseDocumenter.oxt
All platforms
File size: 967 kb

All Releases

Version

Released

Platform(s)

Compatibility

Description

License(s)

Status

0.6.0

  • All platforms
  • LibreOffice 6.0
  • LibreOffice 6.1
Show 1-N relationships between tables. List secundary indexes and involved fields.
  • LGPL-v3+ (GNU Lesser General Public License Version 3 and later)
  • MPL-v2.0+ (Mozilla Public License Version 2.0 or later)
beta

0.5.1

  • All platforms
  • LibreOffice 6.0
  • LibreOffice 6.1
Fix error when 'Collect data statistics' deselected
  • LGPL-v3+ (GNU Lesser General Public License Version 3 and later)
  • MPL-v2.0+ (Mozilla Public License Version 2.0 or later)
beta

0.5.0

  • All platforms
  • LibreOffice 6.0
  • LibreOffice 6.1
First public release. Minimal requirement: LibreOffice 6.0, recommended: LibreOffice 6.1
  • LGPL-v3+ (GNU Lesser General Public License Version 3 and later)
  • MPL-v2.0+ (Mozilla Public License Version 2.0 or later)
beta

Legal Disclaimer and Limitations for Downloads

The Document Foundation has not reviewed, and cannot review, all of the material, including computer software, available on or by means of The Document Foundation's
websites, and cannot therefore be responsible for that material's content, use or effects. By operating its websites, The Document Foundation does not represent or imply that it endorses the material there available, or that it believes such material to be accurate, useful or nonharmful. You are responsible for taking precautions as necessary to protect yourself and your computer systems from viruses, worms, Trojan horses and other harmful or destructive content. The Document Foundation's websites may contain content that is offensive, indecent or otherwise objectionable, as well as content containing technical inaccuracies, typographical mistakes and other errors. The Document Foundation's websites may also contain material that violates the privacy or publicity rights, or infringes the proprietary rights, of third parties, or the downloading, copying or use of which is subject to additional terms and conditions, stated or unstated. The Document Foundation disclaims any responsibility for any harm resulting from the use by The Document Foundation's visitors of The Document Foundation's websites, or from any downloading by those visitors of content available on or by means of The Document Foundation's websites.

Changes

Content contained on The Document Foundation's websites, including these Legal Disclaimers and Limitations, may be changed at the sole discretion of The Document Foundation and without notice. You are bound by any such updates or changes, and so should periodically review these Legal Disclaimers and Limitations.

If you believe any file is present on the site contrary to any TDF rule or applicable law, please supply full details to info@documentfoundation.org for impartial consideration.