\About
\DThe Clean Editor

\dA menu-driven multi-window editor.
\L
\cThis application is developed using the Concurrent
\cClean System, a programming environment for the
\cfunctional language Concurrent Clean. This system
\cis developed by the research group Parallel
\cSystems and Computational Models at the
\cUniversity of Nijmegen.

\dThe Concurrent Clean System is
\dfreely available via FTP for
\dMacintosh, Sun3 and Sun4.
\EndAbout

\Help
\DClean Editor Help

This help file will explain all available commands and the available key- and mouse-combinations.
\L
\BThe Menus

Below follows a list of the menus of the Clean Editor with a short description of all commands.
In the following 'active window' means the frontmost edit window. When your keyboard has no
'Command' key the Control key can be used instead.

\bThe File menu:

\bNew (Command-N)
Open a new edit window called 'Untitled'. Until 'Save' or 'Save As...' are chosen there is no
corresponding file for this window. Both 'Save' and 'Save As...' present the standard Save As
dialog when an 'Untitled' window is the active window.

\bOpen (Command-O)
Opens a file using the standard Open dialog.

\bClose (Command-W)
Close the active window. When the contents of the window has been edited since the last save an
alert dialog will appear asking whether you want to save the changes.

\bSave (Command-S)
Save the contents of the active window to the corresponding file. When the active window has no
corresponding file (when it is an 'Untitled' window) a dialog will appear in which a file can be
specified.

\bSave As...
Save the contents of the active window to a file using the standard Save As dialog. The title of a
window always shows the name of the corresponding file, so this title will change after this
operation.

\bRevert
Revert to the last saved version of the document. A confirm dialog appears that warns you that
changes made since the last save will be lost.

\bQuit (Command-Q)
Quit the Clean Editor.


\bThe Edit menu:

\bUndo (Command-Z)
Undoes the effect of all actions that change the text and/or the clipboard. The actions that can be
undone are typing sequences, the Cut, Copy, Paste and Clear commands and of course the Undo
command. Undoing of typing sequences has not been implemented yet!

\bCut (Command-X)
Cut the currently selected text in the active window from the text to the clipboard.

\bCopy (Command-C)
Copy the currently selected text in the active window to the clipboard.

\bPaste (Command-V)
Paste (insert) the contents of the clipboard at the current cursor location. When a piece of the
text is selected in the active window it will be replaced by the contents of the clipboard.

\bClear
Remove the currently selected text in the active window. The text is not copied to the clipboard.
Pressing backspace or delete has the same effect.

\bWarning:
The clipboard of the Clean Editor is not the system clipboard. It is therefore not possible to copy
pieces of text to or from other applications.

\bBalance (Command-B)
Select the smallest piece of balanced text surrounding the cursor or currently selected text in
the active window. This command can be used to find corresponding open and close symbols. The
following pairs of open and close symbols are recognized: '(' ')', '[' ']' and '{' '}'.

\bFormat... (Command-J)
A dialog appears in which the font and font size, the tab width and the auto indent option can be
set for the active window. The options that are set in the dialog can be used as default settings,
such that all new edit windows will be opened using these settings. The default settings will be
saved when the editor is quitted.
  The tab width can be any number of spaces between 1 and 99. When a number smaller than 1
resp. greater than 99 is chosen the tab width will become 1 resp. 99.
  The auto indent facility of the editor can be switched on and off. When it is on the editor will
remember the first non-tab non-space position in the current line. When return is typed the
cursor will move automatically to the remembered position and the needed amount of spaces and
tabs will be added. When Option- (or Alt-) return is typed the cursor will move to the beginning
of the next (new) line. When the auto indent option is off it is the other way around: Option-return
auto-indents the next (new) line, return does not.


\bThe Search menu:

\bFind... (Command-F)
A dialog appears in which a text to search for and a text to replace the found text with can be
specified. By default the find/replace starts from the current cursor location downwards to the
end of the text. It is also possible to search backwards to the beginning of the text (check the
Backward option). When Wrap Around is checked (which is the default case) the search will
continue from the beginning or end of the text of the active window when the beginning or end of
the text has been reached.
When Ignore Case is chosen no distinction is made between lower- and uppercase characters.
When Match Words is checked only whole words will be found. When the text to search for
appears as part of another word it will be ignored. Whole words are delimited by outline
characters (tabs, spaces, (semi)colons, quotation marks etcetera).
When the Find button is pressed the text to be found will be found (if it exists). With the Replace
button the found text will also be replaced by the text to replace with. When the Replace All
button is pressed all occurrences of the text to be found will be replaced by the text to replace
with.

\bWarning: 
The text to be found and the text to replace with may not contain non-printables such as tabs or
newlines. When they do the find or replace commands will be ignored.

\bFind Next / Find Previous (Command-G)
Depending on the Backward option in the Find dialog this command is Find Next or Find Previous.
It will find the next (or previous) piece of text in the active window as defined in the Find dialog.
The options set in the Find dialog will of course be taken into account (Wrap Around, Ignore Case
and Match Words).

\bFind Selection (Command-H)
The currently selected piece of the text will become the text to search for and the next (or
previous) occurrence of this piece of text will be found. When the selected piece of text contains
one or more non-printable characters (such as tabs or newlines) this command will be ignored.

\bReplace & Find (Command-T)
When the currently selected piece of text corresponds with the text to be found it is replaced by
the text to replace with and the next (or previous) occurrence of the text to be found will be
found (if it exists).

\bGoto Cursor (Command-L)
Scroll the active window in such a way that the cursor (insertion point) becomes visible. When
the cursor was already visible nothing happens. When it was not the text will scroll in such a
way that the cursor will be as close as possible to the middle of the window. When a piece of
text has been selected the beginning of the selection will be taken as the cursor location.

\bGoto Line...
A dialog appears in which a line number can be entered. The cursor will move to the beginning of
the indicated line. When the line number is smaller than one resp. greater than the number of
lines in the active window the cursor will move to the beginning of the first resp. last line.


\bThe Windows menu:

\bHelp... (Command-/)
Open the Clean Editor Help window you are reading now or bring it to front when it is already
open.

\bSave All
Save the contents of all open windows.

\bClose All
Close all open windows. For each window that has been changed since the last save a dialog will
be presented asking you whether you want to save the changes.

\bOther open windows.
All open windows (except the Clean Editor Help window) are listed in the Windows menu. The
active window is marked. By choosing a window name in the menu the corresponding window
will become the active window.


\BKey combinations

The following keys and key combinations have been given a more or less special meaning in the
Clean Editor.

\bDeleting:

\b  Backspace
        delete previous character
\b  Delete
        delete next character
\b  Option-Backspace
        delete to begin of word
\b  Option-Delete
        delete to end of word

\bCursor movement:

With Left, Right, Up and Down the arrow keys present on most of the keyboards are meant.

\b  Left
        one character left
\b  Right
        one character right
\b  Up
        one line up
\b  Down
        one line down
\b  Option-Left
        one word left
\b  Option-Right
        one word right
\b  Command-Left
        begin of line
\b  Command-Right
        end of line
\b  Command-Up
        top of window / previous page
\b  Command-Down
        bottom of window / next page

\bSelecting with the arrow keys

\b  Shift + Any of the cursor movement combinations
        extend current selection


\BMouse combinations

It is of course also possible to move the cursor and to select pieces of text with the mouse.
Special mouse combinations are:

\b  Shift-click
        extend the current selection to the character underneath the pointer.

\b  Double-click
        select the word surrounding the pointer.

\b  Triple-click
        select the line surrounding the pointer.
\EndHelp
