OpenInteract2::Manual::API is a Perl module with API guidelines for OpenInteract2.
This document will provide an overview of the different APIs in OpenInteract2 -- configuration, templating and interfaces, logging, coding, etc. -- and provide recommended uses.
INI files everywhere
Where possible OpenInteract2 uses configuration in a slightly customized INI format. You can learn details of this format in the module that does the parsing (OpenInteract2::Config::Ini) but it's useful to put a few usage guidelines here.
Our custom INI format has different ways to define lists. You can just use the key multiple times:
key = value
key = value2
key = value3
But since some configuration keys take a lot of values this can make for a very long configuration file. As an alternative you can use this syntax:
@,key = value, value2, value3
The leading '@,' means:
@: This is a list
,: ...and I'm using a ',' to delimit the values.
This might be weird to some people so if people who are only vaguely familar with configuration files will be editing your data you might want to either add a note about what the leading '@' sequence means or just use the longer form.