DECdocument
Using Doctypes and Related Tags
Volume 1
Previous Contents Index

<LMF_ALTNAME>

For Bookreader documentation, the <LMF_ALTNAME> tag specifies an alternate product name for the software product.

Syntax

<LMF_ALTNAME> (alternate name)

ARGUMENTS

alternate name

Specifies an alternate product name. If you need to specify more than one alternate product name, use a separate <LMF_ALTNAME> tag for each alternate product name.

related tags

restrictions

Valid only in the context of the <LMF> tag.

DESCRIPTION

For Bookreader documentation, the <LMF_ALTNAME> tag specifies an alternate product name for the software product. This tag has no effect for printed output.

You may need to supply more than one alternate product name for a product. You can supply multiple <LMF_ALTNAME> tags in any order.

You do not have to use the <LMF_ALTNAME> tag; if you do not use it, however, you receive a warning-level message.

Example

See the example in the discussion of the <LMF> tag.

<LMF_INFO>

For Bookreader documentation, the <LMF_INFO> tag writes licensing information into the .DECW$BOOK file.

Syntax

<LMF_INFO> ( )

ARGUMENTS

book symbol name

Specifies, for a single book, the book symbol name argument that you defined in the <DEFINE_BOOK_NAME> tag, thus matching the argument to the <DEFINE_BOOK_NAME> tag. It must also match the argument to the <LMF> tag.

multibook license identifier

Refers to a single set of LMF tags, which specify the licensing information for an entire documentation set or group of documents. This argument must match the argument to the <LMF> tag.

related tags

restrictions

Must not precede the <LMF> tag.

DESCRIPTION

For Bookreader documentation, the <LMF_INFO> tag writes licensing information into the .DECW$BOOK file. For a single book, the argument to the <LMF_INFO> tag must match the book symbol name argument you defined in the <DEFINE_BOOK_NAME> tag and must also match the argument to the <LMF> tag. Therefore, a set of LMF tags must exist either in a source file or in a symbols file.

For an entire documentation set or group of documents, use the multibook license identifier argument to refer to a single set of LMF tags. The multibook license identifier argument must match the argument to the <LMF> tag. This avoids having to specify the same LMF information for every document in the set.

You must specify the <LMF_INFO> tag after the <LMF> tag, but the <LMF_INFO> tag does not have to fall within the <LMF> and <ENDLMF> tags.

Examples

The following example shows how to use the <LMF_INFO> tag in a source file or in a symbols file for a single document.
#1 

Code in a source file or a symbols file:
 
<DEFINE_BOOK_NAME>(my_book\VMS Overview) 
<LMF>(my_book) 
<LMF_PRODUCER>(DEC) 
<LMF_PRODUCT>(VAX-VMS) 
<LMF_VERSION_NUMBER>(0) 
<LMF_RELEASE_DATE>(0) 
<LMF_ALTNAME>(ANOTHER_NAME) 
<ENDLMF> 
 
 
Code in a source file:
 
 
<PROFILE> 
<LMF_INFO>(my_book) 
<ELEMENT>(front_matter.sdml) 
<ellipsis> 
<ENDPROFILE>

This example shows, for a single document, how to use the <LMF_INFO> tag. Notice that the arguments to the <LMF> and the <LMF_INFO> tags match the symbol name argument to the <DEFINE_BOOK_NAME> tag.

The following example shows how to use the <LMF_INFO> tag in a source file or in a symbols file for a documentation set.

#2 

Code in a symbols file:
 
<DEFINE_BOOK_NAME>(his_book\User's Guide) 
<LMF>(many_books) 
<LMF_PRODUCER>(DEC) 
<LMF_PRODUCT>(FORTRAN) 
<LMF_VERSION_NUMBER>(0) 
<LMF_RELEASE_DATE>(0) 
<LMF_ALTNAME>(ANOTHER_NAME) 
<ENDLMF> 
 
 
Code in a source file:
 
<FRONT_MATTER>(front) 
<TITLE_PAGE> 
<DEFINE_SYMBOL>(product_name\VAX FORTRAN) 
<TITLE>(User's Guide) 
<LMF_INFO>(many_books) 
<ORDER_NUMBER>(AA-12345-BC) 
<ellipsis> 
<ENDTITLE_PAGE> 
<ENDFRONT_MATTER>

This example shows, for an entire documentation set or any group of documents, how to use the <LMF_INFO> tag to access the same set of LMF tags for all the documents.

<LMF_PRODUCER>

For Bookreader documentation, the <LMF_PRODUCER> tag specifies the producer of the software product.

Syntax

<LMF_PRODUCER> (producer)

ARGUMENTS

producer

Specifies the name of the software producer, for example, DEC. The spelling of the product name information you supply must match exactly what exists in the LMF database. The name must not exceed 24 characters.

related tags

restrictions

Valid only in the context of the <LMF> tag.

DESCRIPTION

For Bookreader documentation, the <LMF_PRODUCER> tag specifies the producer of the software product. This tag has no effect for printed output.

Example

See the example in the discussion of the <LMF> tag.

<LMF_PRODUCT>

For Bookreader documentation, the <LMF_PRODUCT> tag specifies the software product.

Syntax

<LMF_PRODUCT> (product name)

ARGUMENTS

product name

Specifies the name of the software product, for example, VAX-VMS. The spelling of the product name information you supply must match exactly what exists in the LMF database. The name must not exceed 24 characters.

related tags

restrictions

Valid only in the context of the <LMF> tag.

DESCRIPTION

For Bookreader documentation, the <LMF_PRODUCT> tag specifies the software product. This tag has no effect for printed output.

Example

See the example in the discussion of the <LMF> tag.

<LMF_RELEASE_DATE>

For Bookreader documentation, the <LMF_RELEASE_DATE> tag specifies the release date of the software product.

Syntax

<LMF_RELEASE_DATE> (dd-mmm-yyyy)

ARGUMENTS

dd-mmm-yyyy

Specifies the day, month, and year of the release of the software product.

related tags

restrictions

Valid only in the context of the <LMF> tag.

DESCRIPTION

For Bookreader documentation, the <LMF_RELEASE_DATE> tag specifies the release date of the software product. This tag has no effect for printed output.

Example

See the example in the discussion of the <LMF> tag.

<LMF_VERSION_NUMBER>

For Bookreader documentation, the <LMF_VERSION_NUMBER> tag specifies the version number of the software product.

Syntax

<LMF_VERSION_NUMBER> (version number)

ARGUMENTS

version number

Specifies the version number of the software product.

related tags

restrictions

Valid only in the context of the <LMF> tag.

DESCRIPTION

For Bookreader documentation, the <LMF_VERSION_NUMBER> tag specifies the version number of the software product. This tag has no effect for printed output.

Example

See the example in the discussion of the <LMF> tag.

<ONLINE_CHUNK>

For Bookreader documentation, the <ONLINE_CHUNK> tag breaks lengthy pieces of text into online chunks to prevent the text formatter from running out of memory.

Syntax

<ONLINE_CHUNK>

ARGUMENTS

None.

restrictions

Invalid in formal tables and formal examples.

related tags

DESCRIPTION

For Bookreader documentation, the <ONLINE_CHUNK> tag breaks lengthy pieces of text into online chunks to prevent the text formatter from running out of memory. Using this tag, then, prevents undesirable breaks of information. Use this tag carefully and sparingly.

When the text formatter breaks long code examples, about an inch of white space is sometimes left in the Bookreader output. Inserting an <ONLINE_CHUNK> tag before this space removes the extra white space.

This tag has no effect for printed output.

examples

The following example shows how to use the <ONLINE_CHUNK> tag.
#1 

<code_example> 
SQL> ! 
SQL> ! You can see from the following display that the CURRENT_INFO 
SQL> ! view contains an employee with a last name Toliver and an ID 
SQL> ! number 00164. 
SQL> ! 
SQL> SELECT LAST_NAME, FIRST_NAME, ID FROM CURRENT_INFO ORDER BY ID; 
 LAST_NAME        FIRST_NAME   ID      
 Toliver          Alvin        00164   
 Smith            Terry        00165   
 Dietrich         Rick         00166   
 Kilpatrick       Janet        00167   
 Nash             Norman       00168   
<ellipsis> 
<valid_break> 
SQL> ! 
SQL> SELECT LAST_NAME, FIRST_NAME, EMPLOYEE_ID 
cont> FROM CURRENT_JOB 
cont> WHERE JOB_START > "AUG-26-1981"; 
%SQL-F-DATCONERR, Data conversion error 
-LIB-F-AMBDATTIM, ambiguous date-time   
<tag>(online_chunk) 
SQL> ! 
SQL> ! Now (finally) the correct way to compare a literal to a 
SQL> ! value in a column defined as DATE. 
SQL> ! 
SQL> SELECT LAST_NAME, FIRST_NAME, EMPLOYEE_ID 
cont> FROM CURRENT_JOB 
<ellipsis> 
<tag>(endcode_example)

This example shows how to use the <ONLINE_CHUNK> tag in a long code example.

<ONLINE_POPUP>

Specifies that an informal text element appear (that is, pop up) in a separate window (as do formal examples, formal figures, and formal tables).

Syntax

<ONLINE_POPUP> (text type)

ARGUMENTS

text type

Specifies a short description of the type of text you want to pop up.

restrictions

A <HEADN> tag is invalid in the context of an <ONLINE_POPUP> tag. Begin a pop-up after a <HEADN> tag and end it before the next <HEADN> tag. This includes template headings, such as Description and Examples.

Do not nest <ONLINE_POPUP> tags.

Do not use with formal examples, figures, or tables.

required terminator

<ENDONLINE_POPUP>

related tags

DESCRIPTION

The <ONLINE_POPUP> tag specifies that an informal text element appear (that is, pop up) in a separate window (as do formal examples, formal figures, and formal tables). Use this tag to display the text elements more clearly and to help keep the online topics that contain the pop-ups from becoming unmanageably long for Bookreader navigation. This tag has no effect for printed output.

Note
The text formatter may run out of memory when processing long topics that contain many long, informal tables. Use the <ONLINE_POPUP> tag to pop up the tables in separate windows.

You can use the <ONLINE_POPUP> tag with any segment of text: paragraphs, lists, or notes. However, use the tag sparingly; too many pop-up windows can hinder the usability of your document. Pop-up windows are most useful for displaying graphics or text segments that are somewhat peripheral to the flow of text in the manual. Experiment to determine if a pop-up window is a useful and effective means of presenting peripheral information. Too many pop-up windows create clutter on the screen and confusion for the user.

A pop-up window must have an associated text window hotspot at which the user can point and click. The <ONLINE_POPUP> tag automatically creates a hotspot and uses the argument you supply. For example, if you supply the argument table, the hotspot is the following:

TABLE: Click here to display table.

Do not use the <ONLINE_POPUP> tag with formal examples, figures, or tables. Hotspots for formal elements are created when you use the <REFERENCE> tag to refer to them.

Examples

The following example shows how to use the <ONLINE_POPUP> tag for an informal table.
#1 

<ONLINE_POPUP>(table) 
<TABLE>
   .
   .
   .
<ENDTABLE>
<ENDONLINE_POPUP>

This example shows how to use the <ONLINE_POPUP> and <ENDONLINE_POPUP> tags so that an informal table pops up in a separate window.

The following example shows how to use the <ONLINE_POPUP> tag within an example sequence.

#2 

<EXAMPLE_SEQUENCE>
<ONLINE_POPUP>(Example) 
<EXC>
   .
   .
   .
<EXTEXT>
   .
   .
   .
<ENDONLINE_POPUP>
<ENDEXAMPLE_SEQUENCE>

This example shows how to use the <ONLINE_POPUP> and <ENDONLINE_POPUP> tags within an example sequence. You can find the <EXAMPLE_SEQUENCE>, <EXC>, and <EXTEXT> tags in Using Doctypes and Related Tags.

<ONLINE_TITLE>

Specifies text that overrides the default section title in the topic label above the text in the text window.

Syntax

<ONLINE_TITLE> (text)

ARGUMENTS

text

Specifies the text that you want to appear in the title region. The text should be no longer than 40 characters, because the region where the title appears is narrow. If part of the title is hidden, you must resize the window.

restrictions

Do not use tags in the text argument.

related tags

DESCRIPTION

The <ONLINE_TITLE> tag specifies text that overrides the default section title in the topic label above the text in the text window. This tag overrides only the current title; the next topic title is displayed as usual, unless you override it with another <ONLINE_TITLE> tag. This tag has no effect for printed output.

Use the <ONLINE_TITLE> tag on the title page, just before the <TITLE> tag (or for the MILSPEC.ONLINE doctype, just before the <SPEC_TITLE> tag) to specify an abbreviated title that will appear in three places: the title bar, the topic bar, and the Bookreader library. This tag is especially useful for documents that you create with the MILSPEC.ONLINE doctype, because these documents often have very long titles.

Examples

The following example shows how to use the <ONLINE_TITLE> tag.
#1 

<ONLINE_TITLE>(Routine$Name) 
<ROUTINE>(ANY$ROUTINE$NAME) 
   .
   .
   .

This example specifies that the title be displayed as "Routine$Name", rather than the full title, "ANY$ROUTINE$NAME".

The following example shows how to use the <ONLINE_TITLE> tag to produce a Bookreader title that is significantly shorter than the printed title.

#2 

<FRONT_MATTER>(front)
<TITLE_PAGE>
<ONLINE_TITLE>(Short Title)
<TITLE>(A Very Long Title That You Might Want To Abbreviate)
<ENDTITLE_PAGE>
<ENDFRONT_MATTER>

This example shows how to use the <ONLINE_TITLE> tag on the title page of a document.

<SET_HELP_LEVEL>

Allows you to alter the default Help levels in your Help files.

Syntax

<SET_HELP_LEVEL> [(number)]

ARGUMENTS

number

This is an optional argument. It specifies a positive or negative number that is added to or subtracted from the default value to determine a new Help level. Note that this number is not the Help level number, but a value to be applied to the default Help level.

To reset the default Help levels, specify zero (0) as the number argument or do not use an argument. For example, both the <SET_HELP_LEVEL> and <SET_HELP_LEVEL>(0) tags reset the default Help levels.

related tags

DESCRIPTION

The <SET_HELP_LEVEL> tag allows you to alter the default Help levels in your Help files. Remember that each word in the command is a different Help level, by default. This tag changes all the default Help levels until you explicitly reset them using the tag again without an argument, or with the zero (0) argument.

For example, by default <HEAD1>, <STATEMENT>, and <COMMAND> tags produce level-1 Help topics. You may want, however, your level-1 "Command" topic to be a level-2 topic, and the "Format", "Qualifier", and "Description" sections, which are normally level-2 topics, to be level-3 topics. In this case, use the <SET_HELP_LEVEL>(1) tag before the Help level you want to alter. Using the argument 1 adds one level to the default level-1, thus adding one level to each subsequent Help level.

If you use a negative number argument, one level is subtracted from the default Help level. For example, if you want your level-2 "Description" section to be a level-1, use the <SET_HELP_LEVEL>(-1) tag before the <DESCRIPTION> tag. If you want your level-3 "Example" section to be a level-1, use the <SET_HELP_LEVEL>(-2) tag before the <EXAMPLE> tag.

When you want to reset the default Help levels, use the <SET_HELP_LEVEL> tag with or without the zero (0) argument.

Example

The following example shows how to use the <SET_HELP_LEVEL> tag. 

<COMMAND_SECTION>
<COMMAND>(SET TERMINAL)
   .
   .
   .
<SET_HELP_LEVEL>(1)
<COMMAND>(SET QUEUE)
   .
   .
   .
<SET_HELP_LEVEL>(0)
<COMMAND>(SET PASSWORD)
   .
   .
   .
<ENDCOMMAND_SECTION>

This example shows how to use the <SET_HELP_LEVEL> tag to alter the default Help levels. One Help level is added to the commands following the <SET_HELP_LEVEL> tag. You reset the default Help levels with another <SET_HELP_LEVEL> tag, with the zero (0) argument or without an argument. This example produces the following levels in the .HLP file: 


1 SET 
2 TERMINAL 
2 SET 
3 QUEUE 
2 PASSWORD

Previous Next Contents Index