15.03.94 - by Sorina COTISEL (cotisel@imag.fr)

Mediatheque IMAG - BP 53X, 38041 GRENOBLE Cedex - mediatheque@imag.fr

GENERAL HELP ON XHTMLEDIT

Xhtmledit's primary aim is to provide an easy introduction to HTML documents editing , but it is hoped that it is also sufficiently flexible to continue to meet most users' needs as their editing skills develop. It is based on the old xedit editor.

  1. Syntax
  2. Description
  3. Options
  4. Editing
  5. Default Key Bindings
  6. Dynamique reconfiguration of the keyboard to support accents
  7. Resources
  8. Widgets

SYNTAX

***

xhtmledit [-toolkitoption...] [filename]

DESCRIPTION

***

xhtmledit provides a window consisting of the following areas:

Information Label
A line that is updated with brief help explaining the action that would be performed if mouse button 1 were to be operated with the mouse pointer in the current position. If an action can be performed directly from the keyboard then the help line will contain a description of the keystroke(s) that would achieve it.

Commands Section
A row of command buttons and associated pulldown menus.Pressing and holding down mouse button 1 whilst a button is highlighted (by moving the mouse pointer onto it) will reveal the menu.

Message Window
Displays xhtmledit messages. In addition this window can be used as a scratch pad.

Filename Display
Displays the name of the file currently being edited, and whether this file is Read-Write or Read Only. If a file has not been associated with this window then 'No file yet' wil be displayed.

Edit Window
Displays the text of the file that you are editing or creating.

OPTIONS

***

toolkitoption
xhtmledit accepts all of the standard X Toolkit command line options. The order of the command line options is not important.
filename
Specifies the file that is to be loaded during start-up. This is the file which will be edited. If a file is not specified, xhtmledit lets you load a file or create a new file after it has started up.

EDITING

***

The Athena Text widget is used for the three sections of this application that allow text input. The characters typed will go to the Text widget that the pointer cursor is currently over. If the pointer cursor is not over a text widget then the keypresses will have no effect on the application. This is also true for the special key sequences that popup dialog widgets, so typing Control-S in the filename widget will enable searching in that widget, not the edit widget. Both the message window and the edit window will create a scrollbar if the text to display is too large to fit in that window.

DEFAULT KEY BINDINGS

***

The following keystroke combinations are defined:

     Ctrl-a    Beginning Of Line   Meta-b         Backward Word
     Ctrl-b    Backward Character  Meta-f         Forward Word
     Ctrl-d    Delete Next Character              Meta-iInsert File
     Ctrl-e    End Of Line         Meta-k         Kill To End Of Paragraph
     Ctrl-f    Forward Character   Meta-q         Form Paragraph
     Ctrl-g    Multiply Reset      Meta-v         Previous Page
     Ctrl-h    Delete Previous Character          Meta-yInsert Current Selection
     Ctrl-j    Newline And Indent  Meta-z         Scroll One Line Down
     Ctrl-k    Kill To End Of Line Meta-d         Delete Next Word
     Ctrl-l    Redraw Display      Meta-D         Kill Word
     Ctrl-m    Newline             Meta-h         Delete Previous Word
     Ctrl-n    Next Line           Meta-H         Backward Kill Word
     Ctrl-o    Newline And Backup  Meta-<         Beginning Of File
     Ctrl-p    Previous Line       Meta->         End Of File
     Ctrl-r    Search/Replace Backward            Meta-]Forward Paragraph
     Ctrl-s    Search/Replace Forward             Meta-[Backward Paragraph
     Ctrl-t    Transpose Characters
     Ctrl-u    Multiply by 4       Meta-Delete    Delete Previous Word
     Ctrl-v    Next Page           Meta-Shift     DeleteKill Previous Word
     Ctrl-w    Kill Selection      Meta-Backspace Delete Previous Word
     Ctrl-y    Unkill              Meta-Shift     BackspaceKill Previous Word
     Ctrl-z    Scroll One Line Up
In addition, the pointer may be used to cut and paste text:

DYNAMIQUE RECONFIGURATION OF THE KEYBOARD TO SUPPORT ACCENTS

***

In order to write and read documents which contain accents it is necessary to use an 8 bit character set instead of US_ASCII (7 bit character set). There is an international standard ISO-8859-1,used on the UNIX systems supporting 8 bit characters.

To use the accents it is necessary that your terminal is able to display them and for the operating system to send them to the terminal without cutting off the 8-th bit.

To write the accents you can do a dynamic reconfiguration of your keyboard. A good solution is to use the translations resource in your .Xdefaults file. Click here to see how to use it.

For xhtmledit the resource file Xhtmledit already contains the following configuration of the keys:

	F1  => à
	F2  => â
	F3  => ä
	F4  => é
	F5  => è
	F6  => ê
	F7  => î
	F8  => ï
	F9  => ô
	F10 => ö
	F11 => ç
	F12 => ü
If you want another assignment write it in your .Xdefaults file.

In HTML there are additional escape sequences, such as a whole set of sequences to support 8-bit character sets (ISO-8859-1).

RESOURCES

***

For xhtmledit the available resources are:

enableBackups (Class EnableBackups)
Specifies that, when edits made to an existing file are saved, xhtmledit is to copy the original version of that file to <prefix>file<suffix> before it saves the changes. The default value for this resource is ``off,'' stating that no backups should be created.
backupNamePrefix (Class BackupNamePrefix)
Specifies a string that is to be prepended to the backup filename. The default is that no string shall be prepended.
backupNameSuffix (Class BackupNameSuffix)
Specifies a string that is to be appended to the backup filename. The default is to use ``.BAK'' as the suffix.
xmosaicPath (Class XmosaicPath)
Specifies the used path of xmosaic for checking up and help operations.
helpGeneralPath(Class HelpGeneralPath)
Specifies the path for the general help file.
helpHTMLPath (Class HelpHTMLPath)
Specifies the path for the HTML help file .

WIDGETS

***

In order to specify resources, it is useful to know the hierarchy of the widgets which compose xhtmledit. In the notation below, indentation indicates hierarchical structure. The widget instance name is given first , followed by the widget classname in parantheses .