Task Documentation Architecture


This document describes the ways in which we create and maintain the tasks document also known as the Tasks Cookbook. The Cookbook is be accessed from the Config Tool and Monitor Tool through the Docs button. The Cookbook is created with FrameMaker and then converted to HTML with WebWorks Publisher.

Document Organization

The document itself consists of a table of contents; a series of sections, each dealing with a single subject (multicast tunnels, IPX, etc.); and an index. Each section can contain as many tasks related to the given subject as are necessary. The organization is as follows:

Grouping the tasks by subject allows us to complete a section at a time and add it to the Cookbook as we complete it. This enables us to produce a document (such as a beta release) even though we may not have the entire Cookbook completed or the indexing done.

Each section can contain the following:



The FrameMaker document for a section starts with a line tagged ChapTitle. This tells the user the subject of the section, for example, Multicast Tunnel.

Body, Body2, Body3
Used for a normal paragraph. Body2 and Body3 are at increasing levels of indentation.

Body

Bulleted, Bulleted2, Bulleted_Cont, Bulleted2_Cont
Bulleted paragraphs. Bulleted2 is a sub-bullet under Bulleted. The _Cont tags are for the 2nd and subsequent paragraphs under the Bulleted or Bulleted2 paragraphs.
These paragraphs are all for unordered lists and produce <UL> and </UL> tags in HTML.
Caution, Warning, Note, Tip

Caution: This is a caution. It points out ways to avoid damaging your hardware or data.



Warning: This is a warning. It states potential dangers to your personal safety if the procedure is not followed.



[Note]Note: This is a note. It provides information that is related to the text



[Note]Tip: It points out ways you can improve the efficiency of your network procedures.


CellBody, CellBullet, CellHeading
Used in Tables

CellHeading

CellBody

ChapTitle
Used to tag the title of the section.
Code, Code2, Code3, CodeWide
Code, Code2 and Code3 are used to tag code samples at successive levels of indentation. Codewide is for full page width code samples.

CodeWide

Glossary Term
The word you are going to define. Also used for the "See also" heading.
Glossary Text
The definition of the word in Glossary Term. Also used for the "See also" link text.
Lettered_One, Lettered
A lettered sub-entry under the Task_Step list item tag. Lettered_One is the first item in the list.
  1. Lettered_One
  2. Lettered
Task_Step_One, Task_Step, Task_Body
Task_Step_One is the tag for the first item in a numbered ordered list. Task_Step is the tag for subsequent numbered paragraphs. Task_Body is for subsequent paragraphs of a Task_Step paragraph. These are the tags used in the task steps.

    1. Task_Step_One

    2. Task_Step

Task_Top, Task_Graphic
These are the tags used in the actual task header. The task header is a table with two cells:


This is a Task Header

Task_Graphic is the tag used in the left cell that contains the graphic. Task_Top is the tag of the right cell that contains the task name.
Task_Body
This tag is used for paragraphs under a step in the task.
Task_End
This is the paragraph tag that ends a task. It has the same format as the Task_Body tag except that is has a double line below it. Do not use the Task_End tag if one task immediately follows another. Simply begin the next task with the Task Header. Use the Task_End tag if more text not in the task follows a task.


TableTitle
Tag for the caption of a table.


Computer
The text supplied by the computer in the CLI.
ComputerUser
The text entered by the user in the CLI.
Emphasis
Italics. Use the Character tag emphasis rather than simply turning italics on.
Key
The name of a key such as Docs.
Link
The name of a link.
Link Text
The actual hypertext link.
MenuItem
The name of a menu item or field.
Strong
Bold. Use the Character tag Strong rather than simply turning bold on.


Use WebWorks Publisher with the Tasks.wdt file set to create the Cookbook documents.

[PreviousBtn] [NextBtn]


Copyright © 1997 Ipsilon Networks, Inc.
Updated March 31, 1997
This document can be found at http://<switchname>/conf/Task_Desc.fm.html
Send comments to Ipsilon Technical Publications docs@ipsilon.com