The Tech Note feature is the cross platform and internet help system for both the software program and your company. Uses include on-line help, ISO manuals, supporting documentation for customers, etc...
Tech Note References, managing the manual
Play Movie: u2_TechN.MOV
Access the TechNotes on-line, GOTO Dept menu >> Tech Note References.
Use the bold fields to search for the desired TechNotes. Remember the more you type the more specific the search.
There are two ways to access TechNotes for editing
1. GOTO Dept menu >> Admin, GOTO Records menu >> TechNotes.
2. GOTO Dept menu >> Tech Note References, with the TechNote you wish to modify in the right hand list, hold down the option key (Mac) or Alt key (PC) and double click on the TechNote. The TechNote will open in a seperate process.
There are a number of fields in TechNotes designed to assist in defining and finding TechNotes.
1. TN ID is the unique ID of each TechNote.
2. Publish allows the TechNote to be published to the web. A value less than or equal to zero prevents publishing. A value of greater than zero sets the access authority for the TechNote, the higher the value the more restricted the access.
3. Name, Subject and Author are as their names imply. These are searchable fields.
4. Purpose sets the general use of TechNotes, such as "jitManual", "ISO", etc....
5. Version is the revision or control ID for the TechNote.
6. Chapter and Section support segmenting the TechNotes into groups.
7. FileID allows TechNotes to associate with a specific database file.
8. Tech Font sets the font and size for TechNotes.
9. Make Key button and Keywords are the tools to create additional search capabilities.
1. Enter keywords seperating them by Tab characters.
2. Highlight the keywords.
3. Click the make key button. The keywords will display in the Keywords list.
10. Reference and URL allow you to reference outside resources.
The small menu controls the TechNote entry area. The use of the command is self-evident.
TechNotes have a set of standard formats. It is highly recommended that you use these the maximum extent possible. The jitManual records typically employ these formating standards. In future revisions these formats will be the basis for creating HTML pages on the fly.
There are a number of commands which can be added to TechNotes to make them more powerful when view the the TechNotes Reference Screen. There are typically two parts to a command. The active portion (generally colored) and the parameter (generally black and surrounded by "<--???-->"). Execute a command by clicking on the active portion.
1. LaunchThis<--S15614:Movies:u2_TechN.MOV--> launched what ever parameter is passed to it. If it ends in a recognized ending string and there is memory available, the program will automatically lauch the document with its application. If the application cannot be found, or has not be identified, a dialog will open asking that the Application be selected.
NOTE: On Windows machines you must list the letter of the Alt Drive if the drive designated in the file name is not a letter drive ID.
2. DoScript<--5-->, searches for a TallyResults record with a Unique ID equal to the parameter (5). If it finds one, the text in field [TallyResults]TextBlk2 is executed as a script.
3. DoThis<--Alert("will launch you to an exercise")-->, executes the parameter as a script.
2. LaunchThis<--S15614:Movies:u2_TechN.MOV-->, launches the document listed as the parameter.
2. LaunchThis<--Web_FilePath(images/Logo_Main.gif)-->, opens the document listed form inside the jitWeb folder on that machine.
2. LaunchWeb<--www.webclerk.com-->, launches your browser and the web site or page listed.
2. ReferenceThis<--Page Construction-->, jumps to a referenced TechNote., Use the Back button in the upper right of the TechNotes Reference page to jump back.