1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
|
<HTML><HEAD><TITLE>Template Help</TITLE></HEAD><BODY>
<IMG ALIGN=right SRC=images/template.png><P>
<H1>Template Help</H1>
This tool provides help for writing PL/SQL and SQL queries by allowing a non obtrusive
database browser and help lookup.<P>
The template help is implemented as a docked window if these are available. They are available
in Qt 3.0 (Released only as beta as of 2001-07-11) and KDE.<P>
The help browser are divided into two panes. The top pane displays a tree view of the available
documentation. The lower is used to display more information about the selected item in the top pane
and it's content may differ depending on what is selected.<P>
The top pane is in the default distribution divided into two parts as well. The
<A HREF=template.html#browser>DB Browser</A></B> which lets you explore your connected
databases through a tree structure. The second part is a plain tree list of available text
documentation. By default only one manual is supplied which contain PL/SQL functions, but
an <A HREF=template.html#editor>editor</A> is supplied to write more help.<P>
Items in the second part is simply items with a descriptive text associated with them. Selecting
the item will bring up the description of it in the information.<P>
<A NAME=browser><H2>DB Browser</H2>
The database browser allows you to browse the schema objects in the open databases. All the
open databases will have an item under which the following information is available. Under
each table is a list of the visible schemas for the database. Under the schema the following
items are available.<P>
<TABLE>
<TR><TD VALIGN=top><B>
Code</B></TD><TD VALIGN=top>
Under this item all the code objects are displayed. The information in the child objects
will bring up the source of the object. There are also child items to this that contain information about
<B>grants</B> and <B>dependencies</B>.</TD></TR>
<TR><TD VALIGN=top><B>
Indexes</B></TD><TD VALIGN=top>
Contains all the indexes of the schema. The information in the child objects will bring up
the columns on which the index is defined.</TD></TR>
<TR><TD VALIGN=top><B>
Sequences</B></TD><TD VALIGN=top>
The sequences of the schema. The information in the child objects will bring up information
about the sequence. There are also child item to this that contain information about
<B>grants</B>.</TD></TR>
<TR><TD VALIGN=top><B>
Synonyms</B></TD><TD VALIGN=top>
The synonyms of the schema. The information in the child objects will bring up information
about the sequence. There are also child item to this that contain information about
<B>grants</B></TD></TR>
<TR><TD VALIGN=top><B>
Tables</B></TD><TD VALIGN=top>
The tables available in the schema. Selecting the table will bring up the columns of the
table. There are also three child items to this that contain information about
<B>constraints</B>, <B>grants</B> and <B>references</B>.</TD></TR>
<TR><TD VALIGN=top><B>
Triggers</B></TD><TD VALIGN=top>
Triggers in the schema. Selecting the item will bring up the source for the trigger.
There are also child items to this that contain information about
<B>grants</B> and <B>dependencies</B>.</TD></TR>
<TR><TD VALIGN=top><B>
Views</B></TD><TD VALIGN=top>
The views available in the schema. Selecting the view name will bring up the columns of the
table. There are also child items to this that contain information about
<B>grants</B> and <B>dependencies</B>.</TD></TR>
</TABLE><P>
Don't forget that more database browsing functionality is available in the
<A HREF=browser.html>database browser tool</A>.<P>
<A NAME=setup><H2>Setup help templates</H2>
You set up additional help files by selecting the SQL Template page in the
<A HREF=preferences.html>options</A> dialog.<P>
<IMG SRC=images/templatesetup.png><P>
To add an existing or start a new template help collection select the <B>add file</B> button
and enter the filename under which to store the help collection and the name of the root
item under which the collection should be displayed in the template help tree.<P>
To edit a collection select the collection in the list and press the <B>edit file</B> button to
bring up the <A HREF=template.html#editor>template editor</A>. If the name doesn't exist you
are asked to start a new file or cancel.<P>
To remove a template press the <B>remove file</B>, this will not remove the actual file.<P>
<A NAME=editor><H2>Template editor</H2>
The template editor is used to edit and create new text template help collections.<P>
<IMG SRC=images/templateeditor.png><P>
The editor are separated into a few different parts. On the left is a list of available
items. To the top right are two buttons <B>add new template</B> and <B>remove current
template</B>. Then comes a line editor where the name of template is. If a ':' character
is in the name it will split into a tree in the template collection tree. Then comes
a text editor where the actual description of the title is written. You can specify
simple HTML in this editor. Finally there is a button called <B>preview</B> which will
give you a preview of the editor result of HTML.<P>
The result is not saved until you press OK in the dialog. Pressing cancel will discard
any changes made.
</BODY>
</HTML>
|