number-items(3)

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

NAME

number-items - Renumber a vertical list of items

SYNOPSIS

n number-items start-number char-width num-lines

DESCRIPTION

number-items provides a short cut method of re-numbering a list of vertically aligned numbered items. The command assumes a fixed width number per line. The command operates from the current cursor position in a downward direction. The parameters are defined as follows:

start-number

The value of the first item to renumber.

char-width

The width of the number space i.e. 1-10 is a width of 2, 89-101 is a width of 3.

num-lines

The number of lines to re-number, including the current line.

If a numeric argument of 0 is given the inserted numbers are all prefixed with 0's to ensure each is at least char-width characters long.

EXAMPLE

The following code fragment shows how a list is renumbered.

MY_COMMAND (myCMD_UP,   # 9, "Move Up") 
MY_COMMAND (myCMD_DOWN,  10, "Move down") 
MY_COMMAND (myCMD_LEFT,  15, "Move down") 
MY_COMMAND (myCMD_RIGHT, 10, "Move down")

To to use the command to renumber the list from 100 to 103 then the cursor is placed at the left hand side where the number should start. In the example this is #, then issue the command esc x number-items 100 3 4. This renumbers the list resulting in the following:

MY_COMMAND (myCMD_UP,   100, "Move Up") 
MY_COMMAND (myCMD_DOWN, 101, "Move down") 
MY_COMMAND (myCMD_LEFT, 102, "Move down") 
MY_COMMAND (myCMD_RIGHT,103, "Move down")

NOTES