Table of Contents

  1. Documentation
    1. Installation
      1. Requirements
      2. Installation
    1. Configuration
      1. General
      2. FileNames
      3. PageNames
      4. Pages
      5. Process
      6. Logging
      7. Verification
      8. DepGraph
      9. Colors
      10. Forms
    1. Usage
      1. Background
      2. Overview
      1. Oracle Forms
      1. Running the script
      1. Code Arrangement
    1. Support for Javadoc style comments
      1. Description
      2. Supported Tags
    1. Embedding unit-tests with JavaDoc
      1. Defining test-cases
      2. The generated XML file
      3. Generating the real code
      4. Generated documentation
      5. Future Plans
    1. Syntax Highlighting
      1. How it works
      2. Keywords and their maintenance
    1. Localization
      1. Introduction
      2. Setting your locale
      3. Create missing translations
      4. Keep your translations up-to-date

Usage

This part of the documentation will give some hints on how to use HyperSQL. Topics like Installation, Configuration, JavaDoc, Syntax Highlighting and Localization are dealt with in the other parts of the documentation.

Background

First some background information, which should help you to better and easier understand the details following.

HyperSQL was originally developed by Randy Phillips back in 2001. After its release in the very same year, there have been no updates until I continued development in 2010 (take it binary, and it's just the next number), Randy handing me over all resources. He might have had different ideas of the final state of the programm, such using approaches which where perfect for those but might be a bit hindering now. Nevertheless, it would mean a complete rewrite to change them - so for now I chose to live with the possible limitations caused by those rather than spending long time to re-organize everything (time which I don't have).

One of these things is the linewise processing of code: HyperSQL does no complete SQL syntax analyzis. To find objects, it simply walks the code files line by line looking out for declarations such as e.g. CREATE TABLE xxx. Obviously all code Randy was concerned about was bundled in packages - so functions and procedures were only looked for if a package declaration was met. No stand-alone functions/procedures were expected. They are still not handled today (at version 3.4.5) - the special problems with those stand-alone objects are described in Object Order.

At another task, this linewise processing has already been replaced by a full file scan: Looking where objects are used. While switching to regular expression search for more accuracy considerably slowed down this process, switching from walking line-by-line to a full file scan fully compensated for the loss.

And before you ask (you might already have guessed that): The naming conventions for the generated HTML files of objects are bound to historic reasons as well. I know, this makes it almost impossible to have "steady links" to the page describing an object (and I don't like that idea either) - but currently it is the way it is. At least this is an issue I hope to address in a later version.

Overview

So if you are looking for special information, here is a short overview on what to find where:

If you feel some information missing here, please let me know. The easiest (and best) way to do this is to open a ticket - but if you prefer to write a mail, you find a suitable link at the bottom of each page here.

Last modified by izzy, 08/20/10 18:45:10 (3 years ago)