# scheme-editor(3)

[Home] [Commands] [Variables] [Macro-Dev] [Glossary]

## NAME

scheme-editor - Color Scheme Editor

## SYNOPSIS

scheme-editor

## DESCRIPTION

scheme-editor is a color and font scheme editor that provides a dialog interface to configure the display schemes used by the editor. The schemes may be created or modified within the scheme editor and then committed to the configuration files for general use.

The editor can be used to create both screen and printer color/font schemes, they are typically stored in the `macros` directory and are executed as macro files at start up or when printing. The standard screen schemes are called `scheme` X`.emf` and printer ones `print` X`.emf`.

The scheme-editor is displayed within a single dialog box, tab selections at the top of the dialog box enable color and scheme creation and/or modification. Navigation is typically performed using the mouse, where the mouse is absent then the `TAB` key may be used to move between the fields. The information presented is defined as follows:-

File Name

The name of the color scheme to be modified. This is the name of the scheme X.emf file, omitting the file extension. See the FILES section below for a list of standard screen and printer scheme supplied with MicroEmacs 2009.

Type

Defines whether the scheme is a screen or printer type.

Description

An ASCII description of the color scheme, used to identify the color scheme.

Buffer Hilight

Available when scheme is a screen type. Defines whether buffer hilighting should be enabled, when Completely Disable all buffers are displayed character for character in the standard text scheme, this will ensure maximum update performance but some file formats such as the on-line help will become unreadable so this option is really selected. Similarly Reformat Only disables the majority of buffers, hilighting is only enabled when the file would be unreadable without it, such as the on-line help or man page files. The default Fully Enabled setting enables all buffer hilighting.

Print Option

Available when scheme is a printer type. Defines what components of a scheme is to be used when printing.

## Colors

The colors tab allows the basic palette colors of the editor to be created and modified. The left-hand side of the dialog contains a scrolling window containing the existing color entries. The right-hand side of the dialog provides the controls to add and change the color assignment. The controls operate on the currently selected palette entry.

Cursor

Defines the colour of the text cursor.

Show in Dialogs

Defines whether the cursor should be displayed in the main OSD dialogs, this improves usability of the dialogs when limited colors are available. Indirectly sets bit `0x20` of $system(5).

Red/Green/Blue

The color entries allow the currently selected palette color entry to be modified. The color values may be changed by direct numeric entry (0..255) or via the ^/v controls; the color is committed to the palette using the Add or Change button.

Change

Commits changes to the currently selected color in the palette.

Add

Creates and adds a new color entry into the palette. The new palette entry is created with a default color that may be subsequently modified.

## Schemes

The schemes tab allows the schemes to be edited. The left-hand side of the dialog contains a scrolling window of the available color palette (created from the Colors tab). The right-hand side of the window shows the variants of the scheme.

Selection

The selection item provides a pull-down menu containing gross scheme categories used by the editor.

Scheme

A pull-down menu containing the schemes of the selection, modifying this entry shows the variants of the scheme in the Normal, Current, Select and Sel-Cur dialogs.

Reset

Resets the current scheme back to the default Standard Text scheme.

There are 4 variants, or styles, for a single scheme; each style is comprised of a foreground and background color, and a row of toggle button to enable/disable fonts, defined as follows.

`B` - Bold.
`I` - Italic.
`L` - Light (typically not supported).
`R` - Reverse video (fore/back-ground swapped).
`U` - Underline.
`V` - Toggle reverse video when inverted.

The last mode V needs a little more explanation; commands such as screen-poke(2) are able to invert the color scheme, i.e. use the fore color for the background etc. Enabling this mode will toggle the reverse video mode (R) when this feature is used.

The style displayed by a particular scheme depends upon the selection/current status of the text:

Normal

The normal style, when the text object is not selected or current (i.e. out of focus).

Current

The style used when the text object is current (i.e. in focus)

Select

The style used when the text object is selected (i.e. by the mouse) and is not current.

Sel-Cur

The style used when the text object is selected and is current.

Note that a printer scheme only uses the Normal style.

Setting of the selection and scheme shows the current scheme in the Normal, Current, Select and Sel-Cur dialogs. New colors are assigned by selecting a color in the palette area and making it current. The current color is applied by selecting the Fore / Back boxes of the scheme dialog. The assigned color is displayed in the text box The big brown fox....

## Controls

The controls at the bottom of the dialog apply the edits to the configuration files.

Current

Makes the changes to the palette and schemes current, they are applied to the current editing session but are not committed to file. This allows the palette changes to be used prior to commitment. Note that all modifications are lost if they are not saved and the editing session is terminated.

Save

Saves the scheme modifications to file, effectively making the changes permanent. Note however that the scheme macro file will be saved in the first directory in the $search-path(5), regardless of the location of the original. For network systems this typically means that the changes will only effect the current user.

Install

Installs the current color scheme into the configuration files, making the color scheme accessible to the user-setup(3) dialog.

Exit

Quits the scheme editor without modifying the settings.

## FILES

`scheme.emf` - Defines the standard scheme variables, including the available scheme list, and associated text.
`schemed.emf` - Default white on black color scheme.
`schemej.emf` - Black on cream color scheme.
`schemevi` - Sandy shores.
`schemesf` - Sherwood Forest.
`schemebh` - Blue Hue.
`schemepd` - Plain Black on Cream.
`schemepl` - Plain White on Black.
`schemel` - Black on grey.
`schememd` - Microsoft Developer Studio Colors.
`printers.emf` - Defines the list of available printer schemes and drivers.
`printd` - Default plain print-out.
`printf` - Print using fonts.
`printepc` - Print using Epson base colors and fonts.

## NOTES

scheme-editor is a macro that is implemented in file `schemosd.emf`. The scheme editor uses osd(2) to create and manage the dialogs.

Only the Normal scheme style is used by printer schemes.

The setting of Buffer Hilight can effect the way buffer hooks are load so changing from one scheme to another with differing Buffer Hilight settings may not fully work. This can be rectified by restart MicroEmacs with the new scheme as default.

The current screen scheme can effect the printing due to the Buffer Hilight setting, e.g. if the screen scheme is set to completely disable hilighting then any print-out will also have no hilighting.

## SEE ALSO

user-setup(3), add-color-scheme(2), print-scheme(2), osd(2).

(c) Copyright JASSPA 2009
Last Modified: 2009/08/29
Generated On: 2009/10/12

</HMTL>