Copyright: Created with EasyHelp (Tel: 0973 209667)


 CLEARweb™ Applet Help

Welcome to the help system for the CLEARweb Applet from CLEAR Software.

Overview

Using the Applet

Installing the Applet on a Web Page

Creating Outlines for the Applet

Creating Framed Pages

Customizing the Applet

Contacting CLEAR Software


Overview

Add a CLEARweb Map to any Web Page

The CLEARweb Applet allows webmasters to publish working outlines of Internet addresses on any web page. Users are able to view the outline without downloading or installing any additonal software.

Multiple Browsers and Operating Systems

The Applet is written in Java, so anyJava equipped web browser can be used to view the outline. The Applet can be viewed with browsers on Unix, Mac, and Windows computers.

Instant Access to Internet Address

The Applet is the perfect solution for publishing maps of websites, hotlists of favorite web pages, and any other list of Internet addresses. To open any address in the web browser, just double-click the matching outline item.

Expand and Collapse Outline

The outline format used in the Applet makes it easy to navigate through long lists of addresses. You can expand or collapse any section of an outline by clicking the + or - leader in front of any outline heading.

Built-in Search Engine

The outline can be quickly searched for any text using the built-in search feature. It is no longer necessary to install a complex search engine on a website to offer searching capability.

Easy Installation

The Applet can be added to a web page by anyone who knows HTML. No Java programming is needed.

Completely Customizable

All aspects of the Applet's interface can be customized to display any text, in any language. Webmasters can create versions of the Applet for multiple languages and make them all available on their web pages.


Using the Applet

Anatomy of the Applet

Open any Address Instantly

To open an address in your browser, just double-click the text of the outline item, or click the Goto button. You can surf through dozens of websites in minutes and never lose your place.

Expand and Collapse the Outline

The outline is initially displayed with all the items visible. You can collapse or expand sections of the outline by clicking on the + or - leaders in front of items.

Search the Outline

The CLEARweb applet has an automatic search feature that lets you find any word within the outline.  Just enter what you are looking for, and click the search button.

Online Help

The Applet help page can be displayed at any time by clicking the Help button.

Frame and Full Window View

Web pages that are loaded when an outline item is double-clicked can be displayed in the full browser window or within a frame. Clicking the Frame Switch button will toggle between frame view and full window view. This button doesn't affect currently visible pages. First you must set the button to the correct mode, and then any pages that are opened by the Applet will use a frame or full window.

Downloading the Map

The outline display in the Applet can be downloaded to your computer for local viewing and editing. Clicking the Download button will transfer the outline over the Internet and open it in CLEARweb.


Installing the Applet on a Web Page

This operation is only necessary for webmasters who want to publish their own pages with the Applet. Users who only need to view the page do not have to do any installation and should ignore these instructions. The steps necessary to install the Applet on a web page are straightforward, but must be followed exactly as outlined below.

Copy Applet.Zip to a Web Server

The file APPLET.ZIP containing the CLEARweb Applet components is automatically placed in the \applet subdirectory of the \clearweb directory when CLEARweb is installed. This file must be uploaded to a web server. The directory for the Applet can have any name.

Extract the Applet Files

The Applet consists of a collection of Java class library files, which must be extracted from APPLET.ZIP before they can be used. After the files are extracted, they must be left with the complete file extension of '.class'. The upper and lower case characters in the file names must also be retained exactly as they appear when first extracted.

Unix Server

On a Unix based web server the files can be extracted by using a Telnet client to log onto the server, moving to the directory containing the file applet.zip, and running the Unix command 'unzip applet.zip'. This will extract the files and place them in the current subdirectory.

Windows Server

On a Windows web server the standard Pkunzip program cannot be used to extract the Applet files, because it will convert the file extensions from .class to .cla, making them unable to run. You must use a unzipping tool which preserves the entire file name. One product we have used successfully for this task is WinZip, which can be downloaded from the Internet at:

http://www.winzip.com/winzip/download.htm

Icons Subdirectory

The unzipping process on Unix or Windows will also create a subdirectory within the Applet directory with the icons used by the Applet. The name of this subdirectory must be left as 'icons' in all lowercase characters.

Copy the CWO Files to a Web Server

The Applet displays outlines in CWO format, which are created with the full CLEARweb product. Because of security restrictions in Java, the Applet and the CWO outline files it displays must be placed in the same directory on the web server. APPLET.ZIP contains a sample CWO file named PCTOP100.CWO for initial testing.

Create a Web Page

Once all the files are in place on a web server, you can create a web page which displays the Applet along with one of your CWO files. There are many optional parameters for the Applet, but the minimal definition is as follows:

<APPLET CODE=CWebView.class WIDTH=260 HEIGHT=300>

<PARAM NAME='Source' VALUE='<CWO file name>'>

</APPLET>

The name of the starting class, CWebView.class, must be entered with upper and lower case characters exactly as shown. The case of any other characters in the definition may be changed.

Sample Page

A sample web page named APPLET.HTML is included with the APPLET.ZIP package. It displays a minimal version of the Applet:

<HTML><HEAD>

<TITLE>CLEARweb Applet</TITLE>

</HEAD>

<BODY>

<APPLET CODE=CWebView.class WIDTH=260 HEIGHT=300>

<PARAM NAME='Source' VALUE='pctop100.cwo'>

</APPLET>

</BODY>

</HTML>


Creating Maps for the Applet
Creating Outlines for the Applet

CWO File Format

The Applet works with outlines in CWO format. This is a text file format that is created with the full CLEARweb product using the File Export menu option. Netscape bookmark files and web page files can also be read into CLEARweb with the File Import option, edited, and exported  to CWO format.

Generating Maps with Scripts

Because CWO files are in text format, they can be generated by programs other than CLEARweb, such as CGI scripts running on a web server. This makes it easy to create web pages that use the Applet to display the results of search engines and other programming processes.

Internal Format

If you want to create your own CWO files with a custom program, you will need to understand the internal format. Here is an abbreviated copy of the PC Magazine Top 100 CWO file. As you can see, it is basically a standard HTML file with a few custom additions.

<!DOCTYPE CLEARweb-Outline-2>

<!-- This is an automatically generated file.

It will be read and overwritten.

Do Not Edit! -->

<DL><p>

<DT><A HREF="http://www.clearsoft.com/clearweb/applet/conven.txt">PC Magazine's Top 100{*S2}</A>

<DL><p>

<DT><A HREF=" ">COMPUTER RESOURCES{*S0}</A>

<DL><p>

<DT><A HREF="http://www.apple.com">Apple{*S2}</A>

<DT><A HREF="http://www.cnet.com">CNet{*S2}</A>

<DT><A HREF="http://www.dell.com">Dell Computer{*S2}</A>

<DT><A HREF="http://www.digital.com">Digital{*S2}</A>

<DT><A HREF="http://www.hp.com">Hewlett-Packard{*S2}</A>

<DT><A HREF="http://www.ibm.com">IBM{*S2}</A>

<DT><A HREF="http://www.intel.com">Intel{*S2}</A>

<DT><A HREF="http://www.microsoft.com">Microsoft{*S2}</A>

<DT><A HREF="http://www.novell.com">Novell{*S2}</A>

<DT><A HREF="http://www.zdnet.com">ZD Net{*S2}</A>

</DL><p>

</DL><p>

</DL><p>

Icon Numbers

The only nonstandard portion of the CWO file is the icon entry for each item, which is entered as {*S#}. The # represents the number of the icon to be used for this address. These icon numbers are required in the CWO format, even if icons won't be displayed in the Applet. When creating your own CWO files, you should use the following icon assignments:

Address Type	Icon Number

No address	{*S0}

http:// or ftp:// protocol 	{*S2}

     Extension of .doc, .rtf, .rtx, .ps, .eps	{*S3}

     Extension of .bin, .exe, .tar, .zip, .z, .gz	{*S4}

     Extension of .tcl, .sh, .pl	{*S5}

     Extension of .map	{*S6}

     Extension of .js, .ls, .mocha	{*S7}

     Extension of .cwm, .cwo	{*S8}

     Extension of .ra, .ram, .wav, .au,

             .snd, .aif, .aiff, .aifc	{*S9}

     Extension of .gif, .bmp, .tif, .tiff,

             .jpeg, .jpg, .jpe	{*S10}

     Extension of .avi, .mov, .qt, .mpeg,

                              .mpg, .mpe	{*S11}

     Extension of .wrl, .wrz, .flr	{*S12}

mailto: protocol	{*S13}

gopher:// protocol	{*S14}

news: protocol	{*S15}

telnet:// protocol	{*S16}

file:/// protocol	{*S17}


Creating Framed Pages

The Applet works well with collections of web pages organized as frames. You can place the Applet in one frame and have it load pages into a second frame. This allows the Applet to remain visible along with any visited pages. Here is a sample set of pages that demonstrate this technique. All of these files can be found in APPLET.ZIP along with the Applet class libraries. They can be seen in action at:

http://www.clearsoft.com/clearweb/applet/welcome.html.

Welcome.html

This file is the starting page that should be run first by the user. It creates two frames, 'applet' for displaying the Applet , and 'display' for the loaded pages. At first the help page is loaded into the 'display' frame.

<HTML>

<HEAD>

<TITLE>CLEARweb Applet</TITLE>

<FRAMESET cols="230,*">

<FRAME src='applet.html' name='applet'>

<FRAME src='help.html' name='display'>

</FRAMESET>

Applet.html

This page is displayed in the 'applet' frame. The UseFrame parameter tells the Applet to load visited pages in the frame named 'display'. The ShowDescription parameter has a value of 0, which hides the description portion of the outine.

<HTML>

<HEAD><TITLE>CLEARweb Applet Beta Test</TITLE>

</HEAD>

<BODY bgcolor ="ffffff">

<CENTER>

<b>Top 100 List

(<a href="help.html" target="display">Help</a>)</b><br>

<APPLET code=CWebView.class width=190 height=300>

<PARAM name='Source' value='pctop100.cwo'>

<PARAM name='UseFrame' value='display'>

<PARAME name='ShowDescription' value=0>

</APPLET>

</CENTER>

</BODY>

</HTML>

Help.html

This file displays the Applet help page in the 'display' frame.

<HTML>

<BODY bgcolor="ffffff">

<HTML><HEAD><TITLE>CLEARweb Applet Help Page</TITLE>

</HEAD>

<CENTER>

<H3><a href="../welcome.html"><img src="clearweb.gif" border=0> CLEARweb</a> Applet Help Page</h3>

</CENTER>

Welcome to the CLEARweb Applet from CLEAR Software. Here is a brief overview of the Applet and its use:<p>

<CENTER><img src="applet.gif"></CENTER>

<ul>

<li><b>Instant access to Internet sites</b><br>

Each outline item can contain an Internet address, just like a hyperlink on a web page. To open an address in your browser, just double-click the text of the outline item. You can surf through dozens of websites in minutes and never lose your place.<p>

<li><b>Adjustable outline view</b><br>

The outline is initially displayed with all the items visible. You can collapse or expand sections of the outline by clicking on the + or - leaders in front of items.<p>

<li><b>Built-in search engine</b><br>

The CLEARweb applet has an automatic search feature that lets you find any word within the outline.  Just enter what you are looking for, and click the search button.

<p>

<li><b>The perfect solution to website maps</b><br>

Evey website needs a table of contents to speed user access, and the CLEARweb Applet is the easiest way to create a clickable site map. Place it on your home page, and visitors will be able to jump to any page on your website in seconds. <p>

<li><b>Runs on any computer</b><br>

The CLEARweb Applet is written in Java, so it will appear when its web page is viewed by users on Macs, PCs, and Unix computers. One copy of the Applet can be placed on a website, and be viewed with many different types of computers.

<p>

<li><b>No download or installation required</b><br>

Web pages with the CLEARweb applet can be viewed immediately without having to download or install any software. When a web page with the CLEARweb Applet is opened in a Java equipped web browser, the outline automatically appears without any work on the user's part.  <p>

<li><b>Easy web page publishing</b><br>

Adding the CLEARweb Applet to an existing web page coudn't be easier. Just copy the Applet program files and CLEARweb outline files to a directory on any web server. Then add a few lines of HTML to a web page to name the Applet and the outline file. Here is the HTML required to display the PC Top 100 outline: <p>

<pre>&lt;APPLET CODE=CWebView.class WIDTH=260 HEIGHT=300&gt;

&lt;PARAM NAME='source' VALUE='pctop100.cwo'&gt;

&lt;/APPLET&gt;</pre>

No changes are made to the server software, and no additional MIME types need to be installed by users of the pages. The Applet will automatically be run by any Java equipped browser.

<p>

<li><b>Fully customizable interface</b><br>

The Applet offers the web page publisher control over every aspect of its user interface, including the text of all of the onscreen prompts and messages. By changing the text of the interface and the outline, the Applet can be translatd into any languages.<p>

<p>

<li><b>System requirements</b><br>

The CLEARweb Applet can be added to web pages on Mac, PC, and Unix web servers. The pages can be viewed by anyone running a Java equipped web browser.

</blockquote>

<center><hr border="2">

<b>CLEAR Software, Inc.</b><br>

<basefont size ="2">

199 Wells Avenue, Newton, MA  02159<br>

Phone: 800-338-1759  Fax: 617-965-5310<br>

Email: webmaster@clearsoft.com<br>

Home Page: <a href="http://www.clearsoft.com">http://www.clearsoft.com</a>

<hr border="2">

</address>

</center>

</BODY>

</HTML>


Customizing the Applet

Using Applet Parameters

There are many optional parameters available for use with the Applet. These are added to an Applet definition using the PARAM tag. Any number of parameters can be added to the same definition. Here is a complete listing of the parameters along with simple examples of each:

BackColor

Background color of the outline.

Type: Hexadecimal RGB value

Default: 'FFFFFF'

Example:

<APPLET CODE=CWebView.class WIDTH=260 HEIGHT=300>

<PARAM NAME='Source' VALUE='pctop100.cwo'>

<PARAM NAME='BackColor' VALUE='FF0000'>

</APPLET>

DownloadButtonText

Text on the Download button.

Type: String

Default: 'D'

Example:

<APPLET CODE=CWebView.class WIDTH=260 HEIGHT=300>

<PARAM NAME='Source' VALUE='pctop100.cwo'>

<PARAM NAME='DownloadButtonText' VALUE='Download'>

</APPLET>

Font

The name of the font used in the outline. The available font names are: Helvetica, Times Roman, CourierHelvetica, Courier, Dialog, and Symbol.

Type: String

Default: 'Courier'

Example:

<APPLET CODE=CWebView.class WIDTH=260 HEIGHT=300>

<PARAM NAME='Source' VALUE='pctop100.cwo'>

<PARAM NAME='Font' VALUE='Helvetica'>

</APPLET>

FontSize

The size of the font  used in the outline.

Type: Integer

Default: 12

Example:

<APPLET CODE=CWebView.class WIDTH=260 HEIGHT=300>

<PARAM NAME='Source' VALUE='pctop100.cwo'>

<PARAM NAME='FontSize' VALUE=16>

</APPLET>

ForeColor

Color of the outline text.

Type: Hexadecimal RGB value

Default: '000000'

Example:

<APPLET CODE=CWebView.class WIDTH=260 HEIGHT=300>

<PARAM NAME='Source' VALUE='pctop100.cwo'>

<PARAM NAME='ForeColor' VALUE='FF0000'>

</APPLET>

FrameButtonTextFull

Text on the frame switch button when using the current frame for viewing open pages.

Type: String

Default: '[]'

Example:

<APPLET CODE=CWebView.class WIDTH=260 HEIGHT=300>

<PARAM NAME='Source' VALUE='pctop100.cwo'>

<PARAM NAME='FrameButtonTextFull' VALUE='Window'>

</APPLET>

FrameButtonTextSplit

Text on the frame switch button when using a different frame for viewing open pages.

Type: String

Default: '[|]'

Example:

<APPLET CODE=CWebView.class WIDTH=260 HEIGHT=300>

<PARAM NAME='Source' VALUE='pctop100.cwo'>

<PARAM NAME='FrameButtonTextSplit' VALUE='Frame'>

</APPLET>

HelpButtonText

Text on the Help button.

Type: String

Default: '?'

Example:

<APPLET CODE=CWebView.class WIDTH=260 HEIGHT=300>

<PARAM NAME='Source' VALUE='pctop100.cwo'>

<PARAM NAME='HelpButtonText' VALUE='Help'>

</APPLET>

HelpURL

Address of web page displayed when the Help button is clicked.

Type: String

Default: 'http://www.clearsoft.com/clearweb/applet/help.html'

Example:

<APPLET CODE=CWebView.class WIDTH=260 HEIGHT=300>

<PARAM NAME='Source' VALUE='pctop100.cwo'>

<PARAM NAME='HelpURL' VALUE='http://www.mycompany.com/help.html'>

</APPLET>

LoadMapText

The text message that appears when loading a map into the Applet.

Type: String

Default: 'Loading CLEARweb Map'

Example:

<APPLET CODE=CWebView.class WIDTH=260 HEIGHT=300>

<PARAM NAME='Source' VALUE='pctop100.cwo'>

<PARAM NAME='LoadMapText' VALUE='Transferring data'>

</APPLET>

LoadURLText1

The first half of the message that appears when opening an address.

Type: String

Default: 'Loading'

Example: 'Transferring'

<APPLET CODE=CWebView.class WIDTH=260 HEIGHT=300>

<PARAM NAME='Source' VALUE='pctop100.cwo'>

<PARAM NAME='LoadURLText1' VALUE='Transferring data'>

</APPLET>

LoadURLText2

The second half of the message that appears when opening an address.

Type: String

Default: 'Please  wait...'

Example:

<APPLET CODE=CWebView.class WIDTH=260 HEIGHT=300>

<PARAM NAME='source' VALUE='pctop100.cwo'>

<PARAM NAME='LoadURLText2' VALUE='Transferring data'>

</APPLET>

LoadURLError1

Text of error message when an outline item with no address is double-clicked.

Type: String

Default: 'This item has no address'

Example:

<APPLET CODE=CWebView.class WIDTH=260 HEIGHT=300>

<PARAM NAME='Source' VALUE='pctop100.cwo'>

<PARAM NAME='LoadURLError1' VALUE='No address found'>

</APPLET>

LoadURLError2

Text of error message when an outline item with an invalid address is double-clicked.

Type: String

Default: 'Error: This item has invalid address'

Example:

<APPLET CODE=CWebView.class WIDTH=260 HEIGHT=300>

<PARAM NAME='Source' VALUE='pctop100.cwo'>

<PARAM NAME='LoadURLError2' VALUE='Bad address'>

</APPLET>

SearchButtonText

Text on the Search button.

Type: String

Default: 'S'

Example:

<APPLET CODE=CWebView.class WIDTH=260 HEIGHT=300>

<PARAM NAME='Source' VALUE='pctop100.cwo'>

<PARAM NAME='SearchButtonText' VALUE='Search'>

</APPLET>

SelectedBackColor

Background color of the selected item.

Type: Hexadecimal RGB value

Default: '0000FF'

Example:

<APPLET CODE=CWebView.class WIDTH=260 HEIGHT=300>

<PARAM NAME='Source' VALUE='pctop100.cwo'>

<PARAM NAME='SelectedBackColor' VALUE='FFFFFF'>

</APPLET>

SelectedForeColor

Text color of the selected item.

Type: Hexadecimal RGB value

Default: 'FFFFFF'

Example:

<APPLET CODE=CWebView.class WIDTH=260 HEIGHT=300>

<PARAM NAME='Source' VALUE='pctop100.cwo'>

<PARAM NAME='SelectedForeColor' VALUE='000000'>

</APPLET>

ShowAddress

Toggle the display of the address field.

Type: Boolean(1/0)

Default: 1 (true)

Example:

<APPLET CODE=CWebView.class WIDTH=260 HEIGHT=300>

<PARAM NAME='Source' VALUE='pctop100.cwo'>

<PARAM NAME='ShowAddress' VALUE='0'>

</APPLET>

ShowDescription

The number of rows in the description field (0 to hide this field).

Type: Integer

Default: 2

Example:

<APPLET CODE=CWebView.class WIDTH=260 HEIGHT=300>

<PARAM NAME='Source' VALUE='pctop100.cwo'>

<PARAM NAME='ShowDescripton' VALUE='0'>

</APPLET>

ShowIcons

Use icons in the outline. Different icons are used for each type of address. This options will only work

Type: Boolean(1/0)

Default: 0 (false)

Example:

<APPLET CODE=CWebView.class WIDTH=260 HEIGHT=300>

<PARAM NAME='Source' VALUE='pctop100.cwo'>

<PARAM NAME='ShowIcons' VALUE='1'>

</APPLET>

UseFrame

Name of web page frame used to display opened web pages.

Type: String

Default: ''

Example:

<APPLET CODE=CWebView.class WIDTH=260 HEIGHT=300>

<PARAM NAME='Source' VALUE='pctop100.cwo'>

<PARAM NAME='UseFrames' VALUE='display'>

</APPLET>

VisitedForeColor

Foreground color of a visited item.

Type: Hexadecimal RGB value

Default: 'FF0000'

Example:

<APPLET CODE=CWebView.class WIDTH=260 HEIGHT=300>

<PARAM NAME='Source' VALUE='pctop100.cwo'>

<PARAM NAME='VisitedForeColor' VALUE='0000FF'>

</APPLET>


Contacting CLEAR Software

Mail: 199 Wells Avenue

Newton, MA  02159

Order Line: 800-338-1759

Fax: 617-965-5310

CLEARweb Product Manager Email: clearweb@clearsoft.com

Company Home Page: http://www.clearsoft.com

CLEARweb Home Page: http://www.clearsoft.com/clearweb

CLEARweb User Survey: http://www.clearsoft.com/clearweb/survey.html

CLEARweb Mailing Lists: http://www.clearsoft.com/clearweb/subscrib.html

CLEARweb Product Registration: http://www.clearsoft.com/clearweb/register.html