| Metadata Element | Description |
|---|
| Breadcrumbs | Outputs a breadcrumbs section. The breadcrumbs section is only output if the option is enabled in the
Build Profile editor. |
| BuildProfileName | Outputs the name of the current Project Profile. |
| Charset | Outputs the numeric identifier of the encoding codepage defined in the project. |
| ChildItemTypeName | Outputs the child item type name for the current item. One of "jsonschema", "jsonschemaproperty",
"jsonarrayproperty", "jsonschemacomplexproperty" or "jsonschemacomplexarrayproperty". |
| ChildTree | Outputs the _CHILD_TREE scrap for the current item. |
| ChildTreeChildren | Used internally for _CHILD_TREE support. Use _CHILD_TREE instead. |
| ChildTreeSummary | Outputs the content of the Template _{ItemType}_CHILD_TREE_SUMMARY phrase, where {ItemType} is the current item type. |
| CommunityBaseUrl | Outputs the location to which the generated Html will output. This setting is used only if a Community Extensions proxy page is being used. |
| CommunityItemID | Returns the unique Id used by Community Extensions to identify the current item. |
| CommunityProjectKey | Outputs the Community Extensions Project Key defined for this Project. The Project Key is an encoded value based on the
setting defined on the Community Settings page in the Build Profile editor. |
| CommunityProxyTargetUrl | Outputs the address of the Community Extensions proxy page (if one is being used). |
| ContentSection | Add this to a base page type to create a section that can be populated in a derived page type. |
| CrLf | Outputs carriage return and line feed characters. |
| CurrentFileNameNoExtension | Outputs the current filename excluding the file extension. |
| CustomHeadContent | Outputs the content of any custom HEAD tag content, as well as Google Analytics script (if enabled) |
| DefaultTopic | Outputs the file name (including extension) of the default Topic. |
| Description | Outputs the summary content for the current item. |
| Designtime | Outputs any content between the start and end DXMETADATA markers at design time, otherwise returns nothing. |
| ExampleCode | Outputs the code for the current Example. |
| ExampleId | Returns a unique id (different for each documentation generation) for the current Example. |
| ExampleLanguage | Outputs the language name of the current Example (e.g. CS). |
| ExampleLanguageCaption | Outputs a readable name for the language of the current example (e.g. C++/CLI). |
| ExampleTitle | Outputs the title of the current Example. |
| FaultName | Returns the name of the current fault response. |
| FaultNameScriptSafe | Returns the name of the current fault response, with any characters unsuitable for use in script or element names removed. |
| FileName | Outputs the filename for the current item. |
| FilteredItemList | Generates output based on a set of child items (of the Item Type identified by the Namespace parameter). The output generated for each item is formatted using the parsed
value of a Scrap named {Scrap}_BODY. The complete output is then prefixed with the parsed value of a Scrap named {Scrap}_HEADER and suffixed with the parsed value
of a Scrap named {Scrap}_FOOTER. No output is generated if no child items are found. |
| FullPropertyName | Returns the full name of the current Json Property item. |
| FullyQualifiedResourcePath | Returns the fully qualified resource path (a full uri including the web service public uri). |
| GeneralDate | Outputs the current date in General Date format. |
| GroupExamples | Outputs "True" if the option to group examples has been enabled. Otherwise returns nothing. |
| HelpProjectTitle | Outputs the Project Title. |
| IncludeFullResourceUriInOperationPages | Returns the literal "True" if the IncludeFullResourceUriInOperationPages option is enabled in the current Build Profile. |
| IsGroupedByResource | Returns "True" if the "Group by Resource" option is enabled in the current Build Profile. |
| IsNew | Outputs True if the current item is new. |
| IsTemplateFileFeatureEnabled | Outputs "True" if the named Template File Feature is enabled or nothing if it is disabled |
| ItemName | Outputs the name of the current item. |
| ItemQualifiedName | Outputs the fully qualified name of the current item. The fully qualified name uniquely identifies the current item. |
| ItemQualifiedName_ScriptSafe | Outputs the qualified name of the current item, with any reserved script characters encoded so the value can be used directly in script. |
| ItemTitle | Outputs a readable title for the current item, e.g. "Add Method". |
| ItemType | Outputs the type of the current item (e.g. "Namespace", "Class" etc.). |
| Link | Outputs an html anchor element for the current item. |
| LinkCategoryName | Outputs the category name for the current See Also link. |
| LinkedParameterDataType | Returns an anchor link pointing to the page generated for the type used by the current parameter. If the parameter type is not contained in the
current project, text will be returned instead. |
| LinkedPropertyDataType | Returns an anchor link pointing to the page generated for the type returned by the current property. If the parameter type is not contained in the
current project, text will be returned instead. |
| LinkedRequestDataType | Returns an anchor link pointing to the page generated for the type used by the current request. If the parameter type is not contained in the
current project, text will be returned instead. |
| LinkedResponseDataType | Returns an anchor link pointing to the page generated for the type returned by the current response. If the parameter type is not contained in the
current project, text will be returned instead. |
| LinkTarget_ScriptSafe | Outputs the target of the current link, with any reserved script characters encoded so the value can be used directly in script. |
| Literal | Outputs the content of the value parameter. This element can be used in combination with conditions to include/exclude
static content according to particular conditions. |
| LocaleString | Outputs a string identifying the encoding defined in the project (e.g. "0x432 English (United States)"). |
| LocalItemTitle | Outputs a readable title for the current item, e.g. "Add Method". |
| LogoImage | Outputs an <img> tag for the projects logo image. |
| LongDate | Outputs the current date in Long Date format. |
| LongTime | Outputs the current time in Long Time format. |
| MarkOfTheWeb | Outputs <!-- saved from url= --> tag using the URL defined in the Build Profile. |
| MetaCharset | Outputs an Html META element defining the charset to use according to the encoding settings defined in the project. |
| Name | Outputs the name of the current item. |
| OperationKind | Returns the operation kind. One of HttpGet, HttpPut, HttpPost, HttpDelete, HttpHead, HttpOptions, HttpPatch. |
| OperationKindLocalized | Returns a phrase looked up using the current %OperationKind%. |
| OutputFileExtension | Outputs the file extension defined in the project (defaults to .html). |
| PageItemTitle | An alias for LocalItemTitle. The two are equivalent. |
| ParameterDataType | Returns the type name of the current parameter. Use %LinkedParameterDataType% to return the type name as a link (if the target
type exists in the current project). |
| ParentItemName | Outputs the name of the parent item for the current item. |
| ParentQualifiedName | Outputs the fully qualified name of the parent of the current item. |
| Phrase | Outputs a phrase from the Template phrase table according to the current phrase language. |
| PhraseLanguage | Outputs the current Phrase language. |
| ProjectId | Outputs the Id of the current Project. |
| ProjectTitle | Outputs the Project Title. The Project Title is defined in the BuildProfileTerm Editor. |
| PublicUri | Returns the public uri of the current Web Service. |
| RawDataType | Returns the raw type name associated with the current request, response or parameter. |
| RelativeFileName | Outputs the filename for the current item, relative to the project file. Use RelativeUrlFileName if you are using this value as a link target rather than a local path and filename, as it replaces \ with /. |
| RelativeUrlFileName | Outputs the filename for the current item, relative to the project file. Any \ characters in the path will be replaced with / so that the value is usable as a relative url. |
| RequestBodyDiagram | Returns the HTML for a diagram that represents the structure of the current Request. |
| RequestBodyOverview | Returns the HTML for an overview table that summarizes the structure of the current Request. |
| RequestName | Returns the name of the current request. |
| RequestNameScriptSafe | Returns the name of the current request, with any characters unsuitable for use in script or element names removed. |
| ResourceGroupId | Returns the unique id associated with the current Resource Group. |
| ResourceGroupName | Returns the name of the current Resource Group. |
| ResourcePath | Outputs the resource path for the current item (operation or resource). |
| ResponseBodyDiagram | Returns the HTML for a diagram that represents the structure of the current Response body. |
| ResponseBodyOverview | Returns the HTML for an overview table that summarizes the structure of the current Response. |
| ResponseName | Returns the name of the current response. |
| ResponseNameScriptSafe | Returns the name of the current response, with any characters unsuitable for use in script or element names removed. |
| Scrap | Outputs the value of a Scrap defined in the current Template. |
| Scripts | Outputs a <script> element for each script file. |
| ShortDate | Outputs the current date in Short Date format. |
| ShortItemName | Outputs the name of the current item. |
| ShortItemTypeName | Outputs the short type name for the current item. |
| ShortTime | Outputs the current time in Short Time format. |
| StrippedDescription | Outputs the summary content for the current item. |
| Stylesheets | Outputs a <link> element for each stylesheet. |
| TaggedComment | Outputs the content for a particular content type. |
| TypeName | Outputs the name of the current item type - e.g. Class, Namespace etc. |
| Variable | Outputs the value of a Project or Template property. |
| WebServiceName | Returns the full name of the current Web Service. |
| XmlEncoding | Outputs a string that represents the current output encoding, suitable for including in an Xml file encoding attribute, e.g. "utf-8" |
| Year | Outputs the current year. |