diff --git a/docs/metadata/data_structures/cleaning.rst b/docs/metadata/data_structures/cleaning.rst index 4e50f3d2..018b5f1c 100644 --- a/docs/metadata/data_structures/cleaning.rst +++ b/docs/metadata/data_structures/cleaning.rst @@ -13,13 +13,13 @@ This structure holds information on which versions of a plugin are dirty or clea ``string`` - **Required.** The utility that was used to check the plugin for dirty edits. If available, the version of the utility used should also be included (e.g. ``TES5Edit v3.11``). The string will be interpreted as GitHub Flavored Markdown. + **Required.** The utility that was used to check the plugin for dirty edits. If available, the version of the utility used should also be included (e.g. ``TES5Edit v3.11``). The string will be interpreted as CommonMark. .. describe:: detail ``string`` or ``localised content list`` - A message that will be displayed to the user. If a string is provided, it will be interpreted as GitHub Flavored Markdown. If a localised content list is provided, one of the structures must be for English. This is only used if the plugin is dirty, and is intended for providing cleaning instructions to the user. If undefined, defaults to an empty string. + A message that will be displayed to the user. If a string is provided, it will be interpreted as CommonMark. If a localised content list is provided, one of the structures must be for English. This is only used if the plugin is dirty, and is intended for providing cleaning instructions to the user. If undefined, defaults to an empty string. .. describe:: itm diff --git a/docs/metadata/data_structures/file.rst b/docs/metadata/data_structures/file.rst index 5bd844fc..118aea1b 100644 --- a/docs/metadata/data_structures/file.rst +++ b/docs/metadata/data_structures/file.rst @@ -12,7 +12,7 @@ Map Form .. describe:: display - A GitHub Flavored Markdown string, to be displayed instead of the file path in any generated messages, eg. the name of the mod the file belongs to. + A CommonMark string, to be displayed instead of the file path in any generated messages, eg. the name of the mod the file belongs to. .. describe:: detail @@ -20,9 +20,9 @@ Map Form if this file causes an error message to be displayed (e.g. because it's a missing requirement), this detail message content will be appended to that - error message. If a string is provided, it will be interpreted as GitHub - Flavored Markdown. If a localised content list is provided, one of the - structures must be for English. If undefined, defaults to an empty string. + error message. If a string is provided, it will be interpreted as CommonMark. + If a localised content list is provided, one of the structures must be for + English. If undefined, defaults to an empty string. .. describe:: condition diff --git a/docs/metadata/data_structures/group.rst b/docs/metadata/data_structures/group.rst index 1e5ac627..52446054 100644 --- a/docs/metadata/data_structures/group.rst +++ b/docs/metadata/data_structures/group.rst @@ -16,8 +16,8 @@ This structure can be used to hold group definitions. It is a key-value map. ``string`` - A GitHub Flavored Markdown description of the group, e.g. what sort of plugins - it contains. If undefined, the description is an empty string. + A CommonMark description of the group, e.g. what sort of plugins it contains. + If undefined, the description is an empty string. .. describe:: after diff --git a/docs/metadata/data_structures/localised_content.rst b/docs/metadata/data_structures/localised_content.rst index bdf4aee4..17179769 100644 --- a/docs/metadata/data_structures/localised_content.rst +++ b/docs/metadata/data_structures/localised_content.rst @@ -5,7 +5,7 @@ The localised content data structure is a key-value string map. .. describe:: text - **Required.** The GitHub Flavored Markdown message content string. + **Required.** The CommonMark message content string. .. describe:: lang diff --git a/docs/metadata/data_structures/message.rst b/docs/metadata/data_structures/message.rst index 6eea9d03..c0600caa 100644 --- a/docs/metadata/data_structures/message.rst +++ b/docs/metadata/data_structures/message.rst @@ -25,7 +25,7 @@ Messages are given as key-value maps. ``string`` or ``localised content list`` - **Required.** Either simply a GitHub Flavored Markdown string, or a list of localised content data structures. If the latter, one of the structures must be for English. + **Required.** Either simply a CommonMark string, or a list of localised content data structures. If the latter, one of the structures must be for English. .. describe:: condition @@ -37,7 +37,7 @@ Messages are given as key-value maps. ``string list`` - A list of GitHub Flavored Markdown strings to be substituted into the message content string. The content string must use numbered specifiers (``%1%``, ``%2%``, etc.), where the numbers correspond to the position of the substitution string in this list to use, to denote where these strings are to be substituted. + A list of CommonMark strings to be substituted into the message content string. The content string must use numbered specifiers (``%1%``, ``%2%``, etc.), where the numbers correspond to the position of the substitution string in this list to use, to denote where these strings are to be substituted. .. _languages: diff --git a/docs/metadata/introduction.rst b/docs/metadata/introduction.rst index 35821f4f..19eb7586 100644 --- a/docs/metadata/introduction.rst +++ b/docs/metadata/introduction.rst @@ -18,6 +18,6 @@ An important point that is more specific to how LOOT uses YAML: In this document, where a value's type is given as ``X list`` this is equivalent to a YAML sequence of values which are of the data type ``X``. Where a value's type is given as ``X set``, this is equivalent to a YAML sequence of **unique** values which are of the data type ``X``. Uniqueness is determined using the equality criteria for that data type. All the non-standard data types that LOOT's metadata syntax uses have their equality criteria defined later in this document. -Some strings are interpreted as `GitHub Flavored Markdown`_: where this is the case, the strings are interpreted according to version ``0.29-gfm`` of the specification. +Some strings are interpreted as `CommonMark`_: where this is the case, the strings are interpreted according to version ``0.29`` of the specification. -.. _GitHub Flavored Markdown: https://github.github.com/gfm/ +.. _CommonMark: https://spec.commonmark.org/0.29/ diff --git a/include/loot/metadata/file.h b/include/loot/metadata/file.h index 97016d18..5a2c70ac 100644 --- a/include/loot/metadata/file.h +++ b/include/loot/metadata/file.h @@ -49,7 +49,7 @@ public: * The filename of the file. * @param display * The name to be displayed for the file in messages, formatted using - * GitHub Flavored Markdown. + * CommonMark. * @param condition * The File's condition string. * @return A File object. diff --git a/include/loot/metadata/plugin_cleaning_data.h b/include/loot/metadata/plugin_cleaning_data.h index df92bd71..5fb34037 100644 --- a/include/loot/metadata/plugin_cleaning_data.h +++ b/include/loot/metadata/plugin_cleaning_data.h @@ -124,7 +124,7 @@ public: /** * Get the name of the cleaning utility that was used to check the plugin. * @return A cleaning utility name, possibly related information such as - * a version number and/or a Markdown-formatted URL to the utility's + * a version number and/or a CommonMark-formatted URL to the utility's * download location. */ LOOT_API std::string GetCleaningUtility() const; diff --git a/include/loot/struct/simple_message.h b/include/loot/struct/simple_message.h index eb30d8e6..b3419eb6 100644 --- a/include/loot/struct/simple_message.h +++ b/include/loot/struct/simple_message.h @@ -39,9 +39,7 @@ struct SimpleMessage { std::string language; /** - * @brief The message string, which may be formatted using - * [GitHub Flavored - * Markdown](https://help.github.com/articles/github-flavored-markdown). + * @brief The message string, which may be formatted using CommonMark. */ std::string text;