Skip to content

Latest commit

 

History

History
 
 

doc

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
bookmarkspopup.jpg
bookmarkspopup.jpg
 
 
changes.txt
changes.txt
 
 
licence.txt
licence.txt
 
 
prefs.jpg
prefs.jpg
 
 
readme.html
readme.html
 
 
toolspopup.jpg
toolspopup.jpg
 
 

readme.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
	<META HTTP-EQUIV="CONTENT-TYPE" CONTENT="text/html; charset=iso-8859-15">
	<TITLE></TITLE>
	<META NAME="GENERATOR" CONTENT="OpenOffice.org 2.0  (Linux)">
	<META NAME="CREATED" CONTENT="20050606;20143600">
	<META NAME="CHANGEDBY" CONTENT="Gerd Wagner">
	<META NAME="CHANGED" CONTENT="20060509;23124800">
</HEAD>
<BODY LANG="en-US" DIR="LTR">
<P><B>SQLBookmark 1.0</B> - Joe Mocker, Gerd Wagner</P>
<P>SQLBookmark allows you to &quot;bookmark&quot; commonly used SQL
code for easy point and click reuse. Whatever you type in the SQL
editor can be easily bookmarked by opening SQuirreL's tools popup via
the <kbd>ctrl + t</kbd> shortcut and then selecting the add bookmark function.
</P>
<P><IMG SRC="toolspopup.jpg" NAME="Graphic1" ALIGN=LEFT BORDER=0><BR CLEAR=LEFT><BR><BR>
</P>
<P>Bookmarks are then accessed through <kbd>ctrl + j</kbd> shortcut. This opens
a filterable popup similar to the tools popup.</P>
<P><IMG SRC="bookmarkspopup.jpg" NAME="Graphic2" ALIGN=LEFT BORDER=0><BR CLEAR=LEFT><BR><BR>
</P>
<P>Additionally, bookmarks can be administered through &quot;Bookmarks&quot;
tab of the Global Preferences dialog.
</P>
<P>Bookmarked SQL strings can have replaceable parameters. At the
time the bookmark is loaded, the user is asked to enter values for
any of the parameters. Parameters are defined in the SQL with a
special syntax. There are three formats:
</P>
<DL>
	<DD>
	<TABLE WIDTH=100% BORDER=0 CELLPADDING=2 CELLSPACING=2>
		<TR>
			<TD VALIGN=TOP>
				<P>${prompt[, tip]}</P>
			</TD>
			<TD>
				<P>simple anonymous parameter</P>
			</TD>
		</TR>
		<TR>
			<TD VALIGN=TOP>
				<P>${id=name, prompt[, tip]}</P>
			</TD>
			<TD>
				<P>named parameter, allows it to be reused elsewhere</P>
			</TD>
		</TR>
		<TR>
			<TD VALIGN=TOP>
				<P>${ref=name}</P>
			</TD>
			<TD>
				<P>use the value of an already named parameter.</P>
			</TD>
		</TR>
	</TABLE>
</DL>
<P>where
</P>
<DL>
	<DD>
	<TABLE WIDTH=100% BORDER=0 CELLPADDING=2 CELLSPACING=2>
		<TR>
			<TD>
				<P>prompt</P>
			</TD>
			<TD>
				<P>is the string to display in the popup prompt</P>
			</TD>
		</TR>
		<TR>
			<TD>
				<P>tip</P>
			</TD>
			<TD>
				<P>is the optional tooltip to display on the popup prompt</P>
			</TD>
		</TR>
		<TR>
			<TD>
				<P>name</P>
			</TD>
			<TD>
				<P>is the &quot;variable&quot; name of the parameter.</P>
			</TD>
		</TR>
	</TABLE>
</DL>
<P>In case you want to give a default value for a parameter the syntax would be ${prompt[, tip](defaultValue)}.<BR>
   Also a list of predefined values is possible. The syntax then is ${prompt[, tip](defaultValue_1|defaultValue_2|defaultValue_3)}
</P>
<P><BR><BR>
</P>
<P>Bookmarks are managed through Global Preferences:</P>
<P><IMG SRC="prefs.jpg" NAME="graphics1" ALIGN=LEFT BORDER=0><BR CLEAR=LEFT><BR><BR>
</P>
<P>The Global Preferences window can be opened using the &ldquo;Edit
Bookmarks&rdquo; toolbar button of a Session window.</P>
</BODY>
</HTML>