server/php/basic/public_html/static/lib/ckeditor/README.md
author ymh <ymh.work@gmail.com>
Sun, 14 Jul 2024 22:00:08 +0200
changeset 666 9d6550026232
parent 489 7f25a4453865
permissions -rw-r--r--
Added tag V00.13.04 for changeset 69d13e7dd286
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
489
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
     1
CKEditor 4 - Releases
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
     2
=====================
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
     3
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
     4
## Releases Code
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
     5
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
     6
This repository contains the official release versions of [CKEditor](http://ckeditor.com).
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
     7
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
     8
There are four versions for each release &mdash; `standard-all`, `basic`, `standard`, and `full`.
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
     9
They differ in the number of plugins that are compiled into the main `ckeditor.js` file as well as the toolbar configuration.
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    10
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    11
See the [comparison](http://ckeditor.com/presets) of the `basic`, `standard`, and `full` installation presets for more details.
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    12
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    13
The `standard-all` build includes all official CKSource plugins with only those from the `standard` installation preset compiled into the `ckeditor.js` file and enabled in the configuration. 
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    14
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    15
All versions available in this repository were built using [CKBuilder](http://ckeditor.com/builder), so they are optimized and ready to be used in a production environment.
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    16
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    17
## Documentation
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    18
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    19
Developer documentation for CKEditor is available online at: <http://docs.ckeditor.com>.
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    20
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    21
## Installation
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    22
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    23
### Git clone
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    24
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    25
To install one of the available releases, just clone this repository and switch to the respective branch (see next section):
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    26
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    27
	git clone -b <release branch> git://github.com/ckeditor/ckeditor-releases.git
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    28
	
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    29
### Git submodule
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    30
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    31
If you are using git for your project and you want to integrate CKEditor, we recommend to add this repository as a
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    32
[submodule](http://git-scm.com/book/en/Git-Tools-Submodules).
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    33
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    34
	git submodule add -b <release branch> git://github.com/ckeditor/ckeditor-releases.git <clone dir>
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    35
	git commit -m "Added CKEditor submodule in <clone dir> directory."
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    36
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    37
### Using Package Managers
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    38
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    39
See the [Installing CKEditor with Package Managers](http://docs.ckeditor.com/#!/guide/dev_package_managers) article for more details about installing CKEditor with Bower and Composer.
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    40
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    41
## Repository Structure
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    42
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    43
### Branches
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    44
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    45
This repository contains the following branches:
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    46
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    47
  - `master` and `latest` &ndash; the latest release of the `standard-all` preset (including betas).
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    48
  - `stable` &ndash; the latest stable release of the `standard-all` preset (non-beta).
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    49
  - `A.B.x` (e.g. `4.3.x`) &ndash; the latest release of the `standard-all` preset in the `A.B` branch.
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    50
  - `(basic|standard|full)/stable` &ndash; the latest stable release tag point (non-beta).
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    51
  - `(basic|standard|full)/latest` &ndash; the latest release tag point (including betas).
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    52
  - `(basic|standard|full)/A.B.x` (e.g. `basic/4.0.x`) &ndash; the latest releases in the `A.B` branch.
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    53
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    54
### Tags
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    55
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    56
**Since version 4.3.3** this repository uses the following tag naming rules:
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    57
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    58
  - `x.y.z` &ndash; contains the `standard-all` editor build, e.g. `4.3.3`, `4.4.0` etc.
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    59
  - `(basic|standard|full)/x.y.z` &ndash; contains the editor build with a given preset, e.g. `basic/4.3.3`.
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    60
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    61
The version numbers follow the [Semantic Versioning 2.0.0](http://semver.org/) scheme.
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    62
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    63
Up to version **4.3.2** the tags were released in the following form `x.y[.z]/(basic|standard|full)`.
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    64
For example: `4.0/basic`, `4.0.1/standard`. This convention was changed in CKEditor 4.3.3 to conform to the Semantic Versioning scheme.
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    65
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    66
## Checking Your Installation
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    67
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    68
The editor comes with a few sample pages that can be used to verify if the installation succeeded. Take a look at the `samples` directory.
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    69
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    70
To test your installation, just call the following page for your website:
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    71
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    72
	http://<your site>/<CKEditor installation path>/samples/index.html
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    73
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    74
For example:
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    75
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    76
	http://www.example.com/ckeditor/samples/index.html
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    77
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    78
### License
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    79
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    80
Licensed under the GPL, LGPL, and MPL licenses, at your choice.
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    81
7f25a4453865 update renkan server deploiement
ymh <ymh.work@gmail.com>
parents:
diff changeset
    82
Please check the `LICENSE.md` file for more information about the license.