filename
Synopsis
Mixed Content Model
filename ::= (#PCDATA|replaceable|inlinegraphic|inlinemediaobject|indexterm| beginpage)*
Attributes
Name |
Type |
Default |
|||||
| class |
Enumeration:
|
None | |||||
| path | CDATA | None | |||||
| moreinfo |
Enumeration:
|
"none" |
Parameter Entities
The following parameter entities contain filename:
| Parameter Entities | ||
| %cptr.char.mix; | %ndxterm.char.mix; | %para.char.mix; |
| %refinline.char.mix; | %refname.char.mix; | %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.
![[4.0]](figures/rev_4.0.png)
Future Changes
The content model of Filename will be constrained to (#PCDATA | Replaceable | InlineGraphic) in DocBook V4.0.
![[5.0]](figures/rev_5.0.png)
Future ChangesParents
These elements contain filename: application, attribution, bibliomisc, bridgehead, citation, citetitle, classsynopsisinfo, command, computeroutput, emphasis, entry, foreignphrase, funcparams, funcsynopsisinfo, function, glosssee, glossseealso, glossterm, lineannotation, link, literal, literallayout, lotentry, member, msgaud, olink, optional, para, phrase, primary, primaryie, productname, programlisting, quote, refdescriptor, refentrytitle, refname, refpurpose, remark, screen, screeninfo, secondary, secondaryie, see, seealso, seealsoie, seeie, seg, segtitle, simpara, subtitle, synopsis, term, tertiary, tertiaryie, title, titleabbrev, tocback, tocentry, tocfront, trademark, ulink, userinput.
Children
The following elements occur in filename: beginpage, indexterm, inlinegraphic, inlinemediaobject, replaceable.
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.
See Also
application, computeroutput, database, envar, hardware, medialabel, productname, prompt, systemitem, userinput.
Examples
<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<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 .