========================================================================= CODEBRAIN NEWS - FREE VERSION CodeBrainNewsFree.class - Version 3.0.1 of 5/20/2000 ========================================================================= GENERAL NOTES ------------------------------------------------------------------------- Print out this guide for use while configuring your new CodeBrain applet! ------------------------------------------------------------------------- // The CodeBrainNewsFree applet code is written protectively -- to make // it easy to set up and get running. Demos and the associated graphics // are included, with simple HTML pages, to get you rolling quickly. // // Other than the "Notice" parameter and a couple of items in the Text // parameters, you can leave out any parameter and the applet will run. // That is, "If in doubt, leave it out!" // // You can make the applet as simple as you wish, without the clutter and // confusion of many parameters -- then gradually build more complex uses. // // Keep image files (BackImage) to the smallest dimensions and file sizes // possible. Large images backload the applet and slow it down. Using a // BackImage and the scroller positioning features can make really great // displays, though, so do experiment with this. // // To get started, place the CodeBrainNewsFree.class file and ALL files // used by the applet in the SAME directory. // // Check out the demo(s) included, and gradually change parameters to get // a feel for how the applet works. // // We know you'll have great success with CodeBrainNewsFree.class. It's // a simple applet to use, but undoubtedly one of the very best and most // versatile scrollers you'll find anywhere. // // Best regards, // // CodeBrain // // IMPORTANT: // CodeBrainNewsFree.class will show a 20-second notice plate when live // to the Net. The Pro version of the applet does NOT show this notice // plate, and starts and runs 20 seconds faster. If you choose to upgrade // to the Pro version, the only code change needed will be changing the // code= filename from CodeBrainNewsFree.class to CodeBrainNews.class. P A R A M E T E R S ========================================================================= ------------------------------------------------------------------------- // Must be present, EXACTLY, or the applet will not run. ------------------------------------------------------------------------- // This parameter is optional. // // Pause sets the pause (dwell) time each text items makes at the top of // the scroll. Although this parameter is optional, you usually want // to set it to some value -- or the reader has difficulty with the text // going by too quickly. We suggest a range of 2000 to 5000. The value // is set in milliseconds; that is, value="2000" would pause for two full // seconds as each text item comes to the top of the applet. // // The default for this parameter is value="2000" -- so if you want no // pause at all, you should set it to value="1". ------------------------------------------------------------------------- // This sets the applet background color. // // Usual RGB format, values 0-255. // Example: value = "255,0,0" would make the applet background red. // // The default color (if you don't use this parameter) is white. ------------------------------------------------------------------------- // This parameters sets the (optional) image to be used for the applet // background. This image sits on top of the applet background, but // behind the applet text. Leave this parameter out if you use no // image for the background. // // Images may be .gif, transparent.gif, animated .gif, or .jpg format. // Keep image file sizes and dimensions as small as possible, of course, // to keep down loading time and redrawing overhead. ------------------------------------------------------------------------- // This sets the color of the applet text. // // Usual RGB format, values 0-255. // Example: value = "0,255,0" would make the text medium green. // // The default color (if you don't use this parameter) is black. ------------------------------------------------------------------------- // This sets the mouseOver or 'link' color. The text for each item // changes to this color when the mouse passes over it. // // Usual RGB format, values 0-255. // Example: value = "0,0,128" would make the link color dark blue. // // The default color (if you don't use this parameter) is red. ------------------------------------------------------------------------- // This is the font to be used by the applet, sometimes called the font // face. JAVA applets universally support the following fonts: // // Dialog // Helvetica // Courier // TimesRoman // Symbol // // The default font (if you don't use this parameter) is Dialog. ------------------------------------------------------------------------- // This sets the overall size of the applet font. Practical sizes range // from around 10 to 36, though smaller and larger sizes will work. // // The default size (if you leave out this parameter) is a compromise 11 // that works well for general use across a variety of screen resolutions. ------------------------------------------------------------------------- // This sets the font style for the text. // JAVA applets universally support the following styles: // // plain // bold // italic // bolditalic // // The default font style (if you don't use this parameter) is plain. ------------------------------------------------------------------------- // This parameter is optional. // // The parameter sets how far from the LEFT side of the applet, in // pixels, that the text will appear. This is quite useful in // controlling your layout, so the text won't be slammed against // the side of the applet, and can be used in conjunction with // the BackImage (above) to create striking displays. // // For example, value="25" would cause the text to begin its printing // 25 pixels from the left of the applet. ------------------------------------------------------------------------- // This parameter is optional. // // The parameter sets how far from the TOP edge of the applet, in // pixels, that the text will appear. This is quite useful in // controlling your layout, so the text won't be slammed against // the top of the applet, and can be used in conjunction with // the BackImage (above) to create striking displays. // // For example, value="50" would cause the text to begin its printing // 50 pixels from the top of the applet. ------------------------------------------------------------------------- // This parameter is optional. // // This effectively "clips" the scroller display area. The dimension // is in pixels, and will be in addition to any LeftMargin if you've // set that parameter. For instance, if you set LeftMargin as // value="30" and ScrollerWidth as value="100" the text would begin // printing at 30 pixels from the left, and be clipped at 130 pixels // from the left. // // This parameter is particularly useful when you're using the scroller // on top of a BackImage (above), for fitting the scrolling area // exactly where you want it. ------------------------------------------------------------------------- // This parameter is optional. // // This effectively "clips" the scroller display area. The dimension // is in pixels, and will be in addition to any TopMargin if you've // set that parameter. For instance, if you set TopMargin as // value="50" and ScrollerHeight as value="200" the text would begin // printing at 50 pixels from the top, and be clipped at 250 pixels // from the top. // // This parameter is particularly useful when you're using the scroller // on top of a BackImage (above), for fitting the scrolling area // exactly where you want it. ------------------------------------------------------------------------- // This parameter is optional. // // If set, the soundfile will play each time a text item is coming to the // top of the applet. // // The soundfile must be a standard .au file, per usual JAVA use. // // Special Note: Your sound file should be as short as possible (time), // and you should NOT use this parameter unless you have the Pause // (above) value set. The Pause value really should be longer than // the duration of the sound file. Doing otherwise won't crash // anything -- but the sound file may sometimes not play. ------------------------------------------------------------------------- // This set of parameters sets the text to be used for each item. // // For EACH TEXT ITEM, change the number portion of the parameter. // Numbers MUST be successive, starting at 1, with no skips in the number // sequence. For example: // // // // // For multiple lines in an item, you MUST use the special character | // (called a 'pipe') at the end of each line. For instance: // // // // would show up in the applet as: // // This is how // you break // lines // // For spacing, you can use spaces anywhere but at the beginning of the // first line in the value="". Use spaces to simulate indentation, to // center text, lay out in cascades, etc. Remember most fonts are // proportioning, so sometimes you have to fiddle with this to get just // the effect you want. // // To get a space between lines, use two pipes with a space between // them, like this: // // // // which would show up in the applet like this: // // This is how // // you space // lines // // Have a look at the included demo(s) if you need additional examples. // Also, we usually suggest you do this in NotePad or another plain // text editor -- it's easier (though not necessary). Some HTML // editors (notably MS FrontPage) make this simple task painful, at // times. ------------------------------------------------------------------------- // This would be the link associated with a given text item, following // the same numbering scheme as in the TextX parameter above -- that // is, Link1 would be the link associated with Text1, Link2 associates // with Text2, etc. // // If you do NOT want a text item linked -- leave out the tag. Skips in // the number sequence of the LinkX parameter ARE permitted. If you // don't want an item linked, just leave out the associate LinkX // parameter. ------------------------------------------------------------------------- // This is the target frame or window that the corresponding image will // link to. Again, same numbering scheme as with images. It IS okay to // skip numbers in TargX. If you don't specify a TargX, the default // is _top -- that is, same window. // // Just so you don't have to go look it up... TargX takes the // same general values that you use in HTML. Values with an underscore // usually refer to the browser itself, thus: // _new - opens a new window // _blank - also a new window // _self - loads in the same frame // _top - opens in the same window // When using a framed page layout, the value for TargX would be the // name of the frame where you want the linked page to appear; i.e., // main, contents, george -- whatever name you've given the frame. ========================================================================= The CodeBrainNewsFree.class applet is (c) 1999,2000 by CodeBrain Redistribution of this applet is strictly forbidden. All responsibility for use of the applet remains with the user.