You need to understand the API docs site to know what methods etc are available for CBI18N.
The confusion comes when only some of the methods are automatically registered on installation and for the rest you need to put in the injection into the handlers.
Obviously when you know that it’s trivial but why make life difficult? The package methods surely should all be registered or not at all. Or even this fact should be mentioned in the API docs.
AFAIK does ‘not work’ means that an error is thrown when trying to use the method. I cut my coding teeth with Golang where issues like this have been explicitly removed - these problems with Coldbox, for a newbie, are very disheartening as they can be avoided completely by management of the learning resources available.
I’ve lost count of the times I’ve had to repeat areas because things just are not clear!
Coldbox has the opportunity to increase its user base but making documentation difficult is not the way forward.
I’m not really sure I’m following the use case for documenting what is not registered. The i18n() method is available and the documentation already demonstrates the usage of that object and its methods here: Coding for i18n - cbi18n
Surely the documentation needs to explain the caveats. I agree that it’s not difficult IF you have an understanding of the way ColdBox is constructed. There is a very steep learning curve for this, full of magic that only becomes clear after many many hours of study.
However for somebody new this is really hard and necessitates lots of extra work to understand as nothing works first or second time.
Thanks, Tony! We do value your input. Please note that managing over 350 different Open-Source libraries gets complicated for a small team. We need help in many ways, either as patrons or people who contribute their time to assist us with sources or docs. So if you can assist us in making the docs more straightforward for new developers, that would be fantastic.
Writing documentation is one of the hardest things to do since you are targeting multiple people at multiple education levels, multiple experience levels, and multiple learning ability levels. They are, quite frankly, living docs. Since you have hit several roadblocks, sending us the contributions that would assist others in your position would be great. As I said, it’s impossible for us to determine how someone will learn our tools, and ultimately there can be many oversights as things are in our heads.