To say that the Internet has changed in the past 10 years is a
vast understatement. The Internet today is the single most
influential phenomenon in computing. The way in which it continues
to evolve is likely to affect every form of data communication on a
global scale. Internet information-handling strategies, such as
Web-based customer support and secure networked commerce, will
permanently alter business and consumer behavior.
As the Internet and networking have evolved, so too has Cisco
Systems' role. Cisco has become the premier worldwide provider of
networking for the Internet. In this role, Cisco helps network
managers build reliable, scalable, and cost-effective solutions for
networks that span the requirements of small offices to
globally-dispersed enterprises. Over the years, Cisco has assembled
the largest and most experienced staff of networking experts who
serve customers in planning, implementing, and troubleshooting large
networks. Bassam Halabi is one of those experts.
Although Cisco's expertise is primarily delivered directly to
customers, it also can be shared through other means. A new and
important medium for sharing Cisco's networking expertise is the
Cisco Press. In creating this new forum, New Riders Publishing and
Cisco Systems jointly plan to build a library of publications that
provide practical information about the design and implementation of
routers, switches, servers, and connectivity software.
Bassam Halabi's Internet Routing Architectures is the first of
these books. Bassam provides his keen insight into interdomain
routing, Internet service provider requirements, and the changing
Internet infrastructure. He touches on issues that affect everyone
connecting networks to or through the Internet. Bassam's many years
of consulting experience with Cisco's largest IP-based networks
contribute to this book's useful design recommendations. He brings a
pragmatic perspective to the process of building links between
domains and selecting network designs for specific situations.
Internet Routing Architectures is a readable distillation of
essential design and implementation guidelines. We trust you will
find it a valuable addition to your networking library.
Edward R. Kozel
Chief Technology Officer
Cisco Systems,
Inc.
Trademark Acknowledgments
All terms mentioned in this book that are known to be trademarks
or service marks have been appropriately capitalized. New Riders
Publishing cannot attest to the accuracy of this information. Use of
a term in this book should not be regarded as affecting the validity
of any trademark or service mark.
Knowledge Products File-Naming
Conventions
- Originated By: Genie Mak, Knowledge Products
- Approved By: Dave Horner, Project Manager
- December 18, 1996
This document contains file-naming guidelines everyone in
Knowledge Products needs to follow. As we create and distribute
documents on different operating systems (for example, Macintosh,
PC, and UNIX), naming conventions that conform to all the platforms
are essential.
The following sections are described in this document:
- • See General File-Naming Guidelines
- • See Filename Extensions
- • See Changes in FrameMaker Book and
Generated File Creation
- • See Examples
General File-Naming Guidelines
The new file-naming conventions conform to the DOS 8.3
file-naming convention (8_character_filename.3_letter_extension).
Beginning immediately, any new files created by Knowledge
Products members must conform to the 8.3 file-naming convention.
Note: Effectively immediately, any new files
with nonconforming names added to CMS will need to get reworked by
the author to conform to the specified conventions.
Keep the following in mind when creating new files:
- • When creating new classes, make sure that
your class hierarchy contains information about the product,
release number, and book (for example, the CMS path
CMS:Files:Doc:Software:103:EM provides you with the
software release version and type of book).
- • Only use eight characters in your
filename; these eight characters can consist of lowercase letters
or numbers. Do not use capital letters anywhere in the filename,
even in the extension. More information about extensions is
provided in the "Filename Extensions" section later in this
document.
Note: Remember not to use chapter numbers or
appendix letters as part of your filename.
- • Do not use any special characters such as
hyphens, underscores, slashes, or periods in the first eight
characters of the filename. The only place where a period is
allowed is between the filename and the extension.
- • The first eight characters should be
descriptive about the content of the file. In general, do not use
version or release numbers or book titles in your filenames so
that you can maximize filename descriptiveness. Examples of some
common manuals' filenames are included in the "Examples" section
on on page page 7.
Note: If necessary, some documents might need
a letter in the filename to differentiate between book types. In
addition, documents such as configuration notes and release
notes might require part numbers or software release numbers in
their filenames if the current class structure does not contain
this information. Individual groups need to define these
particular standards.
- • When working with and transferring files,
remember to create working directories on your Macintosh or PC and
on delphi. The CMS class structure will now provide the
product, release number, and book type information. Because
filenames no longer contain book name or release and version
numbers, you could have files on your desktop or delphi
that have the same name.
Filename Extensions
Filename extensions are being used companywide so that you can
identify different file types at first glance and process files
through filters that identify files by the filename extension. The
filename extension cannot be longer than three characters and should
be lowercase.
Table 1 outlines the filename extensions for commonly used
authoring tools in Knowledge Products.
Table 1 Filename Extensions for
Commonly Used Authoring Tools
| Authoring Tool
| File Type
| Filename Extension
|
| FrameMaker
| FrameMaker document file
| filename.fm
|
|
| Book file
| filename.fmb
|
|
| Table of contents (generated file)
| filename.fmc
|
|
| List of figures (generated file)
| filename.fmf
|
|
| List of tables (generated file)
| filename.fmt
|
|
| Index (generated file)
| filename.fmx
|
|
| Maker Interchange Format (MIF)
| filename.mif
|
| Any text editor
| UniverCD list file (ASCII text)
| filename.lst
|
| Adobe Illustrator
| EPSI
| filename.ps
|
| Microsoft Word
| Word document file
| filename.msw1
|
|
| Rich Text Format
| filename.rtf
|
| RoboHelp
| Help project file
| filename.hpj
|
| Any text editor
| Online help file (ASCII text)
| filename.hh
|
| Microsoft Excel
| Excel file
| filename.xls
|
| Microsoft PowerPoint
| PowerPoint file
| filename.ppt
|
| Aldus Persuasion
| Persuasion file
| filename.per
|
| Aldus Persuasion Player
| View-only GIF file
| filename.ply |
1Online help
developers using RoboHelp should continue to use the default
extension RoboHelp assigns to the Word for Windows file.
Table 2 lists some other commonly used filename extensions.
Table 2 Other Common Filename
Extensions
| Authoring Tool
| File Type
| Filename Extension
|
|
| HTML
| filename.htm
|
|
| GIF
| filename.gif
|
|
| JPEG
| filename.jpg
|
|
| ASCII text
| filename.txt
|
| Adobe Acrobat
| Portable Document Format (PDF) file
| filename.pdf
|
| FYProject
|
| filename.fyp |
Note: If you have created a document whose file
type is not listed in this document, refer to the Cisco Systems
Electronic Document Formats document, which can be accessed
via the World Wide Web. Use the URL http://www-corp-int.cisco.com/corporate/sit-isaac/std-doc-formats.txt
If you cannot find the file type in the Cisco Systems
Electronic Document Formats document, see your manager.
Changes in FrameMaker Book and Generated File
Creation
Because of FrameMaker's method of naming generated files, you
need to perform the following procedures to make sure that your
extensions for your book file and generated files are correct. These
procedures are similar to what you currently do to create books and
generated files, but there are minor variations you need to look out
for.
To ensure that your book file and generated files are properly
named, complete the following procedures in the specified order:
- • Creating a Book File
- • Adding Generated Files to a Book
- • Generating the Table of Contents, List of
Figures, List of Tables, and Index
- • Naming the Book File for the Final Time
Note: Do not create a book file or any generated
files using any UNIX version of FrameMaker. Book files and
generated files created with UNIX FrameMaker do not conform to the
new file-naming guidelines. Any book or generated files created
with UNIX FrameMaker will have to be recreated on the Macintosh or
PC. You can still use any UNIX version of FrameMaker to work with
files created on a Macintosh or PC.
Creating a Book File
The name of a generated file is based on the name of its book
file. This is why you need to initially rename your book after you
create it.
Do the following to create a book file:
- Step 1 Open any file that will be in the book file.
- Step 2 Select Generate/Book from the File menu.
- Step 3 Select New Multifile Book.
- Step 4 Click on Generate.
FrameMaker creates
a book file.
- Step 5 Select Save As from the File menu.
- Step 6 Give the book file a new name; the new name
should have eight characters or less. For example, you might call
the Router Products Configuration Guide's book file rpcg;
you might name the Cisco 7010 Hardware and Installation
Maintenance's book file 7010him.
Note: For now, make sure that your new filename
does not include a period or extension; you will add an
extension later in this process.
Adding Generated Files to a
Book
The table of contents, list of figures, list of tables, and index
are generated files. Generated files are created by FrameMaker using
paragraph tags and markers. For more information about generated
files, see your FrameMaker documentation.
Adding a Table of Contents
Before adding the table of contents, generate the book first so
that all the paragraph tags will be included.
To add a table of contents to your book, do the following:
- Step 1 Open the book file.
- Step 2 Select Add File from the File menu.
- Step 3 Click on the Generated List option.
- Step 4 Select Table of Contents from the
Generated List pop-up menu.
- Step 5 Use the Add File After pop-up menu to determine
where you want the new file placed in relation to the files
already added.
- Step 6 Click Add.
The Setup Table of
Contents window appears.
- Step 7 Macintosh users: Enter .fmc in the
Filename Suffix field. Do not accept the default suffix filename.
PC users: Enter fmc in the Filename Suffix
field; do not enter a period before the suffix. FrameMaker
will automatically add a period before the suffix. Do not accept
the default suffix filename.
- Step 8 Set up the table of contents as you normally
would. Refer to the Template Handbook if you need more
information.
Adding a List of Figures
To add a list of figures to your book, do the following:
- Step 1 Open the book file.
- Step 2 Select Add File from the File menu.
- Step 3 Click on the Generated List option.
- Step 4 Select List of Figures from the Generated
List pop-up menu.
- Step 5 Use the Add File After pop-up menu to determine
where you want the new file placed in relation to the files
already added.
- Step 6 Click Add.
The Setup List of Figures
window appears.
- Step 7 Macintosh users: Enter .fmf in the
Filename Suffix field. Do not accept the default suffix filename.
PC users: Enter fmf in the Filename Suffix
field; do not enter a period before the suffix. FrameMaker
will automatically add a period before the suffix. Do not accept
the default suffix filename.
- Step 8 Set up the list of figures as you normally
would. Refer to the Template Handbook if you need more
information.
Adding a List of Tables
To add a list of tables to your book, do the following:
- Step 1 Open the book file.
- Step 2 Select Add File from the File menu.
- Step 3 Click on the Generated List option.
- Step 4 Select List of Tables from the Generated
List pop-up menu.
- Step 5 Use the Add File After pop-up menu to determine
where you want the new file placed in relation to the files
already added.
- Step 6 Click Add.
The Setup List of Tables
window appears.
- Step 7 Macintosh users: Enter .fmt in the
Filename Suffix field. Do not accept the default suffix filename.
PC users: Enter fmt in the Filename Suffix field; do
not enter a period before the suffix. FrameMaker will
automatically add a period before the suffix. Do not accept the
default suffix filename.
- Step 8 Set up the list of tables as you normally would.
Refer to the Template Handbook if you need more
information.
Adding an Index
To add an index to your book, do the following:
- Step 1 Open the book file.
- Step 2 Select Add File from the File menu.
- Step 3 Click on the Generated Index option.
- Step 4 Use the Add File After pop-up menu to determine
where you want the new file placed in relation to the files
already added.
- Step 5 Click Add.
The Setup Index window
appears.
- Step 6 Macintosh users: Enter .fmx in the
Filename Suffix field. Do not accept the default suffix filename.
PC users: Enter fmx in the Filename Suffix
field; do not enter a period before the suffix. FrameMaker
will automatically add a period before the suffix. Do not accept
the default suffix filename.
- Step 7 Set up the index as you normally would. Refer to
the Template Handbook if you need more information.
Generating the Table of Contents, List of
Figures, List of Tables, and Index
After adding the table of contents, list of figures, list of
tables, and index to your book file, generate and format them as you
normally would.
Naming the Book File for the Final
Time
When you created your book file and named it, the name did not
include a suffix because FrameMaker uses the book file's name as the
base for its generated file names. After you have generated and
formatted your generated files, you must rename your book file to
conform to the file-naming conventions.
To rename your book file, do the following:
- Step 1 Save and close your book file.
- Step 2 Macintosh users: In the Finder, add the
.fmb extension to the end of the book file's name. If you
had initilly named your book file rpcg, you would rename your book
file to rpcg.fmb in the Finder.
PC users: Find your
book in File Manager and select it. Select Rename from the
File menu and enter the book name with the .fmb extension in the
To field.
Examples
The following sections provide examples of filenames for current
documents that conform to the previously discussed file-naming
guidelines. Sample document types from the Knowledge Products groups
(IOS1/IBM, IOS2/Ports, Access, CiscoFusion, Internetwork Management)
are listed.
Note: The following filenames are only possible
examples; they are not mandatory filename requirements.
When naming files, use names that make sense to you; the only
restrictions are listed in the "General File-Naming Guidelines"
section of this document.
Cisco IOS
Examples of IOS documentation includes getting started guides,
configuration guides, command reference documents, and release
notes.
The following table lists possible filenames that conform to the
new file-naming conventions for the Router Products Configuration
Guide (Cisco IOS Release 10.3). The documents for this release
have the following CMS path:
CMS:Files:Doc:Software:10.3:RPCG.
| Document Name
| Document Component
| Example of FrameMaker Filename
|
| Router Products Configuration Guide
| Frame book file
| rpcg.fmb
|
|
| Title page
| title.fm
|
|
| Table of contents
| rpcg.fmc
|
|
| List of figures
| rpcg.fmf
|
|
| List of tables
| rpcg.fmt
|
|
| Index
| rpcg.fmx
|
|
| About This Manual
| about.fm
|
|
| Part 1—Product Introduction
| prodpt.fm
|
|
| Overview
| overc.fm
|
|
| Understanding the User Interface
| uiinfo.fm
|
|
| Part 2—System and Interface Configuration and Management
| syscfgpt.fm
|
|
| Loading System Images, Microcode Images, and Configuration
Files
| loadfile.fm
|
|
| Configuring Terminal Lines and Modem Support
| termmod.fm
|
|
| Managing the System
| sysmgt.fm
|
|
| Configuring Interfaces
| intfce.fm
|
|
| Part 3—Wide Area Networking
| wanpt.fm
|
|
| Configuring ATM
| atm.fm
|
|
| Configuring DDR
| ddr.fm
|
|
| Configuring Frame Relay
| framerel.fm
|
|
| Configuring ISDN
| isdn.fm
|
|
| Configuring SMDS
| smds.fm
|
|
| Configuring X.25 and LAPB
| x25lapb.fm
|
|
| Part 4—Routing Protocols
| rtprotpt.fm
|
|
| Configuring Apollo Domain
| apollo.fm
|
|
| Configuring AppleTalk
| appletlk.fm
|
|
| Configuring Banyan VINES
| vines.fm
|
|
| Configuring DECnet
| decnet.fm
|
|
| Configuring IP
| confip.fm
|
|
| Configuring IP Routing Protocols
| iprout.fm
|
|
| Configuring ISO CLNS
| isoclns.fm
|
|
| Configuring Novell IPX
| ipx.fm
|
|
| Configuring XNS
| xns.fm
|
|
| Part 5—Bridging
| bridgept.fm
|
|
| Configuring Transparent Bridging
| tb.fm
|
|
| Configuring Source-Route Bridging
| srb.fm
|
|
| Part 6—IBM Networking
| ibmnetpt.fm
|
|
| Configuring STUN
| stun.fm
|
|
| Configuring LLC2 and SDLC Parameters
| llc2sdlc.fm
|
|
| Configuring IBM Network Protocol Translation
| sdllc.fm
|
|
| Configuring DSPU
| dspu.fm
|
|
| Configuring SNA Frame Relay Access Support
| snafras.fm
|
|
| Configuring IBM Channel Attach
| ibmchan.fm |
The following table lists some example filenames for the
Access and Communication Servers Command Reference. These
files have the following CMS path:
CMS:Files:Doc:Software:10.3:ACCSCR.
| Document Name
| Document Component
| Example of FrameMaker Filename
|
| Access and Communication Servers Command Reference
| Frame book file
| accsref.fmb
|
|
| Title page
| title.fm
|
|
| Table of contents
| accsref.fmc
|
|
| List of figures
| accsref.fmf
|
|
| List of tables
| accsref.fmt
|
|
| About This Manual
| about.fm
|
|
| Access and Communications Servers Product Overview
| overview.fm
|
|
| User Interface Commands
| uintrfce.fm
|
|
| Loading System Images, Microcode Images, and Configuration
Files
| loadfile.fm
|
|
| Terminal Line and Modem Support Commands
| termmod.fm
|
|
| Managing the System
| sysmgt.fm
|
|
| Interface Configuration Commands
| intfce.fm
|
|
| Dial-on-Demand Routing Commands
| ddr.fm
|
|
| X.25 Configuration Commands
| x25.fm
|
|
| Frame Relay Commands
| framerel.fm
|
|
| SMDS Commands
| smds.fm
|
|
| Telnet Configuration Commands
| telnet.fm
|
|
| LAT Configuration Commands
| lat.fm
|
|
| AppleTalk Remote Access Commands
| ara.fm
|
|
| SLIP and PPP Commands
| slipppp.fm
|
|
| XRemote Configuration Commands
| xremote.fm
|
|
| IP Commands
| ip.fm
|
|
| IP Routing Protocols Commands
| iprout.fm
|
|
| Novell IPX Commands
| ipx.fm
|
|
| Protocol Translation Commands
| pttrans.fm
|
|
| ASCII Character Set
| ascii.fm
|
|
| Regular Expressions
| regexp.fm
|
|
| X.3 PAD Parameters
| x3pad.fm |
The following lists an example of the Router Products Release
Notes for Software Release 9.17. This file has the following CMS
path: CMS:Files:Doc:Software:9.1:Rel.Notes.
| Document Name
| Document Component
| Example of FrameMaker Filename
|
| Router Products Release Notes for Software Release
9.17
|
| rp917.fm |
Hardware
Examples of hardware documentation include the "quick-start"
installation guides, installation and maintenance documents, and
configuration notes.
The following table lists possible examples for the Cisco 2500
Series Hardware Installation document. These files have the
following CMS path:
CMS:Files:Doc:hardware:access:2500:HI.
| Document Name
| Document Component
| Example of FrameMaker Filename
|
| Cisco 2500 Series Hardware Installation
| Frame book file
| 2500hig.fmb
|
|
| Title page
| title.fm
|
|
| Table of contents
| 2500hig.fmc
|
|
| List of figures
| 2500hig.fmf
|
|
| List of tables
| 2500hig.fmt
|
|
| Getting Started
| preinst.fm (or prep.fm)
|
|
| Installing the Hardware
| install.fm
|
|
| Reference
| ref.fm
|
|
| Regulatory Compliance
| intcomp.fm
|
|
| System Specifications
| specs.fm |
The following table lists some possible filenames for the
Cisco 7010 Hardware Installation and Maintenance. These files
have the following CMS path:
CMS:Files:Doc:hardware:fusion:7010:HIM.
| Document Name
| Document Component
| Example of FrameMaker Filename
|
| Cisco 7010 Hardware and Installation Maintenance
| Frame book file
| 7010him.fmb
|
|
| Title page
| title.fm
|
|
| Table of contents
| 7010him.fmc
|
|
| List of figures
| 7010him.fmf
|
|
| List of tables
| 7010him.fmt
|
|
| Index
| 7010him.fmx
|
|
| About This Manual
| about.fm
|
|
| Product Overview
| overview.fm
|
|
| Preparing for Installation
| preinst.fm
|
|
| Installing the Router
| install.fm
|
|
| Troubleshooting the Installation
| trblsht.fm
|
|
| Maintenance
| maint.fm
|
|
| Cabling Specifications
| cablespc.fm
|
|
| Reading LED Indicators
| readled.fm
|
|
| Industry-Standard Wiring Plans
| wiring.fm
|
|
| Operating Conditions for the United Kingdom
| ukopcond.fm
|
|
| European Communities
| eurocomm.fm |
The following lists an example of the Fast Ethernet Interface
Processor (FEIP) Installation and Configuration. This file has
the following CMS path:
CMS:Files:Doc:hardware:fusion:7010:CFG_NTS.
| Document Name
| Document Component
| Example of FrameMaker Filename
|
| Fast Ethernet Interface Processor (FEIP) Installation
and Configuration
|
| 1812feip.fm |
Internetwork Management
Examples of documentation this group produces include
installation guides, user guides, and CD-ROM booklets.
The following table lists possible filenames for the
CiscoWorks Administration and Installation Guide on NetView for
AIX. These files have the following CMS path:
CMS:Files:Doc:Rtr_Mgmt:CW2RSC:CWAIG.
| Document Name
| Document Component
| Example of FrameMaker Filename
|
| CiscoWorks Administration and Installation Guide
| Frame book file
| cwaignv.fmb
|
|
| Title page
| title.fm
|
|
| Table of contents
| cwaignv.fmc
|
|
| List of figures
| cwaignv.fmf
|
|
| List of tables
| cwaignv.fmt
|
|
| Index
| cwaignv.fmx
|
|
| About This Guide
| about.fm
|
|
| Product Overview
| overview.fm
|
|
| Preparing to Install CiscoWorks
| preinst.fm
|
|
| Installing and Configuring CiscoWorks
| instcfg.fm
|
|
| Validating CiscoWorks Installation
| valinst.fm
|
|
| Error Messages
| errmsg.fm |
Previous
| Content
| Next