NoteTab (notetab.com)

Contents

  1. Introduction
  2. Hyperlinks
  3. Outline Documents
  4. Document Templates
  5. Clipbook Wizards
  6. Quick List
  7. Web Documents
  8. Mathematics
  9. Clipbook & Maths

1. Introduction

This document demonstrates some of the capabilities of the Outline feature and other important functions available in NoteTab.

Outline documents make it easy to organize your information in a structured format without using a database application or splitting your text into multiple files. The window on the left side of this text shows all the available headings (or topics). When you select a heading, its content is displayed in the main editor window.

You can have up to about 5400 headings per Outline document and a heading can contain many megabytes of information. An Outline file can theoretically have a maximum capacity of 2GB.

You can use hyperlinks to easily jump to any piece of information. See the hyperlinks topic for more information on the subject. To jump to a topic, hold the Ctrl key down while you double-click on the hyperlink. If you set the "Quick Open Links" option under the Tools menu, you do not have to hold down the Ctrl key when you activate a hyperlink.

See the Outline Documents topic to find out how you can create your own. Other new features of interest include Document Templates -- ideal for saving time in creating many common types of documents (web pages, letters, etc.). Clipbook fans should take a look at the topic about Clipbook Wizards. See how the new Quick List can help you develop your web pages. And make sure you check the Mathematics topic to find out how NoteTab can replace your calculator for many tasks.

[ Top of Page ]

2. Hyperlinks

Hyperlinks must be placed between square brackets "[]". You can jump to a hyperlink topic by holding down the Ctrl key while you double-click on the text between the brackets. Or, if you prefer, place the cursor anywhere between the brackets and press Ctrl+H to go to the matching topic. Note that if you set the "Quick Open Links" option under the Tools menu, you do not have to hold down the Ctrl key when you activate a hyperlink with the mouse.

Hyperlinks can be inserted in any kind of document. They can represent a heading in the active Outline document, or another Outline document, or the name of a file, or an Internet link, or a program to launch, or a line number, or a text search criteria. Case is not important unless you use the search criteria feature with case sensitivity enabled.

Examples:
* If you activate the introduction hyperlink, the content of that Outline topic will be displayed.

*  If you have another Outline file called "Important.OTL", you can create a hyperlink that will display it and select the topic you specify. For example, [important.otl::meetings] will display the "meetings" heading. Note the use of the double colon to separate the main link criteria from the secondary criteria.

* The accompanying "WhatsNew.txt" file can be opened with this hyperlink: WhatsNew.txt. Note that a hyperlink is automatically created when you drag a file name from the Quick List (Favorites or Disk Files).

* The following command [explorer.exe] will launch Windows Explorer. You can also specify parameters as long as you place the program's file name between double quotes ["explorer.exe" /e,/root,C:\].

* The following hyperlink readme.txt will display the "readme.txt" file. As it is not an Outline file, NoteTab assumes the second criteria "outline" is text to search and will select the first occurrence of the word "outline". Note that you will have to specify the full path name if the file is not in the same directory as the document containing the hyperlink.

* If you want to apply the search criteria type of hyperlink on the active document, just omit the file name. For example, [::NoteTab] will find the next occurrence of the name NoteTab. Since the double colon does not necessarily look very nice in this case, the following format with a blank space on each side of the search criteria is also valid: [ NoteTab ].

* By default, the search feature is case sensitive, only matches single words, and searches forwards. However, you can change this behavior by using extra parameters: "I" indicates that the search should not be case sensitive, "T" indicates that any text is acceptable, and "B" tells NoteTab to search backwards. Use the "^" character to separate the search criteria from its parameters. For example, [ tab^ITB] will select the "Tab" part of the name NoteTab preceding the hyperlink. And readme.txt will find the last occurrence of the word "NoteTab" in the Readme.txt file.

* To jump to a specific line number in a document, the format of the hyperlink is similar to the search criteria. You use the line number instead of the search text and use the parameter "L" so that NoteTab knows it is the line number you want and not text to search. For example, readme.txt will display the Readme.txt file with the cursor at the beginning of the 5th line. If you specify "-1", the cursor will be placed on the last line: readme.txt

* URLs are also valid. However, if the link does not start with the typical "www.", then you must fully qualify the URL (add "http://", or "ftp://", etc.). The following will connect to the NoteTab site through your default web browser www.notetab.ch. Hold the Alt key down if you want to open the link in a new web browser window (this feature may not work with all browsers).

[ Top of Page ]

3. Outline Documents

You can create your own outline documents by choosing the "New Outline" command from the File menu (trial or commercial version required). Unlike standard documents, you must choose a name before it is created. You will also be prompted to enter a name for the first heading. Once you have completed those steps, you are ready to enter content for your first heading.

To create a new heading, just press Shift+Ctrl+A. You will then be prompted to enter the name for the new heading. Note that you do not need to save the content of modified headings as you move through the list -- this is automatically taken care of by NoteTab. Shift+Ctrl+R will remove the current topic. If you can't remember these shortcuts, just place the mouse cursor over the Headings window and look at the hint in the status bar. You will also find other shortcuts listed in the "Outline Heading" submenu under the Documents menu. You can also invoke the shortcut menu from the Headings window.

You can add hyperlinks to other headings. When activated, the content of the linked heading is displayed. Use the "Documents|Outline Heading|Copy Heading" menu command (or the keyboard shortcut Shift+Ctrl+B) to easily create a new heading based on selected text in your outline document. This command automatically inserts square brackets around the selection, adds the heading to the list, and opens it for input.

The PageUp/PageDown keys also let you scroll from one heading to the next. If the cursor is at the beginning of the heading's content, pressing PageUp will display the previous heading. Pressing PageDown when the cursor is at the end of the heading's content will display the next heading. If the last heading is already selected, NoteTab will ask you if you want to add a new heading. You can easily reorder headings by dragging them with the mouse to a new position.

Just like any other document, you can have multiple Outline documents open simultaneously. Outline files are very similar to Clipbook libraries and do not contain any control codes other than plain text characters (i.e. no binary characters). As a result, you can easily open them in any text editor or word processor (although you won't benefit from the outline layout), or send them in e-mail messages.

[ Top of Page ]

4. Document Templates

A template is a special kind of document that provides content for shaping a new document. You can use several templates to save time in creating many common types of documents.

Templates are slightly different from normal documents in that their first line contains the template header definition. The header informs NoteTab that the file being opened is a template; it can also tell NoteTab what name it should generate for the new document. For example, the header of this document's template looks like this:

= DocTemplate "Notes%0.3d.txt"

You can easily insert a template header in your active document by choosing the command "Add Header" under the File|Template menu.

Headers must always start with an equal (=) sign as the first character on the line followed by the word "DocTemplate" (case is not important). After that first part, you can add the text format that NoteTab should use to generate the names of documents based on the template. This information is optional and must be enclosed in double quotes (") when used. The code "%d" indicates where the incremental numbering is inserted in the name. In the above example, the "0.3" between the % and d tells NoteTab to format numbers smaller than 3 digits with leading zeroes. If you omit the extension, the currently defined default extension will be added when the name is generated. You can also include a path name if you always want the documents saved in the specified directory.

Add this type of header on the first line of any document and it will become a template once you save it. Then, whenever you open it through the File|Open or File|Template|Open menu command, a new document based on your template will be created. If you need to modify the content of a template, use the File|Template|Edit menu command.

Starting with version 4.6, NoteTab template files accept Clip commands and functions embedded in the text. When such a file is opened, the text contained in it is interpreted and the resulting text is displayed in the document. To enable this feature, you will have to include the keyword "ClipCode" in the header line of the template file. See the template file HTML.tpl for an example of embedded functions. Example of header:

= DocTemplate ClipCode "Home%0.3d.htm"

Note that you cannot close a template document through its own embedded Clip code.

Since version 4.8, template headers accept the ^$GetDate()$ function in order to use the current date in the file name. Example:
= DocTemplate ClipCode "Notes-^$GetDate(yyyymmdd)$-%0.3d.txt"

[ Top of Page ]

5. Clipbook Wizards

In previous NoteTab versions, inserted Clipbook items with multiple prompts would display a dialog box for each prompt one after the other. Now, multiple prompts are all shown in a single dialog box called a Wizard. This new approach makes filling the fields quicker and more user friendly.

Clipbook Wizards are fairly easy to create using the special Clipbook syntax (see the Help file for more details). Each field can either be a single or multi-line input box, a list box, or a combo box with a list of predefined values. Each field can have a descriptive label and contain predefined values.

Many examples are provided in the sample Clipbook libraries included with NoteTab. Open the HTML library (click on the HTML button below) and double-click in the list on the item "HTML begin" to see an example of a relatively complex Wizard. You'll find another type of example by double-clicking on the "US Dollars to Swiss Francs" in the Convert library (click on the Convert button below).

Another feature gives Clipbook-library authors the possibility to advertise their work. Double-click on the item "About this library" to see an example of this new feature. The dialog box is web sensitive so a user can double-click on your web or E-mail address to reach you. Use the syntax element "^!INFO" to create the information dialog box and "^P" tokens to indicate a new line in your text.

Because the Clipbook syntax can be hard to remember, a "Clip Assistant" is available under the Tools|Quick List menu. When you activate this command, a list of ready-to-use syntax elements is displayed in place of the Quick List. You can paste the items into your document by double-clicking on them or by dragging them. You can edit the ClipHelp.CLH file if you want to customize the Clip Assistant list.

Press F4 if you want to close the Clipbook at this stage.

[ Top of Page ]

6. Quick List

You can open the Quick List by pressing F6. When you use this feature for the first time, it will display the list of documents currently open in NoteTab. You can move to another document by selecting it from that list.

The Quick List window can be used to display four types of content:

1. Opened documents (Documents)
2. Favorites list (Favorites)
3. Files in a directory (Disk Files)
4. Clip Assistant

The simplest way to change the type of list is by invoking the shortcut menu in the Quick List window. Choosing Disk Files will display all the TXT files in the current directory. You can change directory or file criteria by editing the content of the combo box and then pressing the ENTER key. You can specify multiple criteria in the combo box; the different criteria must be separated with a semi colon (;). Example: c:\images\*.gif;*.jpg;*.jpeg.

Double-clicking in the combo box will open a dialog box that makes it easy to change directories. To open one of the files listed, just double-click on its name.

The Favorites list contains the same items as the Favorites menu. When you use NoteTab for the first time, the Favorites list will be empty. Once you have added documents to the list, just double-click on a document name to open it.

When the Favorites or Disk Files are displayed, you can drag-and-drop the names into your document. If the document has an HTML extension (as listed in the Options dialog box), dragged file names are converted to HTML links: image files (GIF, JPG, JPEG, and BMP) will be inserted as Img tags and other files as a HRef tags. The Img tags will even have the image size attributes completed. You can change the format of the default tag by editing the appropriate fields in the Options dialog box. See the topic Web Documents for more information on creating web pages.

The Clip Assistant contains all the commands and functions available in the Clip syntax. You select and complete commands and functions through the Clip Wizards (which are themselves created through Clip syntax).

Press F6 if you want to close the Quick List at this stage.

[ Top of Page ]

7. Web Documents

NoteTab has many features that make it easy to create or convert documents to web pages. Note, however, that only NoteTab Pro offers HTML-syntax highlighting. Support tools include the Editor Clipbook, the Quick List, and the Modify menu which offers powerful commands to convert characters, selected text, or entire documents to HTML.

For example, this Outline document can be converted to a web page complete with a table of contents, headers for each topic, and links between them. To see for yourself, use the menu command "Modify|Document to HTML|With Paragraph Tags". Once the new HTML document is created, hit the F8 shortcut key to view it in your favorite browser. Settings in the Options dialog box let you customize the HTML header and footer. Creating this type of web page has never been easier. Webmasters maintaining FAQ lists will love this feature!

The Editor Clipbook is a powerful tool for adding HTML tags to your text. Most HTML editors let you add tags through toolbars loaded with buttons or cascading menus. This approach is awkward to say the least. With the Clipbook, tags are clearly identified by meaningful names, the list is always in view once you open it, and it can contain a virtually unlimited number of items (tags or frequently used text). You can easily customize the Clipbook HTML libraries to suit your needs. A little icon next to each item indicates whether it contains a tag that can wrap around selected text (a + symbol) or not (a circle). Some Clipbook items even accept user input before they are pasted in the document (see the topic Clipbook Wizards for more information). You can insert Clipbook items by double-clicking on them, by dragging them into the document, by typing the first matching characters and hitting the F2 function key, or by invoking the In-Context Clipbook using the ESC key. Use Ctrl+Spacebar as a shortcut to insert the active Clipbook item. See the Help file for more information on this tool.

Adding links to other web pages or images stored on your computer is really easy when you use the Quick List. When it is configured to display disk files or Favorites, files can be dragged from the list into the document. If the extension of the document is listed in the "HTML File Extensions" listbox (Options dialog box), the appropriate link tag is inserted at the point where you drop the file.

Changing a URL or any other type of text (even multiple lines) across many web pages is also easy with NoteTab. Two methods are available: either you open all the files that are likely to contain the searched text and then use the Replace command (Ctrl+R) to scan through them, or use the "Search Disk" command (Ctrl+D) to scan your disk files.

Use Document Templates to create new documents that already contain the framework of your web page layout. This feature will save you a lot of typing when you create a new web page. A sample HTML template is provided with NoteTab.

You can view your HTML document in your default web browser by using the F8 function key. There is no need to save your changes when you use this feature. If NoteTab detects that your document has been modified, it stores the changes in a temporary file and sends it to the browser. Hold the Alt key down if you want to open the document in a new web browser window (this feature may not work with all browsers).

You can organize your HTML documents in multiple categories by using the flexible Favorites dialog box (Shift+F2). The Favorites feature can exploit an unlimited number of categories. Items in the list can represent file names (including wildcards), directories, and the names of other categories. See the Help file for more information on this feature.

[ Top of Page ]

8. Mathematics

NoteTab can also calculate mathematical expressions in a document. Expressions can have up to 40 embedded parentheses. Note that you may need to break down very long expressions into groups of parentheses if you get an error message.

For example, if you enter the following expressions in a document:

    Sin(3)*5/Pi=

and then press Ctrl+E (or from the menu Tools|Calculate Expression), the result will be added after the equal sign. If there is no equal sign, or if the document is Read-Only then it copies the result to the Clipboard and displays it in a small window. You can also add numbers arranged in a column; just select all the numbers in the following four lines and press Ctrl+E:

        23
        -5
        42
        40

See the topic Clipbook & Maths for more interesting uses of the mathematics feature.

Supported mathematical operators and functions are listed below.

Predefined value:
PI

Accepted operators: + , - , * , / , ^ , MOD, DIV

The following functions are supported; it doesn't matter if you use lower or upper case:

COS, SIN, SINH, COSH, TAN, COTAN, ARCTAN, EXP, LN, LOG10, LOG2, LOGN, SQRT, SQR, POWER, INTPOWER, MIN, MAX, ABS, TRUNC, ROUND, INT, CEIL, FLOOR,
HEAV (heav(x) is =1 for x>=0 and =0 for x<0),
SIGN (sign(x) is 1 for x>1, 0 for x=0, -1 for x<0),
ZERO (zero(x) is 0 for x=0, 1 for x<>0),
LZERO (lzero(x) is 0 for x<>0, 1 for x=0),
RND (rnd(x) = int(x) * Random)
RANDOM (random(X) = Random; the argument X is not used)

Functions like MIN and MAX take two values; you must use a semi-colon ";" to separate them. For example: MAX(2;3)

Trigonometric functions take values in radian units.

Acknowledgments:
================
The mathematics feature was made possible thanks to the superb freeware parsing function developed by the following people:
Renate Schaaf (schaaf@math.usu.edu), Alin Flaider (aflaidar@datalog.ro), and Stefan Hoffmeister (Stefan.Hoffmeister@Uni-Passau.de)

[ Top of Page ]

9. Clipbook & Maths

The Clipbook also supports mathematical expressions. The advantage of the Clipbook is that you can create Clipbook Wizards to insert the values of variables. You can create Clipbook items that will either paste the result in your document or display it in an information window.

The new syntax element is as follows:
  ^$Calc(Expression)$
or
  ^$Calc(Expression;Decimals)$

"Expression" can be any mathematical expression using the operators and functions listed further down. You can optionally define how many decimal values should be displayed in the result by placing a figure after the expression with a semicolon (;) between the two parts. If you want to place some meaningful text on the left side of the answer, use the old syntax format and add an equal sign (=) at the end of the tag followed by the text to display. If you want to display units or some other text after the result, just place that information before the equal sign.

For example: ^$Calc(7/11;3)$ will display the result 0.636

You can also add prompts to supply values to variables. The following example will prompt the user to define a value for x and the number of decimals that the answer should display:

  ^$Calc(Sin(^?[Sin(x): Enter a value for x]);^?[Decimals])$

Look at the Euro and Utilities libraries for more examples.

[ Top of Page ]