Naming conventions

OpenXPKI employs a few naming conventions in its code and configuration files:

Methods are usually in lower case and separated by an underscore, i.e. get_chain.
Internationalization identifiers always start with I18N_OPENXPKI and are all caps seperated by underscores. They indicate the path to the module in which they are used, i.e. if you have an exception in OpenXPKI::Crypto::Toolkit, the identifier should start with I18N_OPENXPKI_CRYPTO_TOOLKIT_.
Workflow configuration files only use internationalization identifiers in the type and description, workflow states are short words in capitals, seperated by underscores. Examples are INITIAL or CSR_EXTRACTED. Workflow activities (which are called actions in the configuration) are short words (usually verbs) in lowercase, such as extract_csr or null. Workflow conditions and validators use similar conventions. Conditions which have to do with ACLs use the prefix ACL:: to distinguish them from normal conditions.

Of course, these rules are not set in stone, but make working together a bit easier.