|
|
 |
|
|
iFrame Applet Documentation |
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+ DOCUMENTATION: iFRAME APPLET
+ CodeBrain.com's iframe.class applet
+ Version 3.0.1 Final Release
+ Browsers: NS4 & later, MSIE & later, NeoPlanet
+ Copyright 2000 by CodeBrain.com
+ Source: http://www.CodeBrain.com
+
+
+ FREE for Private and Non-Profit Users. The FREE version displays a
+ brief hook notice to www.CodeBrain.com at start-up -- otherwise it
+ functions exactly as the purchased version does.
+
+ COMMERCIAL & FOR-PROFIT USERS ARE *REQUIRED* TO USE THE PURCHASE
+ VERSION of this applet, always quickly available at www.CodeBrain.com.
+ Keys are generated automatically, so there is no waiting.
+
+ The PURCHASE version has *no* start-up or other notices; and it starts
+ and runs much faster. WE ENCOURAGE those wishing to buy the applet to
+ use the free version for trials, however, so you know what you're
+ getting when you purchase.
+
+ Support is available for the purchase version of the applet, only. The
+ support address is: NovaHelp@CodeBrain.com You MUST include your
+ USER ID in *all* correspondence.
+
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
===============================================================
=
= P A R A M E T E R S A N D I N S T R U C T I O N S
=
===============================================================
GENERAL NOTES
-------------------------------------------------------------------------
// CodeBrain's iframe.class code is written protectively -- to make it
// easy to set up and get running. Demos and all the associated
// graphics are included, to get you rolling quickly.
//
// Other than the "Notice" parameter and the TextFile parameter (pay
// special attention the notes on pathing) you can leave out any
// parameter and the applet will run. That is, "If in doubt, leave
// it out!"
//
// To get started, place the iframe.class file and any files used by
// the applet in the same directory. Remember that .class files
// must go to your server in binary!
//
// Check out the demos included, and gradually change parameters
// to get a feel for how the applet works.
//
// Good luck, and we hope find numerous uses for CodeBrain's
// iframe.class. It's a truly simple applet to use, but does a great
// job of providing a quick work-around for a lot of tricky
// layout problems.
//
// Best regards,
//
// CodeBrain
P A R A M E T E R S
===============================================================
<param name="Notice" value="Applet by www.CodeBrain.com">
-------------------------------------------------------------------------
// Must be present, EXACTLY, or the applet will run, but return an error
// message indicating the notice is wrong or missing.
<PARAM NAME="KeyCode" VALUE="whatever_the_key_is">
-------------------------------------------------------------------------
// COMMERCIAL & FOR-PROFIT USERS ARE *REQUIRED* TO PURCHASE keys for
// this applet, always quickly available at www.CodeBrain.com. You may
// of course use the free version for evaluation purposes!
//
// If you have the FREE version...
// Enter FREE in the VALUE. For example:
//
// <PARAM NAME="KeyCode" VALUE="FREE">
//
// If you have the PRO version...
// Enter your key in the VALUE. For example:
//
// <PARAM NAME="KeyCode" VALUE="AQ?/F@FG1*P@U9">
//
// For those with the purchased version, keys are automatically made
// for you dynamically off the CodeBrain.com site. You'll receive
// explicit instructions on this at time of purchase, and each time
// that you make a key. Six keys are included with your purchase, so
// you can use the applet as many times as you wish on as many pages
// as you like on up to six different sites.
//
// If you are unsure what the domain for the key is, use DOMAIN as
// the value in this parameter. For example:
//
// <PARAM NAME="KeyCode" VALUE="DOMAIN">
//
// and iframe.class will tell you the domain name needed when you
// run it from your site. Use exactly what the applet tells you to use
// in the URL box on the keymaker form on our site. Note that when you
// receive your keycode off the site, it will clip the "www." off the
// beginning of your URL. This *is* correct, and the key will work
// properly whether users enter via www.sitename.com or sitename.com.
<PARAM NAME="TextFile" VALUE="filename.txt">
-------------------------------------------------------------------------
// This is REQUIRED. It is the path to the text file that the applet
// will read in. The filename can be anything you wish, ending in the
// extension .txt. Use NotePad or any plain text editor to create the
// text file. Only plain text files can be used. IMPORTANT: See the
// notes on paths, below. In general, put this file in the same place
// as the .class file and the html page calling it to get started.
<PARAM NAME="PageColor" VALUE="#FFFFFF">
-------------------------------------------------------------------------
// This is OPTIONAL, but it most designs you will want to use it. The
// default color is #FFFFFF (white). This value sets the color of the
// page inside the applet space. The format is usual html: #FF0000 is
// red, #00FF00 is green, #0000FF is blue, #000000 is black, etc. Don't
// forget the # sign.
<PARAM NAME="FontSize" VALUE="12">
-------------------------------------------------------------------------
// This is OPTIONAL, but you will want to use it in most cases. The
// value sets the size of the font, in points, same as html.
<PARAM NAME="FontColor" VALUE="#000000">
-------------------------------------------------------------------------
// This is OPTIONAL, but you will often wish to use it. The value sets
// the color of the text in the applet space, usual html format (as
// explained above in PageColor).
<PARAM NAME="FontStyle" VALUE="0">
-------------------------------------------------------------------------
// This is OPTIONAL, but often useful. The default font sytle is 0,
// which is plain. The following are the font style values.
//
// 0 = Plain (default)
// 1 = Bold
// 2 = Italic
// 3 = Bold Italic
//
// Use these numerical values only. Text-format style names will not work.
<PARAM NAME="FontName" VALUE="Dialog">
-------------------------------------------------------------------------
// This is OPTIONAL but frequently used. The value sets the font face
// used by the applet. The default is Dialog, which sets the font to
// the standard JAVA "Dialog" font. The following values may be used:
//
// Dialog (default)
// Courier
// TimesRoman
<PARAM NAME="ScrollBars" VALUE="1">
-------------------------------------------------------------------------
// This is OPTIONAL. The default value is 1, vertical scrollbar showing,
// as this is how most users would set up the applet. However, you can
// force the applet to use the following scrollbar "policies" for special
// purposes:
//
// 0 = both vertical and horizontal scrollbars
// 1 = vertical scrollbar (default)
// 2 = horizontal scrollbar
// 3 = no scrollbars
<PARAM NAME="MaxFileSize" VALUE="64000">
-------------------------------------------------------------------------
// This is OPTIONAL in most cases: The default value is 64000, and the
// value is in bytes. What this sets is, the maximum size of the
// TextFile (above) that the applet will read. Normally, 64000 bytes is
// more than enough; but if you have a file larger than 64000 bytes, the
// applet will not fully load the file unless you set this number higher.
// Setting this lower than the default does not improve performance.
CHANGING THE APPLET SIZE ON THE PAGE: HEIGHT AND WIDTH
------------------------------------------------------------------------
// You change the size of the applet with height= and width= in the
// <APPLET> tag in your html code. There are no parameters needed.
IMPORTANT NOTE: THE PATH TO THE TEXT FILE, PATH ERROR ANOMALIES
-------------------------------------------------------------------------
// The iframe.class applet is designed to cooperate with RELATIVE paths.
// (That is, in most cases, depending on the server and other factors,
// explicit addresses (i.e., http://www.sitename.com/text.text) will
// *not* work.)
//
// These relative paths should always work:
//
// Putting the text file in the same directory as the applet and html
// page, thus:
//
// <param name="TextFile" value="text.txt">
//
// Putting the text file in a subdirectory of the one where the applet
// and html page reside, thus:
//
// <param name="TextFile" value="subdirectory/text.txt">
//
// This relative path will usually work, though some few servers may
// reject it, as it runs "backward up the directory"; thus:
//
// <param name="TextFile" value="../text.txt">
//
// In general, we recommend putting the TextFile in the same directory
// as the html and class file, or a subdirectory thereto. That will
// usually cover most organizational needs.
//
// IMPORTANT:
//
// Under some circumstances and on some servers, if iframe.class cannot
// find the file you specify in the TextFile parameter, it may jump to
// the domain root and read the (default) index html file. Netscape will
// usually catch this, but IE sometimes will not, and it does depend on
// the server and path. If iframe.class comes back with what looks like
// the html of your default page, assume this has occurred, and that the
// filename or path in the TextFile parameter is incorrect. Other errors
// in your filename or path are reported normally in the text area of
// the applet as an aid to set-up.
==============================================================
That's it, that's all, go to it!
Best regards,
CodeBrain.com
===============================================================
CodeBrain's iframe.class applet is (c) 2000 by CodeBrain
All responsibility for use of the applet remains with the user.
Modification, resale, or redistribution of the applet class file is forbidden!
|
|
|
|
