README.md

# CKEditor Integration with XWiki

Adds support for editing wiki pages using [CKEditor](http://ckeditor.com/).

Starting with XWiki 8.2 this is the default WYSIWYG content editor. On older versions of XWiki this application extends the Edit menu with a new entry called 'CKEditor' that loads a new edit mode where you can edit the content of the wiki page using the CKEditor.

* Project Lead: [Marius Dumitru Florea](http://www.xwiki.org/xwiki/bin/view/XWiki/mflorea)
* [Documentation & Download](http://extensions.xwiki.org/xwiki/bin/view/Extension/CKEditor+Integration)
* [Issue Tracker](http://jira.xwiki.org/browse/CKEDITOR)
* Communication: [Mailing List](http://dev.xwiki.org/xwiki/bin/view/Community/MailingLists>), [IRC]( http://dev.xwiki.org/xwiki/bin/view/Community/IRC)
* [Development Practices](http://dev.xwiki.org)
* Minimal XWiki version supported: XWiki 6.2.5
* License: LGPL 2.1+
* [Translations](http://l10n.xwiki.org/xwiki/bin/view/Contrib/CKEditorIntegration)
* Sonar Dashboard: N/A
* Continuous Integration Status: [![Build Status](http://ci.xwiki.org/buildStatus/icon?job=xwiki-contrib-application-ckeditor)](http://ci.xwiki.org/job/xwiki-contrib-application-ckeditor/)

## Building

You need Maven 3.1+ in order to build this extension.

## Release Steps

    ## Release the new version in JIRA and create the next version.

    ## Update the version hard-coded in the wiki pages.
    ## This is required because on older versions of XWiki the WebJar version is not automatically detected.
    ## If you are releasing the version X.Y then search for X.Y-SNAPSHOT in the UI module sources and replace
    ## each occurrence that refers to the CKEditor webjar with X.Y (i.e. replace the snapshot with the final
    ## version). Normally, you should get 3 occurrences, 2 in EditSheet and 1 in VelocityMacros.
    ## Commit the changes with the message "[release] Update version before release".

    ## Update the translations.
    ## * download the translation pack from l10n and unpack
    ##   http://l10n.xwiki.org/xwiki/bin/view/L10NCode/GetTranslationFile?name=Contrib.CKEditorIntegration&app=Contrib
    ## * copy the translation pages to the UI module sources
    ## * apply XAR format and review the changes
    ## * commit only the significant changes

    ## Prepare the tag for the new version.
    mvn org.apache.maven.plugins:maven-release-plugin:2.5:prepare -DautoVersionSubmodules

    ## Select Java 7 in order to silence the enforcer (even if we don't have Java code ATM,
    ## a WebJar is a Jar and we support older versions of XWiki that run on Java 7).
    sudo update-alternatives --config java
    sudo update-alternatives --config javac

    ## Perform the release
    mvn org.apache.maven.plugins:maven-release-plugin:2.5:perform

    ## Restore the Java version.
    sudo update-alternatives --config java
    sudo update-alternatives --config javac

    ## Update the version hard-coded in the wiki pages.
    ## Put back the snapshot version in the wiki pags, but using the next version. So if you released X.Y
    ## then look for X.Y in the UI module sources and replace it with <X.Y+1>-SNAPSHOT. As in the second step,
    ## there should be only 3 occurrence normally.
    ## Commit the changes with the message "[release] Update version after release".

    ## Finish the release on http://nexus.xwiki.org (Staging Repositories)

    ## Update the documentation page on http://extensions.xwiki.org
    ## Keep the release notes (the list of JIRA issues) only for the 2 most recent releases.

    ## Announce the release

    ## Update the version used in XWiki Enterprise