If the string contains any single quotes, they should be repeated.
Arbitrary string values should be enclosed in single quotes.Lists should also use the "block" style, unless they contain only one element, in which case the "flow" style can be used for compactness. Maps should be written in YAML's "block" style.Child data nodes should be indented two spaces from their parents, for the best trade-off between compactness and readability.Writing Styleįor consistency and to make it easier for people to understand what others have written, it's best to use the following style points when editing the masterlist. For more information, please read this article by Arthur Koziel. And using the following plugin Plug 'pedrohdz/vim-yaml-folds' If you're using Vim, you can add this line to your Vim config autocmd FileType yaml setlocal tabstop=2 softtabstop=2 shiftwidth=2 expandtab The keyboard shortcut "Alt+Shift+0" will then reverse this action. As the masterlists use two-space indentation, a "Tab size" of 2 is preferable.Īnother good piece of advice is to make use of the keyboard shortcut "Alt+0" to collapse the main nodes of the masterlists ("common", "plugins", etc), which will make navigating the masterlists easier. To do this, go to Settings > Preferences > Languages > Tab Settings > yaml > Replace by space.
If you're using Notepad++, you can set it to use spaces instead of tabs when you press the tab key on your keyboard, avoiding YAML parsing errors. See Quickly Testing Your Masterlist Changes for instructions. Test your changes before uploading them, to make sure you didn't make any syntax mistakes.Where you put a plugin doesn't matter - you may want to see if there are any related plugins in the masterlist already and group them together, or you can just add the plugin to the end of the list.Use blank lines to separate mods that are grouped together or where it helps readability.However, make sure to put them above the line(s) that they refer to. Make as many silent comments as you want within the masterlists - it doesn't hurt (within reason).Only make edits/additions you're confident about - otherwise create an issue in the masterlist repository's issue tracker, or discuss in the official LOOT forum thread.Look in the masterlists for examples, and see the Metadata Syntax documentation for the details.The purpose of this page is to give a bit of information to help with editing a masterlist.
0 kommentar(er)
