releasehx 0.1.0

data/lib/releasehx/mcp/assets/config-reference.adoc

@@ -0,0 +1,4104 @@
+:page-layout: default
+:page-permalink: /config-reference/
+:page-nav_order: 2
+:page-title: Configuration Reference
+
+[[conf_ppty_DOLLARSIGN_meta,config.$meta]]
+$meta::
++
+--
+The metadata settings for the configuration file.
+
+
+[horizontal]
+path;; `xref:conf_ppty_DOLLARSIGN_meta[config.$meta]`
+--
+
+[[conf_ppty_DOLLARSIGN_meta_markup,config.$meta.markup]]
+$meta.markup:::
++
+--
+The markup format used in strings in this configuration file.
+May be `asciidoc` or `markdown`.
+
+This probably matters less than you might imagine, as ReleaseHx will use AsciiDoc-style `+++_italic_+++` and `+++*bold*+++` syntax, and there should not be much call for divergent syntax like for links or images.
+All default values are cross-compatible.
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++markdown+++`
+path;; `xref:conf_ppty_DOLLARSIGN_meta_markup[config.$meta.markup]`
+--
+
+[[conf_ppty_DOLLARSIGN_meta_slug_type,config.$meta.slug_type]]
+$meta.slug_type:::
++
+--
+The format of slugs used in your application, for use with `sluggerize` Liquid filter.
+
+Must be `kebab` (ex: `hyphen-delimited-slug`) or `snake` (ex: `underscore_delimited_slug`).
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++kebab+++`
+path;; `xref:conf_ppty_DOLLARSIGN_meta_slug_type[config.$meta.slug_type]`
+--
+
+[[conf_ppty_DOLLARSIGN_meta_tplt_lang,config.$meta.tplt_lang]]
+$meta.tplt_lang:::
++
+--
+The default format used in fields of `Template` type.
+Must be `liquid` or `erb`.
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++liquid+++`
+path;; `xref:conf_ppty_DOLLARSIGN_meta_tplt_lang[config.$meta.tplt_lang]`
+--
+
+[[conf_ppty_origin,config.origin]]
+origin::
++
+--
+The API or file source for the issues.
+
+
+[horizontal]
+path;; `xref:conf_ppty_origin[config.origin]`
+--
+
+[[conf_ppty_origin_source,config.origin.source]]
+origin.source:::
++
+--
+The type of API or file to use for the issues source.
+May be `jira`, `github`, `gitlab`, or `rhyml`.
+
+The `jira`, `github`, and `gitlab` types are all REST APIs that return an individualized JSON payload upon request, to be converted to RHYML format.
+
+Alternately, you may use a file directly written in <<rhyml,RHYML-style YAML>> (`rhyml`).
+
+If you wish to mix Git and API sources, this field should still reference the API.
+
+Custom APIs are also available, but you will need to create a custom client in the `_apis` directory (<<conf_ppty_paths_api_clients_dir>>), and a custom mapping in the `_mappings` directory (<<conf_ppty_paths_mappings_dir).
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++rhyml+++`
+path;; `xref:conf_ppty_origin_source[config.origin.source]`
+--
+
+[[conf_ppty_origin_project,config.origin.project]]
+origin.project:::
++
+--
+The string used to identify the project in the remote API.
+Only required if the API requires a project identifier.
+
+
+[horizontal]
+type;; Slug
+path;; `xref:conf_ppty_origin_project[config.origin.project]`
+--
+
+[[conf_ppty_origin_href,config.origin.href]]
+origin.href:::
++
+--
+The local or remote URI for the API or JSON file.
+Either the REST API endpoint path or the path to a local or remote JSON file containing the issues data.
+
+This field may be templated, accepting Liquid placeholders like `{{ proj }}` (the sibling `project` property) or `{{ version }}` (the argued release version code).
+
+
+[horizontal]
+type;; URI
+templating;;  immediate rendering
+path;; `xref:conf_ppty_origin_href[config.origin.href]`
+--
+
+[[conf_ppty_origin_auth,config.origin.auth]]
+origin.auth:::
++
+--
+Properties related to API authentication.
+
+This block should be unnecessary if you use a supported API (Jira, GitHub, GitLab), unless you wish to use differently named environment variables for API credentials.
+
+
+[horizontal]
+path;; `xref:conf_ppty_origin_auth[config.origin.auth]`
+--
+
+[[conf_ppty_origin_auth_mode,config.origin.auth.mode]]
+origin.auth.mode::::
++
+--
+The type of authentication to use.
+
+Options are: `basic`, `token`, `bearer`, `header`, `query`, `none`.
+
+
+[horizontal]
+path;; `xref:conf_ppty_origin_auth_mode[config.origin.auth.mode]`
+--
+
+[[conf_ppty_origin_auth_header,config.origin.auth.header]]
+origin.auth.header::::
++
+--
+The header to use for authentication.
+Only used if `origin.auth.mode` is `header`.
+
+
+[horizontal]
+type;; String
+path;; `xref:conf_ppty_origin_auth_header[config.origin.auth.header]`
+--
+
+[[conf_ppty_origin_auth_cred_uri,config.origin.auth.cred_uri]]
+origin.auth.cred_uri::::
++
+--
+The location of the API credentials file for declaring API authentication arguments without environment variables.
+
+The value can be a local path with read access or an HTTP path (not recommended unless ReleaseHx is always executed on an organizational VPN).
+
+The default order of credential strings defaults to:
+
+....
+API_KEY
+USERNAME
+ORGANIZATION
+....
+
+However, this format can be customized using <<conf_ppty_cred_key_line>>, <<conf_ppty_cred_user_line>>, and <<conf_ppty_cred_org_line>>.
+
+Note that each of these lines can be overridden with an environment variable: <<conf_ppty_origin_auth_key_env>>, <<conf_ppty_origin_auth_user_env>>, and <<conf_ppty_origin_auth_org_env>>.
+
+[IMPORTANT]
+This file should probably be added to `.gitignore` in your application repo.
+
+
+[horizontal]
+type;; URI
+default;;
++
+`+++RELEASEHX_API_CRED+++`
+path;; `xref:conf_ppty_origin_auth_cred_uri[config.origin.auth.cred_uri]`
+--
+
+[[conf_ppty_origin_auth_cred_key_line,config.origin.auth.cred_key_line]]
+origin.auth.cred_key_line::::
++
+--
+Number of the line of the credentials file (at <<conf_ppty_origin_auth_cred_uri>>) on which the key or token string appears.
+
+
+[horizontal]
+type;; Number
+default;;
++
+`+++1+++`
+path;; `xref:conf_ppty_origin_auth_cred_key_line[config.origin.auth.cred_key_line]`
+--
+
+[[conf_ppty_origin_auth_cred_user_line,config.origin.auth.cred_user_line]]
+origin.auth.cred_user_line::::
++
+--
+Number of the line of the credentials file (at <<conf_ppty_origin_auth_cred_uri>>) on which the user string appears.
+
+
+[horizontal]
+type;; Number
+default;;
++
+`+++2+++`
+path;; `xref:conf_ppty_origin_auth_cred_user_line[config.origin.auth.cred_user_line]`
+--
+
+[[conf_ppty_origin_auth_cred_org_line,config.origin.auth.cred_org_line]]
+origin.auth.cred_org_line::::
++
+--
+Number of the line of the credentials file (at <<conf_ppty_origin_auth_cred_uri>>) on which the org string appears.
+
+
+[horizontal]
+type;; Number
+default;;
++
+`+++3+++`
+path;; `xref:conf_ppty_origin_auth_cred_org_line[config.origin.auth.cred_org_line]`
+--
+
+[[conf_ppty_origin_auth_key_env,config.origin.auth.key_env]]
+origin.auth.key_env::::
++
+--
+Name of the environment variable containing the API key or token.
+Will override the key line in an existing credentials file (see <<conf_ppty_origin_auth_cred_uri>>).
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++RELEASEHX_API_KEY+++`
+path;; `xref:conf_ppty_origin_auth_key_env[config.origin.auth.key_env]`
+--
+
+[[conf_ppty_origin_auth_user_env,config.origin.auth.user_env]]
+origin.auth.user_env::::
++
+--
+Name of the environment variable containing the API username.
+Will override the user line in an existing credentials file (see <<conf_ppty_origin_auth_cred_uri>>).
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++RELEASEHX_API_USER+++`
+path;; `xref:conf_ppty_origin_auth_user_env[config.origin.auth.user_env]`
+--
+
+[[conf_ppty_origin_auth_org_env,config.origin.auth.org_env]]
+origin.auth.org_env::::
++
+--
+Name of the environment variable containing the organization credential.
+Will override the org line in an existing credentials file (see <<conf_ppty_origin_auth_cred_uri>>).
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++RELEASEHX_API_ORG+++`
+path;; `xref:conf_ppty_origin_auth_org_env[config.origin.auth.org_env]`
+--
+
+[[conf_ppty_conversions,config.conversions]]
+conversions::
++
+--
+Details about content origination, as well as markup sources and conversion.
+Used to assist mapping between API source payloads and the corresponding properties of their target RHYML _change_ records.
+
+
+[horizontal]
+path;; `xref:conf_ppty_conversions[config.conversions]`
+--
+
+[[conf_ppty_conversions_summ,config.conversions.summ]]
+conversions.summ:::
++
+--
+The source of the summary (Changelog) content.
+Must be `issue_heading`, `custom_field`, or `commit_message_heading`.
+
+If `issue_heading`, the summary or title field will be used.
+If `commit_message_heading`, the first line of the Git commit will be used.
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++issue+++`
+path;; `xref:conf_ppty_conversions_summ[config.conversions.summ]`
+--
+
+[[conf_ppty_conversions_head,config.conversions.head]]
+conversions.head:::
++
+--
+The source of release-note headlines, when it is not the same as the summary.
+
+Unless a `head` is available in the RHYML source, the `summ` will be used.
+By default, ReleaseHx does not generate a `head` property for work items.
+
+Potential values: `issue_heading`, `release_note_heading`, or `commit_message_heading`.
+
+When set to *`issue_heading`*, the RHYML `head` property will derive from the issue title or summary.
+
+When set to *`release_note_heading`* or *`commit_message_heading`*, the `head` property will derive from the first line of the release note or commit message, respectively, so long as it matches the Regular Expression set in `ppty.release_note_heading_pattern`.
+When set to `commit_message_heading`, the RHYML `head` property will derive from the first line of the commit message.
+
+
+[horizontal]
+type;; String
+path;; `xref:conf_ppty_conversions_head[config.conversions.head]`
+--
+
+[[conf_ppty_conversions_note,config.conversions.note]]
+conversions.note:::
++
+--
+The source of the release notes content.
+Must be `issue_body`, `custom_field`, or `commit_message`.
+
+Defaults to `issue_body` for GitHub and GitLab, but to `custom_field` for Jira.
+
+
+[horizontal]
+type;; String
+path;; `xref:conf_ppty_conversions_note[config.conversions.note]`
+--
+
+[[conf_ppty_conversions_note_custom_field,config.conversions.note_custom_field]]
+conversions.note_custom_field:::
++
+--
+The name of the custom field to use for the release notes content.
+Only used if `conversions.note` is `custom_field`.
+
+This purposely has no default, as you will probably have to look up the actual field ID, which will be something like `customfield_10010`.
+
+
+[horizontal]
+type;; String
+path;; `xref:conf_ppty_conversions_note_custom_field[config.conversions.note_custom_field]`
+--
+
+[[conf_ppty_conversions_note_pattern,config.conversions.note_pattern]]
+conversions.note_pattern:::
++
+--
+The Regular Expressions pattern to match in the body of an issue or commit message, after which all content is considered the release `note` matter.
+
+Defaults to a Markdown or AsciiDoc header or HTML comment with the case-insensitive string `release note` in it.
+
+Uses Capture group `note` in the Regular Expression to establish the entire note content.
+
+See the `conversions.head_pattern` property for details on extracting a heading (`head` in RHYML) from the `note` content.
+
+
+[horizontal]
+type;; RegExp
+default;;
++
+....
+/^((#|=)+ (Draft )?Release Note.*)|(<!-- (draft )?release note -->)\n(?<note>\w(.|\n)+)/gmi
+....
+path;; `xref:conf_ppty_conversions_note_pattern[config.conversions.note_pattern]`
+--
+
+[[conf_ppty_conversions_head_pattern,config.conversions.head_pattern]]
+conversions.head_pattern:::
++
+--
+The Regular Expressions pattern to match in the `note` text to be used to establish a heading for the note (`head`).
+This text is removed from the `note` value during a draft operation, if the pattern matches.
+
+Defaults to a Markdown or AsciiDoc header or HTML comment with the case-insensitive string `release note` in it.
+
+The `head` capture group is snipped from text matching this pattern.
+
+
+[horizontal]
+type;; RegExp
+default;;
++
+....
+/^(?<head>[A-Z].*[^.!])\n\n[A-Z].*/gm
+....
+path;; `xref:conf_ppty_conversions_head_pattern[config.conversions.head_pattern]`
+--
+
+[[conf_ppty_conversions_markup,config.conversions.markup]]
+conversions.markup:::
++
+--
+The origin markup format for notes.
+May be `markdown` or `asciidoc`.
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++markdown+++`
+path;; `xref:conf_ppty_conversions_markup[config.conversions.markup]`
+--
+
+[[conf_ppty_conversions_engine,config.conversions.engine]]
+conversions.engine:::
++
+--
+The markup converter to use for the issues.
+Defaults to `asciidoctor` for AsciiDoc and `redcarpet` for Markdown.
+Options include `asciidoctor`, `redcarpet`, `commonmarker`, `kramdown`, or `pandoc`.
+
+
+[horizontal]
+type;; String
+path;; `xref:conf_ppty_conversions_engine[config.conversions.engine]`
+--
+
+[[conf_ppty_extensions,config.extensions]]
+extensions::
++
+--
+Default file extensions.
+
+[horizontal]
+path;; `xref:conf_ppty_extensions[config.extensions]`
+--
+
+[[conf_ppty_extensions_markdown,config.extensions.markdown]]
+extensions.markdown:::
++
+--
+File extension for Markdown drafts.
+
+[horizontal]
+type;; String
+default;;
++
+`+++md+++`
+path;; `xref:conf_ppty_extensions_markdown[config.extensions.markdown]`
+--
+
+[[conf_ppty_extensions_asciidoc,config.extensions.asciidoc]]
+extensions.asciidoc:::
++
+--
+File extension for AsciiDoc drafts.
+
+[horizontal]
+type;; String
+default;;
++
+`+++adoc+++`
+path;; `xref:conf_ppty_extensions_asciidoc[config.extensions.asciidoc]`
+--
+
+[[conf_ppty_extensions_yaml,config.extensions.yaml]]
+extensions.yaml:::
++
+--
+File extension for YAML drafts.
+
+[horizontal]
+type;; String
+default;;
++
+`+++yml+++`
+path;; `xref:conf_ppty_extensions_yaml[config.extensions.yaml]`
+--
+
+[[conf_ppty_types,config.types]]
+types::
++
+--
+Issue types to include in the release history, in the order of display.
+
+List as many as you wish to match up with corresponding metadata at the source.
+
+
+[horizontal]
+type;; Map
+path;; `xref:conf_ppty_types[config.types]`
+--
+
+[[conf_ppty_types_label_prefix,config.types.label_prefix]]
+types.label_prefix:::
++
+--
+The prefix used in issue labels to identify type labels.
+For example, 'type:' would match labels like 'type:feature', 'type:bug'.
+Another common pattern is 'kind:' for labels like 'kind:feature', 'kind:enhancement'.
+
+If set to an empty string or null, type detection will only look for direct label matches
+against the configured type slugs (e.g., looking for 'bug', 'feature' labels directly).
+
+This setting allows you to customize how your organization names type labels.
+The mapping system will look for labels that start with this prefix to determine the type of each change.
+
+Examples:
+
+* `type:` matches `type:feature`, `type:bug`
+* `kind:` matches `kind:enhancement`, `kind:defect` 
+* `category-` matches `category-feature`, `category-bugfix`
+
+When no prefix is configured (empty string), the system will look for labels that directly match
+the `slug` property of each configured type.
+
+
+[horizontal]
+type;; String
+default;;
++
+`++++++`
+path;; `xref:conf_ppty_types_label_prefix[config.types.label_prefix]`
+--
+
+[[conf_ppty_types_feature,config.types.feature]]
+types.feature:::
++
+--
+A new capability, functionality, or interface element.
+
+
+[horizontal]
+path;; `xref:conf_ppty_types_feature[config.types.feature]`
+--
+
+[[conf_ppty_types_feature_slug,config.types.feature.slug]]
+types.feature.slug::::
++
+--
+The literal string used in the Issues system for tagging or labeling an issue to be handled, if different than the key name.
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++feature+++`
+path;; `xref:conf_ppty_types_feature_slug[config.types.feature.slug]`
+--
+
+[[conf_ppty_types_feature_text,config.types.feature.text]]
+types.feature.text::::
++
+--
+The display label for the type in the release history output.
+Defaults to the capitalized key name.
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++New feature+++`
+path;; `xref:conf_ppty_types_feature_text[config.types.feature.text]`
+--
+
+[[conf_ppty_types_feature_head,config.types.feature.head]]
+types.feature.head::::
++
+--
+The header for the type in the release history output.
+Defaults in templates to the `text` property pluralized.
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++New features+++`
+path;; `xref:conf_ppty_types_feature_head[config.types.feature.head]`
+--
+
+[[conf_ppty_types_feature_icon,config.types.feature.icon]]
+types.feature.icon::::
++
+--
+The icon to use for issues of this type.
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++plus-square-o+++`
+path;; `xref:conf_ppty_types_feature_icon[config.types.feature.icon]`
+--
+
+[[conf_ppty_types_bug,config.types.bug]]
+types.bug:::
++
+--
+A fix for a previously reported issue.
+
+
+[horizontal]
+path;; `xref:conf_ppty_types_bug[config.types.bug]`
+--
+
+[[conf_ppty_types_bug_slug,config.types.bug.slug]]
+types.bug.slug::::
++
+--
+The literal string used in the Issues system for tagging or labeling an issue to be handled, if different than the key name.
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++bug+++`
+path;; `xref:conf_ppty_types_bug_slug[config.types.bug.slug]`
+--
+
+[[conf_ppty_types_bug_text,config.types.bug.text]]
+types.bug.text::::
++
+--
+The display label for the type in the release history output.
+Defaults to the capitalized key name.
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++Bug fix+++`
+path;; `xref:conf_ppty_types_bug_text[config.types.bug.text]`
+--
+
+[[conf_ppty_types_bug_head,config.types.bug.head]]
+types.bug.head::::
++
+--
+The header for the type in the release history output.
+Defaults in templates to the `text` property pluralized.
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++Bug fixes+++`
+path;; `xref:conf_ppty_types_bug_head[config.types.bug.head]`
+--
+
+[[conf_ppty_types_bug_icon,config.types.bug.icon]]
+types.bug.icon::::
++
+--
+The icon to use for issues of this type.
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++bug+++`
+path;; `xref:conf_ppty_types_bug_icon[config.types.bug.icon]`
+--
+
+[[conf_ppty_types_improvement,config.types.improvement]]
+types.improvement:::
++
+--
+An enhancement to an existing capability, functionality, or interface element.
+
+
+[horizontal]
+path;; `xref:conf_ppty_types_improvement[config.types.improvement]`
+--
+
+[[conf_ppty_types_improvement_slug,config.types.improvement.slug]]
+types.improvement.slug::::
++
+--
+The literal string used in the Issues system for tagging or labeling an issue to be handled, if different than the key name.
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++improvement+++`
+path;; `xref:conf_ppty_types_improvement_slug[config.types.improvement.slug]`
+--
+
+[[conf_ppty_types_improvement_text,config.types.improvement.text]]
+types.improvement.text::::
++
+--
+The display label for the type in the release history output.
+Defaults to the capitalized key name.
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++Improvement+++`
+path;; `xref:conf_ppty_types_improvement_text[config.types.improvement.text]`
+--
+
+[[conf_ppty_types_improvement_head,config.types.improvement.head]]
+types.improvement.head::::
++
+--
+The header for the type in the release history output.
+Defaults in templates to the `text` property pluralized.
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++Improvements+++`
+path;; `xref:conf_ppty_types_improvement_head[config.types.improvement.head]`
+--
+
+[[conf_ppty_types_improvement_icon,config.types.improvement.icon]]
+types.improvement.icon::::
++
+--
+The icon to use for issues of this type.
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++wrench+++`
+path;; `xref:conf_ppty_types_improvement_icon[config.types.improvement.icon]`
+--
+
+[[conf_ppty_types_documentation,config.types.documentation]]
+types.documentation:::
++
+--
+An update to the documentation.
+
+
+[horizontal]
+path;; `xref:conf_ppty_types_documentation[config.types.documentation]`
+--
+
+[[conf_ppty_types_documentation_slug,config.types.documentation.slug]]
+types.documentation.slug::::
++
+--
+The literal string used in the Issues system for tagging or labeling an issue to be handled, if different than the key name.
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++documentation+++`
+path;; `xref:conf_ppty_types_documentation_slug[config.types.documentation.slug]`
+--
+
+[[conf_ppty_types_documentation_text,config.types.documentation.text]]
+types.documentation.text::::
++
+--
+The display label for the type in the release history output.
+Defaults to the capitalized key name.
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++Documentation+++`
+path;; `xref:conf_ppty_types_documentation_text[config.types.documentation.text]`
+--
+
+[[conf_ppty_types_documentation_head,config.types.documentation.head]]
+types.documentation.head::::
++
+--
+The header for the type in the release history output.
+Defaults in templates to the `text` property pluralized.
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++Docs Changes+++`
+path;; `xref:conf_ppty_types_documentation_head[config.types.documentation.head]`
+--
+
+[[conf_ppty_types_documentation_icon,config.types.documentation.icon]]
+types.documentation.icon::::
++
+--
+The icon to use for issues of this type.
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++book+++`
+path;; `xref:conf_ppty_types_documentation_icon[config.types.documentation.icon]`
+--
+
+[[conf_ppty_types__type_name_,config.types.<type_name>]]
+types.<type_name>:::
++
+--
+The corresponding issue type.
+
+The key should be a simple string for referencing the slug in RHYML and ReleaseHx templates.
+This is what will be entered in a change's `type` property in RHYML.
+
+
+[horizontal]
+path;; `xref:conf_ppty_types__type_name_[config.types.<type_name>]`
+--
+
+[[conf_ppty_types__type_name__slug,config.types.<type_name>.slug]]
+types.<type_name>.slug::::
++
+--
+The literal string used in the Issues system for tagging or labeling an issue to be handled, if different than the key name.
+
+
+[horizontal]
+type;; String
+path;; `xref:conf_ppty_types__type_name__slug[config.types.<type_name>.slug]`
+--
+
+[[conf_ppty_types__type_name__text,config.types.<type_name>.text]]
+types.<type_name>.text::::
++
+--
+The display label for the type in the release history output.
+Defaults to the capitalized key name.
+
+
+[horizontal]
+type;; String
+path;; `xref:conf_ppty_types__type_name__text[config.types.<type_name>.text]`
+--
+
+[[conf_ppty_types__type_name__head,config.types.<type_name>.head]]
+types.<type_name>.head::::
++
+--
+The header for the type in the release history output.
+Defaults in templates to the `text` property pluralized.
+
+
+[horizontal]
+type;; String
+path;; `xref:conf_ppty_types__type_name__head[config.types.<type_name>.head]`
+--
+
+[[conf_ppty_types__type_name__icon,config.types.<type_name>.icon]]
+types.<type_name>.icon::::
++
+--
+The icon to use for issues of this type.
+
+
+[horizontal]
+type;; String
+path;; `xref:conf_ppty_types__type_name__icon[config.types.<type_name>.icon]`
+--
+
+[[conf_ppty_parts,config.parts]]
+parts::
++
+--
+The map of product components to include in the release history, in the order of display.
+
+List as many as you wish to match up with corresponding metadata at the source.
+
+
+[horizontal]
+type;; Map
+path;; `xref:conf_ppty_parts[config.parts]`
+--
+
+[[conf_ppty_parts_label_prefix,config.parts.label_prefix]]
+parts.label_prefix:::
++
+--
+The prefix used in issue labels to identify component/part labels.
+For example, 'part:' would match labels like 'part:frontend', 'part:backend'.
+Another common pattern is 'component:' for labels like 'component:ui', 'component:api'.
+
+This setting allows you to customize how your organization names component labels.
+The mapping system will look for labels that start with this prefix to determine which parts/components are affected by each change.
+
+Examples:
+
+* `part:` matches `part:frontend`, `part:backend`
+* `component:` matches `component:ui`, `component:api`
+* `area-` matches `area-security`, `area-performance`
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++part:+++`
+path;; `xref:conf_ppty_parts_label_prefix[config.parts.label_prefix]`
+--
+
+[[conf_ppty_parts__part_name_,config.parts.<part_name>]]
+parts.<part_name>:::
++
+--
+The corresponding product component.
+
+The key should be a simple string for referencing the slug in RHYML and ReleaseHx templates.
+This is what will be entered in a change's `part` property in RHYML.
+
+
+[horizontal]
+type;; Map
+path;; `xref:conf_ppty_parts__part_name_[config.parts.<part_name>]`
+--
+
+[[conf_ppty_parts__part_name__slug,config.parts.<part_name>.slug]]
+parts.<part_name>.slug::::
++
+--
+The literal string used in the Issues system for tagging or labeling an issue to be handled, if different than the key name.
+
+[NOTE]
+This technically does not have to be a "`Slug`" String, if the system permits spaces, colons, etc.
+It just needs to _exactly_ match whatever String the remote API returns to represent the label/tag.
+
+
+[horizontal]
+type;; String
+path;; `xref:conf_ppty_parts__part_name__slug[config.parts.<part_name>.slug]`
+--
+
+[[conf_ppty_parts__part_name__text,config.parts.<part_name>.text]]
+parts.<part_name>.text::::
++
+--
+The display text for the component in the release history output.
+Defaults to the capitalized key name.
+
+
+[horizontal]
+type;; String
+path;; `xref:conf_ppty_parts__part_name__text[config.parts.<part_name>.text]`
+--
+
+[[conf_ppty_parts__part_name__head,config.parts.<part_name>.head]]
+parts.<part_name>.head::::
++
+--
+The header for the component in the release history output.
+Defaults in templates to the `text` property pluralized.
+
+
+[horizontal]
+type;; String
+path;; `xref:conf_ppty_parts__part_name__head[config.parts.<part_name>.head]`
+--
+
+[[conf_ppty_parts__part_name__icon,config.parts.<part_name>.icon]]
+parts.<part_name>.icon::::
++
+--
+The icon to use for issues that affect this component.
+
+
+[horizontal]
+type;; String
+path;; `xref:conf_ppty_parts__part_name__icon[config.parts.<part_name>.icon]`
+--
+
+[[conf_ppty_tags,config.tags]]
+tags::
++
+--
+Handling for tags, labels, or toggles associated with source Issues.
+
+Subordinate property keys (other than `include` and `exclude`) represent individual tag names, with the default set documented here.
+The property `<your_tag_name>` represents arbitrarily named tags, any number of which you are welcome to add.
+
+This block serves to filter out any unrelated labels/tags ingested from APIs during the conversion from payload to RHYML draft.
+Only tags with their own property here will be ported from the issue source to the RHYML change record's `tags` Array.
+
+
+[horizontal]
+type;; Array
+path;; `xref:conf_ppty_tags[config.tags]`
+--
+
+[[conf_ppty_tags__include,config.tags._include]]
+tags._include:::
++
+--
+The tags, labels, or toggles that trigger inclusion in the release history.
+
+
+[horizontal]
+type;; Array
+default;;
++
+....
+- highlight
+- deprecation
+- removal
+- breaking
+- experimental
+- changelog
+....
+path;; `xref:conf_ppty_tags__include[config.tags._include]`
+--
+
+[[conf_ppty_tags__exclude,config.tags._exclude]]
+tags._exclude:::
++
+--
+The list of tags that cause a change/issue to be excluded from the release history.
+
+
+[horizontal]
+type;; Array
+default;;
++
+`++++++`
+path;; `xref:conf_ppty_tags__exclude[config.tags._exclude]`
+--
+
+[[conf_ppty_tags_highlight,config.tags.highlight]]
+tags.highlight:::
++
+--
+The tag, label, or toggle that indicates an issue is to be highlighted or prioritized in sorts.
+
+[horizontal]
+path;; `xref:conf_ppty_tags_highlight[config.tags.highlight]`
+--
+
+[[conf_ppty_tags_highlight_head,config.tags.highlight.head]]
+tags.highlight.head::::
++
+--
+How this tag will display as a grouping title.
+
+[horizontal]
+type;; String
+default;;
++
+`+++Highlights+++`
+path;; `xref:conf_ppty_tags_highlight_head[config.tags.highlight.head]`
+--
+
+[[conf_ppty_tags_highlight_text,config.tags.highlight.text]]
+tags.highlight.text::::
++
+--
+How this tag will display as a label.
+
+[horizontal]
+type;; String
+default;;
++
+`+++highlight+++`
+path;; `xref:conf_ppty_tags_highlight_text[config.tags.highlight.text]`
+--
+
+[[conf_ppty_tags_highlight_slug,config.tags.highlight.slug]]
+tags.highlight.slug::::
++
+--
+The literal string used in the Issues system for tagging or labeling an issue to be handled, if different than the key name.
+
+[NOTE]
+This technically does not have to be a "`Slug`" String, if the system permits spaces.
+It just needs to exactly match whatever String the remote API returns to represent the label/tag.
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++highlighted+++`
+path;; `xref:conf_ppty_tags_highlight_slug[config.tags.highlight.slug]`
+--
+
+[[conf_ppty_tags_highlight_icon,config.tags.highlight.icon]]
+tags.highlight.icon::::
++
+--
+The icon to use for issues so-tagged.
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++star+++`
+path;; `xref:conf_ppty_tags_highlight_icon[config.tags.highlight.icon]`
+--
+
+[[conf_ppty_tags_highlight_drop,config.tags.highlight.drop]]
+tags.highlight.drop::::
++
+--
+Whether to drop this tag when creating a RHYML object from API source.
+Basically decides whether this tag is user-facing.
+
+
+[horizontal]
+type;; Boolean
+default;;
++
+`+++false+++`
+path;; `xref:conf_ppty_tags_highlight_drop[config.tags.highlight.drop]`
+--
+
+[[conf_ppty_tags_highlight_groupable,config.tags.highlight.groupable]]
+tags.highlight.groupable::::
++
+--
+Whether this tag can be used to group issues in the release history.
+
+
+[horizontal]
+type;; Boolean
+default;;
++
+`+++true+++`
+path;; `xref:conf_ppty_tags_highlight_groupable[config.tags.highlight.groupable]`
+--
+
+[[conf_ppty_tags_breaking,config.tags.breaking]]
+tags.breaking:::
++
+--
+The tag, label, or toggle that indicates a potentially disruptive change.
+
+[horizontal]
+path;; `xref:conf_ppty_tags_breaking[config.tags.breaking]`
+--
+
+[[conf_ppty_tags_breaking_head,config.tags.breaking.head]]
+tags.breaking.head::::
++
+--
+How this tag will display as a grouping title.
+
+[horizontal]
+type;; String
+default;;
++
+`+++Breaking Changes+++`
+path;; `xref:conf_ppty_tags_breaking_head[config.tags.breaking.head]`
+--
+
+[[conf_ppty_tags_breaking_text,config.tags.breaking.text]]
+tags.breaking.text::::
++
+--
+How this tag will display as a label.
+
+[horizontal]
+type;; String
+default;;
++
+`+++Breaking+++`
+path;; `xref:conf_ppty_tags_breaking_text[config.tags.breaking.text]`
+--
+
+[[conf_ppty_tags_breaking_slug,config.tags.breaking.slug]]
+tags.breaking.slug::::
++
+--
+The literal string used in the Issues system for tagging or labeling an issue to be handled, if different than the key name.
+
+[NOTE]
+This technically does not have to be a "`Slug`" String, if the system permits spaces.
+It just needs to exactly match whatever String the remote API returns to represent the label/tag.
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++breaking+++`
+path;; `xref:conf_ppty_tags_breaking_slug[config.tags.breaking.slug]`
+--
+
+[[conf_ppty_tags_breaking_icon,config.tags.breaking.icon]]
+tags.breaking.icon::::
++
+--
+The icon to use for issues so-tagged.
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++exclamation-triangle+++`
+path;; `xref:conf_ppty_tags_breaking_icon[config.tags.breaking.icon]`
+--
+
+[[conf_ppty_tags_breaking_drop,config.tags.breaking.drop]]
+tags.breaking.drop::::
++
+--
+Whether to drop this tag when creating a RHYML object from API source.
+Basically decides whether this tag is user-facing.
+
+
+[horizontal]
+type;; Boolean
+default;;
++
+`+++false+++`
+path;; `xref:conf_ppty_tags_breaking_drop[config.tags.breaking.drop]`
+--
+
+[[conf_ppty_tags_breaking_groupable,config.tags.breaking.groupable]]
+tags.breaking.groupable::::
++
+--
+Whether this tag can be used to group issues in the release history.
+
+
+[horizontal]
+type;; Boolean
+default;;
++
+`+++true+++`
+path;; `xref:conf_ppty_tags_breaking_groupable[config.tags.breaking.groupable]`
+--
+
+[[conf_ppty_tags_removal,config.tags.removal]]
+tags.removal:::
++
+--
+The tag, label, or toggle that indicates a change includes a feature removal.
+
+[horizontal]
+path;; `xref:conf_ppty_tags_removal[config.tags.removal]`
+--
+
+[[conf_ppty_tags_removal_head,config.tags.removal.head]]
+tags.removal.head::::
++
+--
+How this tag will display as a grouping title.
+
+[horizontal]
+type;; String
+default;;
++
+`+++Feature Removals+++`
+path;; `xref:conf_ppty_tags_removal_head[config.tags.removal.head]`
+--
+
+[[conf_ppty_tags_removal_text,config.tags.removal.text]]
+tags.removal.text::::
++
+--
+How this tag will display as a label.
+
+[horizontal]
+type;; String
+default;;
++
+`+++Removed+++`
+path;; `xref:conf_ppty_tags_removal_text[config.tags.removal.text]`
+--
+
+[[conf_ppty_tags_removal_slug,config.tags.removal.slug]]
+tags.removal.slug::::
++
+--
+The literal string used in the Issues system for tagging or labeling an issue to be handled, if different than the key name.
+
+[NOTE]
+This technically does not have to be a "`Slug`" String, if the system permits spaces.
+It just needs to exactly match whatever String the remote API returns to represent the label/tag.
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++removal+++`
+path;; `xref:conf_ppty_tags_removal_slug[config.tags.removal.slug]`
+--
+
+[[conf_ppty_tags_removal_icon,config.tags.removal.icon]]
+tags.removal.icon::::
++
+--
+The icon to use for issues so-tagged.
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++sign-out+++`
+path;; `xref:conf_ppty_tags_removal_icon[config.tags.removal.icon]`
+--
+
+[[conf_ppty_tags_removal_drop,config.tags.removal.drop]]
+tags.removal.drop::::
++
+--
+Whether to drop this tag when creating a RHYML object from API source.
+Basically decides whether this tag is user-facing.
+
+
+[horizontal]
+type;; Boolean
+default;;
++
+`+++false+++`
+path;; `xref:conf_ppty_tags_removal_drop[config.tags.removal.drop]`
+--
+
+[[conf_ppty_tags_removal_groupable,config.tags.removal.groupable]]
+tags.removal.groupable::::
++
+--
+Whether this tag can be used to group issues in the release history.
+
+
+[horizontal]
+type;; Boolean
+default;;
++
+`+++true+++`
+path;; `xref:conf_ppty_tags_removal_groupable[config.tags.removal.groupable]`
+--
+
+[[conf_ppty_tags_deprecation,config.tags.deprecation]]
+tags.deprecation:::
++
+--
+The tag, label, or toggle that indicates an issue includes a feature discontinuation announcement.
+
+[horizontal]
+path;; `xref:conf_ppty_tags_deprecation[config.tags.deprecation]`
+--
+
+[[conf_ppty_tags_deprecation_head,config.tags.deprecation.head]]
+tags.deprecation.head::::
++
+--
+How this tag will display as a grouping title.
+
+[horizontal]
+type;; String
+default;;
++
+`+++Deprecations+++`
+path;; `xref:conf_ppty_tags_deprecation_head[config.tags.deprecation.head]`
+--
+
+[[conf_ppty_tags_deprecation_text,config.tags.deprecation.text]]
+tags.deprecation.text::::
++
+--
+How this tag will display as a label.
+
+[horizontal]
+type;; String
+default;;
++
+`+++Deprecated+++`
+path;; `xref:conf_ppty_tags_deprecation_text[config.tags.deprecation.text]`
+--
+
+[[conf_ppty_tags_deprecation_slug,config.tags.deprecation.slug]]
+tags.deprecation.slug::::
++
+--
+The literal string used in the Issues system for tagging or labeling an issue to be handled, if different than the key name.
+
+[NOTE]
+This technically does not have to be a "`Slug`" String, if the system permits spaces.
+It just needs to exactly match whatever String the remote API returns to represent the label/tag.
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++deprecation+++`
+path;; `xref:conf_ppty_tags_deprecation_slug[config.tags.deprecation.slug]`
+--
+
+[[conf_ppty_tags_deprecation_icon,config.tags.deprecation.icon]]
+tags.deprecation.icon::::
++
+--
+The icon to use for issues so-tagged.
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++exclamation-triangle+++`
+path;; `xref:conf_ppty_tags_deprecation_icon[config.tags.deprecation.icon]`
+--
+
+[[conf_ppty_tags_deprecation_drop,config.tags.deprecation.drop]]
+tags.deprecation.drop::::
++
+--
+Whether to drop this tag when creating a RHYML object from API source.
+Basically decides whether this tag is user-facing.
+
+
+[horizontal]
+type;; Boolean
+default;;
++
+`+++false+++`
+path;; `xref:conf_ppty_tags_deprecation_drop[config.tags.deprecation.drop]`
+--
+
+[[conf_ppty_tags_deprecation_groupable,config.tags.deprecation.groupable]]
+tags.deprecation.groupable::::
++
+--
+Whether this tag can be used to group issues in the release history.
+
+
+[horizontal]
+type;; Boolean
+default;;
++
+`+++true+++`
+path;; `xref:conf_ppty_tags_deprecation_groupable[config.tags.deprecation.groupable]`
+--
+
+[[conf_ppty_tags_security,config.tags.security]]
+tags.security:::
++
+--
+The tag, label, or toggle that indicates a change includes a security-related alteration.
+
+
+[horizontal]
+path;; `xref:conf_ppty_tags_security[config.tags.security]`
+--
+
+[[conf_ppty_tags_security_head,config.tags.security.head]]
+tags.security.head::::
++
+--
+How this tag will display as a grouping title.
+
+[horizontal]
+type;; String
+default;;
++
+`+++Security Fixes+++`
+path;; `xref:conf_ppty_tags_security_head[config.tags.security.head]`
+--
+
+[[conf_ppty_tags_security_text,config.tags.security.text]]
+tags.security.text::::
++
+--
+How this tag will display as a label.
+
+[horizontal]
+type;; String
+default;;
++
+`+++Security+++`
+path;; `xref:conf_ppty_tags_security_text[config.tags.security.text]`
+--
+
+[[conf_ppty_tags_security_slug,config.tags.security.slug]]
+tags.security.slug::::
++
+--
+The literal string used in the Issues system for tagging or labeling an issue to be handled, if different than the key name.
+
+[NOTE]
+This technically does not have to be a "`Slug`" String, if the system permits spaces.
+It just needs to exactly match whatever String the remote API returns to represent the label/tag.
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++security+++`
+path;; `xref:conf_ppty_tags_security_slug[config.tags.security.slug]`
+--
+
+[[conf_ppty_tags_security_icon,config.tags.security.icon]]
+tags.security.icon::::
++
+--
+The icon to use for issues so-tagged.
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++shield+++`
+path;; `xref:conf_ppty_tags_security_icon[config.tags.security.icon]`
+--
+
+[[conf_ppty_tags_security_drop,config.tags.security.drop]]
+tags.security.drop::::
++
+--
+Whether to drop this tag when creating a RHYML object from API source.
+Basically decides whether this tag is user-facing.
+
+
+[horizontal]
+type;; Boolean
+default;;
++
+`+++false+++`
+path;; `xref:conf_ppty_tags_security_drop[config.tags.security.drop]`
+--
+
+[[conf_ppty_tags_security_groupable,config.tags.security.groupable]]
+tags.security.groupable::::
++
+--
+Whether this tag can be used to group issues in the release history.
+
+
+[horizontal]
+type;; Boolean
+default;;
++
+`+++true+++`
+path;; `xref:conf_ppty_tags_security_groupable[config.tags.security.groupable]`
+--
+
+[[conf_ppty_tags_experimental,config.tags.experimental]]
+tags.experimental:::
++
+--
+The tag, label, or toggle that indicates a feature that is not yet stable or may not be permanent.
+
+[horizontal]
+path;; `xref:conf_ppty_tags_experimental[config.tags.experimental]`
+--
+
+[[conf_ppty_tags_experimental_head,config.tags.experimental.head]]
+tags.experimental.head::::
++
+--
+How this tag will display as a grouping title.
+
+[horizontal]
+type;; String
+default;;
++
+....
+Experimental Features
+....
+path;; `xref:conf_ppty_tags_experimental_head[config.tags.experimental.head]`
+--
+
+[[conf_ppty_tags_experimental_text,config.tags.experimental.text]]
+tags.experimental.text::::
++
+--
+How this tag will display as a label.
+
+[horizontal]
+type;; String
+default;;
++
+`+++Experimental+++`
+path;; `xref:conf_ppty_tags_experimental_text[config.tags.experimental.text]`
+--
+
+[[conf_ppty_tags_experimental_slug,config.tags.experimental.slug]]
+tags.experimental.slug::::
++
+--
+The literal string used in the Issues system for tagging or labeling an issue to be handled, if different than the key name.
+
+[NOTE]
+This technically does not have to be a "`Slug`" String, if the system permits spaces.
+It just needs to exactly match whatever String the remote API returns to represent the label/tag.
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++experimental+++`
+path;; `xref:conf_ppty_tags_experimental_slug[config.tags.experimental.slug]`
+--
+
+[[conf_ppty_tags_experimental_icon,config.tags.experimental.icon]]
+tags.experimental.icon::::
++
+--
+The icon to use for issues so-tagged.
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++flask+++`
+path;; `xref:conf_ppty_tags_experimental_icon[config.tags.experimental.icon]`
+--
+
+[[conf_ppty_tags_experimental_drop,config.tags.experimental.drop]]
+tags.experimental.drop::::
++
+--
+Whether to drop this tag when creating a RHYML object from API source.
+Basically decides whether this tag is user-facing.
+
+
+[horizontal]
+type;; Boolean
+default;;
++
+`+++false+++`
+path;; `xref:conf_ppty_tags_experimental_drop[config.tags.experimental.drop]`
+--
+
+[[conf_ppty_tags_experimental_groupable,config.tags.experimental.groupable]]
+tags.experimental.groupable::::
++
+--
+Whether this tag can be used to group issues in the release history.
+
+
+[horizontal]
+type;; Boolean
+default;;
++
+`+++true+++`
+path;; `xref:conf_ppty_tags_experimental_groupable[config.tags.experimental.groupable]`
+--
+
+[[conf_ppty_tags_internal,config.tags.internal]]
+tags.internal:::
++
+--
+The tag, label, or toggle that indicates an issue documents a feature that is not intended for "`public`" use or visibility.
+
+[horizontal]
+path;; `xref:conf_ppty_tags_internal[config.tags.internal]`
+--
+
+[[conf_ppty_tags_internal_head,config.tags.internal.head]]
+tags.internal.head::::
++
+--
+How this tag will display as a grouping title.
+
+[horizontal]
+type;; String
+default;;
++
+`+++Internal Changes+++`
+path;; `xref:conf_ppty_tags_internal_head[config.tags.internal.head]`
+--
+
+[[conf_ppty_tags_internal_text,config.tags.internal.text]]
+tags.internal.text::::
++
+--
+How this tag will display as a label.
+
+[horizontal]
+type;; String
+default;;
++
+`+++Internal+++`
+path;; `xref:conf_ppty_tags_internal_text[config.tags.internal.text]`
+--
+
+[[conf_ppty_tags_internal_slug,config.tags.internal.slug]]
+tags.internal.slug::::
++
+--
+The literal string used in the Issues system for tagging or labeling an issue to be handled, if different than the key name.
+
+[NOTE]
+This technically does not have to be a "`Slug`" String, if the system permits spaces.
+It just needs to exactly match whatever String the remote API returns to represent the label/tag.
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++internal+++`
+path;; `xref:conf_ppty_tags_internal_slug[config.tags.internal.slug]`
+--
+
+[[conf_ppty_tags_internal_icon,config.tags.internal.icon]]
+tags.internal.icon::::
++
+--
+The icon to use for issues so-tagged.
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++lock+++`
+path;; `xref:conf_ppty_tags_internal_icon[config.tags.internal.icon]`
+--
+
+[[conf_ppty_tags_internal_drop,config.tags.internal.drop]]
+tags.internal.drop::::
++
+--
+Whether to drop this tag when creating a RHYML object from API source.
+Basically decides whether this tag is user-facing.
+
+
+[horizontal]
+type;; Boolean
+default;;
++
+`+++false+++`
+path;; `xref:conf_ppty_tags_internal_drop[config.tags.internal.drop]`
+--
+
+[[conf_ppty_tags_internal_groupable,config.tags.internal.groupable]]
+tags.internal.groupable::::
++
+--
+Whether this tag can be used to group issues in the release history.
+
+
+[horizontal]
+type;; Boolean
+default;;
++
+`+++true+++`
+path;; `xref:conf_ppty_tags_internal_groupable[config.tags.internal.groupable]`
+--
+
+[[conf_ppty_tags_changelog,config.tags.changelog]]
+tags.changelog:::
++
+--
+The tag, label, or toggle that indicates an issue should appear in the Changelog even if it does not have a Release Note.
+
+There is no icon associated with changelog-tagged issues, as it is only declaring that an issue belongs in the Changelog.
+
+
+[horizontal]
+path;; `xref:conf_ppty_tags_changelog[config.tags.changelog]`
+--
+
+[[conf_ppty_tags_changelog_slug,config.tags.changelog.slug]]
+tags.changelog.slug::::
++
+--
+The literal string used in the Issues system for tagging or labeling an issue to be handled, if different than the key name.
+
+[NOTE]
+This technically does not have to be a "`Slug`" String, if the system permits spaces.
+It just needs to exactly match whatever String the remote API returns to represent the label/tag.
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++changelog+++`
+path;; `xref:conf_ppty_tags_changelog_slug[config.tags.changelog.slug]`
+--
+
+[[conf_ppty_tags_changelog_drop,config.tags.changelog.drop]]
+tags.changelog.drop::::
++
+--
+Whether to drop this tag when creating a RHYML object from API source.
+Basically decides whether this tag is user-facing.
+
+
+[horizontal]
+type;; Boolean
+default;;
++
+`+++true+++`
+path;; `xref:conf_ppty_tags_changelog_drop[config.tags.changelog.drop]`
+--
+
+[[conf_ppty_tags_changelog_groupable,config.tags.changelog.groupable]]
+tags.changelog.groupable::::
++
+--
+Whether this tag can be used to group issues in the release history.
+
+
+[horizontal]
+type;; Boolean
+default;;
++
+`+++false+++`
+path;; `xref:conf_ppty_tags_changelog_groupable[config.tags.changelog.groupable]`
+--
+
+[[conf_ppty_tags_release_note_needed,config.tags.release_note_needed]]
+tags.release_note_needed:::
++
+--
+The tag, label, or toggle that indicates an issue requires a release note to be written. This is used by the `rhx` CLI to determine which issues are expected to contain release notes when the release-note content is empty.
+This tag can be automatically removed, and it does not show up in published Changelog or Release Notes (unless you add it).
+
+[horizontal]
+path;; `xref:conf_ppty_tags_release_note_needed[config.tags.release_note_needed]`
+--
+
+[[conf_ppty_tags_release_note_needed_slug,config.tags.release_note_needed.slug]]
+tags.release_note_needed.slug::::
++
+--
+The literal string used in the Issues system for tagging or labeling an issue to be handled, if different than the key name.
+
+[NOTE]
+This technically does not have to be a "`Slug`" String, if the system permits spaces.
+It just needs to exactly match whatever String the remote API returns to represent the label/tag.
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++release_note_needed+++`
+path;; `xref:conf_ppty_tags_release_note_needed_slug[config.tags.release_note_needed.slug]`
+--
+
+[[conf_ppty_tags_release_note_needed_drop,config.tags.release_note_needed.drop]]
+tags.release_note_needed.drop::::
++
+--
+Whether to drop this tag when creating a RHYML object from API source.
+Basically decides whether this tag is user-facing.
+
+
+[horizontal]
+type;; Boolean
+default;;
++
+`+++true+++`
+path;; `xref:conf_ppty_tags_release_note_needed_drop[config.tags.release_note_needed.drop]`
+--
+
+[[conf_ppty_tags_release_note_needed_groupable,config.tags.release_note_needed.groupable]]
+tags.release_note_needed.groupable::::
++
+--
+Whether this tag can be used to group issues in the release history.
+
+
+[horizontal]
+type;; Boolean
+default;;
++
+`+++false+++`
+path;; `xref:conf_ppty_tags_release_note_needed_groupable[config.tags.release_note_needed.groupable]`
+--
+
+[[conf_ppty_tags__your_tag_name_,config.tags.<your_tag_name>]]
+tags.<your_tag_name>:::
++
+--
+Unlimited custom tags of your choosing, associated with a tag, label, or toggle in the Issues system _or_ manually assignable in RHYML.
+These property represents any arbitrarily named tags you might wish to add.
+No `slug` sub-property is available because the name of this property should exactly match your tag/label.
+
+
+[horizontal]
+path;; `xref:conf_ppty_tags__your_tag_name_[config.tags.<your_tag_name>]`
+--
+
+[[conf_ppty_tags__your_tag_name__head,config.tags.<your_tag_name>.head]]
+tags.<your_tag_name>.head::::
++
+--
+How this tag will display as a grouping title.
+
+[horizontal]
+type;; String
+path;; `xref:conf_ppty_tags__your_tag_name__head[config.tags.<your_tag_name>.head]`
+--
+
+[[conf_ppty_tags__your_tag_name__text,config.tags.<your_tag_name>.text]]
+tags.<your_tag_name>.text::::
++
+--
+How this tag will display as a label.
+
+[horizontal]
+type;; String
+path;; `xref:conf_ppty_tags__your_tag_name__text[config.tags.<your_tag_name>.text]`
+--
+
+[[conf_ppty_tags__your_tag_name__icon,config.tags.<your_tag_name>.icon]]
+tags.<your_tag_name>.icon::::
++
+--
+The icon to use for issues so-tagged.
+
+
+[horizontal]
+type;; String
+path;; `xref:conf_ppty_tags__your_tag_name__icon[config.tags.<your_tag_name>.icon]`
+--
+
+[[conf_ppty_tags__your_tag_name__drop,config.tags.<your_tag_name>.drop]]
+tags.<your_tag_name>.drop::::
++
+--
+Whether to drop this tag when creating a RHYML object from API source.
+Basically decides whether this tag is user-facing.
+
+
+[horizontal]
+type;; Boolean
+path;; `xref:conf_ppty_tags__your_tag_name__drop[config.tags.<your_tag_name>.drop]`
+--
+
+[[conf_ppty_tags__your_tag_name__groupable,config.tags.<your_tag_name>.groupable]]
+tags.<your_tag_name>.groupable::::
++
+--
+Whether this tag can be used to group issues in the release history.
+
+
+[horizontal]
+type;; Boolean
+path;; `xref:conf_ppty_tags__your_tag_name__groupable[config.tags.<your_tag_name>.groupable]`
+--
+
+[[conf_ppty_links,config.links]]
+links::
++
+--
+Path templates and other metadata for building links to online references like issues (web) and commits (git).
+
+
+[horizontal]
+path;; `xref:conf_ppty_links[config.links]`
+--
+
+[[conf_ppty_links_web,config.links.web]]
+links.web:::
++
+--
+Properties to enable linking to issue-management system ticket URLs corresponding to individual changes.
+
+[horizontal]
+path;; `xref:conf_ppty_links_web[config.links.web]`
+--
+
+[[conf_ppty_links_web_href,config.links.web.href]]
+links.web.href::::
++
+--
+The URL template for the links to the issue-management system ticket URL.
+May include `{{ tick }}` placeholder or any other from the change object.
+
+For example:
+
+* `https://jira.example.com/issues/{{ tick }}`
+* `https://github.com/example/project/issues/{{ tick }}`
+
+Web links must still be enabled in <<conf_ppty_history_items_show_issue_links>>, <<conf_ppty_changelog_items_show_issue_links>>, or <<conf_ppty_notes_items_show_issue_links>> properties.
+
+
+[horizontal]
+type;; Liquid
+path;; `xref:conf_ppty_links_web_href[config.links.web.href]`
+--
+
+[[conf_ppty_links_web_icon,config.links.web.icon]]
+links.web.icon::::
++
+--
+The icon to use for the issue links.
+
+[horizontal]
+type;; String
+default;;
++
+`+++ticket+++`
+path;; `xref:conf_ppty_links_web_icon[config.links.web.icon]`
+--
+
+[[conf_ppty_links_web_text,config.links.web.text]]
+links.web.text::::
++
+--
+The text label to use for the issue links.
+May include placeholders for any variables in the `change` object.
+
+
+[horizontal]
+type;; Liquid
+default;;
++
+`+++{{ tick }}+++`
+path;; `xref:conf_ppty_links_web_text[config.links.web.text]`
+--
+
+[[conf_ppty_links_git,config.links.git]]
+links.git:::
++
+--
+Properties to enable linking to the Git commit URL corresponding to individual changes.
+
+
+[horizontal]
+path;; `xref:conf_ppty_links_git[config.links.git]`
+--
+
+[[conf_ppty_links_git_href,config.links.git.href]]
+links.git.href::::
++
+--
+The URL template for the git links in the release history listings.
+May include `{{ hash }}` placeholder.
+
+For example:
+
+* `https://git.example.com/project/commit/{{ hash }}`
+* `https://github.com/example/project/commit/{{ hash }}`
+
+Git links must still be enabled in <<conf_ppty_history_items_show_git_links>>, <<conf_ppty_changelog_items_show_git_links>>, or <<conf_ppty_notes_items_show_git_links>> properties.
+
+
+[horizontal]
+type;; Liquid
+path;; `xref:conf_ppty_links_git_href[config.links.git.href]`
+--
+
+[[conf_ppty_links_git_icon,config.links.git.icon]]
+links.git.icon::::
++
+--
+The icon to use for the git links.
+
+[horizontal]
+type;; String
+default;;
++
+`+++code-fork+++`
+path;; `xref:conf_ppty_links_git_icon[config.links.git.icon]`
+--
+
+[[conf_ppty_links_git_text,config.links.git.text]]
+links.git.text::::
++
+--
+The text label to use for the git links.
+May include `{{ hash }}` placeholder.
+
+
+[horizontal]
+type;; Liquid
+default;;
++
+....
+{{ hash | slice: 0, 7 }}
+....
+path;; `xref:conf_ppty_links_git_text[config.links.git.text]`
+--
+
+[[conf_ppty_links_user,config.links.user]]
+links.user:::
++
+--
+
+
+[horizontal]
+path;; `xref:conf_ppty_links_user[config.links.user]`
+--
+
+[[conf_ppty_links_user_href,config.links.user.href]]
+links.user.href::::
++
+--
+A template for forming links to bio or homepages for the lead contributor of a change.
+May include `{{ username }}` placeholder.
+
+For example:
+
+* `https://github.com/{{ username }}`
+
+
+[horizontal]
+type;; Template
+templating;; liquid,  delayed rendering
+path;; `xref:conf_ppty_links_user_href[config.links.user.href]`
+--
+
+[[conf_ppty_links_user_icon,config.links.user.icon]]
+links.user.icon::::
++
+--
+The icon to use for the user links.
+
+[horizontal]
+type;; String
+default;;
++
+`+++user+++`
+path;; `xref:conf_ppty_links_user_icon[config.links.user.icon]`
+--
+
+[[conf_ppty_links_user_text,config.links.user.text]]
+links.user.text::::
++
+--
+The text label to use for the user links.
+May include `{{ username }}` placeholder.
+
+
+[horizontal]
+type;; Liquid
+default;;
++
+`+++{{ username }}+++`
+path;; `xref:conf_ppty_links_user_text[config.links.user.text]`
+--
+
+[[conf_ppty_links_get,config.links.get]]
+links.get:::
++
+--
+Properties to enable linking to the download or installation instructions for the release.
+
+
+[horizontal]
+path;; `xref:conf_ppty_links_get[config.links.get]`
+--
+
+[[conf_ppty_links_get_href,config.links.get.href]]
+links.get.href::::
++
+--
+The URL template for the release download page.
+May include `{{ code }}` (version ID) as placeholder.
+
+For example:
+
+* `https://example.com/releases/{{ code }}`
+* `https://example.com/dl/{{ code | replace: '.', '-' }}`
+
+The existence of this property causes the download link or element to appear in the Release History page.
+
+
+[horizontal]
+type;; Liquid
+path;; `xref:conf_ppty_links_get_href[config.links.get.href]`
+--
+
+[[conf_ppty_links_get_icon,config.links.get.icon]]
+links.get.icon::::
++
+--
+The icon to use for the download links.
+
+[horizontal]
+type;; String
+default;;
++
+`+++download+++`
+path;; `xref:conf_ppty_links_get_icon[config.links.get.icon]`
+--
+
+[[conf_ppty_links_get_text,config.links.get.text]]
+links.get.text::::
++
+--
+The text label to use for the download links.
+May include `{{ code }}` (version ID) as placeholder.
+
+
+[horizontal]
+type;; Liquid
+default;;
++
+`+++Download {{ code }}+++`
+path;; `xref:conf_ppty_links_get_text[config.links.get.text]`
+--
+
+[[conf_ppty_paths,config.paths]]
+paths::
++
+--
+The configuration for the paths to include in the release history listings.
+
+
+[horizontal]
+path;; `xref:conf_ppty_paths[config.paths]`
+--
+
+[[conf_ppty_paths_drafts_dir,config.paths.drafts_dir]]
+paths.drafts_dir:::
++
+--
+The path to the output directory for generated drafts (YAML, Markdown, AsciiDoc).
+
+
+[horizontal]
+type;; Path
+default;;
++
+`+++_drafts+++`
+path;; `xref:conf_ppty_paths_drafts_dir[config.paths.drafts_dir]`
+--
+
+[[conf_ppty_paths_enrich_dir,config.paths.enrich_dir]]
+paths.enrich_dir:::
++
+--
+The path to the output directory for enriched files (HTML, PDF).
+
+
+[horizontal]
+type;; Path
+default;;
++
+`+++_publish+++`
+path;; `xref:conf_ppty_paths_enrich_dir[config.paths.enrich_dir]`
+--
+
+[[conf_ppty_paths_output_dir,config.paths.output_dir]]
+paths.output_dir:::
++
+--
+The base directory from which any other output paths are relative.
+This is the parent directory for <<conf_ppty_paths_drafts_dir>> and <<conf_ppty_paths_enrich_dir>>.
+It also serves as a base path for any argued files.
+
+Example: If this property is set to `_output`, and <<conf_ppty_paths_drafts_dir>> is `_drafts`, then running `rhx 1.1.0 --md --yaml --asciidoc`  would generate the files at `_releasehx/_drafts/`.
+
+
+[horizontal]
+type;; Path
+default;;
++
+`+++.+++`
+path;; `xref:conf_ppty_paths_output_dir[config.paths.output_dir]`
+--
+
+[[conf_ppty_paths_draft_filename,config.paths.draft_filename]]
+paths.draft_filename:::
++
+--
+The filename template for the draft files.
+
+May include `{{ version }}` and `{{ format_ext }}` as placeholders, where `format_ext` is determined at file-write time and based on preferences defined in the `config.extensions` block.
+
+
+[horizontal]
+type;; FileName
+templating;; liquid,  delayed rendering
+default;;
++
+....
+{{ version }}.{{ format_ext }}
+....
+path;; `xref:conf_ppty_paths_draft_filename[config.paths.draft_filename]`
+--
+
+[[conf_ppty_paths_enrich_filename,config.paths.enrich_filename]]
+paths.enrich_filename:::
++
+--
+The filename template for the enriched files.
+
+May include `{{ version }}` and `{{ format_ext }}` as placeholders, where `format_ext`.
+
+Published file extensions must be: `.html`, `.pdf`.
+They can be set with <<conf_ppty_extensions_html>> and <<conf_ppty_extensions_pdf>> properties, respectively.
+
+
+[horizontal]
+type;; FileName
+templating;; liquid,  delayed rendering
+default;;
++
+....
+release-history-{{ version }}.{{ format_ext }}
+....
+path;; `xref:conf_ppty_paths_enrich_filename[config.paths.enrich_filename]`
+--
+
+[[conf_ppty_paths_payloads_dir,config.paths.payloads_dir]]
+paths.payloads_dir:::
++
+--
+The path to the directory for storing API payloads.
+This is used to store the raw API responses for debugging and reference.
+
+
+[horizontal]
+type;; Path
+default;;
++
+`+++_payloads+++`
+path;; `xref:conf_ppty_paths_payloads_dir[config.paths.payloads_dir]`
+--
+
+[[conf_ppty_paths_cache,config.paths.cache]]
+paths.cache:::
++
+--
+Settings for the ReleaseHx application cache.
+
+
+[horizontal]
+path;; `xref:conf_ppty_paths_cache[config.paths.cache]`
+--
+
+[[conf_ppty_paths_cache_enabled,config.paths.cache.enabled]]
+paths.cache.enabled::::
++
+--
+Enable automatic caching of API responses to improve performance and reduce API calls.
+
+
+[horizontal]
+type;; Boolean
+default;;
++
+`+++false+++`
+path;; `xref:conf_ppty_paths_cache_enabled[config.paths.cache.enabled]`
+--
+
+[[conf_ppty_paths_cache_ttl_hours,config.paths.cache.ttl_hours]]
+paths.cache.ttl_hours::::
++
+--
+Time-to-live for cached API responses in hours.
+After this time, cached responses will be considered stale and fresh data will be fetched from the API.
+
+
+[horizontal]
+type;; Integer
+default;;
++
+`+++24+++`
+path;; `xref:conf_ppty_paths_cache_ttl_hours[config.paths.cache.ttl_hours]`
+--
+
+[[conf_ppty_paths_cache_dir,config.paths.cache.dir]]
+paths.cache.dir::::
++
+--
+The directory where cached API responses are stored.
+Cache files are organized by API type, project, and version.
+
+
+[horizontal]
+type;; Path
+default;;
++
+`+++.releasehx/cache+++`
+path;; `xref:conf_ppty_paths_cache_dir[config.paths.cache.dir]`
+--
+
+[[conf_ppty_paths_cache_prompt_gitignore,config.paths.cache.prompt_gitignore]]
+paths.cache.prompt_gitignore::::
++
+--
+Quietly check the project's git status after writing to cache and, if cache is found untracked, suggest adding this cache path to .gitignore or deleting and disabling caching.
+
+
+[horizontal]
+type;; Boolean
+default;;
++
+`+++true+++`
+path;; `xref:conf_ppty_paths_cache_prompt_gitignore[config.paths.cache.prompt_gitignore]`
+--
+
+[[conf_ppty_paths_templates_dir,config.paths.templates_dir]]
+paths.templates_dir:::
++
+--
+The path to the templates directory.
+
+
+[horizontal]
+type;; Path
+default;;
++
+`+++_templates+++`
+path;; `xref:conf_ppty_paths_templates_dir[config.paths.templates_dir]`
+--
+
+[[conf_ppty_paths_mappings_dir,config.paths.mappings_dir]]
+paths.mappings_dir:::
++
+--
+The path to the directory containing user-defined API mappings.
+
+ReleaseHx checks here first for a file named `<origin_source_name>.yaml` or `<origin_source_name>.yml`, where `<origin_source_name>` is set in the `origin.source` property.
+If no file is found, the mapping is expected to be supplied by the gem (see `<GEM_ROOT>/mappings/`).
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++_mappings+++`
+path;; `xref:conf_ppty_paths_mappings_dir[config.paths.mappings_dir]`
+--
+
+[[conf_ppty_paths_api_clients_dir,config.paths.api_clients_dir]]
+paths.api_clients_dir:::
++
+--
+The path to the directory containing user-defined API client definitions.
+
+ReleaseHx checks here first for a file named `<api_from_name>.yaml`, where `<api_from_name>` is set in the <<conf_ppty_origin_source>>` property.
+If no file is found, the client class is expected to be supplied by the gem (see `<GEM_ROOT>/lib/releasehx/apis/`).
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++_apis+++`
+path;; `xref:conf_ppty_paths_api_clients_dir[config.paths.api_clients_dir]`
+--
+
+[[conf_ppty_modes,config.modes]]
+modes::
++
+--
+Default settings for `rhx` command executions.
+
+
+[horizontal]
+path;; `xref:conf_ppty_modes[config.modes]`
+--
+
+[[conf_ppty_modes_wrapped,config.modes.wrapped]]
+modes.wrapped:::
++
+--
+Include (or exclude) head, header, and footer elements when enriching to HTML.
+
+
+[horizontal]
+type;; Boolean
+default;;
++
+`+++false+++`
+path;; `xref:conf_ppty_modes_wrapped[config.modes.wrapped]`
+--
+
+[[conf_ppty_modes_html_frontmatter,config.modes.html_frontmatter]]
+modes.html_frontmatter:::
++
+--
+Include frontmatter in the rendered HTML.
+
+See the `templates.page_frontmatter` property for details.
+
+
+[horizontal]
+type;; Boolean
+default;;
++
+`+++true+++`
+path;; `xref:conf_ppty_modes_html_frontmatter[config.modes.html_frontmatter]`
+--
+
+[[conf_ppty_modes_markdown_frontmatter,config.modes.markdown_frontmatter]]
+modes.markdown_frontmatter:::
++
+--
+Include frontmatter in Markdown drafts.
+
+Uses the `templates.markdown_frontmatter` template.
+
+
+[horizontal]
+type;; Boolean
+default;;
++
+`+++false+++`
+path;; `xref:conf_ppty_modes_markdown_frontmatter[config.modes.markdown_frontmatter]`
+--
+
+[[conf_ppty_modes_asciidoc_frontmatter,config.modes.asciidoc_frontmatter]]
+modes.asciidoc_frontmatter:::
++
+--
+Include frontmatter in AsciiDoc drafts.
+
+Uses the `templates.asciidoc_frontmatter` template.
+
+
+[horizontal]
+type;; Boolean
+path;; `xref:conf_ppty_modes_asciidoc_frontmatter[config.modes.asciidoc_frontmatter]`
+--
+
+[[conf_ppty_modes_fetch,config.modes.fetch]]
+modes.fetch:::
++
+--
+What to fetch when gathering issues from API.
+
+Valid entries:
+
+* `all-tagged` -- fetches issues with `release_note_needed` tag.
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++notes-only+++`
+path;; `xref:conf_ppty_modes_fetch[config.modes.fetch]`
+--
+
+[[conf_ppty_modes_remove_excess_lines,config.modes.remove_excess_lines]]
+modes.remove_excess_lines:::
++
+--
+Reduces _N_+ consecutive blank lines to _N_ lines.
+
+
+[horizontal]
+type;; Integer
+default;;
++
+`+++1+++`
+path;; `xref:conf_ppty_modes_remove_excess_lines[config.modes.remove_excess_lines]`
+--
+
+[[conf_ppty_rhyml,config.rhyml]]
+rhyml::
++
+--
+Settings related to RHYML data objects and documents.
+
+
+[horizontal]
+path;; `xref:conf_ppty_rhyml[config.rhyml]`
+--
+
+[[conf_ppty_rhyml_markup,config.rhyml.markup]]
+rhyml.markup:::
++
+--
+The markup format for the `note` or `memo` properties of RHYML objects.
+
+Change to `asciidoc` to convert upstream Markdown to AsciiDoc.
+
+This setting can be set (and overridden) with the `$config.markup` property in any given RHYML document.
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++markdown+++`
+path;; `xref:conf_ppty_rhyml_markup[config.rhyml.markup]`
+--
+
+[[conf_ppty_rhyml_chid,config.rhyml.chid]]
+rhyml.chid:::
++
+--
+The template for automatic change ID/slug construction, if available at draft-time.
+
+A liquid template with access to local variables including:
+
+Release variables::
+
+* `release.code`
+* `release.date`
+* `release.hash`
+
+Work/change item variables::
+
+* `change.tick`
+* `change.hash`
+* `change.type`
+* `change.part`
+* `change.summ`
+
+The template established here is only for drafting `chid` slugs.
+It is not used down the line to validate `chid` entries, which will be valid as long as they are Slug-formatted strings.
+
+
+[horizontal]
+type;; Slug
+templating;; liquid,  delayed rendering
+default;;
++
+....
+{{- change.tick }}-{{ change.summ | truncate: 20 | slugify }}
+
+....
+path;; `xref:conf_ppty_rhyml_chid[config.rhyml.chid]`
+--
+
+[[conf_ppty_rhyml_empty_notes,config.rhyml.empty_notes]]
+rhyml.empty_notes:::
++
+--
+What to do for issues that lack a release note but have the `release_note_needed` tag (or a label otherwise declared in <<conf_ppty_tags_release_note_needed_slug>>).
+
+* `skip` the issue when drafting notes (can update with `--amend`)
+* `empty` include the issue with an empty note
+* `dump` the complete issue body/description and commit message as the `note` property
+// * `ai` generate a note using generative AI
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++skip+++`
+path;; `xref:conf_ppty_rhyml_empty_notes[config.rhyml.empty_notes]`
+--
+
+[[conf_ppty_rhyml_empty_notes_content,config.rhyml.empty_notes_content]]
+rhyml.empty_notes_content:::
++
+--
+The content to use for empty notes when <<conf_ppty_rhyml_empty_notes>> is set to 'empty'
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++RELEASE NOTE NEEDED+++`
+path;; `xref:conf_ppty_rhyml_empty_notes_content[config.rhyml.empty_notes_content]`
+--
+
+[[conf_ppty_rhyml_max_parts,config.rhyml.max_parts]]
+rhyml.max_parts:::
++
+--
+The maximum number of affected _part_ categories that can be recorded for a single change.
+
+When `0`, _part_ records are disabled for all changes.
+When `1`, only one _part_ is allowed per change (String).
+When `2` or more, a single affiliated _part_ category may be recorded using the `part` property, but more than one must be recorded using the `parts` property (Array).
+
+
+[horizontal]
+type;; Integer
+default;;
++
+`+++1+++`
+path;; `xref:conf_ppty_rhyml_max_parts[config.rhyml.max_parts]`
+--
+
+[[conf_ppty_rhyml_pasterize_summ,config.rhyml.pasterize_summ]]
+rhyml.pasterize_summ:::
++
+--
+Whether to convert verbs in the `summ` property to past tense when drafting.
+Replaces common words like `adds` with `added`, `fix` with `fixed`, etc.
+
+
+[horizontal]
+type;; Boolean
+default;;
++
+`+++false+++`
+path;; `xref:conf_ppty_rhyml_pasterize_summ[config.rhyml.pasterize_summ]`
+--
+
+[[conf_ppty_rhyml_pasterize_head,config.rhyml.pasterize_head]]
+rhyml.pasterize_head:::
++
+--
+Whether to convert verbs in the `head` property to past tense when drafting.
+Replaces common words like `adds` with `added`, `fix` with `fixed`, etc.
+
+
+[horizontal]
+type;; Boolean
+default;;
++
+`+++false+++`
+path;; `xref:conf_ppty_rhyml_pasterize_head[config.rhyml.pasterize_head]`
+--
+
+[[conf_ppty_history,config.history]]
+history::
++
+--
+Configurations for the overall document, when applicable.
+
+
+[horizontal]
+path;; `xref:conf_ppty_history[config.history]`
+--
+
+[[conf_ppty_history_head,config.history.head]]
+history.head:::
++
+--
+The header for the release history output.
+
+
+[horizontal]
+type;; String
+templating;; liquid,  delayed rendering
+default;;
++
+....
+Release History -- {{ release.code }} - {{ release.date }}
+....
+path;; `xref:conf_ppty_history_head[config.history.head]`
+--
+
+[[conf_ppty_history_htag,config.history.htag]]
+history.htag:::
++
+--
+The heading level (H1, H2, etc) for the release history header.
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++h1+++`
+path;; `xref:conf_ppty_history_htag[config.history.htag]`
+--
+
+[[conf_ppty_history_markdown_frontmatter,config.history.markdown_frontmatter]]
+history.markdown_frontmatter:::
++
+--
+Designates the content inserted at the top of Markdown files as document-level metadata.
+
+A Liquid template to be prepended at the top of Markdown draft files.
+
+Templates may contain the following variables, automatically generated, as applicable:
+
+* `date` (DateTime)
+* `version` (String)
+* `title` (String)          
+
+
+[horizontal]
+type;; Liquid
+default;;
++
+....
+---
+title: Release History for {{ release.code }}
+version: {{ release.code }}
+date: {{ release.date }}
+---
+
+....
+path;; `xref:conf_ppty_history_markdown_frontmatter[config.history.markdown_frontmatter]`
+--
+
+[[conf_ppty_history_asciidoc_frontmatter,config.history.asciidoc_frontmatter]]
+history.asciidoc_frontmatter:::
++
+--
+Designates the way front-matter is inserted at the top of AsciiDoc files.
+Several variables are available to templates.
+
+AsciiDoc frontmatter templates may also contain AsciiDoc attribute placeholders.
+
+
+[horizontal]
+type;; Liquid
+default;;
++
+....
+:page-title: Release History for {{ release.code }}
+:page-version: {{ release.code }}
+:page-date: {{ release.date }}
+
+....
+path;; `xref:conf_ppty_history_asciidoc_frontmatter[config.history.asciidoc_frontmatter]`
+--
+
+[[conf_ppty_history_html_frontmatter,config.history.html_frontmatter]]
+history.html_frontmatter:::
++
+--
+Designates the way front-matter is inserted at the top of _unwrapped_ rendered HTML.
+
+The `frontmatter` property is a Liquid template that is inserted at the top of the rendered HTML file.
+
+It may include `{{ title }}`, `{{ version }}`, `{{ date }}`, as well as any `vars`-scoped variables as you pass in.
+
+
+[horizontal]
+type;; Liquid
+default;;
++
+....
+---
+title: Release History for {{ release.code }}
+version: {{ release.code }}
+date: {{ release.date }}
+---
+
+....
+path;; `xref:conf_ppty_history_html_frontmatter[config.history.html_frontmatter]`
+--
+
+[[conf_ppty_history_items,config.history.items]]
+history.items:::
++
+--
+Settings pertaining to displayed items across Changelog and Release Notes sections.
+
+Most of these settings can be defined separately for each section under <<conf_ppty_changelog_items>> and <<conf_ppty_notes_items>>.
+If an identically named setting exists, it will override the primary designator defined in this `config.history.items` block.
+
+
+[horizontal]
+path;; `xref:conf_ppty_history_items[config.history.items]`
+--
+
+[[conf_ppty_history_items_allow_redundant,config.history.items.allow_redundant]]
+history.items.allow_redundant::::
++
+--
+Whether to allow duplicate entries in a given section, for instance across groups for `part:group` sorts where a change affects multiple parts.
+
+
+[horizontal]
+type;; Boolean
+default;;
++
+`+++false+++`
+path;; `xref:conf_ppty_history_items_allow_redundant[config.history.items.allow_redundant]`
+--
+
+[[conf_ppty_history_items_show_issue_links,config.history.items.show_issue_links]]
+history.items.show_issue_links::::
++
+--
+Whether to include web links in item metadata.
+
+Requires `links.web` to be defined.
+
+
+[horizontal]
+type;; Boolean
+default;;
++
+`+++false+++`
+path;; `xref:conf_ppty_history_items_show_issue_links[config.history.items.show_issue_links]`
+--
+
+[[conf_ppty_history_items_show_git_links,config.history.items.show_git_links]]
+history.items.show_git_links::::
++
+--
+Whether to include git links in item metadata.
+
+Requires `links.git` to be defined.
+
+
+[horizontal]
+type;; Boolean
+default;;
++
+`+++false+++`
+path;; `xref:conf_ppty_history_items_show_git_links[config.history.items.show_git_links]`
+--
+
+[[conf_ppty_history_items_metadata_labels,config.history.items.metadata_labels]]
+history.items.metadata_labels::::
++
+--
+If and where to display icons in relation to labels in item metadata.
+
+Use `before` or `after` to choose a spot, `none` or `'$nil'` to disable.
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++before+++`
+path;; `xref:conf_ppty_history_items_metadata_labels[config.history.items.metadata_labels]`
+--
+
+[[conf_ppty_history_items_metadata_icons,config.history.items.metadata_icons]]
+history.items.metadata_icons::::
++
+--
+Whether to include icons for metadata in item metadata.
+
+
+[horizontal]
+type;; Boolean
+default;;
++
+`+++before+++`
+path;; `xref:conf_ppty_history_items_metadata_icons[config.history.items.metadata_icons]`
+--
+
+[[conf_ppty_history_items_show_lead,config.history.items.show_lead]]
+history.items.show_lead::::
++
+--
+Whether to include the lead-in text for the section in the item metadata.
+This is useful for displaying the section header in the item metadata.
+
+
+[horizontal]
+type;; Boolean
+default;;
++
+`+++false+++`
+path;; `xref:conf_ppty_history_items_show_lead[config.history.items.show_lead]`
+--
+
+[[conf_ppty_history_items_show_type_label,config.history.items.show_type_label]]
+history.items.show_type_label::::
++
+--
+Whether to show the type label in the item metadata output.
+If `false`, the type will be listed unlabeled in the output, for templates that support this option.
+
+Corresponds to the <<conf_ppty_history_labeling_type_label>> property, which defines the content displayed when this property is `true` for a given section of the history output.
+
+
+[horizontal]
+type;; Boolean
+default;;
++
+`+++false+++`
+path;; `xref:conf_ppty_history_items_show_type_label[config.history.items.show_type_label]`
+--
+
+[[conf_ppty_history_items_show_parts_label,config.history.items.show_parts_label]]
+history.items.show_parts_label::::
++
+--
+Whether to show the parts label in the item metadata output.
+If `false`, parts will be listed unlabeled in the output, for templates that support this option.
+
+Corresponds to the <<conf_ppty_history_labeling_parts_label>> property (and optionally the <<conf_ppty_history_labeling_part_label>>), which defines the content displayed when this property is `true` for a given section of the history output.
+
+
+[horizontal]
+type;; Boolean
+default;;
++
+`+++false+++`
+path;; `xref:conf_ppty_history_items_show_parts_label[config.history.items.show_parts_label]`
+--
+
+[[conf_ppty_history_items_show_tags_label,config.history.items.show_tags_label]]
+history.items.show_tags_label::::
++
+--
+Whether to show the tags label in the item metadata output.
+If `false`, tags will be listed unlabeled in the output, for templates that support this option.
+
+Corresponds to the <<conf_ppty_history_labeling_tags_label>> property (and optionally the <<conf_ppty_history_labeling_tag_label>>), which defines the content displayed when this property is `true` for a given section of the history output.
+
+
+[horizontal]
+type;; Boolean
+default;;
++
+`+++false+++`
+path;; `xref:conf_ppty_history_items_show_tags_label[config.history.items.show_tags_label]`
+--
+
+[[conf_ppty_history_items_show_lead_label,config.history.items.show_lead_label]]
+history.items.show_lead_label::::
++
+--
+Whether to show the lead label in the item metadata output.
+If `false`, the lead will be listed unlabeled in the output, for templates that support this option.
+
+Corresponds to the <<conf_ppty_history_labeling_lead_label>> property, which defines the content displayed when this property is `true` for a given section of the history output.
+
+
+[horizontal]
+type;; Boolean
+default;;
++
+`+++false+++`
+path;; `xref:conf_ppty_history_items_show_lead_label[config.history.items.show_lead_label]`
+--
+
+[[conf_ppty_history_items_show_auths_label,config.history.items.show_auths_label]]
+history.items.show_auths_label::::
++
+--
+Whether to show the authors label in the item metadata output.
+If `false`, authors will be listed unlabeled in the output, for templates that support this option.
+
+Corresponds to the <<conf_ppty_history_labeling_auth_label>> property, which defines the content displayed when this property is `true` for a given section of the history output.
+
+
+[horizontal]
+type;; Boolean
+default;;
++
+`+++false+++`
+path;; `xref:conf_ppty_history_items_show_auths_label[config.history.items.show_auths_label]`
+--
+
+[[conf_ppty_history_labeling,config.history.labeling]]
+history.labeling:::
++
+--
+Settings for labeling items in the release history output.
+These properties establish how metadata and other elements apply to a given subject's nomenclature.
+If you want to refer to "`tags`" as "`labels`" or "`parts`" as "`components`", map those namespaces here.
+
+
+[horizontal]
+path;; `xref:conf_ppty_history_labeling[config.history.labeling]`
+--
+
+[[conf_ppty_history_labeling_singularize_labels,config.history.labeling.singularize_labels]]
+history.labeling.singularize_labels::::
++
+--
+Whether to singularize labels in the output _when only one instance_ of the category is present.
+For instance, if a change has only one part and the `conf_ppty_history_labeling_part_label` is set to `Part`, the output will use labeling like *Part:* instead of *Parts:*.
+
+This also applies to `tag_label` and `auth_label` as well as the `part_label`.
+The `type` and `lead` labels are not affected by this setting.
+
+
+[horizontal]
+type;; Boolean
+default;;
++
+`+++true+++`
+path;; `xref:conf_ppty_history_labeling_singularize_labels[config.history.labeling.singularize_labels]`
+--
+
+[[conf_ppty_history_labeling_type_label,config.history.labeling.type_label]]
+history.labeling.type_label::::
++
+--
+The label to use for the type of change.
+Defaults to the `type.text` property of the change.
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++type+++`
+path;; `xref:conf_ppty_history_labeling_type_label[config.history.labeling.type_label]`
+--
+
+[[conf_ppty_history_labeling_type_icon,config.history.labeling.type_icon]]
+history.labeling.type_icon::::
++
+--
+The icon to use for the type of change.
+Defaults to the `type.icon` property of the change.
+
+
+[horizontal]
+type;; String
+path;; `xref:conf_ppty_history_labeling_type_icon[config.history.labeling.type_icon]`
+--
+
+[[conf_ppty_history_labeling_parts_label,config.history.labeling.parts_label]]
+history.labeling.parts_label::::
++
+--
+The label to use for the part/component affected by the change.
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++Components+++`
+path;; `xref:conf_ppty_history_labeling_parts_label[config.history.labeling.parts_label]`
+--
+
+[[conf_ppty_history_labeling_part_label,config.history.labeling.part_label]]
+history.labeling.part_label::::
++
+--
+The label to use for the _singular_ part/component affected by the change, when only one part is permitted.
+
+This value will apply either when <<conf_ppty_rhyml_max_parts>> is set to `1` or when the change has only one part _and_ <<conf_ppty_history_labeling_singularize_labels>> is `true`.
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++Part+++`
+path;; `xref:conf_ppty_history_labeling_part_label[config.history.labeling.part_label]`
+--
+
+[[conf_ppty_history_labeling_parts_icon,config.history.labeling.parts_icon]]
+history.labeling.parts_icon::::
++
+--
+The icon to use for the part/component affected by the change.
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++puzzle-piece+++`
+path;; `xref:conf_ppty_history_labeling_parts_icon[config.history.labeling.parts_icon]`
+--
+
+[[conf_ppty_history_labeling_tags_label,config.history.labeling.tags_label]]
+history.labeling.tags_label::::
++
+--
+The tags associated with the change, if any.
+Defaults to an empty array.
+
+
+[horizontal]
+type;; Array
+default;;
++
+`+++Tags+++`
+path;; `xref:conf_ppty_history_labeling_tags_label[config.history.labeling.tags_label]`
+--
+
+[[conf_ppty_history_labeling_tag_label,config.history.labeling.tag_label]]
+history.labeling.tag_label::::
++
+--
+The label to use for the _singular_ tag associated with the change, when only one tag is permitted.
+
+This value will apply either when <<conf_ppty_rhyml_max_parts>> is set to `1` or when the change has only one tag _and_ <<conf_ppty_history_labeling_singularize_labels>> is `true`.
+
+In supporting templates, this label will only be displayed if the show_tags_label` setting is `true` for the relevant section.
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++Tag+++`
+path;; `xref:conf_ppty_history_labeling_tag_label[config.history.labeling.tag_label]`
+--
+
+[[conf_ppty_history_labeling_tags_icon,config.history.labeling.tags_icon]]
+history.labeling.tags_icon::::
++
+--
+The icon to use for the tags associated with the change.
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++tags+++`
+path;; `xref:conf_ppty_history_labeling_tags_icon[config.history.labeling.tags_icon]`
+--
+
+[[conf_ppty_history_labeling_lead_label,config.history.labeling.lead_label]]
+history.labeling.lead_label::::
++
+--
+The label to use for the lead contributor of the change.
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++Contributed by+++`
+path;; `xref:conf_ppty_history_labeling_lead_label[config.history.labeling.lead_label]`
+--
+
+[[conf_ppty_history_labeling_lead_icon,config.history.labeling.lead_icon]]
+history.labeling.lead_icon::::
++
+--
+The icon to use for the lead contributor of the change.
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++user+++`
+path;; `xref:conf_ppty_history_labeling_lead_icon[config.history.labeling.lead_icon]`
+--
+
+[[conf_ppty_history_labeling_auths_label,config.history.labeling.auths_label]]
+history.labeling.auths_label::::
++
+--
+The label to use for the authors of the change.
+This is used when multiple authors are present.
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++Contributors+++`
+path;; `xref:conf_ppty_history_labeling_auths_label[config.history.labeling.auths_label]`
+--
+
+[[conf_ppty_history_labeling_auth_label,config.history.labeling.auth_label]]
+history.labeling.auth_label::::
++
+--
+The label to use for the _singular_ author of the change, when only one author is listed and <<conf_ppty_history_labeling_singularize_labels>> is `true`.
+
+
+[horizontal]
+type;; String
+path;; `xref:conf_ppty_history_labeling_auth_label[config.history.labeling.auth_label]`
+--
+
+[[conf_ppty_history_labeling_join_string,config.history.labeling.join_string]]
+history.labeling.join_string::::
++
+--
+The string to use to join multiple tags, parts, or authors in the output.
+Defaults to a comma and space (`, `).
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++, +++`
+path;; `xref:conf_ppty_history_labeling_join_string[config.history.labeling.join_string]`
+--
+
+[[conf_ppty_changelog,config.changelog]]
+changelog::
++
+--
+The configuration for the changelog output.
+
+
+[horizontal]
+path;; `xref:conf_ppty_changelog[config.changelog]`
+--
+
+[[conf_ppty_changelog_head,config.changelog.head]]
+changelog.head:::
++
+--
+The header for the changelog output.
+
+
+[horizontal]
+type;; String
+templating;; liquid,  delayed rendering
+default;;
++
+`+++Changelog+++`
+path;; `xref:conf_ppty_changelog_head[config.changelog.head]`
+--
+
+[[conf_ppty_changelog_text,config.changelog.text]]
+changelog.text:::
++
+--
+The text for the changelog output.
+Change to `null` to hide.
+
+
+[horizontal]
+type;; String
+templating;; liquid,  delayed rendering
+default;;
++
+....
+Summaries of all user-facing changes made since the previous release.
+
+....
+path;; `xref:conf_ppty_changelog_text[config.changelog.text]`
+--
+
+[[conf_ppty_changelog_htag,config.changelog.htag]]
+changelog.htag:::
++
+--
+The heading level (H1, H2, etc) for the changelog section header.
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++h2+++`
+path;; `xref:conf_ppty_changelog_htag[config.changelog.htag]`
+--
+
+[[conf_ppty_changelog_spot,config.changelog.spot]]
+changelog.spot:::
++
+--
+Where in the document to place the changelog (`1` = top, `2` = bottom).
+
+
+[horizontal]
+type;; Integer
+default;;
++
+`+++2+++`
+path;; `xref:conf_ppty_changelog_spot[config.changelog.spot]`
+--
+
+[[conf_ppty_changelog_sort,config.changelog.sort]]
+changelog.sort:::
++
+--
+The sort order for the changelog output.
+
+Indicate whether you wish to _group_ output by this sort criterion, or else just order by that criteria, with or without a label denoting the criterion.
+
+If `<criterion>:group` (default), the output will be grouped into sections with the group instance 
+If `<criterion>:grouping1`, the criterion will be added to the first of 2 grouping tiers into which the output will be divided.
+If `<criterion>:grouping2`, the criterion will be added to the second of 2 grouping tiers into which the output will be divided.
+If `<criterion>:label`, the output will be order by the criterion, with a label indicating the criterion.
+If `<criterion>:none`, the output will be ordered by the criterion, with no label.
+
+For example:
+
+[source,yaml]
+----
+sort:
+  - 'part:group'
+  - 'type:label'
+----
+
+Would produce something like:
+
+[source,markdown]
+----
+## Web UI
+
+- Feature description or summary [New feature]
+
+- Another feature description or summary [New feature]
+
+- Improvement description or summary [Improvement]
+
+## Backend
+
+- Feature description or summary [New feature]
+
+- Bug fix description or summary [Bug Fixes]
+----
+
+For 2-tiered grouping arrangements, use something like:
+
+[source,yaml]
+----
+sort:
+  - 'part:grouping1'
+  - 'type:grouping2'
+----
+
+This would output for instance:
+
+[source,markdown]
+----
+## Web UI
+
+### New features
+- Feature description or summary
+- Another feature description or summary
+
+### Improvements
+- Improvement description or summary
+----
+
+You may also use tag-based groupings, but the tags must be listed explicitly.
+
+[source,yaml]
+----
+sort:
+  - 'breaking:group'
+  - 'deprecation:group'
+  - 'type:group'
+  - 'part:label'
+----
+
+This would output something akin to:
+
+[source,markdown]
+----
+## Breaking Changes
+- We are breaking this thing! [Web UI]
+
+## Deprecations
+- We are deprecating this thing! [Backend]
+
+## New features
+- Feature description or summary [Web UI]
+- Another feature description or summary [Web UI]
+
+## Improvements
+- Improvement description or summary [Backend]
+----
+
+
+[horizontal]
+type;; Array
+default;;
++
+....
+- part:grouping1
+....
+path;; `xref:conf_ppty_changelog_sort[config.changelog.sort]`
+--
+
+[[conf_ppty_changelog_items,config.changelog.items]]
+changelog.items:::
++
+--
+Settings that affect the frame/shape and arrangement of individual changelog entries.
+
+
+[horizontal]
+path;; `xref:conf_ppty_changelog_items[config.changelog.items]`
+--
+
+[[conf_ppty_changelog_items_frame,config.changelog.items.frame]]
+changelog.items.frame::::
++
+--
+The layout for the changelog entry display.
+
+Can be `ordered`, `unordered`, `paragraph`, or `basic`.
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++unordered+++`
+path;; `xref:conf_ppty_changelog_items_frame[config.changelog.items.frame]`
+--
+
+[[conf_ppty_changelog_items_allow_redundant,config.changelog.items.allow_redundant]]
+changelog.items.allow_redundant::::
++
+--
+Whether to allow duplicate entries in a given section, for instance across groups for `part:group` sorts where a change affects multiple parts.
+
+
+[horizontal]
+type;; Boolean
+default;;
++
+`+++false+++`
+path;; `xref:conf_ppty_changelog_items_allow_redundant[config.changelog.items.allow_redundant]`
+--
+
+[[conf_ppty_changelog_items_show_git_links,config.changelog.items.show_git_links]]
+changelog.items.show_git_links::::
++
+--
+Whether to include git links in item metadata.
+
+Requires `links.git` to be defined.
+
+
+[horizontal]
+type;; Boolean
+default;;
++
+`+++false+++`
+path;; `xref:conf_ppty_changelog_items_show_git_links[config.changelog.items.show_git_links]`
+--
+
+[[conf_ppty_changelog_items_show_issue_links,config.changelog.items.show_issue_links]]
+changelog.items.show_issue_links::::
++
+--
+Whether to include web links in item metadata.
+
+Requires `links.web` to be defined.
+
+
+[horizontal]
+type;; Boolean
+default;;
++
+`+++false+++`
+path;; `xref:conf_ppty_changelog_items_show_issue_links[config.changelog.items.show_issue_links]`
+--
+
+[[conf_ppty_changelog_items_metadata_labels,config.changelog.items.metadata_labels]]
+changelog.items.metadata_labels::::
++
+--
+If and where to display icons in relation to labels in item metadata.
+
+Use `before` or `after` to choose a spot, `none` or `'$nil'` to disable.
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++before+++`
+path;; `xref:conf_ppty_changelog_items_metadata_labels[config.changelog.items.metadata_labels]`
+--
+
+[[conf_ppty_changelog_items_metadata_icons,config.changelog.items.metadata_icons]]
+changelog.items.metadata_icons::::
++
+--
+Whether to include icons for metadata in item metadata.
+
+
+[horizontal]
+type;; Boolean
+default;;
++
+`+++before+++`
+path;; `xref:conf_ppty_changelog_items_metadata_icons[config.changelog.items.metadata_icons]`
+--
+
+[[conf_ppty_changelog_items_show_lead,config.changelog.items.show_lead]]
+changelog.items.show_lead::::
++
+--
+Whether to include the lead-in text for the section in the item metadata.
+This is useful for displaying the section header in the item metadata.
+
+
+[horizontal]
+type;; Boolean
+default;;
++
+`+++false+++`
+path;; `xref:conf_ppty_changelog_items_show_lead[config.changelog.items.show_lead]`
+--
+
+[[conf_ppty_changelog_items_show_type_label,config.changelog.items.show_type_label]]
+changelog.items.show_type_label::::
++
+--
+Whether to show the type label in the item metadata output.
+If `false`, the type will be listed unlabeled in the output, for templates that support this option.
+
+Corresponds to the <<conf_ppty_history_labeling_type_label>> property, which defines the content displayed when this property is `true` for a given section of the history output.
+
+
+[horizontal]
+type;; Boolean
+default;;
++
+`+++false+++`
+path;; `xref:conf_ppty_changelog_items_show_type_label[config.changelog.items.show_type_label]`
+--
+
+[[conf_ppty_changelog_items_show_parts_label,config.changelog.items.show_parts_label]]
+changelog.items.show_parts_label::::
++
+--
+Whether to show the parts label in the item metadata output.
+If `false`, parts will be listed unlabeled in the output, for templates that support this option.
+
+Corresponds to the <<conf_ppty_history_labeling_parts_label>> property (and optionally the <<conf_ppty_history_labeling_part_label>>), which defines the content displayed when this property is `true` for a given section of the history output.
+
+
+[horizontal]
+type;; Boolean
+default;;
++
+`+++false+++`
+path;; `xref:conf_ppty_changelog_items_show_parts_label[config.changelog.items.show_parts_label]`
+--
+
+[[conf_ppty_changelog_items_show_tags_label,config.changelog.items.show_tags_label]]
+changelog.items.show_tags_label::::
++
+--
+Whether to show the tags label in the item metadata output.
+If `false`, tags will be listed unlabeled in the output, for templates that support this option.
+
+Corresponds to the <<conf_ppty_history_labeling_tags_label>> property (and optionally the <<conf_ppty_history_labeling_tag_label>>), which defines the content displayed when this property is `true` for a given section of the history output.
+
+
+[horizontal]
+type;; Boolean
+default;;
++
+`+++false+++`
+path;; `xref:conf_ppty_changelog_items_show_tags_label[config.changelog.items.show_tags_label]`
+--
+
+[[conf_ppty_changelog_items_show_lead_label,config.changelog.items.show_lead_label]]
+changelog.items.show_lead_label::::
++
+--
+Whether to show the lead label in the item metadata output.
+If `false`, the lead will be listed unlabeled in the output, for templates that support this option.
+
+Corresponds to the <<conf_ppty_history_labeling_lead_label>> property, which defines the content displayed when this property is `true` for a given section of the history output.
+
+
+[horizontal]
+type;; Boolean
+default;;
++
+`+++false+++`
+path;; `xref:conf_ppty_changelog_items_show_lead_label[config.changelog.items.show_lead_label]`
+--
+
+[[conf_ppty_changelog_items_show_auths_label,config.changelog.items.show_auths_label]]
+changelog.items.show_auths_label::::
++
+--
+Whether to show the authors label in the item metadata output.
+If `false`, authors will be listed unlabeled in the output, for templates that support this option.
+
+Corresponds to the <<conf_ppty_history_labeling_auth_label>> property, which defines the content displayed when this property is `true` for a given section of the history output.
+
+
+[horizontal]
+type;; Boolean
+default;;
++
+`+++false+++`
+path;; `xref:conf_ppty_changelog_items_show_auths_label[config.changelog.items.show_auths_label]`
+--
+
+[[conf_ppty_notes,config.notes]]
+notes::
++
+--
+The configuration for the Release Notes listing section.
+
+
+[horizontal]
+path;; `xref:conf_ppty_notes[config.notes]`
+--
+
+[[conf_ppty_notes_head,config.notes.head]]
+notes.head:::
++
+--
+The header for the notes output.
+
+
+[horizontal]
+type;; String
+templating;; liquid,  delayed rendering
+default;;
++
+`+++Release Notes+++`
+path;; `xref:conf_ppty_notes_head[config.notes.head]`
+--
+
+[[conf_ppty_notes_text,config.notes.text]]
+notes.text:::
++
+--
+The text for the release notes output.
+Change to `null` to hide.
+
+
+[horizontal]
+type;; String
+templating;; liquid,  delayed rendering
+default;;
++
+....
+Descriptions of any specially notable changes or additions since the previous release.
+
+....
+path;; `xref:conf_ppty_notes_text[config.notes.text]`
+--
+
+[[conf_ppty_notes_htag,config.notes.htag]]
+notes.htag:::
++
+--
+The heading level (H1, H2, etc) for the release notes section header.
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++h2+++`
+path;; `xref:conf_ppty_notes_htag[config.notes.htag]`
+--
+
+[[conf_ppty_notes_spot,config.notes.spot]]
+notes.spot:::
++
+--
+Where in the document to place the Release Notes relative to the Changelog.
+
+
+[horizontal]
+type;; Integer
+default;;
++
+`+++1+++`
+path;; `xref:conf_ppty_notes_spot[config.notes.spot]`
+--
+
+[[conf_ppty_notes_sort,config.notes.sort]]
+notes.sort:::
++
+--
+The sort *order* for the release notes output.
+
+Indicate whether you wish to _group_ output by this sort criterion, or else just order by that criteria, with or without a label denoting the criterion.
+
+If `<criterion>:group` (default), the output will be grouped into sections with the group instance 
+If `<criterion>:grouping1`, the criterion will be added to the first of 2 grouping tiers into which the output will be divided.
+If `<criterion>:grouping2`, the criterion will be added to the second of 2 grouping tiers into which the output will be divided.
+If `<criterion>:label`, the output will be order by the criterion, with a label indicating the criterion.
+If `<criterion>:none`, the output will be ordered by the criterion, with no label.
+
+For example:
+
+[source,yaml]
+----
+sort:
+  - 'part:group'
+  - 'type:label'
+----
+
+Would produce something like:
+
+[source,markdown]
+----
+## Web UI
+
+- Feature description or summary [New feature]
+
+- Another feature description or summary [New feature]
+
+- Improvement description or summary [Improvement]
+
+## Backend
+
+- Feature description or summary [New feature]
+
+- Bug fix description or summary [Bug Fixes]
+----
+
+For 2-tiered grouping arrangements, use something like:
+
+[source,yaml]
+----
+sort:
+  - 'part:grouping1'
+  - 'type:grouping2'
+----
+
+This would output for instance:
+
+[source,markdown]
+----
+## Web UI
+
+### New features
+- Feature description or summary
+- Another feature description or summary
+
+### Improvements
+- Improvement description or summary
+----
+
+You may also use tag-based groupings, but the tags must be listed explicitly.
+
+[source,yaml]
+----
+sort:
+  - 'breaking:group'
+  - 'deprecation:group'
+  - 'type:group'
+  - 'part:label'
+----
+
+This would output something akin to:
+
+[source,markdown]
+----
+## Breaking Changes
+- We are breaking this thing! [Web UI]
+
+## Deprecations
+- We are deprecating this thing! [Backend]
+
+## New features
+- Feature description or summary [Web UI]
+- Another feature description or summary [Web UI]
+
+## Improvements
+- Improvement description or summary [Backend]
+----
+
+
+[horizontal]
+type;; Array
+default;;
++
+....
+- highlight:grouping1
+- deprecation:grouping1
+- removal:grouping1
+- breaking:grouping1
+- type:grouping1
+- part:grouping2
+....
+path;; `xref:conf_ppty_notes_sort[config.notes.sort]`
+--
+
+[[conf_ppty_notes_items,config.notes.items]]
+notes.items:::
++
+--
+Settings that affect the frame/shape and arrangement of individual release-note item displays.
+
+
+[horizontal]
+path;; `xref:conf_ppty_notes_items[config.notes.items]`
+--
+
+[[conf_ppty_notes_items_frame,config.notes.items.frame]]
+notes.items.frame::::
++
+--
+The layout for the release-note item display.
+
+Can be `table-cols-1`, `table-cols-2`, `desc-list`, or `admonition`.
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++table-cols-1+++`
+path;; `xref:conf_ppty_notes_items_frame[config.notes.items.frame]`
+--
+
+[[conf_ppty_notes_items_allow_redundant,config.notes.items.allow_redundant]]
+notes.items.allow_redundant::::
++
+--
+Whether to allow duplicate entries in a given section, for instance across groups for `part:group` sorts where a change affects multiple parts.
+
+
+[horizontal]
+type;; Boolean
+default;;
++
+`+++false+++`
+path;; `xref:conf_ppty_notes_items_allow_redundant[config.notes.items.allow_redundant]`
+--
+
+[[conf_ppty_notes_items_show_git_links,config.notes.items.show_git_links]]
+notes.items.show_git_links::::
++
+--
+Whether to include git links in item metadata.
+
+Requires `links.git` to be defined.
+
+
+[horizontal]
+type;; Boolean
+default;;
++
+`+++false+++`
+path;; `xref:conf_ppty_notes_items_show_git_links[config.notes.items.show_git_links]`
+--
+
+[[conf_ppty_notes_items_show_issue_links,config.notes.items.show_issue_links]]
+notes.items.show_issue_links::::
++
+--
+Whether to include web links in item metadata.
+
+Requires `links.web` to be defined.
+
+
+[horizontal]
+type;; Boolean
+default;;
++
+`+++false+++`
+path;; `xref:conf_ppty_notes_items_show_issue_links[config.notes.items.show_issue_links]`
+--
+
+[[conf_ppty_notes_items_metadata_labels,config.notes.items.metadata_labels]]
+notes.items.metadata_labels::::
++
+--
+If and where to display icons in relation to labels in item metadata.
+
+Use `before` or `after` to choose a spot, `none` or `'$nil'` to disable.
+
+
+[horizontal]
+type;; String
+default;;
++
+`+++before+++`
+path;; `xref:conf_ppty_notes_items_metadata_labels[config.notes.items.metadata_labels]`
+--
+
+[[conf_ppty_notes_items_metadata_icons,config.notes.items.metadata_icons]]
+notes.items.metadata_icons::::
++
+--
+Whether to include icons for metadata in item metadata.
+
+
+[horizontal]
+type;; Boolean
+default;;
++
+`+++before+++`
+path;; `xref:conf_ppty_notes_items_metadata_icons[config.notes.items.metadata_icons]`
+--
+
+[[conf_ppty_notes_items_show_lead,config.notes.items.show_lead]]
+notes.items.show_lead::::
++
+--
+Whether to include the lead-in text for the section in the item metadata.
+This is useful for displaying the section header in the item metadata.
+
+
+[horizontal]
+type;; Boolean
+default;;
++
+`+++false+++`
+path;; `xref:conf_ppty_notes_items_show_lead[config.notes.items.show_lead]`
+--
+
+[[conf_ppty_notes_items_show_type_label,config.notes.items.show_type_label]]
+notes.items.show_type_label::::
++
+--
+Whether to show the type label in the item metadata output.
+If `false`, the type will be listed unlabeled in the output, for templates that support this option.
+
+Corresponds to the <<conf_ppty_history_labeling_type_label>> property, which defines the content displayed when this property is `true` for a given section of the history output.
+
+
+[horizontal]
+type;; Boolean
+default;;
++
+`+++false+++`
+path;; `xref:conf_ppty_notes_items_show_type_label[config.notes.items.show_type_label]`
+--
+
+[[conf_ppty_notes_items_show_parts_label,config.notes.items.show_parts_label]]
+notes.items.show_parts_label::::
++
+--
+Whether to show the parts label in the item metadata output.
+If `false`, parts will be listed unlabeled in the output, for templates that support this option.
+
+Corresponds to the <<conf_ppty_history_labeling_parts_label>> property (and optionally the <<conf_ppty_history_labeling_part_label>>), which defines the content displayed when this property is `true` for a given section of the history output.
+
+
+[horizontal]
+type;; Boolean
+default;;
++
+`+++false+++`
+path;; `xref:conf_ppty_notes_items_show_parts_label[config.notes.items.show_parts_label]`
+--
+
+[[conf_ppty_notes_items_show_tags_label,config.notes.items.show_tags_label]]
+notes.items.show_tags_label::::
++
+--
+Whether to show the tags label in the item metadata output.
+If `false`, tags will be listed unlabeled in the output, for templates that support this option.
+
+Corresponds to the <<conf_ppty_history_labeling_tags_label>> property (and optionally the <<conf_ppty_history_labeling_tag_label>>), which defines the content displayed when this property is `true` for a given section of the history output.
+
+
+[horizontal]
+type;; Boolean
+default;;
++
+`+++false+++`
+path;; `xref:conf_ppty_notes_items_show_tags_label[config.notes.items.show_tags_label]`
+--
+
+[[conf_ppty_notes_items_show_lead_label,config.notes.items.show_lead_label]]
+notes.items.show_lead_label::::
++
+--
+Whether to show the lead label in the item metadata output.
+If `false`, the lead will be listed unlabeled in the output, for templates that support this option.
+
+Corresponds to the <<conf_ppty_history_labeling_lead_label>> property, which defines the content displayed when this property is `true` for a given section of the history output.
+
+
+[horizontal]
+type;; Boolean
+default;;
++
+`+++false+++`
+path;; `xref:conf_ppty_notes_items_show_lead_label[config.notes.items.show_lead_label]`
+--
+
+[[conf_ppty_notes_items_show_auths_label,config.notes.items.show_auths_label]]
+notes.items.show_auths_label::::
++
+--
+Whether to show the authors label in the item metadata output.
+If `false`, authors will be listed unlabeled in the output, for templates that support this option.
+
+Corresponds to the <<conf_ppty_history_labeling_auth_label>> property, which defines the content displayed when this property is `true` for a given section of the history output.
+
+
+[horizontal]
+type;; Boolean
+default;;
++
+`+++false+++`
+path;; `xref:conf_ppty_notes_items_show_auths_label[config.notes.items.show_auths_label]`
+--