diff --git a/docs/BOSS Metadata Syntax.html b/docs/BOSS Metadata Syntax.html index 006d3488..7dcc743a 100644 --- a/docs/BOSS Metadata Syntax.html +++ b/docs/BOSS Metadata Syntax.html @@ -128,22 +128,22 @@ h3{

Other keys may also be present, but are not processed by BOSS. The message and plugin data structures are detailed in the next section.

An example metadata file: globals: - - type: say - content: You are using the latest version of BOSS. + - type: 'say' + content: 'You are using the latest version of BOSS.' condition: 'version("BOSS", "3.0.0.0", ==)' plugins: - - name: Armamentarium.esm + - name: 'Armamentarium.esm' tag: - - Relev - - name: ArmamentariumFran.esm + - 'Relev' + - name: 'ArmamentariumFran.esm' tag: - - Relev + - 'Relev' - name: 'Beautiful People 2ch-Ed.esm' tag: - - Eyes - - Graphics - - Hair - - R.Relations + - 'Eyes' + - 'Graphics' + - 'Hair' + - 'R.Relations' @@ -163,10 +163,10 @@ plugins: condition✗A condition string that is evaluated to determine whether this Bash Tag should be suggested: if it evaluates to true, the Tag is suggested, otherwise it is ignored. See Condition Strings for details.

Examples: -Relations +'Relations' or -name: -Relations -condition: "file(\"Mart's Monster Mod for OOO.esm\") or file(\"FCOM_Convergence.esm\")" +name: '-Relations' +condition: 'file("Mart''s Monster Mod for OOO.esm") or file("FCOM_Convergence.esm")'

File Data Structure

@@ -184,11 +184,11 @@ condition: "file(\"Mart's Monster Mod for OOO.esm\") or file(\"FCOM_Convergence.

Examples: -../obse_loader.exe +'../obse_loader.exe' or -name: ../obse_loader.exe +name: '../obse_loader.exe' condition: 'version("../obse_loader.exe", "0.0.18.0", >=)' -display: OBSE v18+ +display: 'OBSE v18+'

Message Data Structure

@@ -225,14 +225,14 @@ display: OBSE v18+

Examples (translations by Google): -type: say -condition: file("foo.esp") +type: 'say' +condition: 'file("foo.esp")' content: - - lang: eng + - lang: 'eng' str: 'An example link: http://www.example.com' - - lang: rus + - lang: 'rus' str: 'Это пример ссылки: http://www.example.com' - - lang: ger + - lang: 'ger' str: 'Ein Beispiel-Link: http://www.example.com' would be displayed as @@ -240,8 +240,8 @@ would be displayed as отмечать: Это пример ссылки: http://www.example.com if the current language was Russian and foo.esp was installed, while -type: say -content: An alternative "http://www.example.com example link", with no translations. +type: 'say' +content: 'An alternative "http://www.example.com example link", with no translations.' would be displayed as

@@ -263,11 +263,11 @@ would be displayed as verstring list✓A list of versions that can be found at the URL.

Examples: -http://skyrim.nexusmods.com/mods/19/ +'http://skyrim.nexusmods.com/mods/19/' or -link: http://steamcommunity.com/sharedfiles/filedetails/?id=87144366 +link: 'http://steamcommunity.com/sharedfiles/filedetails/?id=87144366' ver: - - 1.3.2c + - '1.3.2c'

Dirty Info Data Structure

@@ -283,7 +283,7 @@ ver:

Examples: crc: 0x3DF62AB -util: "http://www.creationkit.com/TES5Edit_Cleaning_Guide_-_TES5Edit TES5Edit" +util: '"http://www.creationkit.com/TES5Edit_Cleaning_Guide_-_TES5Edit TES5Edit"' itm: 4 udr: 160 nav: 0 @@ -307,23 +307,23 @@ nav: 0 dirtydirty info list✗An unordered list of dirty info structures for this plugin.

Example: -name: "Oscuro's_Oblivion_Overhaul.esm" +name: 'Oscuro''s_Oblivion_Overhaul.esm' req: - - Oblivion.esm # Don't do this, Oblivion.esm is a master of Oscuro's_Oblivion_Overhaul.esm, so BOSS already knows it's required. - - name: example.esp - display: "http://www.example.com Example Mod" - condition: "version(\"Oscuro's_Oblivion_Overhaul.esm\", \"15.0\", ==)" + - 'Oblivion.esm' # Don't do this, Oblivion.esm is a master of Oscuro's_Oblivion_Overhaul.esm, so BOSS already knows it's required. + - name: 'example.esp' + display: '"http://www.example.com Example Mod"' + condition: 'version("Oscuro''s_Oblivion_Overhaul.esm", "15.0", ==)' tag: - - Actors.Spells - - Graphics - - Invent - - Relations - - Scripts - - Stats - - name: -Relations - condition: "file(\"Mart's Monster Mod for OOO.esm\") or file(\"FCOM_Convergence.esm\")" + - 'Actors.Spells' + - 'Graphics' + - 'Invent' + - 'Relations' + - 'Scripts' + - 'Stats' + - name: '-Relations' + condition: 'file("Mart''s Monster Mod for OOO.esm") or file("FCOM_Convergence.esm")' msg: - - type: say + - type: 'say' content: 'Do not clean. "Dirty" edits are intentional and required for the mod to function.' @@ -332,11 +332,11 @@ msg:

File display strings and message content strings (including the strings in localised content structures) that contain recognised URLs have them displayed as hyperlinks in the BOSS report. Recognised URLs are those that are enclosed in double quotes and that begin with file:, http: or https:.

Hyperlinks may be labelled by writing the label after the URL inside the double quotes, with a space separating the label and URL. If a label is not provided, then the hyperlink will use the URL as its own label.

Examples: -"This \"https://en.wikipedia.org/wiki/String_(computer_science) string\" contains a labelled hyperlink." +'This "https://en.wikipedia.org/wiki/String_(computer_science) string" contains a labelled hyperlink.' would be displayed as

This string contains a labelled hyperlink.

While -"This string (see: \"https://en.wikipedia.org/wiki/String_(computer_science)\") contains an unlabelled hyperlink." +'This string (see: "https://en.wikipedia.org/wiki/String_(computer_science)") contains an unlabelled hyperlink.' both get displayed as

This string (see: https://en.wikipedia.org/wiki/String_(computer_science)) contains an unlabelled hyperlink.