Suggest of an additional config-argument

Hello!
I needed to start CKEditor-instances with special data, because my self-written plugin needs data from the calling site. A comfortable way is to override the config-object with a new argument. Let me name it „myargument“. Now it is possible to give any instance any data I want.

Example:

CKEDITOR.replace('editor1',{
  "customConfig":"folder/config.js",
  ...
  "myargument":{"key1":"value1","key2":"value2" ...}
  });

alert(editor.config.myargument.key1) // shows: value1

After all this works fine. But if CKEditor will make use in the future of an argument called exactly the same as my one, there will be a bug.

So I suggest, because I guess it would be useful for other users as well, to define a reserved keyword just like „additionalData“ or something like this, which is reserved for the use of the useres.

To say it clear: just for my use! :twisted:

Ciao
railing

Sat, 10/15/2011 - 17:58

alfonsoml

Joined: 31/12/2006

Posts: 3735

Re: Suggest of an additional config-argument

That can't work because two plugins will then try to use that reserved word.

Just make the name of your config option specific enough that there's no possibility that another unrelated plugin or core code might try to use it. Instead of "myData" call it "railing_myData" and you'll be safe.