Error in strings file documentation?
-
The documentation on this page:
[https://developers.maxon.net/docs/cpp/2023_2/page_description_resource.html]
...defines the structure of a .str file like this:
STRINGTABLE descriptionname
{
NAME descriptionname;ELEMENT_1 "Long Name";
ELEMENT_2 "Long Name" "Short Name";
}...but all the examples I've seen so far look like this:
STRINGTABLE descriptionname
{
descriptionname "some text here";ELEMENT_1 "Long Name";
ELEMENT_2 "Long Name" "Short Name";
}Is there an error in the documentation or is this something that has changed in R21?
-
Thanks @heilei for reporting.
It will be fixed in a future revision.Best, R
-
Ok, thanks for your reply. I think that particular help page should be rewritten completely, as there are many typographical problems regarding reserved words vs. placeholders. F.ex. words like "CONTAINER", "STRINGTABLE" and "INCLUDE" are meant to be reserved words (i.e. they should appear as-is in the .res or .str file). On the other hand, "ELEMENTTYPE" is not a reserved word (if I've understood the syntax correctly); it represents any valid attribute type, f.ex. "BOOL". There might be other examples as well.
This is probably all clear to experienced C4D developers, but for a newcomer such as myself, the documentation is somewhat confusing. Typography really matters, when you're defining a syntax to someone new.
-
Hi @heilei thanks again for the comment! We'll try, where meaningful, to improve the typography in future releases.
Best, R
