| Metadata Element | Description |
|---|
| Access | Outputs the access type of a particular item (e.g. PUBLIC, PROTECTED etc.). |
| AssemblyName | Outputs the name of the current Java Project. |
| AssemblyQualifiedName | Outputs the fully qualified name of the current Assembly. |
| BaseLink | Outputs a link to the base implementation for the current member. |
| 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. |
| 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). |
| ComponentName | Outputs the current type name with any generics information in readable form (e.g. MyClass<T>). |
| ConstructorName | Outputs a readable name for the current Constructor, e.g. MyClass Constructor. |
| 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. |
| CurrentNamespace | Outputs the Namespace in which the current item is contained. |
| 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. |
| Diagram | Generates an object relationship diagram. |
| EnumMemberHexValue | Outputs the value of the item if it is an enum member as a hex value. |
| EnumMemberValue | Outputs the value of the current item if it is an enum member. |
| 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. |
| ExceptionLink | Outputs an anchor tag that points to the documentation page for the current Exception |
| ExceptionUrl | Outputs a url that points to the documentation page for the current exception. |
| F1ItemName | Outputs the full name of the current item, for use in Help 2.x F1 information. For members this includes the type
name and for types this includes the namespace. |
| 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. |
| FullComponentName | Returns the full name of the current Type. |
| FullItemName | Outputs the full name of the current item. For members this includes the type name and for types this includes the namespace. |
| 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. |
| Hierarchy | Outputs the type inheritance hierarchy for a Namespace or the whole Assembly. |
| ImplementsComma | Outputs a comma if currently within a list and not the last item in the list. |
| IncludeProtectedOrFriendMembers | Outputs "True" if the option to include Protected, Protected Friend or Friend members in the documentation has been enabled and the current item is a Type. Otherwise returns nothing. |
| IndexUrl | Outputs a relative url for the current item suitable for including in index references. |
| InheritanceAndImplementationSyntax | Outputs the inheritance and implementation portion of the Syntax block for types. |
| InheritanceHierarchy | Outputs the inheritance hierarchy for a particular type |
| InheritanceInfo | Outputs the contents of the INHERITANCE_INFO scrap if the current member is an override of a base member. |
| InheritedFrom | Outputs a language specific link to the type that the current item inherits from. |
| InheritsFrom | Outputs a language specific link to the type that the current item inherits from. |
| IsDesignTime | Outputs an Html non breaking space entity only if running at design time.
Is used in combination with format and blankformat attributes to show specific content only at design time, or not design time. |
| IsEnumValuesEnabled | Outputs "True" if the option to include values in enumeration member lists has been enabled. Otherwise returns nothing. |
| 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.). |
| JavadocSignature | Returns the Javadoc signature for an item. |
| Keyword | Outputs a language keyword for a particular item. |
| LanguageCaption | Outputs the caption (readable name) of the current Language (e.g. C#, VB.NET, C++/CLI). |
| LanguageName | Outputs the name of the current language (e.g. CS, VB, CPP2005). |
| LanguageSyntaxCaption | Outputs the SyntaxCaption (readable name, localized in the phrase table) of the current Language (e.g. C#, VB.NET, C++/CLI). |
| Link | Outputs an anchor for the current item. |
| LinkCategoryName | Outputs the category name for the current See Also link. |
| LinkedCurrentNamespace | Outputs a hyperlink to the current items namespace documentation page. |
| LinkedParameterTypeName | Outputs the type name (as a link if noLink is not true) of the current parameter. |
| LinkedReturnTypeName | Outputs the type name (as a link if noLink is not true) of the member return type. |
| LinkedTypeName | Outputs a link to the type of the current item. |
| 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. |
| MethodType | Outputs a language specific string identifying the type of method (if the language supports such an identifier). e.g. Function or Sub in Visual Basic. |
| Name | Outputs the name of the current item. |
| OperatorName | Outputs a readable name for the current Operator (e.g. "Addition"). |
| OperatorSyntaxName | Outputs the language specific name of an operator (e.g. ++ for the increment operator in csharp). |
| OutputFileExtension | Outputs the file extension defined in the project (defaults to .html). |
| OverrideIndicator | Outputs the content of the OVERRIDE_INDICATOR phrase if the current item overrides a base member. |
| PageItemTitle | Outputs a title for the current item, typically {Name} {TypeName}, e.g. "Add Method". |
| ParameterComma | Outputs a language specific parameter delimiter (usually a comma) if currently within a list and not the last item in the list. |
| ParameterDetail | Outputs a formatted list of parameters for a particular item. |
| ParameterSummary | Outputs a one line summary of an items parameters, formatted using the specified language. |
| ParentDescription | Returns summary content for the logical parent of the current item |
| ParentItemName | Outputs the name of the parent of the current item. |
| ParentItemQualifiedName | Outputs the fully qualified name of the logical parent of the current item (e.g. for a Type that would be the Namespace qualified name). |
| ParentQualifiedName | Outputs the fully qualified name of the parent of the current item. |
| ParentShortItemname | Outputs the name of the current items logical parent item (e.g. this would return the namespace name for a class). |
| 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. |
| PropertyType | Outputs the language specific identifier for the type of property (e.g. Read Only, Read Write, Write Only in Visual Basic). |
| RawItemName | Outputs the current items item name without any adjustment for readability or trimming. |
| 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 /. |
| RelativeMemberLink | Returns the main page url for a member, relative to the current output file name. |
| RelativeTypeLink | Returns the main page url for a type, relative to the current output file name. |
| 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. |
| 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. |
| ShortParentItemName | Outputs the name of the parent type of the current member. |
| 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. |
| Syntax | Outputs a syntax block for a particular item. |
| SyntaxCopyCode | Outputs the Copy Code scrap for the current language (typically a hyperlink that copies all code to the clipboard). |
| SyntaxItemName | Outputs the name to use for the current item in the generated syntax sections. |
| SyntaxSection | Outputs a Syntax section according to the Syntax Section Style chosen in the Project Profile. Uses the _SYNTAX_TABS or _SYNTAX_BOXES scraps, according to the
preferenced defined in the Build Profile. |
| TaggedComment | Outputs the content for a particular content type. |
| TocParentId | Outputs the Id of the parent item as defined in the ToC for this item. |
| TypeName | Outputs the name of the current item type - e.g. Class, Namespace etc. |
| Variable | Outputs the value of a Project or Template property. |
| WrappedDescription | Returns the description for an item, wrapped in a paragraph tag if it isn't already. |
| XmlEncoding | Outputs a string that represents the current output encoding, suitable for including in an Xml file encoding attribute, e.g. "utf-8" |
| XmlIsland | Outputs the Help 2.x Xml Island for the current item. |
| Year | Outputs the current year. |