NewsMaker Message Tool
Documentation

©2002 by MicroTicker.com and OEC Corp
All Rights Reserved
.
The NewsMaker Message Tool is for use with the NewsMaker.class Java Applet.

The Message Tool is used to create the message-and-link files that constitute the content displayed in the NewsMaker.class Java applet.

.
Quick Start
.
In general, use the Message Tool to quickly and easily enter the messages (the items that are to appear in the applet) and their associated links.  

Then save the work as NewsMaker.txt (or your filename if you did not use the default) in the same directory where you have the NewsMaker.class Java applet.  Send the file to your server.  The NewsMaker.class Java applet will then read its messages and links from that file.

The Message Tool can also be used to edit existing NewsMaker message-and-link files made previously with the Message Tool.  Open the existing file, make your changes, and again, save the file and send it to your server.

Overall, most users will quickly learn the use of the Message Tool with a just a few minutes of experimentation; however, detailed explanations of all features are provided below.

.
Message Tool Controls & Features
.
Message Link Url Box
Enter the link that will go with a given message in this box.

The link can be in one of two forms, relative or absolute (the NewsMaker Java applet supports both).

In the case of a relative link, enter only the page filename (and any path); for instance, the following three examples:

somepage.html
somedirectory/thatpage.html
../mainpage.html

In the case of an absolute link, enter the full path, including the http:// protocol prefix, like this:

http://www.somesite.com/somepage.html

If no link is required, simply leave the Message Link Url Box empty.

.
Message Link Target
If you need to use a "target" window or frame with the link (above), this dropdown menu offers standard options. These are identical to those used in standard html coding:

.....- Default [ none ]
.....- Same Frame [ _self ]
.....- Whole Page [ _top ]
.....- New Window [ _blank ]
.....- Parent Frame [ _parent ]

Additionally, if you wish to target a frame in a frameset layout, use the final option,

.....- Custom (type in)

and type in the name in the small textbox just to the right of the dropdown menu. Remember that targets within frameset layouts must be the exact name of the frame, as shown in the frameset tags.

Use of a target in, probably, the majority of designs is not need, so the Default [none] is the most usual selection.

.
Message Box
Enter new message items or edit existing message items here. These are the text messages that the applet will show.

See the next four items, New Message Button, Add Message Button, Replace Message Button, and Delete Message Button for details (all directly below).

.
New Message Button
This simply clears the Message Box and resets the Message Link  and the Target dropdown and textbox -- in preparation for typing in a new message and link details.
.
Add Message Button
After you have typed in your message in the Message Box and set the Link (and target if any), click the Add Message button to add that message to the Message List (see below).
.
Replace Message Button (Editing an Existing Message)
If you click on a message that is already in the Message List (see below), it will automatically show in the Message Box (and its associated link and target details will appear in the corresponding text boxes).  After you make any changes or edits to the message itself, or to its link and target details, clicking on the Replace Message button will replace that message and its details with the new information.
.
Delete Message Button
When you click on a message in the Message List (see below), its details appear in the Message Box and the corresponding link and target textboxes.  Clicking on the Delete Message button will delete that message from the Message List (see below).
.
Message List Box
The Message List box shows your current messages and link and target details.

Note that the Message List items cannot be directly edited.  They are in display-only mode. What the items on the list show is actually the specially formatted code needed by the Java applet (see the documentation for it) -- but by scrolling, you can easily see the individual messages and link and target information.

Clicking on an item (that is, selecting it) in the Message List box will cause the details of the message to show in the Message Box and the associated link and target boxes.

You can edit the selected message and details (see Replace Message Button, above), remove the message from the list (see the Delete Message Button, above), or change the position of the message on the list (see the next items, Move Up Button and Move Down Button).

.
Move Up Button and Move Down Button
When you select a message in the Message List Box (see above), you can move it up or down on the list with the Move Up and Move Down buttons.  This allows you to easily change the order of the messages.  All the associated details (link and target) move with the message.
.
Message Preview Box (Right Side)
The long Message Preview box on the right of the application shows the current message list.  Note that the Message Preview box cannot be edited directly; it is in display-only mode.

The purpose of the Message Preview box is to always provide a current plain-text view of the messages and their order, that is much more easily read that the information in the Message List box. It updates immediately with any changes made.

Note that the Message Preview box does not reflect the layout that will appear in the Java applet's display; it is strictly an editorial convenience.

.
Open File Button and Save File Button
Use the Open File button to open an existing message-and-link file.  Take care that you have chosen the correct file, as you will often have numerous files in a given directory.  Open only files previously created by the Message Tool.  When a message-and-link file is opened, all of its information will appear in the Message Tool.

Important: If you have any work in the Message Tool, be sure to save it before importing a new file.

Use the Save File button to save your message-and-link file.  Again, take care to save to the appropriate filename and directory. Remember to save your work before you import any new file or close the application!

.
Help Button
The Help button opens this help file.
.
Close Button
The Close button closes the application.  Remember to save your work before you close the application!
.
Additional Notes
.
Links and the Message Link URL
.......As a rule, the preferred method of linking is the absolute http:// path to a page, as it's obviously the most specific. Occasionally, with relative links, though increasingly uncommon, note that some servers will not allow "going backward up the path"; that is, linking to a file that is higher up the directory tree.
General Notes on Messages

.......This is of little concern for most users, but noted for completeness: Use of just a few certain characters and character strings is blocked.  The NewsMaker tool will automatically protect you from entering these characters and character strings.  Use of these strings is forbidden: ###, @@@, ^^^.  Use of the pipe | sign is forbidden.  Use of the back \ slash is forbidden. These characters and strings are used internally by the applet.
.......The overall length of the Message Line is arbitrary, with no practical limits in general use (theoretically, it's 64K).  Messages are stored in dynamically allocated vector arrays in the applet, so practically speaking, again, there is no limit to the number of messages (theoretically, it's 256 messages). Do bear in mind, though, that very large files will take longer to load; so, as with anything on the Net, brevity is desirable.

.
.
Legal Notices
The NewsMaker applet, its associated Message Tool software, and this documentation are ©2002 by MicroTicker.com and OEC Corp., all rights reserved.  Duplication, redistribution, or resale of these products in any manner or form is strictly prohibited under penalty of law.

MicroTicker™, MicroTicker.com™, CodeBrain™, CodeBrain.com™, NewsMaker™, OEC InterNET Group™, and OEC Corp™ are registered trademarks of OEC Corp.

.
.
[End of Documentation]