Commonly used terms¶
Here are some style guidelines on commonly used terms throughout the documentation:
|TwoEars|– when referring to the project in general, this will be automatically replaced by Two!Ears|TwoEarsModel|– when referring to the complete auditory model, this will be replaced with the text Two!Ears Auditory Model.|BinSim|– when referring to the binaural simulator module of the Two!Ears Auditory Model, this will be automatically replaced by Binaural simulator.|AFE|– when referring to the auditory front-end module of the Two!Ears Auditory Model, this will be automatically replaced by Auditory front-end.|blackboard|– when referring to the blackboard architecture module of the Two!Ears Auditory Model, this will be automatically replaced by Blackboard system.|robot|– when referring to the robot platform of the Two!Ears Auditory Model, this will be automatically replaced by Robotic platform.|database|– when referring to the database of the Two!Ears Auditory Model, this will be automatically replaced by Database.|amtoolbox|– when referring to the Auditory Modelling Toolbox, this will be automatically replaced by Auditory Modeling Toolbox.Matlab– when referring to the language, capitalise Matlab.localise,initialise, etc. – use the British “ise” suffix, not “ize.”
Note
These automatic replacement are defined in the file replacements.py,
which also involves things lile |DnnLocationKS|. Common links are
defined in links.py, acronyms are defined in acronyms.py,
see Using acronyms.