Create a Jupyter notebook to document and design the string substitution feature as it relates to templated LocatableContents.
This includes designing the utility method for substitution, as well as explaining and providing support for managers and hosts wishing to utilize this behaviour, including a listing of all of our defined substitution variables (see LocatableContent docs in traits.yml).
ACs
Should document:
Why substitution is needed
Why a substitution standard needs to exist
Demonstrate substitution syntax
Point out this is broadly compatible with libformat/python format strings, (officially, we only support the simplest substitution, unofficially you can do everything libformat/python format strings do)
Worked example with locatableContent demonstrating openAssetIO substitution method(s)
What
Create a Jupyter notebook to document and design the string substitution feature as it relates to templated LocatableContents.
This includes designing the utility method for substitution, as well as explaining and providing support for managers and hosts wishing to utilize this behaviour, including a listing of all of our defined substitution variables (see LocatableContent docs in traits.yml).
ACs
Should document: