Writer instructions

Purpose

Use this page to display a banner announcement on each page of the space. Create the Space announcements page in the master space, outside of the Home branch.

You can version the Space announcements page to enable different banners to be published into different target spaces, however, the banner that is displayed in the versioned (master) space itself only displays the most recently-published banner.  If you find errors in the banner area of your versioned space and you are sure the Space announcements page is set up correctly, try publishing the page to the same space.

For more information, see Space-announcements-banners.

Removing

When an announcement is no longer needed, remove the BMC Space Banner macro.

Translation

Localized spaces using the L10n Viewport theme must change the name of this page to Space announcements l10n.  See Configuring-the-Scroll-ViewPort-theme-for-translated-spaces.

Usage

Choose one or none of the following BMC Space Banner macros.

If your space requires another kind of announcement, you can use this page in coordination with your team lead and editors.

When should I use a space announcement banner?

Use the space organization announcement after you change the content from a book-like organization (such as User Manual, Configuration Manual, and Administration Guide) to the product model.

Use the latest version announcement to push traffic to later versions. You do not need to add this to every previous version, but if you have a specific reason that you want users to be aware—for example, Google searches show content for an obsolete version—use the banner to help users find a relevant version.

When an announcement is no longer needed, remove the BMC Space Banner macro.

Space announcement This documentation space provides the same content as before, but the organization of the content has changed. The content is now organized based on logical branches instead of legacy book titles. We hope that the new structure will help you quickly find the content that you need.

Specifying the scope of row commands

Many row commands can affect more than one row when you use any of these methods:

  • Repetition factor
  • Ranges:
    • Block range
    • Numeric range
    • Label range
    • Total range
  • Targets.

Each of these is discussed in this section with examples.

Assigning a label

By assigning a label to a row, you can use it as a target or a range specifier for row commands. A label is assigned by typing a period (.) followed by any alphabetic character. To remove a label, enter spaces over the label.

Example

The following example shows how to assign the label Y to row 2:

000001  example row 1
.Y 002  example row 2
000003  example row 3
000004  example row 4

To use a label as a range or a target specifier, see the examples under Ranges and Targets. To use a label with the LABELS primary command, see Scrolling Window Contents.

Repetition factor

Some row commands, such as R (repeat) allow the use of a repetition factor which indicates the number of times the command should be executed. Type the row command followed by an unsigned number representing the number of command executions desired. The repetition factor (number) may immediately follow the row command or be separated from it by one or more blanks.

Example

The following example uses the R (repeat) command to duplicate row 2 two times:

000001  example row 1
R2 002  example row 2
000003  example row 3
000004  example row 4

The following shows the result of the above example:

000001  example row 1
000002  example row 2
000003  example row 2
000004  example row 2
000005  example row 3
000006  example row 4

Ranges

Ranges let you specify which rows or how many rows are to be affected by the command. Types of ranges include label, block, numeric, and total symbols.

Label Range

A label must first be assigned to either the start or the end of the range; see Assigning a Label. Then, type the row command followed by a period (.) and the label. When you press Enter, the command affects all rows between the label and the command, including the label row.

Example

The following example deletes a label range.

000001  example row 1
.Y 002  example row 2
000003  example row 3
000004  example row 4
D.Y 05  example row 5
000006  example row 6

The following shows the result of the above example:

000001  example row 1
000002  example row 6

Block Range

You can apply many row commands to a range of rows by repeating the command and entering it on the first and last rows of a block of rows. The block format of most row commands is entered by duplicating the last letter of the command.

Example

The following example uses the D (delete) row command to delete a block of rows:

000001  example row 1
DD 002  example row 2
000003  example row 3
000004  example row 4
DD 005  example row 5
000006  example row 6

The following shows the result of the example:

000001  example row 1
000002  example row 6

Numeric Range

A numeric range applies a row command to a number of rows preceding or succeeding the current row. It indicates the number of times and the direction (preceding or succeeding) a command should be executed.

To apply a row command to preceding rows, follow the command with a minus symbol (-), the number of times to execute the command, and a blank space. For succeeding rows, follow the command with a plus symbol (+), the number of times to execute the command, and a blank space.

Example

The following example deletes two rows:

000001  example row 1
000002  example row 2
000003  example row 3
000004  example row 4
D-2 05  example row 5
000006  example row 6

The following shows the result of the above row command:

000001  example row 1
000002  example row 2
000003  example row 3
000004  example row 6

Total Symbols

A total symbol is a quick method of applying changes to all rows either preceding or succeeding the current row. A minus symbol (-) applies a row command to the row on which the command is typed and all preceding rows. A plus symbol (+) applies a row command to the row on which it’s typed and all succeeding rows.

Example

The following example deletes row 4 and all rows preceding it:

000001  example row 1
000002  example row 2
000003  example row 3
D- 004  example row 4
000005  example row 5
000006  example row 6

The following shows the result of the above row command:

000001  example row 5
000002  example row 6

Targets

Some row commands capture rows to insert before or after a target. The following row commands can be used with a target:

  • M (move) row command
  • C (copy) row command.

A target can be one of the following:

  • Label; see Assigning a Label for instructions on assigning a label to a row.
  • A (after) row command
  • B (before) row command
  • O (overlay) row command.

Between Windows

Use a label target to copy or move data from one window to another. To insert after a label, follow the row command with a forward slash (/) and the label. To copy before a label, follow the row command with a backward slash (\) and the label.

Within Windows

When the destination is within the same window, type A (after), B (before), or O (overlay) in the same window in which the row command is typed and press Enter. When using target row labels, type the row command followed by a forward slash (/) and the target row label to place the data after the labeled row or followed by a backward slash (\) and the target row label to place the data before the labeled row.

Example

To place a copy of row 2 after row 5, type the row command C (copy) on row 2 and the target command A (after) on row 5:

000001  example row 1
C 0002  example row 2
000003  example row 3
000004  example row 4
A 0005  example row 5
000006  example row 6

The next example shows how to use a label to accomplish the same copy function using a label of "Z" as the target:

000001  example row 1
C/Z 02  example row 2
000003  example row 3
000004  example row 4
.Z 05   example row 5
000006  example row 6

The following shows the result of either of the above row commands:

000001  example row 1
000002  example row 2
000003  example row 3
000004  example row 4
000005  example row 5
000006  example row 2
000007  example row 6

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*