[Question] Discuss path for updating doc params, syntax for different versions

[melinite]

Need a plan of attack for how best to display version specific syntax, attributes, etc.
CF11/Railo and beyond will most likely enhance tags/functions that will either break or silently ignore.

---

We could:

• display version support by tabs or pillboxes (All Latest ACF Railo OpenBD)
• add extra column/field for version support since (paramSupportedSince...)
• or just not worry about it. Let developer deal with it.

⭐
I have updates for the CFDoc JSON Builder to be able to load a tag/function json and edit.

[pfreitag]

My thought was to keep it simple initially. So ideally if there are any compatibility differences those should be put in the notes field under each engine. If that doesn't end up work well, then we could add a compatibility column to the params struct, but I'd like to avoid that until it seams necessary.

[pfreitag]

The more I think about this, it might be a good idea to have support in the params for compatibility info -- I am thinking something like this:

params: [ { compatibility: { engine: "coldfusion", version: "11", notes: "Added this attribute" }, ... } ]

What do you think.

[melinite]

looks good. So dropping the min version in the primary attribute of a parameter and utilizing the version inside the compatibility key?

[pfreitag]

Was there a min version attribute in params? If so I don't know if it was used anywhere.

There is a minimum_version in the engines key -- which I think I'd like to keep that because I am using that to show the version number in the anchor text to the official docs on the top right.

[melinite]

You're right i don't think there was a min version params. I was thinking about engine.

[sihu]

Just as a short addition: Adobe has a history for each tag with all attribute-changes in their documentation (e.g. Coldfusion 9 - cfdump) but i like your suggestion and think, it would be more flexible. As a next step you could summarize all changes of all attributes and display them in as well in the end.
might be that it would be useful to know, when the tag was added to the language (the min-version), but as showed in cfdump, some attributes were added or changed later, so it would be nice, if that was also visible.

[pfreitag]

Sihu - there is the ability to specify what version that the tag was added under the engines key, see example here for a function that was added in cf10 and railo 4: https://github.com/foundeo/cfdocs/blob/master/data/en/sessionrotate.json then when you look at the doc page it shows R4+ and CF10+ on the top right, and links to their respective documentation. Under the engine key you can also specify notes which list any compatibility notes for a specific engine, you could use this to list history of new attributes but I think adding it to the params is going to be a better more structured approach in general, but since we don't support that yet if you want to add something to the notes or the description of the param feel free.

[pfreitag]

I'm going to close this, I think we can simply add CF9+ in the param description if necessary, I don't want to make it too complicated.