Opened 11 years ago

Closed 11 years ago

#2442 closed New Feature (fixed)

V3: trunk folders/files structure

Reported by: Frederico Caldeira Knabben Owned by: Frederico Caldeira Knabben
Priority: Normal Milestone: CKEditor 3.0
Component: General Version:
Keywords: Confirmed V3ProtoStruct Review+ Cc:

Description

The CKEditor prototype presents the following folder structure:

  • _dev: development tools. We should not have files in this folder directly. Each tool should have its own folder.
    • _dev/_thirdparty: contains all third party code used by our tools. We should not have then in other folders.
  • _docs: destined to hold the documentation. Currently the JavaScript API is rendered in the "api" folder under it.
  • _samples: contains all samples. All JavaScript samples are placed in this folder directly. Server side sample will have their own folder, like "php" or "asp".
  • _source: contains the source code.
    • _source/adapters: destined to contain all adapters to JavaScript libraries, like jQuery.
    • _source/core: the core code.
    • _source/lang: destined to hold all language files.
    • _source/plugins: the core plugins code.
    • _source/skins: the skins.
    • _source/tests: the automated tests for the core code.
    • _source/themes: the themes.

Other than the above directories, other basic files are placed in the root:

  • ckeditor_source.js: the main file to be included in the pages when using the editor. This is the source code version, which runs using the _source files.
  • ckeditor_basic_source.js: the file to be included in the pages when using the editor, which contains the basic code for editor integration (this will be explained in another ticket). This is the source code version, which runs using the _source files.
  • .htaccess: specific htaccess entries for the distribution folder. This files has been copied from FCKeditor.
  • config.js: custom configurations file.
  • contents.css: the css file for the editor contents.
  • CHANGES.html: the changelog file.
  • INSTALL.html: basic installation instructions.
  • LICENSE.html: licensing information.
  • README.html: some text giving an overall presentation about the code and the project.

Also, in the root folder, we'll find all integration files, named "ckeditor.ext".

When "building" the development code, several transformations will happen to this structure. The "adapters", "lang", "plugins", "skins" and "themes" folders from _source will have their relative "compiled" versions in the root. The "ckeditor.js" and "ckeditor_basic.js" files will be also created at that point.

Change History (4)

comment:1 Changed 11 years ago by Frederico Caldeira Knabben

Keywords: Review? added
Owner: set to Frederico Caldeira Knabben
Status: newassigned

comment:2 Changed 11 years ago by Frederico Caldeira Knabben

Type: BugNew Feature

comment:3 Changed 11 years ago by Martin Kou

Keywords: Review+ added; Review? removed

comment:4 Changed 11 years ago by Frederico Caldeira Knabben

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