V3: Samples

[Frederico Caldeira Knabben]

We must have clear samples that show most of the editor features. These samples are often used as references when integrating the editor in the real world.

[Frederico Caldeira Knabben]

The CKEditor prototype contains the _samples folder, which should hold all our samples. There are several differences from the samples available with FCKeditor:

• We don't have the "html" folder for the JavaScript samples. Those go directly in that folder. Server side samples should go inside folders instead.

• Sample files now have meaningful names, like "replacebyclass.html", instead of "sample01.html".

• Each sample contains the part of the code that is relevant to that sample. It should make it easy to users to understand how to recreate the sample by themselves.

• An alert is displayed if JavaScript is disabled or a non compatible browser is in use.

• The dev version uses a kind of "template system" for the samples, giving them a uniform output.

Regarding the "template system" in the dev version, all samples run through the "sample.html" file. This file takes the HTML defined in the sample files and fill placeholders with it.

When "building" the code for distribution, we will be transforming the samples, removing the template file and make each sample independent (basically writing the filled template in the files).