Opened 9 years ago

Last modified 9 years ago

#6009 confirmed New Feature

Create "Configurator" sample

Reported by: Alfonso Martínez de Lizarrondo Owned by:
Priority: Normal Milestone:
Component: General Version:
Keywords: Cc: comp615@…

Description

This sample/tool/wizard should allow the user to test the behavior of as much config options as possible and get the js code that he needs to use for use it in his implementation.

Proposed in http://dev.ckeditor.com/ticket/5998#comment:8

Change History (6)

comment:1 Changed 9 years ago by Charlie

Cc: comp615@… added

I was bored so I whipped up a quick example in a few minutes with one way I had of doing it. See: http://alpsoftware.net/ckconfig.php5 http://alpsoftware.net/ckesettings.xml

Basically the php would read the xml file and translate that into a page. Then clicking the button would do an ajax call to process it all and would return the config file (Which would also be used to generate a new editor instance). The base href thing I thought would be good because then it allows people to use relative paths in their configs and still get the right css files to show. I this kind of what you had in mind?

comment:2 Changed 9 years ago by Frederico Caldeira Knabben

Status: newconfirmed

I was thinking about a JavaScript client application though.

comment:3 Changed 9 years ago by Charlie

Ahhh I see...you mean something that could be distributed with the editor? Hmmm also an interesting idea. I suppose that could even be more useful for the people downloading it. The only potential downside I see is people just looking to see what kind of things the editor can do (It'd serve as like a very extended online demo). But ultimately up to you guys!

comment:4 in reply to:  3 Changed 9 years ago by Sa'ar Zac Elias

Replying to comp615:

The only potential downside I see is people just looking to see what kind of things the editor can do (It'd serve as like a very extended online demo).

I actually see that as an advantage. People like to just try stuff and see what happens, so eventually it'll help them to create the configuration they want. Sometimes the very small knowing of an application's options is the reason why people think it's not what they're looking for.

Several notes:

  • In each release all the available options should be listed.
  • Each configuration option should have his name displayed with his description attached (using a tooltip is a great option IMHO).
  • Each option should have a checkbox to determine if the option is currently under testing (if checked off the whole row should be "disabled").
  • The way the values should be available in the interface is:
  • * If there are fixed possible values, all of them should be listed with they're descriptions, using radio buttons or selectboxes.
  • * If the values are T/F, we should use checkboxes.
  • * Otherwise, text inputs should be displayed.
  • Having a possibility the visibly group the configuration options should be a great feature of that (e.g. in an alphabetical order, group by feature etc.).

Any comments?

comment:5 Changed 9 years ago by Sa'ar Zac Elias

And also:

  • In the options that are related to plugins (e.g. extraPlugins) we should have a multiple-choise-selectbox with all available plugins. We should disable and enable them at runtime according to other plugins related options.
  • Should we list all plugins, options and values in a XML file, JS object or something else?

comment:6 Changed 9 years ago by Alfonso Martínez de Lizarrondo

As I said in the initial message, I don't think that we really need to list ALL the options, there might be some parts that are used so little or are so complex that we don't have to worry about them. Also it might be better to have something working with 50% of the options and release it instead of trying to get 100% and never release anything.

It should be very easy to use, it must help to understand and test what each option does, but it doesn't have to be perfect. The ultimate option would be to manually adjust whatever he wants in the output shown in a textarea and press the "test this configuration" button.

Note: See TracTickets for help on using tickets.
© 2003 – 2019 CKSource – Frederico Knabben. All rights reserved. | Terms of use | Privacy policy