CKEditor 3.x/Developers Guide/CKReleaser - Revision history

Anna: Minor adjustment

2011-12-06T15:11:45Z

Minor adjustment

Anna: Article updated

2011-12-06T14:47:25Z

Article updated

Anna: moved FCKeditor 3.x/Design and Architecture/CKReleaser to CKEditor 3.x/Developers Guide/CKReleaser: Moving the updated article to CKEditor 3.x Developer's Guide

2011-12-06T13:16:58Z

moved FCKeditor 3.x/Design and Architecture/CKReleaser to CKEditor 3.x/Developers Guide/CKReleaser: Moving the updated article to CKEditor 3.x Developer's Guide

Anna: Command corrected

2011-12-06T13:14:57Z

Command corrected

Anna: Deprecated documentation and samples information removed

2011-12-06T12:58:33Z

Deprecated documentation and samples information removed

Anna: TOC added

2011-12-05T14:34:28Z

TOC added

Anna: Duplicate title removed

2011-12-05T14:34:03Z

Duplicate title removed

Anna: /* Configuration File */ Article section proof-read and formatted

2011-12-05T14:31:45Z

‎Configuration File: Article section proof-read and formatted

Anna: /* Samples */ Article section proof-read and formatted

2011-12-05T14:23:01Z

‎Samples: Article section proof-read and formatted

Anna: /* Documentation */ Article section proof-read

2011-12-05T13:29:19Z

‎Documentation: Article section proof-read

← Older revision		Revision as of 15:11, 6 December 2011
Line 18:		Line 18:


−	If you downloaded the latest editor source code from [http://dev.ckeditor.com/browser/CKEditor/trunk CKEditor trunk], you can also run the existing CKReleaser script. Go to the <code>_dev/releaser</code> folder and run the <code>release.bat</code> (for Windows) or <code>release.sh</code> for Linux to trigger CKReleaser.	+	If you downloaded the latest editor source code from [http://dev.ckeditor.com/browser/CKEditor/trunk CKEditor trunk], you can also run the existing CKReleaser script. Go to the <code>_dev/releaser</code> folder and run the <code>release.bat</code> (for Windows) or <code>release.sh</code> (for Linux) to trigger CKReleaser.

	== Configuration File ==		== Configuration File ==

← Older revision		Revision as of 14:47, 6 December 2011
Line 17:		Line 17:
	</note>		</note>

		+
		+	If you downloaded the latest editor source code from [http://dev.ckeditor.com/browser/CKEditor/trunk CKEditor trunk], you can also run the existing CKReleaser script. Go to the <code>_dev/releaser</code> folder and run the <code>release.bat</code> (for Windows) or <code>release.sh</code> for Linux to trigger CKReleaser.

	== Configuration File ==		== Configuration File ==

@@ Line 2: / Line 2: @@
 CKReleaser is an application that exports CKEditor code, making all changes, replacements, and compilations necessary to build a public release of CKEditor. It is a command line program, with the following execution syntax:
 <source>
-ckreleaser [source_dir] [target_dir] [version] [zip_name] [gzip_name]
+ckreleaser release_file source_dir target_dir version file_name [--run-before-release=script] [-v | --verbose]
 </source>
 * <code>''source_dir''</code> &ndash; the path to the development code of CKEditor.
 * <code>''target_dir''</code> &ndash; the path to the output directory.
 * <code>''version''</code> &ndash; the version string used to replace the <code>%VERSION%</code> directive.
-* <code>''zip_name''</code> &ndash; the <code>.zip</code> file containing the compressed version of the release.
+* <code>''file_name''</code> &ndash;  name of the release file to create (without the extension).
-* <code>''gzip_name''</code> &ndash; the <code>.tar.gz</code> file containing the compressed version of the release.
+* <code>--run-before-release=''script''</code> &ndash; (optional) the path to a script that is to be run on source files.
-At the end of the process, the <code>''target_dir''</code> directory will be created and it will contain a directory named <code>release</code>, with the uncompressed version of the release files as well as the distribution files (in <code>.zip</code> and <code>.gzip</code> formats).
+At the end of the process, the <code>''target_dir''</code> directory will be created and it will contain a directory named <code>release</code>, with the uncompressed version of the release files as well as the distribution files (in <code>.zip</code> and <code>.tar.gz</code> formats).
 <note>The execution fails if the <code>''target_dir''</code> already exists.

@@ Line 85: / Line 85: @@
 * <code>copy</code> &ndash; a list of objects identifying files and folders to be copied to different directories in the release package. The <code>minify</code> argument specifies whether <code>.js</code> and <code>.css</code> files are to be minified when outputting (see "Minification" below).
 * <code>packages</code> &ndash; a list of configuration files to be executed by CKPackager.
 * <code>skins</code> &ndash; information about the skins location (see "Skins" below).
 == Minification  ==
 The process of reducing the size of JavaScript and CSS files by removing spaces, comments, etc. from it is called ''minification''. Several files are to be minified on the output. We are using [[CKEditor_3.x/Developers_Guide/CKPackager|CKPackager]] to minify our source code.
 == Skins  ==

← Older revision		Revision as of 14:34, 5 December 2011
Line 1:		Line 1:
		+	__TOC__
	CKReleaser is an application that exports CKEditor code, making all changes, replacements, and compilations necessary to build a public release of CKEditor. It is a command line program, with the following execution syntax:		CKReleaser is an application that exports CKEditor code, making all changes, replacements, and compilations necessary to build a public release of CKEditor. It is a command line program, with the following execution syntax:
	<source>		<source>

← Older revision	Revision as of 13:16, 6 December 2011
(No difference)

@@ Line 17: / Line 17: @@
 == Configuration File  ==
-CKReleaser uses a configuration file containing precise information about the tasks to be performed to build a release. The default configuration file for CKEditor is called "ckeditor.release". The following are its contents:
+ignore :
+[
 	'_dev',
-	'_docs/api',
+	'.svn',
-	'_samples',
+	'.settings',
-	'_source/adapters'
+	'.project',
 ],
-copy&nbsp;:
+copy :
+[
+	{
-		source&nbsp;: '_source/lang',
+		source : '_source/lang',
-		target&nbsp;: 'lang',
+		target : 'lang',
-		minify&nbsp;: true
+		minify : true
 	},
+	{
-		source&nbsp;: '_source/plugins',
+		source : '_source/adapters',
-		target&nbsp;: 'plugins',
+		target : 'adapters',
-		minify&nbsp;: true
+		minify : true
 	},
+	{
-		source&nbsp;: '_source/tests',
+		source : '_source/plugins',
-		target&nbsp;: 'tests',
+		target : 'plugins',
-		minify&nbsp;: false
+		minify : true,
 	},
+	{
-		source&nbsp;: '_source/themes',
+		source : '_source/themes',
-		target&nbsp;: 'themes',
+		target : 'themes',
-		minify&nbsp;: true
+		minify : true
+	}
 ],
-packages&nbsp;:
+rename :
+[
 	'ckeditor.pack'
 ],
-documentation&nbsp;:
+skins :
+{
-	config: '_dev/docs_build/docs_build.conf',
+	source : '_source/skins',
-	target: '_docs/api'
+	target : 'skins',
-},
+	minify : true
+}
-</pre>
+</source>
-Note that the configuration file uses the syntax of a JavaScript literal object declaration. This is intentional, and actually it is also possible to use JavaScript code into the file. The entire file will be then loaded as a literal object declaration and interpreted as JavaScript code.
+Note that the configuration file uses the syntax of a JavaScript literal object declaration. This is intentional, and actually it is also possible to use JavaScript code inside the file. The entire file will then be loaded as a literal object declaration and interpreted as JavaScript code.
 The following are the main entries available in the configuration:
+* <code>fixLineEnds</code> &ndash; indicates that the <code>fixlineends</code> application is to be run in the *output* folder at the end of the process.
-*'''fixLineEnds''': indicates that the "fixlineends" application is to be run in the *output* folder at the end of the process.
+* <code>ignore</code> &ndash; a list of files and folder paths that are to be ignored by CKReleaser.
-*'''ignore''': a list of files and folder paths that are to be ignored by CKReleaser.
+* <code>copy</code> &ndash; a list of objects identifying files and folders to be copied to different directories in the release package. The <code>minify</code> argument specifies whether <code>.js</code> and <code>.css</code> files are to be minified when outputting (see "Minification" below).
-*'''copy''': a list of objects identifying files and folders to be copied to different directories in the release. The "minify" argument specifies whether .js and .css files are to be minified when outputting (see "Minification" below).
+* <code>packages</code> &ndash; a list of configuration files to be executed by CKPackager.
-*'''packages''': a list of configuration files to be executed by CKPackager.
+* <code>documentation</code> &ndash; information needed to build the API documentation (see "Documentation" below).
-*'''documentation''': information needed to build the API documentation (see "Documentation" below).
+* <code>samples</code> &ndash; information about the <code>_samples</code> folder, including its location and the path to the template file (see "Samples" below).
-*'''samples''': information about the _samples folder, including its location and the path to the template file (see "Samples" below).
+* <code>skins</code> &ndash; information about the skins location (see "Skins" below).
 == Minification  ==

@@ Line 100: / Line 100: @@
 == Samples  ==
-The "_samples" folder contains a set of examples that show CKEditor in action. The development version of the samples uses a template system to provide a standard output to all samples.
+The template file is called <code>sample.html</code>. All other <code>.html</code> files located in that folder (source files) contain data used to fill the template.
-The template file is called "sample.html". All other .html files located in that folder (source files) contain data used to fill the template.
+The source files are XML files containing several nodes with specific IDs that we use to locate the data to be loaded into the template. The following is a list of possible IDs:
-The source files are XML files containing several nodes with specific ids that we used to locate the data to be loaded into the template. The following are the possible ids:
+The template file contains <code>&lt;script&gt;</code> tags with the same IDs used in the source that need to be replaced by CKReleaser and filled with the source data. For example, the following is the original tag used to embed the <code>html</code> data:
+<source lang="html4strict">
-*'''headscript''' (optional): contains sample specific script to be loaded in the &lt;head&gt;.
+<script id="html" type="text/javascript">
-*'''styles''' (optional): contains sample specific styles.
+//<![CDATA[
 	document.write( CKEDITOR.samples.htmlData );
-//]]&gt;
+//]]>
-&lt;/script&gt;
+</script>
-</pre>
+</source>
-CKReleaser '''removes''' the above tag, replacing it with '''the contents''' of the source node with id "html". The "headscript" and "styles" data are special cases, because other than the data contents, the specific &lt;script&gt; and &lt;style&gt; tags must be also included.
+CKReleaser removes the above tag, replacing it with the contents of the source node with an ID of <code>html</code>. The <code>headscript</code> and <code>styles</code> data are special cases, because other than the data contents, the specific <code>&lt;script&gt;</code> and <code>&lt;style&gt;</code> tags must also be included.
-The original source file names must be used for the release version, containing the "template filled" version of each sample. The template file instead will not be part of the release.
+The original source file names must be used for the release version, containing the template-filled version of each sample. The template file itself will not be part of the release.
 == Skins  ==

@@ Line 95: / Line 95: @@
 == Documentation  ==
-The JavaScript API documentation is automatically generated by CKReleaser. It uses JsDoc Toolkit to build a pure HTML reference, extracting the documentation structure and text from the CKEditor source code.
+CKReleaser runs JsDoc Toolkit over a configuration file present in the source directory and outputs it directly to the target directory.
 == Samples  ==