diff --git a/docs/BOSS Metadata Syntax.html b/docs/BOSS Metadata Syntax.html index cd15ac74..006d3488 100644 --- a/docs/BOSS Metadata Syntax.html +++ b/docs/BOSS Metadata Syntax.html @@ -106,21 +106,8 @@ h3{
Some important points that are more specific to how BOSS uses YAML:
<<:).
- -?:,[]{}#&*!|>"%@`, unless they also contain any single quotes, in which case the string should be enclosed in double quotes instead. This isn't always strictly necessary, but it's better to err on the side of caution. If you really want to only quote strings when absolutely necessary, be sure to check what you write by copy/pasting the whole data structure the string appears into a YAML parser such as this one and making sure that what it outputs is correct.
- " → \" and \ → \\. It's best to avoid using backslashes (except for the purpose of escaping) wherever possible, due to its double meaning. In file paths, a forwardslash can be used instead.
- For example, the following condition nodes are all equivalent: -
condition: not file("meshes\Characters\_1stperson.nif")
- condition: 'not file("meshes\Characters\_1stperson.nif")'
- condition: "not file(\"meshes\\Characters\\_1stperson.nif\")"
- condition: not file("meshes/Characters/_1stperson.nif")
- condition: 'not file("meshes/Characters/_1stperson.nif")'
- condition: "not file(\"meshes/Characters/_1stperson.nif\")"
- These docs give all example syntax in YAML's least compact representation: you can also use a more compact representation, but make sure that you do not sacrifice readability when doing so.
Some properties of file paths as used by BOSS:
Meshes\\Resources(1|2)\\(upperclass)?table.nif, BOSS will look for a file named table.nif or upperclasstable.nif in the Meshes\Resources(1|2) folder, rather than looking in the Meshes\Resources1 and Meshes\Resources2 folders.
Please test any changes you make before uploading them. One way of doing this is to run BOSS, another is to copy/paste what you've changed into an online parser such as this one, though it won't catch condition syntax errors or non-syntax errors such as having the same file both required and incompatible. +
Please test any changes you make before uploading them. One way of doing this is to run BOSS, another is to copy/paste what you've changed into here, though it won't catch condition syntax errors and doesn't use the same parser as BOSS so may give different results.
The root of a metadata file is a key-value map. BOSS will recognise the following keys, none of which are required: