Whole document tree
Replaceable
Name Replaceable -- Content that may be replaced in a
synopsis or command line
Description Content that may be replaced in a synopsis or command line.
It may contain basic in-line elements (not cptr.char.mix)
and has common and Class attributes. Replaceable is not
the name of a variable, nor a value of a variable, but a
string acting as a placeholder, such as "myfilename" or
"type your filename here".
Parents These elements contain Replaceable:
Accel , Ackno , Action , Application , Arg , ArtPageNums , Attribution , AuthorInitials , BiblioMisc , BridgeHead , Citation , CiteTitle , City , ClassName , CollabName , Command , Comment , ComputerOutput , ConfDates , ConfNum , ConfSponsor , ConfTitle , ContractNum , ContractSponsor , Contrib , CorpAuthor , CorpName , Country , Database , Date , Edition , Email , Emphasis , EnVar , ErrorCode , ErrorName , ErrorType , Fax , Filename , FirstName , ForeignPhrase , FuncDef , FuncParams , FuncSynopsisInfo , Function , GUIButton , GUIIcon , GUILabel , GUIMenu , GUIMenuItem , GUISubmenu , GlossSee , GlossSeeAlso , GlossTerm , Group , Hardware , Holder , Honorific , ISBN , ISSN , Interface , InterfaceDefinition , InvPartNumber , IssueNum , JobTitle , KeyCap , KeyCode , KeySym , LineAnnotation , Lineage , Link , Literal , LiteralLayout , LoTentry , Markup , MediaLabel , Member , ModeSpec , MouseButton , MsgAud , MsgLevel , MsgOrig , OLink , Option , Optional , OrgDiv , OrgName , OtherAddr , OtherName , POB , PageNums , Para , ParamDef , Parameter , Phone , Phrase , Postcode , Primary , PrimaryIE , ProductName , ProductNumber , ProgramListing , Prompt , Property , PubDate , PublisherName , PubsNumber , Quote , RefDescriptor , RefEntryTitle , RefMiscInfo , RefName , RefPurpose , ReleaseInfo , ReturnValue , RevNumber , RevRemark , SGMLTag , Screen , ScreenInfo , Secondary , SecondaryIE , See , SeeAlso , SeeAlsoIE , SeeIE , Seg , SegTitle , SeriesVolNums , ShortAffil , SimPara , State , Street , StructField , StructName , Subscript , Subtitle , Superscript , Surname , Symbol , Synopsis , SystemItem , Term , Tertiary , TertiaryIE , Title , TitleAbbrev , ToCback , ToCentry , ToCfront , Token , Trademark , Type , ULink , UserInput , VolumeNum , Year , entry .
Children Replaceable contains these elements:
Anchor , Comment , InlineGraphic , Link , OLink , Optional , #PCDATA, Subscript , Superscript , ULink .
In some contexts, some of these elements
may be invalid due to exclusions in parent elements.
Attributes
Class Class indicates the type of information
the Replaceable represents; there is no default.
Examples <SYNOPSIS>if (<REPLACEABLE>condition</REPLACEABLE>) {
<REPLACEABLE>commands</REPLACEABLE>
} else {
<REPLACEABLE>commands</REPLACEABLE>
}</SYNOPSIS> <FUNCSYNOPSIS>
<FUNCSYNOPSISINFO>TODO TBS
</FUNCSYNOPSISINFO>
<FUNCPROTOTYPE>
<FUNCDEF>TODO TBS
</FUNCDEF>
<VOID>
</FUNCPROTOTYPE>
</FUNCSYNOPSIS>