DocBook: The Definitive Guide

Table of content


	By Norman Walsh & Leonard Muellner 1st Edition October 1999 1-56592-580-7, Order Number: 5807 652 pages, $36.95 , Includes CD-ROM

DocBook: The Definitive Guide
Prev		Next

Name

Filename -- The name of a file

Synopsis

Mixed Content Model

Filename ::= ((#PCDATA|Link|OLink|ULink|Action|Application|ClassName|Command|   ComputerOutput|Database|Email|EnVar|ErrorCode|ErrorName|   ErrorType|Filename|Function|GUIButton|GUIIcon|GUILabel|GUIMenu|   GUIMenuItem|GUISubmenu|Hardware|Interface|InterfaceDefinition|   KeyCap|KeyCode|KeyCombo|KeySym|Literal|Constant|Markup|   MediaLabel|MenuChoice|MouseButton|MsgText|Option|Optional|   Parameter|Prompt|Property|Replaceable|ReturnValue|SGMLTag|   StructField|StructName|Symbol|SystemItem|Token|Type|UserInput|   VarName|Anchor|Comment|Subscript|Superscript|InlineGraphic|   InlineMediaObject|IndexTerm)+)

Attributes

Common attributes

Name	Type	Default
Class	Enumeration: Directory HeaderFile SymLink	None
Path	CDATA	None
MoreInfo	Enumeration: None RefEntry	"None"

Tag Minimization

Both the start- and end-tags are required for this element.

Parameter Entities

`%cptr.char.mix;`	`%ndxterm.char.mix;`	`%para.char.mix;`
`%programlisting.content;`	`%refinline.char.mix;`	`%refname.char.mix;`
`%screen.content;`	`%tbl.entry.mdl;`	`%tech.char.class;`
`%title.char.mix;`

Description

A Filename is the name of a file on a local or network disk. It may be a simple name or may include a path or other elements specific to the operating system.

Processing expectations

Formatted inline. The MoreInfo attribute can help generate a link or query to retrieve additional information.

Future Changes

The content model of Filename will be constrained to (#PCDATA | Replaceable | InlineGraphic) in DocBook V4.0.

Parents

These elements contain Filename: Action, Application, Attribution, BiblioMisc, BridgeHead, Citation, CiteTitle, Command, Comment, ComputerOutput, Database, Emphasis, entry, Filename, ForeignPhrase, FuncParams, FuncSynopsisInfo, Function, GlossSee, GlossSeeAlso, GlossTerm, Hardware, Interface, InterfaceDefinition, KeyCap, LineAnnotation, Link, Literal, LiteralLayout, LoTentry, Member, MsgAud, OLink, Option, Optional, Para, Parameter, Phrase, Primary, PrimaryIE, ProductName, ProgramListing, Property, Quote, RefDescriptor, RefEntryTitle, RefName, RefPurpose, Screen, ScreenInfo, Secondary, SecondaryIE, See, SeeAlso, SeeAlsoIE, SeeIE, Seg, SegTitle, SimPara, Subtitle, Synopsis, SystemItem, Term, Tertiary, TertiaryIE, Title, TitleAbbrev, ToCback, ToCentry, ToCfront, Trademark, ULink, UserInput.

Children

The following elements occur in Filename: Action, Anchor, Application, ClassName, Command, Comment, ComputerOutput, Constant, Database, Email, EnVar, ErrorCode, ErrorName, ErrorType, Filename, Function, GUIButton, GUIIcon, GUILabel, GUIMenu, GUIMenuItem, GUISubmenu, Hardware, IndexTerm, InlineGraphic, InlineMediaObject, Interface, InterfaceDefinition, KeyCap, KeyCode, KeyCombo, KeySym, Link, Literal, Markup, MediaLabel, MenuChoice, MouseButton, MsgText, OLink, Option, Optional, Parameter, Prompt, Property, Replaceable, ReturnValue, SGMLTag, StructField, StructName, Subscript, Superscript, Symbol, SystemItem, Token, Type, ULink, UserInput, VarName.

In some contexts, the following elements are allowed anywhere: BeginPage, IndexTerm.

In some contexts, the following elements are excluded: IndexTerm.

Attributes

Class: Class allows the author to identify particular kinds of files.
MoreInfo: If MoreInfo is set to RefEntry, it implies that a RefEntry exists which further describes the Filename.
Path: Path contains the search path, possibly in a system or application specific form, on which the file can be found.

Examples

<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook V3.1//EN"> <para> The symbolic constants for error numbers are defined in <filename class=headerfile>errno.h</filename> in <filename class=directory>/usr/include/sys</filename>. </para>

The symbolic constants for error numbers are defined in errno.h in /usr/include/sys.

For additional examples, see also Constant, ErrorCode, KeyCap, KeyCode, KeySym, VariableList.