CKSource Docs - User contributions [en]

Template:Ckfinder 2.x Built-in Resource Types Options

2019-09-04T10:43:42Z

Anna: Minor text correction.

== Resource Type Options ==
For each resource type you may set several options to configure its behavior.

* <code>url</code> and <code>directory</code> – define the base URL address and the server directory used to handle and publish the files for this resource type. They follow the same rules as defined in the [[{{{link}}}|Quick Start]] section for the <code>baseUrl</code> and <code>baseDir</code> settings.

* <code>maxSize</code> – is the maximum size of the uploaded image defined in bytes. You may also use shorthand notation. Available options are: <code>G</code>, <code>M</code>, <code>K</code> (case insensitive). Remember that <code>1M</code> equals 1048576 bytes (one Megabyte), <code>1K</code> equals 1024 bytes (one Kilobyte), <code>1G</code> equals 1 Gigabyte.
*; Example: {{{example}}}

You can use the following settings to list the file extensions that can be upload to the server:
* <code>allowedExtensions</code> – the file extensions you wish to be allowed for upload with CKFinder. If left empty, only <code>deniedExtensions</code> is used to check uploads. The <code>NO_EXT</code> value can be used for enabling files without an extension.
* <code>deniedExtensions</code> – the file extensions you do not wish to be uploaded with CKFinder. The <code>NO_EXT</code> value can be used for denying files without an extension.

<note>Important: It is '''recommended''' to always use the <code>allowedExtensions</code> setting, in favor of <code>deniedExtensions</code>. If you leave <code>allowedExtensions</code> empty and you add an extension to the <code>deniedExtensions</code> list, for example <code>pdf</code>, the settings will allow the upload of all other files except the files with the <code>pdf</code> extension. This approach is not a good way to secure your server from unwanted uploads. The best way is to put all of the preferred extensions in the <code>allowedExtensions</code> list. This is the only way to effectively secure your server from hacker attacks.</note>

Template:Ckfinder 2.x Securing a Publicly Accessible Folder

2019-09-04T08:09:45Z

Anna: Removed redundant bracket.

When integrating CKFinder, you will often want to give users access to uploaded files, so they can insert images or links to files into the edited content. This requires to make the folder publicly accessible, so all the files are served through the web server. If you rely on your web server to serve the files uploaded with CKFinder, you should take additional steps to make sure the files are served in a secure way.

Let us assume that you have configured your CKFinder to allow uploading of avi files. Even if the avi file is then served with a valid Content-Type: <code>video/x-msvideo</code> header, some browsers may ignore this information and perform additional checks on the raw file contents. If any HTML-like data is detected in the file content, the browser may decide to ignore information about the content type and handle the served content as if it was a regular web page. This behavior is called [https://en.wikipedia.org/wiki/Content_sniffing content sniffing] (also known as ''media type sniffing'' or ''MIME sniffing''), and in some circumstances, it may lead to security issues (for example, it may open door for XSS attacks).

To avoid content sniffing, you should make sure that your server adds the <code>X-Content-Type-Options: nosniff</code> header to all HTTP responses when serving files from the publicly available folder. The <code>X-Content-Type-Options</code> response HTTP header is a marker used by the server to indicate that the MIME type set by the <code>Content-Type</code> header should not be changed and should be followed. As a result, the browser does not perform any content sniffing on the received content.

Main Page

2016-03-25T14:17:04Z

Anna: CKFinder 3 for ASP.NET Connector Documentation added.

{{#CUSTOMTITLE:CKSource Docs - The Official Documentation Site}}<table style="width:100%" cellspacing="30"><tr><td style="width:50%" valign="top">

{{CKEditor_Docs_FrontPage}}
</td><td style="width:50%" valign="top">

http://a.cksource.com/e/1/img/logo-ckfinder-h100.png

Manage your images and files with this easy to use yet extremely powerful file manager, making your web content truly rich and enhancing the user experience.

<ul>
<li class="homeMainDoc">[http://docs.cksource.com/ckfinder3/ CKFinder 3 Documentation Website]</li>
<li class="homeMainDoc">[http://docs.cksource.com/ckfinder3-php/ CKFinder 3 PHP Connector Documentation]</li>
<li class="homeMainDoc">[http://docs.cksource.com/ckfinder3-net/ CKFinder 3 ASP.NET Connector Documentation]</li>
<li class="homeMainDoc">[[CKFinder_2.x/Developers Guide|CKFinder 2 Developer's Guide]]</li>
<li class="homeMainDoc">[[CKFinder_2.x/Users Guide|CKFinder 2 User's Guide]]</li>
<li class="homeDoc">[[CKFinder_1.x/Developers Guide|CKFinder 1.x Developer's Guide]]</li>
<li class="homeDoc">[[CKFinder_1.x/Users Guide|CKFinder 1.x User's Guide]]</li>
<li class="homeSite">[http://cksource.com/ckfinder CKFinder Web Site]</li>
</ul>

</td></tr>
<tr>
<td style="width:50%" valign="top">
http://a.cksource.com/c/1/inc/img/ckeditor-for-drupal-logo.png

The ultimate editing solution for Drupal Open Source CMS that brings all amazing features of the most popular online WYSIWYG editor in the world to this platform.

<ul>
<li class="homeMainDoc">[[CKEditor_for_Drupal|CKEditor for Drupal Documentation]]</li>
</ul>
</td>
<td style="width:50%" valign="top">
http://a.cksource.com/c/1/inc/img/ckeditor-for-joomla-logo.png

The ultimate editing solution for Joomla! content management system that brings all amazing features of the most popular online WYSIWYG editor in the world to this platform.

<ul>
<li class="homeMainDoc">[[CKEditor_for_Joomla|CKEditor for Joomla Documentation]]</li>
</ul>
</td>
</tr>

</table>

<htmlet>enterprise_box</htmlet>

<htmlet>enterprise_solutions</htmlet>

FCKeditor 3.x/Design and Architecture/Rebranding

2015-11-17T12:14:24Z

Anna: /* The Problem */ Minor grammar correction

== FCKeditor, The Name ==

The '''FCK''' letters in '''FCKeditor''' are the initials of Frederico Caldeira Knabben, the project starter and lead developer of FCKeditor.

Frederico was used to use "fckVarName" while developing to indicate temporary things he introduced in the code. While living in Rome, his Italian co-workers were used to play with him point things like the "FCK Thing" because of it. So, in the late 2002, he decided to call his editor project "FCKeditor", as it fitted well with his friends jokes. The name sounded good in any case.

== The Problem ==

Well, "FCKeditor" doesn't always sound good really. It depends on the person reading it.

For native English speakers (Frederico is Brazilian), the FCK letters combined together are a shortcut for a bad word (probably the most used bad word in English). This information came to Frederico too late, after 2 years of FCKeditor, and the project was already too diffuse and mature to think about changing its name.

Many will say that the name is not a problem. The important thing is the quality of the software. This is true, but many others will feel the overall editor quality lower just because of that name fact. People may not understand how serious we are about FCKeditor, not taking us seriously because of it.

== Rebranding ==

Changing the editor name right now is an extremely complex task. In the marketing point of view, it may be a bad decision, but it depends on the benefits it could bring.

We feel that we need to face this change. We want to make our editor perfect in all senses, so why not work on its name? 

== The New Name: CKEditor ==

After [http://www.fckeditor.net/forums/viewtopic.php?f=11&t=8784 long discussions at our forums], [http://www.fckeditor.net/node/374 polls], and in-depth thoughts, we have defined the new name for the editor: '''CKEditor'''. The "F" has been dropped from "FCK", and the "E" is now uppercased to avoid the confusion we had in the past.

Being this new name a perfect solution for a new editor product is still discussible, but it's proving to be the best compromise for a successful name changing in our case.

This change would also allow us following a product like with the "CK" prefix: CKEditor, CKFinder, CKPackager, etc. The CK letters stand for "Content and Knowledge".

Template:Drupal OS CKFinder

2015-07-14T13:03:05Z

Anna:

CKFinder is an Ajax-based file manager created by CKEditor developers: http://ckfinder.com/. CKFinder support is already built into the CKEditor for Drupal module, but due to licensing issues you need to buy it separately, add the files to your Drupal site and then enable the file browser.

<note>The instructions below are valid for '''CKFinder 2.x only'''. The CKEditor module as well as its documentation will be adjusted to new CKFinder 3.x soon.</note>

<note>If you are looking for a simplified solution, try the [http://ckeditor.com/ckeditor-for-drupal Enterprise version of the module] that comes with a CKFinder license and the file browser already included in the module and working out-of-the-box. The Enterprise version of the component also includes professional assistance from the original CKEditor development team in the form of a '''dedicated e-mail support channel'''.</note>

If you want to install CKFinder on your Drupal {{{version}}} site, follow the steps described below.

First of all, download '''CKFinder for PHP''' from the [http://ckfinder.com/download official CKFinder website].

Unpack the contents of the installation package into the directory that contains the CKEditor module and place it in the <code>sites/all/modules/ckeditor/ckfinder</code> (or <code>sites/all/libraries/ckfinder</code>) folder. . When the files are unpacked, you should see the following file structure inside the <code>drupal/sites/all/modules</code> directory:
<source>
modules <dir>
ckeditor <dir>
ckeditor.css
ckeditor.info
...
ckeditor <dir>
_samples <dir>
_source <dir>
adapters <dir>
images <dir>
...
ckeditor.js
...
ckfinder <dir>
_samples <dir>
core <dir>
...
ckfinder.js
ckfinder.php
...
</source>

You will now need to grant the '''"{{{permission}}}"''' permission in the '''Administration panel''' > '''{{{path1}}}''' > '''Permissions''' section. Note: if you do not see this permission, it means that CKEditor did not find CKFinder and you have probably uploaded CKFinder into a wrong directory.

[[Image:Drupal_{{{version}}}_Enterprise_CKFinder_permission.png|frame|center|Granting CKFinder access permission in the Drupal Administration panel]]

Now open the CKFinder configuration file (<code>ckfinder/config.php</code>) and introduce the code changes described below.

Firstly, remove the <code>CheckAuthentication()</code> function (do not worry, this function is defined in <code>filemanager.config.php</code>, see below):
<source lang="php">
function CheckAuthentication() <- remove it
{ <- remove it
//WARNING : DO NOT simply... <- remove it
... <- remove it
return false; <- remove it
} <- remove it
</source>
For CKFinder installed in the <code>sites/all/modules/ckeditor/ckfinder</code> directory add:
<source lang="php">
require_once '../../../../includes/filemanager.config.php';
</source>
straight below the following line:
<source lang="php">
$baseDir = resolveUrl($baseUrl);
</source>
For CKFinder installed in the <code>sites/all/libraries/ckfinder</code> directory add:
<source lang="php">
require_once '../../../../../modules/ckeditor/includes/filemanager.config.php';
</source>
straight below the following line:
<source lang="php">
$baseDir = resolveUrl($baseUrl);
</source>

Now open the Drupal settings file (<code>sites/default/settings.php</code>) and do the following:
* Uncomment the <code>$base_url</code> variable and set the base URL of your website (without the trailing slash).
* Uncomment the <code>$cookie_domain</code> variable and set the domain name of your website.

Select CKFinder as a preferred file browser in the '''Administration panel''' > '''{{{path2}}}''' > '''CKEditor''' section (for a selected CKEditor profile scroll down to the '''File browser settings''' section).

[[Image:Drupal_{{{version}}}_OS_enable_CKFinder.png|frame|center|Selecting CKFinder as a preferred file browser in the Drupal Administration panel]]

You can now [[CKEditor_for_Drupal/Open Source/Drupal_{{{version}}}/Configuration|configure]] CKFinder settings in the '''File browser settings''' section for the CKEditor profile that you want to use. You may also change destination folders for files uploaded with CKFinder.

CKEditor 3.x/Howto/License Renewal

2015-06-25T09:21:18Z

Anna: Link to renewals updated.

{{#CUSTOMTITLE:How Does the Commercial License Renewal Work?}}
All commercial CKEditor licenses (CKSource Closed Distribution License (CDL)) are ''lifetime'' and ''perpetual''. Your right to use and distribute the purchased software ''never expires''.

Each purchase also gives you the right to upgrade CKEditor to all newer versions released within a year after you buy a license as well as to use the dedicated support channel during this time. After a year from the date of your purchase your access to the support channel is terminated and you can no longer upgrade CKEditor to versions released after this time.

Each license can be renewed yearly at a discounted price in order to make it possible for you to take advantage of latest editor versions and maintain access to professional assistance from the CKEditor development team. To renew your comercial license, just go the the [http://cksource.com/ckeditor/buy#renewal CKEditor Premium website] and scroll to the '''Renew CKEditor Premium support & upgrades''' section.

The full text of the CKSource Closed Distribution License is available [http://cksource.com/cdl here].

CKFinder 2.x/Developers Guide/PHP/Configuration/Sessions

2015-05-20T05:27:43Z

Anna: Missing code formatting added

== Enabling sessions ==

It is quite possible that you will use session variables in the configuration file (<code>config.php</code>), for example when setting up the [[CKFinder_2.x/Developers_Guide/PHP/Configuration/Access_Control|Access Control]] or writing the [[CKFinder_2.x/Developers_Guide/PHP/Configuration/Quick_Start|CheckAuthentication()]] function.

Please remember that you have to start your session before use of <code>$_SESSION</code> becomes available.
In most cases it can be done by uncommenting the <code>session_start()</code> call in the configuration file:
<pre>
session_start();
</pre>

Once enabled, session variables can be accessed using the global <code>$_SESSION</code> array:
<pre>
$_SESSION['CKFinder_UserRole'] = "admin";
</pre>

Please do not call <code>session_start()</code> in the [[CKFinder_2.x/Developers_Guide/PHP/Configuration/Quick_Start|CheckAuthentication()]] function body, it is recommended to call <code>session_start()</code> at the beginning of <code>config.php</code> instead.

More information about session handling can be found in [http://php.net/manual/en/ref.session.php PHP manual].

Template:CKEditor Docs FrontPage

2014-11-06T12:38:54Z

Anna: CKEditor SDK link added

http://a.cksource.com/e/1/img/logo-ckeditor-h100.png

Bring rich editor features to your products and websites, providing your users with powerful tools to make creating Web content easier than ever and accessible to anyone.

<ul>
<li class="homeMainDoc">[http://docs.ckeditor.com/ CKEditor 4 Documentation Website]</li>
<li class="homeMainDoc">[http://sdk.ckeditor.com/ CKEditor SDK with Editor Samples]</li>
<li class="homeMinDoc">[[CKEditor 3.x/Developers Guide|CKEditor 3 Developer's Guide]]</li>
<li class="homeMinDoc">[[CKEditor_3.x/Users_Guide|CKEditor 3 User's Guide]]</li>
<li class="homeMinDoc">[[CKEditor_3.x/Howto|CKEditor 3 HOWTOs]]</li>
<li class="homeMinDoc">[[CKEditor_3.x/Tutorials|CKEditor 3 Tutorials]]</li>
<li class="homeMinDoc">[[CKEditor 3.x/Accessibility Compliance|CKEditor 3 Accessibility Compliance]]</li>
<li class="homeDoc">[[FCKeditor 2.x/Developers Guide|FCKeditor 2 Developer's Guide]]</li>
<li class="homeDoc">[[FCKeditor 2.x/Users Guide|FCKeditor 2 User's Guide]]</li>
<li class="homeSite">[http://ckeditor.com/ CKEditor Web Site]</li>
</ul>

CKFinder 2.x/Developers Guide/Java/Integration

2014-02-20T11:56:50Z

Anna: /* Installing CKFinder as a JSP Page Tag */

__TOC__
{{#CUSTOMTITLE:Integrating CKFinder}}
This article describes various ways of integrating CKFinder for Java with your page.

== Integrating CKFinder with your Application ==
After you download the CKFinder for Java <code>.war</code> file, follow the steps below to integrate it with your application:
* Unpack CKFinder for Java.
* Copy the <code>ckfinder</code> folder to your application.
* Copy the CKFinder <code>config.xml</code> file from its <code>WEB-INF</code> folder into the <code>WEB-INF</code> folder of your application.
* Copy the contents of the CKFinder <code>WEB-INF/lib</code> folder into the <code>WEB-INF/lib</code> folder of your application.
* Copy the <code>ConnectorServlet</code> settings from the CKFinder <code>web.xml</code> file to the <code>web.xml</code> file of your application.
<source lang="xml">
<servlet>
<servlet-name>ConnectorServlet</servlet-name>
<servlet-class>com.ckfinder.connector.ConnectorServlet</servlet-class>
<init-param>
<param-name>XMLConfig</param-name>
<param-value>/WEB-INF/config.xml</param-value>
</init-param>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>ConnectorServlet</servlet-name>
<url-pattern>
/ckfinder/core/connector/java/connector.java
</url-pattern>
</servlet-mapping>
</source>
* Just like in the sample application, by default CKFinder is disabled due to security reasons. To turn it on, change the <code><enabled></code> element value in the <code>config.xml</code> file to <code>true</code>. Note that it is recommended to use a more fine-grained authentication method by overriding the <code>checkAuthentication</code> method.
<source lang="xml">
<enabled>true</enabled>
</source>
* Similarily, some further adjustments of the <code>config.xml</code> file might be needed, like <code>baseUrl</code> and <code>baseDir</code> paths, for example.

==File Upload Filter==

As described in the [[CKFinder_2.x/Developers_Guide/Java/Troubleshooting#Flash_Upload_Problem|Flash Upload Problem]] section of the Troubleshooting article, if you are using the Flash multiple file upload component together with session-based authentication, you might get some "missing cookies" problems when trying to upload files. To work around this Flash bug you have to take care of posting cookies yourself. On server side this is done by setting a <code>FileUploadFilter</code>:
<source lang="xml">
<filter>
<filter-name>FileUploadFilter</filter-name>
<filter-class>com.ckfinder.connector.FileUploadFilter</filter-class>
<init-param>
<param-name>sessionCookieName</param-name>
<param-value>JSESSIONID</param-value>
</init-param>
<init-param>
<param-name>sessionParameterName</param-name>
<param-value>jsessionid</param-value>
</init-param>
</filter>
<filter-mapping>
<filter-name>FileUploadFilter</filter-name>
<url-pattern>/ckfinder/core/connector/java/connector.java</url-pattern>
</filter-mapping>
</source>

Besides basic elements like name, full class declaration (<code><filter-class></code>), and a mapping applying the filter to a specific URL (it has to be the same mapping as for <code>ConnectorServlet</code>), there are also two optional configuration parameters which help to identify "authentication cookies" that need to be rewritten.

Those parameters are the name of the session cookie (<code>sessionCookieName</code>), which in Java defaults to the <code>JSESSIONID</code> value, and the name of the session path parameter (<code>sessionParameterName</code>), which in Java defaults to <code>jsessionid</code>. These parameters are optional and can be omitted. However, if you are using custom configuration and you have changed names for these session identifiers on your server, you should also specify them in the <code>FileUploadFilter</code> init parameters so that CKFinder would know what to rewrite.

== Installing CKFinder as a JSP Page Tag ==
In order to install CKFinder as a tag inside a <code>.jsp</code> page, follow the steps outlined below:
* Install CKFinder as described in the section above.
* In order to use the tag on the JSP page you should import the tag library by using the following directive:
<source lang="java">
<%@ taglib uri="http://cksource.com/ckfinder" prefix="ckfinder" %>
</source>

You can now use the CKFinder tag on your JSP page in the following way:
<source lang="java">
<ckfinder:ckfinder basePath="/CKFinderJava/ckfinder/" />
</source>

The only required attribute is the <code>basePath</code> that specifies the path to the CKFinder folder. Numerous optional attributes are also available and can be used to customize CKFinder to your needs, like in the example below:

<source lang="java">
<ckfinder:ckfinder basePath="/CKFinderJava/ckfinder/" width="700" height="500" />
</source>

This code creates a CKFinder instance with a width of 700 pixels and height of 500 pixels.

== Extending Configuration ==
To read more about extending your CKFinder configuration, refer to the [[CKFinder_2.x/Developers_Guide/Java/Configuration/Extending|Extending CKFinder Configuration]] article.

== Integration methods ==
* [[/JavaScript|JavaScript integration]] – the preferred integration method, simple yet powerful.

Template:Ckfinder 2.x Thumbnail Description

2014-01-10T08:30:22Z

Anna:

* <code>maxWidth</code> and <code>maxHeight</code> – determine the maximum size of the thumbnails which can appear in CKFinder. These values are defined in pixels. You can obviously increase them, but the thumbnails will then look more like full-sized images than like miniatures.

* <code>quality</code> – sets the quality of a thumbnail in a range from <code>1</code> to <code>100</code>. The smaller the quality value, the smaller the size of the thumbnail. Notice that an acceptable quality value is about <code>45</code> and the most frequently used one is about <code>80</code>.

* <code>directAccess</code> – this setting may increase the overall performance of CKFinder. By default, CKFinder connects to the server connector to get the thumbnail. It is not a problem in most cases, because the connector sends the <code>HTTP/304 Not Modified</code> header most of the time to save the traffic and reduce server-side processing. However, sometimes it is better to leave cache control to the browser. When <code>directAccess</code> is set to <code>true</code>, thumbnails are loaded directly from the <code>_thumbs</code> folder by CKFinder. Note that it is impossible to use this setting, if the thumbnail directory is located outside the document root.
{{ #ifeq: {{{language}}} | php | * <code>bmpSupported</code> is a setting available only in the '''PHP connector''', because the GD library in PHP does not support the <code>.bmp</code> format. It is possible to enable support for <code>.bmp</code> files in CKFinder. In this case CKFinder will use a special PHP class to manipulate such images. Because resizing of <code>.bmp</code> files is relatively slow, this feature is disabled by default. }}
* You may disable thumbnails by placing the bool value <code>false</code> in the <code>enabled</code> section.

Template:Ckfinder 2.x Built-in Resource Types Notes

2013-07-15T07:52:38Z

Anna:

<note>Flash files with <code>swf</code> extension, just like HTML files, can be used to execute JavaScript code (and to e.g. perform an XSS attack). Grant permission to upload <code>.swf</code> files only if you understand and can accept this risk.</note>

Template:Drupal OS Upgrade

2013-04-16T13:49:52Z

Anna:

This instruction assumes that you are upgrading the CKEditor module ''[M]'' and CKEditor (the editor) ''[E]'' at the same time.
Instructions specific for module upgrades are tagged with ''[M]''. Steps that must be taken when upgrading CKEditor (the editor) are marked with ''[E]''.

# ''[M]'' Download the latest version of the CKEditor module from http://drupal.org/project/ckeditor (it is advised to read the release notes before going further).
# ''[E]'' Download the latest version of CKEditor from http://ckeditor.com/download (it is advised to read the [http://ckeditor.com/whatsnew "What's New"] page before going further).
# ''[M]'' Back up your database.
# ''[EM]'' Place the site in the "Off-line" mode to let the database updates run without interruption and to avoid displaying errors to end users of the site.
# ''[E]'' If you are using CKFinder, make sure you do not delete it, and move it to a safe place.
# ''[E]'' If you introduced any changes (e.g. custom toolbar definitions etc.) in the <code>sites/all/modules/ckeditor/ckeditor.config.js</code> file (or <code>sites/all/modules/ckeditor/ckeditor/config.js</code>), write down your changes and add them again after uploading new files.
#; In general, try to avoid making any changes to CKEditor's <code>config.js/<code> file and add everything to <code>ckeditor.config.js</code>.
# Delete old files:
#; ''[EM]'' Simply remove the <code>modules/ckeditor</code> directory if upgrading both the editor and the module.
#; ''[M]'' If you are upgrading the module only, remember to leave the <code>modules/ckeditor/ckeditor</code> directory intact.
#; ''[E]'' When upgrading the editor, remove the contents of the <code>modules/ckeditor/ckeditor</code> directory only.
#; '''WARNING''': If you do not remove old files and just rename the <code>ckeditor</code> directory instead (e.g. to <code>ckeditor_old</code>), Drupal may use the module from the renamed <code>ckeditor_old</code> directory.
# ''[M]'' Upload the CKEditor module (extracted files and folders) to the <code>sites/all/modules</code> directory.
# ''[E]'' Upload standalone CKEditor (extracted files and folders from the <code>ckeditor</code> directory) to the <code>sites/modules/ckeditor/ckeditor</code> directory (i.e. where the <code>COPY HERE.txt</code> file exists).
# ''[E]'' Restore the CKFinder files from where you copied them (see step 5).
# ''[E]'' Apply your modifications to default configuration in the <code>ckeditor.config.js</code> file (see step 6).
# ''[M]'' Run <code>update.php</code>.
# ''[EM]'' Put the site back online.

<note>The <code>sites/all/libraries/ckeditor</code> directory is the default and recommended path for standalone CKEditor files when drush is used to download the editor JavaScript code. If you are using drush to upgrade CKEditor, all the contents of the <code>sites/all/modules/ckeditor/</code> directory will be wiped, including the files for standalone editor if you placed them there.</note>

Template:Drupal OS Installation Paths

2013-04-16T13:23:19Z

Anna:

It is recommended to install the CKEditor for Drupal module in the <code>sites/all/modules</code> directory.

When adding the files for standalone CKEditor and CKFinder, you can use one of the following directories:
* <code>sites/all/modules/ckeditor/</code>
* <code>sites/all/libraries/</code>
and create a <code>ckeditor</code> or <code>ckfinder</code> directory inside.

<note>The <code>libraries</code> directory is the default and recommended path when drush is used to download the editor JavaScript code. If you are using drush to upgrade CKEditor in the future, all the contents of the <code>sites/all/modules/ckeditor/</code> directory will be wiped, including the files for standalone editor.</note>

The CKEditor module will automatically recognize the proper path to the editor and the file browser.

All installation and configuration instructions in this documentation assume that you use the first option and place the CKEditor and CKFinder files in the <code>sites/all/modules/ckeditor/</code> directory. If you want to use the <code>sites/all/libraries/</code> directory, you will need to adjust the paths given in the instructions accordingly.

CKFinder 2.x/Developers Guide/ASP.NET/Configuration/Access Control

2013-03-04T09:51:55Z

Anna: /* Folder and File Options */ Example headings added

__TOC__
{{Ckfinder_2.x_Access_Control_Description|file=<code>config.ascx</code>|AccessControl=AccessControl}}
<source lang="asp">AccessControl acl = AccessControl.Add();
acl.Role = "*";
acl.ResourceType = "*";
acl.Folder = "/";

acl.FolderView = true;
acl.FolderCreate = true;
acl.FolderRename = true;
acl.FolderDelete = true;

acl.FileView = true;
acl.FileUpload = true;
acl.FileRename = true;
acl.FileDelete = true;
</source>
Basically, a single Access Control setting is defined in an instance of the <code>AccessControl</code> class, created with the <code>AccessControl.Add()</code> method.

The most important (and required) properties of the <code>AccessControl</code> objects are: <code>Role</code>, <code>ResourceType</code> and <code>Folder</code>.

== Role Property ==
The <code>Role</code> property sets the type of user defined by the ACL. If set to an asterisk (<code>*</code>), it is treated as "all users". You may set this parameter to other names like "Admin" or "Editor". The name of the user type will be directly connected to the function the user is allowed to use. See [[#RoleSessionVar|RoleSessionVar]] for more information.

== ResourceType Property ==
The <code>ResourceType</code> property defines the resource type related to a specific ACL setting. See the [[CKFinder_2.x/Developers_Guide/ASP.NET/Configuration/Resource_Types|Resource Types]] section for more information.

If this property is set to an asterisk (<code>*</code>), the defined ACL is valid for all resource settings definined in the configuration file.

== Folder Property ==
You can apply ACL settings to specific folders by using the <code>Folder</code> property. Just set it to the folder path. The settings will be recursivelly applied to all folders inside that path.

== Folder and File Options ==
All other properties are related to specific features to enable/disable by the ACL setting. Just set them to <code>true</code> or <code>false</code> according to your needs. Setting an option to <code>true</code> enables it, while setting it to <code>false</code> disables it.

== Access Control List Examples ==
Have a look at the following examples that present various permission configurations in order to learn more about using Access Control Lists in CKFinder.

=== Example 1 ===
Add the following configuration code if you want to restrict the user to upload, rename, or delete files in the <code>/Company/Logos</code> folder of the <code>Images</code> resource type:
<source lang="asp">acl = AccessControl.Add();
acl.Role = "*";
acl.ResourceType = "Images";
acl.Folder = "/Company/Logos/";

acl.FileUpload = false;
acl.FileRename = false;
acl.FileDelete = false;
</source>
Note that we are reusing the previously defined <code>acl</code> variable. You may use as many <code>AccessControl.Add()</code> calls as you wish.

The above example only refers to file operations inside the <code>/Company/Logos</code> folder and all its child folders. It does not restrict operations on the folder so the user can delete or rename the folder.

=== Example 2 ===
In order to restrict users from modifying the folder (not its contents) you should change the permissions in its parent folder. For example:
<source lang="asp">acl = AccessControl.Add();
acl.Role = "*";
acl.ResourceType = "Images";
acl.Folder = "/Company/"

folderCreate = true;
folderRename = false;
folderDelete = false;
</source>
Now a user can view and create a folder, but will not be unable to rename or delete it. This is the best way to secure your folders from unauthorized access.

== More About Folder Path ==
In the first example above the <code>/Company/Logos</code> path was used in the ACL definition. It is rather obvious that this is not an absolute path to a folder on the server.

Let us assume that the absolute path on the server to the application folder is <code>/sites/example.com/</code> and the path to the <code>userfiles</code> folder is <code>/sites/example.com/userfiles/</code>.There is also the <code>Images</code> resource type which in this case points to <code>/sites/example.com/userfiles/images/</code>.

Knowing the above we will define the correct path for the <code>Logos</code> folder located in <code>/sites/example.com/userfiles/images/Company/Logos</code>. The key is to define a '''path relative to resource type''' (in this case the resource type is <code>Images</code> pointing to <code>/sites/example.com/userfiles/images/</code>), thus the value that needs to be assigned to the ACL <code>Folder</code> property is <code>/Company/Logos/</code>.

If ACL for both <code>Company</code> and <code>Logos</code> folders need to be defined, it is enough to assign just the <code>/Company</code> path.

Please also note that:
* The folder path has to start from a slash character.
* If you use a wildcard for a resource type (<code>acl.ResourceType = "*";</code>), CKFinder will look through all resource types and apply ACL to every folder that matches the rule, for example <code>Files:/Company/Logos</code>, <code>Flash:/Company/Logos</code>.

== RoleSessionVar ==
CKFinder uses the server-side session to identify the current user role. In order to enable the Access Control settings for different users, you should initialize a session variable when the user logs into your system.

To pass the name of the session variable to identify the user role to CKFinder, use the <code>RoleSessionVar</code> setting. For example:
<source lang="asp">RoleSessionVar = "CKFinder_UserRole";</source>
In the above example, the <code>CKFinder_UserRole</code> session variable value will be used to match the ACL entries defined previously. See the [[#Role Parameter|Role Parameter]] section above.

For example, in the <code>config.ascx</code> file you may assign the following three different roles:

The '''Admin''' role that has full permissions:
<source lang="asp">AccessControl acl = AccessControl.Add();
acl.Role = "Admin";
acl.ResourceType = "*";
acl.Folder = "/";

acl.FolderView = true;
acl.FolderCreate = true;
acl.FolderRename = true;
acl.FolderDelete = true;

acl.FileView = true;
acl.FileUpload = true;
acl.FileRename = true;
acl.FileDelete = true;
</source>
The '''User''' role that cannot rename or delete neither files nor folders:
<source lang="asp">AccessControl acl = AccessControl.Add();
acl.Role = "User";
acl.ResourceType = "*";
acl.Folder = "/";

acl.FolderView = true;
acl.FolderCreate = true;
acl.FolderRename = false;
acl.FolderDelete = false;

acl.FileView = true;
acl.FileUpload = true;
acl.FileRename = false;
acl.FileDelete = false;
</source>
The '''Guest''' role that can only view the folders contents:
<source lang="asp">AccessControl acl = AccessControl.Add();
acl.Role = "Guest";
acl.ResourceType = "*";
acl.Folder = "/";

acl.FolderView = true;
acl.FolderCreate = false;
acl.FolderRename = false;
acl.FolderDelete = false;

acl.FileView = true;
acl.FileUpload = false;
acl.FileRename = false;
acl.FileDelete = false;
</source>

CKFinder 2.x/Developers Guide/ASP.NET/Configuration/Access Control

2013-03-04T09:46:11Z

Anna: /* More About Folder Path */ Minor adjustments

__TOC__
{{Ckfinder_2.x_Access_Control_Description|file=<code>config.ascx</code>|AccessControl=AccessControl}}
<source lang="asp">AccessControl acl = AccessControl.Add();
acl.Role = "*";
acl.ResourceType = "*";
acl.Folder = "/";

acl.FolderView = true;
acl.FolderCreate = true;
acl.FolderRename = true;
acl.FolderDelete = true;

acl.FileView = true;
acl.FileUpload = true;
acl.FileRename = true;
acl.FileDelete = true;
</source>
Basically, a single Access Control setting is defined in an instance of the <code>AccessControl</code> class, created with the <code>AccessControl.Add()</code> method.

The most important (and required) properties of the <code>AccessControl</code> objects are: <code>Role</code>, <code>ResourceType</code> and <code>Folder</code>.

== Role Property ==
The <code>Role</code> property sets the type of user defined by the ACL. If set to an asterisk (<code>*</code>), it is treated as "all users". You may set this parameter to other names like "Admin" or "Editor". The name of the user type will be directly connected to the function the user is allowed to use. See [[#RoleSessionVar|RoleSessionVar]] for more information.

== ResourceType Property ==
The <code>ResourceType</code> property defines the resource type related to a specific ACL setting. See the [[CKFinder_2.x/Developers_Guide/ASP.NET/Configuration/Resource_Types|Resource Types]] section for more information.

If this property is set to an asterisk (<code>*</code>), the defined ACL is valid for all resource settings definined in the configuration file.

== Folder Property ==
You can apply ACL settings to specific folders by using the <code>Folder</code> property. Just set it to the folder path. The settings will be recursivelly applied to all folders inside that path.

== Folder and File Options ==
All other properties are related to specific features to enable/disable by the ACL setting. Just set them to <code>true</code> or <code>false</code> according to your needs. Setting an option to <code>true</code> enables it, while setting it to <code>false</code> disables it.

For example, just add the following configuration code if you want to restrict the user to upload, rename, or delete files in the <code>/Company/Logos</code> folder of the <code>Images</code> resource type:
<source lang="asp">acl = AccessControl.Add();
acl.Role = "*";
acl.ResourceType = "Images";
acl.Folder = "/Company/Logos/";

acl.FileUpload = false;
acl.FileRename = false;
acl.FileDelete = false;
</source>
Note that we are reusing the previously defined <code>acl</code> variable. You may use as many <code>AccessControl.Add()</code> calls as you wish.

The above example only refers to file operations inside the <code>/Company/Logos</code> folder and all its child folders. It does not restrict operations on the folder so the user can delete or rename the folder.

In order to restrict users from modifying the folder (not its contents) you should change the permissions in its parent folder. For example:
<source lang="asp">acl = AccessControl.Add();
acl.Role = "*";
acl.ResourceType = "Images";
acl.Folder = "/Company/"

folderCreate = true;
folderRename = false;
folderDelete = false;
</source>
Now a user can view and create a folder, but will not be unable to rename or delete it. This is the best way to secure your folders from unauthorized access.

== More About Folder Path ==
In the first example above the <code>/Company/Logos</code> path was used in the ACL definition. It is rather obvious that this is not an absolute path to a folder on the server.

Let us assume that the absolute path on the server to the application folder is <code>/sites/example.com/</code> and the path to the <code>userfiles</code> folder is <code>/sites/example.com/userfiles/</code>.There is also the <code>Images</code> resource type which in this case points to <code>/sites/example.com/userfiles/images/</code>.

Knowing the above we will define the correct path for the <code>Logos</code> folder located in <code>/sites/example.com/userfiles/images/Company/Logos</code>. The key is to define a '''path relative to resource type''' (in this case the resource type is <code>Images</code> pointing to <code>/sites/example.com/userfiles/images/</code>), thus the value that needs to be assigned to the ACL <code>Folder</code> property is <code>/Company/Logos/</code>.

If ACL for both <code>Company</code> and <code>Logos</code> folders need to be defined, it is enough to assign just the <code>/Company</code> path.

Please also note that:
* The folder path has to start from a slash character.
* If you use a wildcard for a resource type (<code>acl.ResourceType = "*";</code>), CKFinder will look through all resource types and apply ACL to every folder that matches the rule, for example <code>Files:/Company/Logos</code>, <code>Flash:/Company/Logos</code>.

== RoleSessionVar ==
CKFinder uses the server-side session to identify the current user role. In order to enable the Access Control settings for different users, you should initialize a session variable when the user logs into your system.

To pass the name of the session variable to identify the user role to CKFinder, use the <code>RoleSessionVar</code> setting. For example:
<source lang="asp">RoleSessionVar = "CKFinder_UserRole";</source>
In the above example, the <code>CKFinder_UserRole</code> session variable value will be used to match the ACL entries defined previously. See the [[#Role Parameter|Role Parameter]] section above.

For example, in the <code>config.ascx</code> file you may assign the following three different roles:

The '''Admin''' role that has full permissions:
<source lang="asp">AccessControl acl = AccessControl.Add();
acl.Role = "Admin";
acl.ResourceType = "*";
acl.Folder = "/";

acl.FolderView = true;
acl.FolderCreate = true;
acl.FolderRename = true;
acl.FolderDelete = true;

acl.FileView = true;
acl.FileUpload = true;
acl.FileRename = true;
acl.FileDelete = true;
</source>
The '''User''' role that cannot rename or delete neither files nor folders:
<source lang="asp">AccessControl acl = AccessControl.Add();
acl.Role = "User";
acl.ResourceType = "*";
acl.Folder = "/";

acl.FolderView = true;
acl.FolderCreate = true;
acl.FolderRename = false;
acl.FolderDelete = false;

acl.FileView = true;
acl.FileUpload = true;
acl.FileRename = false;
acl.FileDelete = false;
</source>
The '''Guest''' role that can only view the folders contents:
<source lang="asp">AccessControl acl = AccessControl.Add();
acl.Role = "Guest";
acl.ResourceType = "*";
acl.Folder = "/";

acl.FolderView = true;
acl.FolderCreate = false;
acl.FolderRename = false;
acl.FolderDelete = false;

acl.FileView = true;
acl.FileUpload = false;
acl.FileRename = false;
acl.FileDelete = false;
</source>

CKFinder 2.x/Developers Guide/ASP.NET/Configuration/Access Control

2013-03-04T09:45:40Z

Anna: /* More About Folder Path */

__TOC__
{{Ckfinder_2.x_Access_Control_Description|file=<code>config.ascx</code>|AccessControl=AccessControl}}
<source lang="asp">AccessControl acl = AccessControl.Add();
acl.Role = "*";
acl.ResourceType = "*";
acl.Folder = "/";

acl.FolderView = true;
acl.FolderCreate = true;
acl.FolderRename = true;
acl.FolderDelete = true;

acl.FileView = true;
acl.FileUpload = true;
acl.FileRename = true;
acl.FileDelete = true;
</source>
Basically, a single Access Control setting is defined in an instance of the <code>AccessControl</code> class, created with the <code>AccessControl.Add()</code> method.

The most important (and required) properties of the <code>AccessControl</code> objects are: <code>Role</code>, <code>ResourceType</code> and <code>Folder</code>.

== Role Property ==
The <code>Role</code> property sets the type of user defined by the ACL. If set to an asterisk (<code>*</code>), it is treated as "all users". You may set this parameter to other names like "Admin" or "Editor". The name of the user type will be directly connected to the function the user is allowed to use. See [[#RoleSessionVar|RoleSessionVar]] for more information.

== ResourceType Property ==
The <code>ResourceType</code> property defines the resource type related to a specific ACL setting. See the [[CKFinder_2.x/Developers_Guide/ASP.NET/Configuration/Resource_Types|Resource Types]] section for more information.

If this property is set to an asterisk (<code>*</code>), the defined ACL is valid for all resource settings definined in the configuration file.

== Folder Property ==
You can apply ACL settings to specific folders by using the <code>Folder</code> property. Just set it to the folder path. The settings will be recursivelly applied to all folders inside that path.

== Folder and File Options ==
All other properties are related to specific features to enable/disable by the ACL setting. Just set them to <code>true</code> or <code>false</code> according to your needs. Setting an option to <code>true</code> enables it, while setting it to <code>false</code> disables it.

For example, just add the following configuration code if you want to restrict the user to upload, rename, or delete files in the <code>/Company/Logos</code> folder of the <code>Images</code> resource type:
<source lang="asp">acl = AccessControl.Add();
acl.Role = "*";
acl.ResourceType = "Images";
acl.Folder = "/Company/Logos/";

acl.FileUpload = false;
acl.FileRename = false;
acl.FileDelete = false;
</source>
Note that we are reusing the previously defined <code>acl</code> variable. You may use as many <code>AccessControl.Add()</code> calls as you wish.

The above example only refers to file operations inside the <code>/Company/Logos</code> folder and all its child folders. It does not restrict operations on the folder so the user can delete or rename the folder.

In order to restrict users from modifying the folder (not its contents) you should change the permissions in its parent folder. For example:
<source lang="asp">acl = AccessControl.Add();
acl.Role = "*";
acl.ResourceType = "Images";
acl.Folder = "/Company/"

folderCreate = true;
folderRename = false;
folderDelete = false;
</source>
Now a user can view and create a folder, but will not be unable to rename or delete it. This is the best way to secure your folders from unauthorized access.

== More About Folder Path ==
In the first example above the <code>/Company/Logos</code> path was used in the ACL definition. It is rather obvious that this is not an absolute path to folder on server.

Let us assume that the absolute path on the server to the application folder is <code>/sites/example.com/</code> and the path to the <code>userfiles</code> folder is <code>/sites/example.com/userfiles/</code>.There is also the <code>Images</code> resource type which in this case points to <code>/sites/example.com/userfiles/images/</code>.

Knowing the above we will define the correct path for the <code>Logos</code> folder located in <code>/sites/example.com/userfiles/images/Company/Logos</code>. The key is to define a '''path relative to resource type''' (in this case the resource type is <code>Images</code> pointing to <code>/sites/example.com/userfiles/images/</code>), thus the value that needs to be assigned to the ACL <code>Folder</code> property is <code>/Company/Logos/</code>.

If ACL for both <code>Company</code> and <code>Logos</code> folders need to be defined, it is enough to assign just the <code>/Company</code> path.

Please also note that:
* The folder path has to start from a slash character.
* If you use a wildcard for a resource type (<code>acl.ResourceType = "*";</code>), CKFinder will look through all resource types and apply ACL to every folder that matches the rule, for example <code>Files:/Company/Logos</code>, <code>Flash:/Company/Logos</code>.

== RoleSessionVar ==
CKFinder uses the server-side session to identify the current user role. In order to enable the Access Control settings for different users, you should initialize a session variable when the user logs into your system.

To pass the name of the session variable to identify the user role to CKFinder, use the <code>RoleSessionVar</code> setting. For example:
<source lang="asp">RoleSessionVar = "CKFinder_UserRole";</source>
In the above example, the <code>CKFinder_UserRole</code> session variable value will be used to match the ACL entries defined previously. See the [[#Role Parameter|Role Parameter]] section above.

For example, in the <code>config.ascx</code> file you may assign the following three different roles:

The '''Admin''' role that has full permissions:
<source lang="asp">AccessControl acl = AccessControl.Add();
acl.Role = "Admin";
acl.ResourceType = "*";
acl.Folder = "/";

acl.FolderView = true;
acl.FolderCreate = true;
acl.FolderRename = true;
acl.FolderDelete = true;

acl.FileView = true;
acl.FileUpload = true;
acl.FileRename = true;
acl.FileDelete = true;
</source>
The '''User''' role that cannot rename or delete neither files nor folders:
<source lang="asp">AccessControl acl = AccessControl.Add();
acl.Role = "User";
acl.ResourceType = "*";
acl.Folder = "/";

acl.FolderView = true;
acl.FolderCreate = true;
acl.FolderRename = false;
acl.FolderDelete = false;

acl.FileView = true;
acl.FileUpload = true;
acl.FileRename = false;
acl.FileDelete = false;
</source>
The '''Guest''' role that can only view the folders contents:
<source lang="asp">AccessControl acl = AccessControl.Add();
acl.Role = "Guest";
acl.ResourceType = "*";
acl.Folder = "/";

acl.FolderView = true;
acl.FolderCreate = false;
acl.FolderRename = false;
acl.FolderDelete = false;

acl.FileView = true;
acl.FileUpload = false;
acl.FileRename = false;
acl.FileDelete = false;
</source>

CKFinder 2.x/Developers Guide/ASP.NET/Configuration/Access Control

2013-03-04T09:42:15Z

Anna: Template for intro added

__TOC__
{{Ckfinder_2.x_Access_Control_Description|file=<code>config.ascx</code>|AccessControl=AccessControl}}
<source lang="asp">AccessControl acl = AccessControl.Add();
acl.Role = "*";
acl.ResourceType = "*";
acl.Folder = "/";

acl.FolderView = true;
acl.FolderCreate = true;
acl.FolderRename = true;
acl.FolderDelete = true;

acl.FileView = true;
acl.FileUpload = true;
acl.FileRename = true;
acl.FileDelete = true;
</source>
Basically, a single Access Control setting is defined in an instance of the <code>AccessControl</code> class, created with the <code>AccessControl.Add()</code> method.

The most important (and required) properties of the <code>AccessControl</code> objects are: <code>Role</code>, <code>ResourceType</code> and <code>Folder</code>.

== Role Property ==
The <code>Role</code> property sets the type of user defined by the ACL. If set to an asterisk (<code>*</code>), it is treated as "all users". You may set this parameter to other names like "Admin" or "Editor". The name of the user type will be directly connected to the function the user is allowed to use. See [[#RoleSessionVar|RoleSessionVar]] for more information.

== ResourceType Property ==
The <code>ResourceType</code> property defines the resource type related to a specific ACL setting. See the [[CKFinder_2.x/Developers_Guide/ASP.NET/Configuration/Resource_Types|Resource Types]] section for more information.

If this property is set to an asterisk (<code>*</code>), the defined ACL is valid for all resource settings definined in the configuration file.

== Folder Property ==
You can apply ACL settings to specific folders by using the <code>Folder</code> property. Just set it to the folder path. The settings will be recursivelly applied to all folders inside that path.

== Folder and File Options ==
All other properties are related to specific features to enable/disable by the ACL setting. Just set them to <code>true</code> or <code>false</code> according to your needs. Setting an option to <code>true</code> enables it, while setting it to <code>false</code> disables it.

For example, just add the following configuration code if you want to restrict the user to upload, rename, or delete files in the <code>/Company/Logos</code> folder of the <code>Images</code> resource type:
<source lang="asp">acl = AccessControl.Add();
acl.Role = "*";
acl.ResourceType = "Images";
acl.Folder = "/Company/Logos/";

acl.FileUpload = false;
acl.FileRename = false;
acl.FileDelete = false;
</source>
Note that we are reusing the previously defined <code>acl</code> variable. You may use as many <code>AccessControl.Add()</code> calls as you wish.

The above example only refers to file operations inside the <code>/Company/Logos</code> folder and all its child folders. It does not restrict operations on the folder so the user can delete or rename the folder.

In order to restrict users from modifying the folder (not its contents) you should change the permissions in its parent folder. For example:
<source lang="asp">acl = AccessControl.Add();
acl.Role = "*";
acl.ResourceType = "Images";
acl.Folder = "/Company/"

folderCreate = true;
folderRename = false;
folderDelete = false;
</source>
Now a user can view and create a folder, but will not be unable to rename or delete it. This is the best way to secure your folders from unauthorized access.

== More About Folder Path ==
In the example above the <code>/Company/Logos</code> path was used in the ACL definition. It is rather obvious that this is not an absolute path to folder on server.

Let us assume that the absolute path on the server to the application folder is <code>/sites/example.com/</code> and the path to the <code>userfiles</code> folder is <code>/sites/example.com/userfiles/</code>.There is also the <code>Images</code> resource type which in this case points to <code>/sites/example.com/userfiles/images/</code>.

Knowing the above we will define the correct path for the <code>Logos</code> folder located in <code>/sites/example.com/userfiles/images/Company/Logos</code>. The key is to define a '''path relative to resource type''' (in this case the resource type is <code>Images</code> pointing to <code>/sites/example.com/userfiles/images/</code>), thus the value that needs to be assigned to the ACL <code>Folder</code> property is <code>/Company/Logos/</code>.

If ACL for both <code>Company</code> and <code>Logos</code> folders need to be defined, it is enough to assign just the <code>/Company</code> path.

Please also note that:
* The folder path has to start from a slash character.
* If you use a wildcard for a resource type (<code>acl.ResourceType = "*";</code>), CKFinder will look through all resource types and apply ACL to every folder that matches the rule, for example <code>Files:/Company/Logos</code>, <code>Flash:/Company/Logos</code>.

== RoleSessionVar ==
CKFinder uses the server-side session to identify the current user role. In order to enable the Access Control settings for different users, you should initialize a session variable when the user logs into your system.

To pass the name of the session variable to identify the user role to CKFinder, use the <code>RoleSessionVar</code> setting. For example:
<source lang="asp">RoleSessionVar = "CKFinder_UserRole";</source>
In the above example, the <code>CKFinder_UserRole</code> session variable value will be used to match the ACL entries defined previously. See the [[#Role Parameter|Role Parameter]] section above.

For example, in the <code>config.ascx</code> file you may assign the following three different roles:

The '''Admin''' role that has full permissions:
<source lang="asp">AccessControl acl = AccessControl.Add();
acl.Role = "Admin";
acl.ResourceType = "*";
acl.Folder = "/";

acl.FolderView = true;
acl.FolderCreate = true;
acl.FolderRename = true;
acl.FolderDelete = true;

acl.FileView = true;
acl.FileUpload = true;
acl.FileRename = true;
acl.FileDelete = true;
</source>
The '''User''' role that cannot rename or delete neither files nor folders:
<source lang="asp">AccessControl acl = AccessControl.Add();
acl.Role = "User";
acl.ResourceType = "*";
acl.Folder = "/";

acl.FolderView = true;
acl.FolderCreate = true;
acl.FolderRename = false;
acl.FolderDelete = false;

acl.FileView = true;
acl.FileUpload = true;
acl.FileRename = false;
acl.FileDelete = false;
</source>
The '''Guest''' role that can only view the folders contents:
<source lang="asp">AccessControl acl = AccessControl.Add();
acl.Role = "Guest";
acl.ResourceType = "*";
acl.Folder = "/";

acl.FolderView = true;
acl.FolderCreate = false;
acl.FolderRename = false;
acl.FolderDelete = false;

acl.FileView = true;
acl.FileUpload = false;
acl.FileRename = false;
acl.FileDelete = false;
</source>

Template:Ckfinder 2.x Access Control Description

2013-03-04T09:40:02Z

Anna: Minor correction

__TOC__
{{#CUSTOMTITLE:Defining Access Control}}

Access Control List (ACL) is a method to grant your users different permissions for working with CKFinder folders and files. The default settings placed in the {{{file}}} file grant full permissions for all options to every user.

In order to change this configuration option you should learn the basics of the <code>{{{AccessControl}}}</code> settings placed in the configuration file.

== Access Control List Syntax ==
The syntax of the ACL entries is as follows:

CKFinder 2.x/Developers Guide/ASP.NET/Configuration/Access Control

2013-03-04T08:50:28Z

Anna: Text proof-read

__TOC__

By using Access Control Lists (ACL) you can give your users different permissions while working on folders and files. The default settings in the <code>config.ascx</code> file give full permissions to all users. In order to change this configuration you should understand the basics of the <code>AccessControl</code> settings, which can be found in the <code>config.ascx</code> file.

This is the syntax for these settings:
<source lang="asp">AccessControl acl = AccessControl.Add();
acl.Role = "*";
acl.ResourceType = "*";
acl.Folder = "/";

acl.FolderView = true;
acl.FolderCreate = true;
acl.FolderRename = true;
acl.FolderDelete = true;

acl.FileView = true;
acl.FileUpload = true;
acl.FileRename = true;
acl.FileDelete = true;
</source>
Basically, a single Access Control setting is defined in an instance of the <code>AccessControl</code> class, created with the <code>AccessControl.Add()</code> method.

The most important (and required) properties of the <code>AccessControl</code> objects are: <code>Role</code>, <code>ResourceType</code> and <code>Folder</code>.

== Role Property ==
The <code>Role</code> property sets the type of user defined by the ACL. If set to an asterisk (<code>*</code>), it is treated as "all users". You may set this parameter to other names like "Admin" or "Editor". The name of the user type will be directly connected to the function the user is allowed to use. See [[#RoleSessionVar|RoleSessionVar]] for more information.

== ResourceType Property ==
The <code>ResourceType</code> property defines the resource type related to a specific ACL setting. See the [[CKFinder_2.x/Developers_Guide/ASP.NET/Configuration/Resource_Types|Resource Types]] section for more information.

If this property is set to an asterisk (<code>*</code>), the defined ACL is valid for all resource settings definined in the configuration file.

== Folder Property ==
You can apply ACL settings to specific folders by using the <code>Folder</code> property. Just set it to the folder path. The settings will be recursivelly applied to all folders inside that path.

== Folder and File Options ==
All other properties are related to specific features to enable/disable by the ACL setting. Just set them to <code>true</code> or <code>false</code> according to your needs. Setting an option to <code>true</code> enables it, while setting it to <code>false</code> disables it.

For example, just add the following configuration code if you want to restrict the user to upload, rename, or delete files in the <code>/Company/Logos</code> folder of the <code>Images</code> resource type:
<source lang="asp">acl = AccessControl.Add();
acl.Role = "*";
acl.ResourceType = "Images";
acl.Folder = "/Company/Logos/";

acl.FileUpload = false;
acl.FileRename = false;
acl.FileDelete = false;
</source>
Note that we are reusing the previously defined <code>acl</code> variable. You may use as many <code>AccessControl.Add()</code> calls as you wish.

The above example only refers to file operations inside the <code>/Company/Logos</code> folder and all its child folders. It does not restrict operations on the folder so the user can delete or rename the folder.

In order to restrict users from modifying the folder (not its contents) you should change the permissions in its parent folder. For example:
<source lang="asp">acl = AccessControl.Add();
acl.Role = "*";
acl.ResourceType = "Images";
acl.Folder = "/Company/"

folderCreate = true;
folderRename = false;
folderDelete = false;
</source>
Now a user can view and create a folder, but will not be unable to rename or delete it. This is the best way to secure your folders from unauthorized access.

== More About Folder Path ==
In the example above the <code>/Company/Logos</code> path was used in the ACL definition. It is rather obvious that this is not an absolute path to folder on server.

Let us assume that the absolute path on the server to the application folder is <code>/sites/example.com/</code> and the path to the <code>userfiles</code> folder is <code>/sites/example.com/userfiles/</code>.There is also the <code>Images</code> resource type which in this case points to <code>/sites/example.com/userfiles/images/</code>.

Knowing the above we will define the correct path for the <code>Logos</code> folder located in <code>/sites/example.com/userfiles/images/Company/Logos</code>. The key is to define a '''path relative to resource type''' (in this case the resource type is <code>Images</code> pointing to <code>/sites/example.com/userfiles/images/</code>), thus the value that needs to be assigned to the ACL <code>Folder</code> property is <code>/Company/Logos/</code>.

If ACL for both <code>Company</code> and <code>Logos</code> folders need to be defined, it is enough to assign just the <code>/Company</code> path.

Please also note that:
* The folder path has to start from a slash character.
* If you use a wildcard for a resource type (<code>acl.ResourceType = "*";</code>), CKFinder will look through all resource types and apply ACL to every folder that matches the rule, for example <code>Files:/Company/Logos</code>, <code>Flash:/Company/Logos</code>.

== RoleSessionVar ==
CKFinder uses the server-side session to identify the current user role. In order to enable the Access Control settings for different users, you should initialize a session variable when the user logs into your system.

To pass the name of the session variable to identify the user role to CKFinder, use the <code>RoleSessionVar</code> setting. For example:
<source lang="asp">RoleSessionVar = "CKFinder_UserRole";</source>
In the above example, the <code>CKFinder_UserRole</code> session variable value will be used to match the ACL entries defined previously. See the [[#Role Parameter|Role Parameter]] section above.

For example, in the <code>config.ascx</code> file you may assign the following three different roles:

The '''Admin''' role that has full permissions:
<source lang="asp">AccessControl acl = AccessControl.Add();
acl.Role = "Admin";
acl.ResourceType = "*";
acl.Folder = "/";

acl.FolderView = true;
acl.FolderCreate = true;
acl.FolderRename = true;
acl.FolderDelete = true;

acl.FileView = true;
acl.FileUpload = true;
acl.FileRename = true;
acl.FileDelete = true;
</source>
The '''User''' role that cannot rename or delete neither files nor folders:
<source lang="asp">AccessControl acl = AccessControl.Add();
acl.Role = "User";
acl.ResourceType = "*";
acl.Folder = "/";

acl.FolderView = true;
acl.FolderCreate = true;
acl.FolderRename = false;
acl.FolderDelete = false;

acl.FileView = true;
acl.FileUpload = true;
acl.FileRename = false;
acl.FileDelete = false;
</source>
The '''Guest''' role that can only view the folders contents:
<source lang="asp">AccessControl acl = AccessControl.Add();
acl.Role = "Guest";
acl.ResourceType = "*";
acl.Folder = "/";

acl.FolderView = true;
acl.FolderCreate = false;
acl.FolderRename = false;
acl.FolderDelete = false;

acl.FileView = true;
acl.FileUpload = false;
acl.FileRename = false;
acl.FileDelete = false;
</source>

CKEditor 3.x/Developers Guide/Localization

2013-03-01T13:56:12Z

Anna: Screenshot replaced with a current one

__TOC__
{{#CUSTOMTITLE:CKEditor Localization}}
In an effort to speed up the CKEditor localization process and make it easier and more intuitive for our translators to create and maintain different localizations we have decided to set up the [https://www.transifex.com/projects/p/ckeditor/ CKEditor UI Translation Center on Transifex]. Transifex is an online platform that allows projects to make use of community-based translations, providing suitable resource management tools as well as a user-friendly browser-based interface.

No matter if you are a first-time Transifex user or a seasoned translator, a fresh CKEditor fan or a long time user, feel free to join us, contribute to existing translations or create new ones in an effort to make it easier for people from around the world to use their favorite editor in their native language!

<gallery style="border: 1px solid #DDDDDD; background-color: #FAFAFA;" caption="CKEditor UI Translation Center at Transifex" perrow="2" widths="240px" heights="200px">
File:Transifex_project_page.png
File:Transifex_team_translation_resources_01.png
File:Transifex_team_translation_details_03.png
File:Transifex_online_translation_04.png
</gallery>

== Useful Links ==
* Transifex website: https://www.transifex.com/
* Transifex documentation: http://help.transifex.com
* CKEditor official website for an overview of the editor features: http://ckeditor.com
* CKEditor demo, to see the real context where the language strings are used: http://ckeditor.com/demo

== CKEditor Localization Project Structure ==
The CKEditor UI Translation Center on Transifex includes a list of [https://www.transifex.com/projects/p/ckeditor/resources/ language resources] that can be translated. These include both CKEditor core file and plugin language files. Please note that as of CKEditor 4 the <code>core</code> resource contains only a handful of common entries and plugin files are crucial for a complete localization experience.

== CKEditor Localization Team Structure ==
You will find the following roles among the contributors of the CKEditor localization project on Transifex:
* '''Project maintainers''' – CKSource staff that manage the project and have full administration permissions.
* '''Teams''' – groups of people that take care of specific localizations, like the Hebrew team, the German team, the Spanish team and so on. Each team consists of one or more persons that perform either of the following roles:
** '''Team coordinator''' – usually the creator of the team or a more advanced translator; a user who can manage the team and review submitted translations.
** '''Team member''' – a translator of CKEditor into a given language.

== CKEditor Localization Documentation ==
The localization process of CKEditor is described in a few sections of the documentation page, namely:
* [[CKEditor_3.x/Developers_Guide/Localization_Teams|Localization Teams]] – joining a localization team, requesting a new one.
* [[CKEditor_3.x/Developers_Guide/Translating_CKEditor|Translating CKEditor]] – localizing CKEditor by using the online and offline translation workflow.
* [[CKEditor_3.x/Developers_Guide/Localization_Tips|Localization Tips]] – some useful advice on using Transifex to translate CKEditor.
* [[CKEditor_3.x/Developers_Guide/Localization_Troubleshooting|Localization Troubleshooting]] – some issues that you may encounter while translating CKEditor.
* [[CKEditor_3.x/Developers_Guide/Technical_Details_of_Localization|Technical Details]] – additional, more advanced information about the UI Translation Center.

CKEditor 3.x/Developers Guide/Localization Teams

2013-03-01T13:52:52Z

Anna: Outdated image removed

__TOC__
{{#CUSTOMTITLE:CKEditor Localization Teams}}
CKEditor translation is based on language teams. The CKEditor resources are localized by dedicated teams of users that manage the translations into their native language. Bringing CKEditor to the users all around the world and making the editor available in as many languages as possible are our priorities. This is why all CKEditor developers and users are most welcome to join our [https://www.transifex.com/projects/p/ckeditor/ localization project on Transifex] and to contribute their translations.

== Joining CKEditor Localization Team ==
CKSource is always looking for new translators willing to join the CKEditor localization project, complete existing translations, and add new language versions. If you want to contribute, proceed as described below:
# '''Register on the Transifex website.'''
#; You can [https://www.transifex.com/ sign up for free] by using the "Sign Up Free" button in the top right-hand corner of the Transifex homepage. You will be redirected to the [https://www.transifex.com/signup/ signup form page]. Fill in your personal details and register the account. You will need to confirm your account by clicking the link from the validation e-mail.
# '''[https://www.transifex.com/signin/ Log in] and complete your profile.'''
#; Go to the '''[https://www.transifex.com/settings/ User account]''' section of your dashboard (by clicking your username in the top right-hand corner) and fill in the information that can tell other contributors something more about yourself.
# '''Join a CKEditor translation team.'''
#; Go to the [https://www.transifex.com/projects/p/ckeditor/ project's site] and see the list of available language teams. If you find a suitable one, [[CKEditor_3.x/Developers_Guide/Localization_Teams#Joining_a_Team|join it]]. If a language has the "(no team yet)" caption or it is not listed, [[CKEditor_3.x/Developers_Guide/Localization_Teams#Requesting_a_New_Team|request the creation of a new team]] for your native language.
#; Your requests will need to be approved by one of the maintainers or coordinators before you can actively contribute to the project.

== Joining an Existing Team ==
Go to the [https://www.transifex.com/projects/p/ckeditor/ CKEditor project page] and click a language that you want to join. Click '''Join team''' to request access to an existing team.

[[Image:Transifex_join_team_01.png|thumb|center|800px|Joining an existing team in Transifex]]

Before joining, you will need to accept the [https://www.transifex.com/projects/p/ckeditor/cla/ Contributor License Agreement]. Select the checkbox and press the '''Join language translation''' button.

[[Image:Transifex_join_team_03.png|thumb|center|800px|Accepting the Contributor License Agreement in Transifex]]

After you click the '''Join language translation''' button, a notification will be sent to the team coordinator. Your user name will now appear on the waiting list and you will be able to withdraw your application by clicking the '''Withdraw''' button.

[[Image:Transifex_join_team_02.png|thumb|center|800px|Team waiting list in Transifex]]

The request will also be visible in your dashboard — see the '''Recent Events''' list.

[[Image:Transifex_recent_activity_01.png|frame|center|Recent Events list in Transifex dashboard]]

When your request is approved, you will receive an e-mail notification. Your username will also appear on the language team page.

[[Image:Transifex_team_members.png|thumb|center|800px|Team members list in Transifex]]

You can now start translating project resources within your language team.

<note>Please note that in order to join more language teams you need to apply to all of them separately.
</note>

== Requesting a New Team ==
If a team for your native language does not exist, you can request creating a new one. Please note that two situations may occur.

CKEditor may already have some translations for your native language coming from the past, but no team coordinates these efforts on Transifex. If this is the case, the language will be listed as '''''Language'' (no team yet)''' on the [https://www.transifex.com/projects/p/ckeditor/ project page].

[[Image:Transifex_no_team.png|thumb|center|800px|Languages without a team in Transifex]]

If this is the case, choose the language and then proceed as described in the [[CKEditor_3.x/Developers_Guide/Localization_Teams#Joining_a_Team|Joining a Team]] section. Your request will be sent to project maintainers and when accepted, you will become the team coordinator.

If, however, the language of your choice is not listed, just click the '''Request language''' link above the languages list.

[[Image:Transifex_request_team_01.png|thumb|center|800px|Requesting a new team in Transifex]]

The following form will open, letting you choose a language for the team.

[[Image:Transifex_request_team_02.png|thumb|center|800px|Requesting a new team in Transifex]]

<note>Please note that CKEditor uses two-letter ISO 639-1 language codes (like <code>de</code>, <code>it</code>, <code>fi</code>) for the majority of translations. In some cases, when a regional variation is required, the four-letter language code can be used (like in <code>pt_BR</code> for Brazilian Portuguese). Please contact the project maintainers if you have any doubts in this regard.</note>

You will need to accept the [https://www.transifex.com/projects/p/ckeditor/cla/snippet/ Contributor License Agreement] by selecting an appropriate checkbox in the form. After you click the '''Request team''' button, a notification will be sent to the project maintainers. The requested team will now appear on the waiting list.

[[Image:Transifex_request_team_03.png|thumb|center|800px|Pending team requests in Transifex]]

The request will also be visible in your dashboard — see the '''Recent Events''' list.

[[Image:Transifex_recent_activity_02.png|frame|center|Recent Events list in Transifex dashboard]]

When your request is approved, you will receive an e-mail notification. The new language will also immediately become available on the main project page.

File:Transifex request team 03.png

2013-03-01T13:50:46Z

Anna: Anna uploaded a new version of "File:Transifex request team 03.png": Updated to Feb 2013 look

Pending team requests in Transifex

File:Transifex recent activity 02.png

2013-03-01T13:49:48Z

Anna: Anna uploaded a new version of "File:Transifex recent activity 02.png": Updated to Feb 2013 look

Recent activity list in Transifex profile

CKEditor 3.x/Developers Guide/Localization Teams

2013-03-01T13:34:17Z

Anna: /* Requesting a New Team */ Updated part 4

File:Transifex request team 02.png

2013-03-01T13:31:08Z

Anna: Anna uploaded a new version of "File:Transifex request team 02.png": Updated to Feb 2013 look with CLA

Requesting a new team in Transifex

File:Transifex request team 01.png

2013-03-01T13:28:40Z

Anna: Anna uploaded a new version of "File:Transifex request team 01.png": Updated to Feb 2013 look

Requesting a new team in Transifex

File:Transifex language codes.png

2013-03-01T13:24:43Z

Anna: Anna uploaded a new version of "File:Transifex language codes.png": Updated to Feb 2013 look

Language codes available in Transifex

CKEditor 3.x/Developers Guide/Localization Teams

2013-03-01T12:19:59Z

Anna:

__TOC__
{{#CUSTOMTITLE:CKEditor Localization Teams}}
CKEditor translation is based on language teams. The CKEditor resources are localized by dedicated teams of users that manage the translations into their native language. Bringing CKEditor to the users all around the world and making the editor available in as many languages as possible are our priorities. This is why all CKEditor developers and users are most welcome to join our [https://www.transifex.com/projects/p/ckeditor/ localization project on Transifex] and to contribute their translations.

== Joining CKEditor Localization Team ==
CKSource is always looking for new translators willing to join the CKEditor localization project, complete existing translations, and add new language versions. If you want to contribute, proceed as described below:
# '''Register on the Transifex website.'''
#; You can [https://www.transifex.com/ sign up for free] by using the "Sign Up Free" button in the top right-hand corner of the Transifex homepage. You will be redirected to the [https://www.transifex.com/signup/ signup form page]. Fill in your personal details and register the account. You will need to confirm your account by clicking the link from the validation e-mail.
# '''[https://www.transifex.com/signin/ Log in] and complete your profile.'''
#; Go to the '''[https://www.transifex.com/settings/ User account]''' section of your dashboard (by clicking your username in the top right-hand corner) and fill in the information that can tell other contributors something more about yourself.
# '''Join a CKEditor translation team.'''
#; Go to the [https://www.transifex.com/projects/p/ckeditor/ project's site] and see the list of available language teams. If you find a suitable one, [[CKEditor_3.x/Developers_Guide/Localization_Teams#Joining_a_Team|join it]]. If a language has the "(no team yet)" caption or it is not listed, [[CKEditor_3.x/Developers_Guide/Localization_Teams#Requesting_a_New_Team|request the creation of a new team]] for your native language.
#; Your requests will need to be approved by one of the maintainers or coordinators before you can actively contribute to the project.

== Joining an Existing Team ==
Go to the [https://www.transifex.com/projects/p/ckeditor/ CKEditor project page] and click a language that you want to join. Click '''Join team''' to request access to an existing team.

[[Image:Transifex_join_team_01.png|thumb|center|800px|Joining an existing team in Transifex]]

Before joining, you will need to accept the [https://www.transifex.com/projects/p/ckeditor/cla/ Contributor License Agreement]. Select the checkbox and press the '''Join language translation''' button.

[[Image:Transifex_join_team_03.png|thumb|center|800px|Accepting the Contributor License Agreement in Transifex]]

After you click the '''Join language translation''' button, a notification will be sent to the team coordinator. Your user name will now appear on the waiting list and you will be able to withdraw your application by clicking the '''Withdraw''' button.

[[Image:Transifex_join_team_02.png|thumb|center|800px|Team waiting list in Transifex]]

The request will also be visible in your dashboard — see the '''Recent Events''' list.

[[Image:Transifex_recent_activity_01.png|frame|center|Recent Events list in Transifex dashboard]]

When your request is approved, you will receive an e-mail notification. Your username will also appear on the language team page.

[[Image:Transifex_team_members.png|thumb|center|800px|Team members list in Transifex]]

You can now start translating project resources within your language team.

<note>Please note that in order to join more language teams you need to apply to all of them separately.
</note>

== Requesting a New Team ==
If a team for your native language does not exist, you can request creating a new one. Please note that two situations may occur.

CKEditor may already have some translations for your native language coming from the past, but no team coordinates these efforts on Transifex. If this is the case, the language will be listed as '''''Language'' (no team yet)''' on the [https://www.transifex.com/projects/p/ckeditor/ project page].

[[Image:Transifex_no_team.png|thumb|center|800px|Languages without a team in Transifex]]

If this is the case, choose the language and then proceed as described in the [[CKEditor_3.x/Developers_Guide/Localization_Teams#Joining_a_Team|Joining a Team]] section. Your request will be sent to project maintainers and when accepted, you will become the team coordinator.

If, however, the language of your choice is not listed, just click the '''Request language''' link above the languages list.

[[Image:Transifex_request_team_01.png|thumb|center|800px|Requesting a new team in Transifex]]

The following form will open, letting you choose a language for the team.

[[Image:Transifex_request_team_02.png|thumb|center|800px|Requesting a new team in Transifex]]

<note>Please note that CKEditor uses two-letter ISO 639-1 language codes (like <code>de</code>, <code>it</code>, <code>fi</code>) for the majority of translations. In some cases, when a regional variation is required, the four-letter language code can be used (like in <code>pt_BR</code> for Brazilian Portuguese). Please contact the project maintainers if you have any doubts in this regard.</note>

After you click the '''Request team''' button, a notification will be sent to the project maintainers. The requested team will now appear on the waiting list.

[[Image:Transifex_request_team_03.png|thumb|center|800px|Pending team requests in Transifex]]

The request will also be visible in your dashboard — see the '''Recent Events''' list.

[[Image:Transifex_recent_activity_02.png|frame|center|Recent Events list in Transifex dashboard]]

When your request is approved, you will receive an e-mail notification. The new language will also immediately become available on the main project page.

[[Image:Transifex_teams_01.png|frame|center|Language teams list in Transifex]]

CKEditor 3.x/Developers Guide/Localization Teams

2013-03-01T12:18:52Z

Anna: /* Joining a Team */ CLA note added

__TOC__
{{#CUSTOMTITLE:CKEditor Localization Teams}}
CKEditor translation is based on language teams. The CKEditor resources are localized by dedicated teams of users that manage the translations into their native language. Bringing CKEditor to the users all around the world and making the editor available in as many languages as possible are our priorities. This is why all CKEditor developers and users are most welcome to join our [https://www.transifex.com/projects/p/ckeditor/ localization project on Transifex] and to contribute their translations.

== Joining CKEditor Localization Team ==
CKSource is always looking for new translators willing to join the CKEditor localization project, complete existing translations, and add new language versions. If you want to contribute, proceed as described below:
# '''Register on the Transifex website.'''
#; You can [https://www.transifex.com/ sign up for free] by using the "Sign Up Free" button in the top right-hand corner of the Transifex homepage. You will be redirected to the [https://www.transifex.com/signup/ signup form page]. Fill in your personal details and register the account. You will need to confirm your account by clicking the link from the validation e-mail.
# '''[https://www.transifex.com/signin/ Log in] and complete your profile.'''
#; Go to the '''[https://www.transifex.com/settings/ User account]''' section of your dashboard (by clicking your username in the top right-hand corner) and fill in the information that can tell other contributors something more about yourself.
# '''Join a CKEditor translation team.'''
#; Go to the [https://www.transifex.com/projects/p/ckeditor/ project's site] and see the list of available language teams. If you find a suitable one, [[CKEditor_3.x/Developers_Guide/Localization_Teams#Joining_a_Team|join it]]. If a language has the "(no team yet)" caption or it is not listed, [[CKEditor_3.x/Developers_Guide/Localization_Teams#Requesting_a_New_Team|request the creation of a new team]] for your native language.
#; Your requests will need to be approved by one of the maintainers or coordinators before you can actively contribute to the project.

=== Joining a Team ===
Go to the [https://www.transifex.com/projects/p/ckeditor/ CKEditor project page] and click a language that you want to join. Click '''Join team''' to request access to an existing team.

[[Image:Transifex_join_team_01.png|thumb|center|800px|Joining an existing team in Transifex]]

Before joining, you will need to accept the [https://www.transifex.com/projects/p/ckeditor/cla/ Contributor License Agreement]. Select the checkbox and press the '''Join language translation''' button.

[[Image:Transifex_join_team_03.png|thumb|center|800px|Accepting the Contributor License Agreement in Transifex]]

After you click the '''Join language translation''' button, a notification will be sent to the team coordinator. Your user name will now appear on the waiting list and you will be able to withdraw your application by clicking the '''Withdraw''' button.

[[Image:Transifex_join_team_02.png|thumb|center|800px|Team waiting list in Transifex]]

The request will also be visible in your dashboard — see the '''Recent Events''' list.

[[Image:Transifex_recent_activity_01.png|frame|center|Recent Events list in Transifex dashboard]]

When your request is approved, you will receive an e-mail notification. Your username will also appear on the language team page.

[[Image:Transifex_team_members.png|thumb|center|800px|Team members list in Transifex]]

You can now start translating project resources within your language team.

<note>Please note that in order to join more language teams you need to apply to all of them separately.
</note>

=== Requesting a New Team ===
If a team for your native language does not exist, you can request creating a new one. Please note that two situations may occur.

CKEditor may already have some translations for your native language coming from the past, but no team coordinates these efforts on Transifex. If this is the case, the language will be listed as '''''Language'' (no team yet)''' on the [https://www.transifex.com/projects/p/ckeditor/ project page].

[[Image:Transifex_no_team.png|thumb|center|800px|Languages without a team in Transifex]]

If this is the case, choose the language and then proceed as described in the [[CKEditor_3.x/Developers_Guide/Localization_Teams#Joining_a_Team|Joining a Team]] section. Your request will be sent to project maintainers and when accepted, you will become the team coordinator.

If, however, the language of your choice is not listed, just click the '''Request language''' link above the languages list.

[[Image:Transifex_request_team_01.png|thumb|center|800px|Requesting a new team in Transifex]]

The following form will open, letting you choose a language for the team.

[[Image:Transifex_request_team_02.png|thumb|center|800px|Requesting a new team in Transifex]]

<note>Please note that CKEditor uses two-letter ISO 639-1 language codes (like <code>de</code>, <code>it</code>, <code>fi</code>) for the majority of translations. In some cases, when a regional variation is required, the four-letter language code can be used (like in <code>pt_BR</code> for Brazilian Portuguese). Please contact the project maintainers if you have any doubts in this regard.</note>

After you click the '''Request team''' button, a notification will be sent to the project maintainers. The requested team will now appear on the waiting list.

[[Image:Transifex_request_team_03.png|thumb|center|800px|Pending team requests in Transifex]]

The request will also be visible in your dashboard — see the '''Recent Events''' list.

[[Image:Transifex_recent_activity_02.png|frame|center|Recent Events list in Transifex dashboard]]

When your request is approved, you will receive an e-mail notification. The new language will also immediately become available on the main project page.

[[Image:Transifex_teams_01.png|frame|center|Language teams list in Transifex]]

CKEditor 3.x/Developers Guide/Localization Troubleshooting

2013-03-01T12:17:44Z

Anna: Section sequence changed

__TOC__
{{#CUSTOMTITLE:CKEditor Localization Troubleshooting}}
The following article describes some issues that may arise during the localization process. If your problem is not described here, [https://www.transifex.com/projects/p/ckeditor/ contact CKEditor project maintainers] to get support.

== How to report disruptive team members, abuse, and vandalism ==
If you feel that there is a member of your team who is abusing the CKEditor localization project in any way, please report him or her to the project maintainers.

== Resource was not locked after downloading it for translation ==
You can lock the resource manually by selecting the '''Lock this translation to notify others you're working with it.''' option in the language resource dialog window.

[[Image:Transifex_manual_locking.png|frame|center|Lock file option in Transifex]]

Do not forget to unlock the translation when you are done with your work.

== Which language code should I use for a new team? ==
When you are [[CKEditor_3.x/Developers_Guide/Localization_Teams#Requesting_a_New_Team|setting up a new localization team]], you will be able to choose one from the drop-down list on Transifex page.

[[Image:Transifex_language_codes.png|thumb|center|800px|Language codes available in Transifex]]

Please note that while Transifex offers both two letter and four letter language codes, you should stick to the following CKSource rules based on ISO 639-1:
* For a ''standard variation of a language'', use a two letter language code, for example <code>pt</code> for Portuguese as used in Portugal.
* For a ''regional variant of a language only'', use a four letter language code, for example <code>pt_BR</code> for Portuguese as used in Brazil.

== Contribution License Agreement Error ==
When trying to join a translation team or requesting creation of a new team your action might be blocked with the following error message urging you to sign the Contribution License Agreement.

[[Image:Transifex_cla_error.png|thumb|center|800px|Contribution License Agreement error in Transifex]]

If this is the case, open the https://www.transifex.com/projects/p/ckeditor/cla/ page in your browser, select the checkbox and click the '''Sign it''' button.

[[Image:Transifex_signing_cla.png|frame|center|Signing the Contribution License Agreement in Transifex]]

== Do I still need to escape apostrophes in localized strings? ==
No. Although previously we have been working directly on JavaScript files and all apostrophes had to be escaped by using a backslash character, you no longer need to do this. Our tools will now perform all the necessary replacements in the background so just enter a correct literal string.
* '''Old version:'''
*; <code>Barre d\'emplacement des éléments de l\'éditeur</code>
* '''Current version:'''
*; <code>Barre d'emplacement des éléments de l'éditeur</code>

== How Do I Correct Existing Localizations? ==
When using CKEditor, you might notice that some language strings are not as good as they could be. If this is the case, you can log into the CKEditor UI Translation Center at Transifex and choose the resource you want to correct. When in [[CKEditor_3.x/Developers_Guide/Translating_CKEditor#Online_Translation|online translation mode]], just use the search bar to search for the term that you want to correct. Make sure you have not limited the list to untranslated entries only by clicking the '''Untranslated''' link above the editor input field.

== Transifex hangs on uploading a localized file ==
Sometimes when a file is malformed or uses an incorrect encoding, the upload may not succeed — it will hang without a descriptive error message. If this happens please check the following:
* Whether the file is correctly encoded. All CKEditor files are UTF-8 encoded. ANSI files will be rejected.
* Whether the file does not contain BOM.
* Whether the file structure was not altered in any way.
*; You can run <code>msgfmt -c</code> on the file to check its correctness before you attempt to upload it.

== Transifex reports a failed file correctness check ==
On uploading the file Transifex may report that the file is malformed.

[[Image:Transifex_offline_translation_error.png|thumb|600px|center|Failed file correctness check in Transifex]]

As suggested by Transifex, check the file by running <code>msgfmt -c</code>. Possible causes of the error might be:
* BOM is present at the beginning of the file.
* The <code>.po</code> file structure was altered and is no longer compliant with the project resources.

File:Transifex join team 03.png

2013-03-01T11:35:12Z

Anna: Accepting the CLA in Transifex

Accepting the CLA in Transifex

CKEditor 3.x/Developers Guide/Localization Troubleshooting

2013-03-01T11:05:44Z

Anna: Error with CLA added

__TOC__
{{#CUSTOMTITLE:CKEditor Localization Troubleshooting}}
The following article describes some issues that may arise during the localization process. If your problem is not described here, [https://www.transifex.com/projects/p/ckeditor/ contact CKEditor project maintainers] to get support.

=== Contribution License Agreement Error ===
When trying to join a translation team or requesting creation of a new team your action might be blocked with the following error message urging you to sign the Contribution License Agreement.

[[Image:Transifex_cla_error.png|thumb|center|800px|Contribution License Agreement error in Transifex]]

If this is the case, open the https://www.transifex.com/projects/p/ckeditor/cla/ page in your browser, select the checkbox and click the '''Sign it''' button.

[[Image:Transifex_signing_cla.png|frame|center|Signing the Contribution License Agreement in Transifex]]

=== How to report disruptive team members, abuse, and vandalism ===
If you feel that there is a member of your team who is abusing the CKEditor localization project in any way, please report him or her to the project maintainers.

=== Resource was not locked after downloading it for translation ===
You can lock the resource manually by selecting the '''Lock this translation to notify others you're working with it.''' option in the language resource dialog window.

[[Image:Transifex_manual_locking.png|frame|center|Lock file option in Transifex]]

Do not forget to unlock the translation when you are done with your work.

=== Which language code should I use for a new team? ===
When you are [[CKEditor_3.x/Developers_Guide/Localization_Teams#Requesting_a_New_Team|setting up a new localization team]], you will be able to choose one from the drop-down list on Transifex page.

[[Image:Transifex_language_codes.png|thumb|center|800px|Language codes available in Transifex]]

Please note that while Transifex offers both two letter and four letter language codes, you should stick to the following CKSource rules based on ISO 639-1:
* For a ''standard variation of a language'', use a two letter language code, for example <code>pt</code> for Portuguese as used in Portugal.
* For a ''regional variant of a language only'', use a four letter language code, for example <code>pt_BR</code> for Portuguese as used in Brazil.

=== Do I still need to escape apostrophes in localized strings? ===
No. Although previously we have been working directly on JavaScript files and all apostrophes had to be escaped by using a backslash character, you no longer need to do this. Our tools will now perform all the necessary replacements in the background so just enter a correct literal string.
* '''Old version:'''
*; <code>Barre d\'emplacement des éléments de l\'éditeur</code>
* '''Current version:'''
*; <code>Barre d'emplacement des éléments de l'éditeur</code>

=== How Do I Correct Existing Localizations? ===
When using CKEditor, you might notice that some language strings are not as good as they could be. If this is the case, you can log into the CKEditor UI Translation Center at Transifex and choose the resource you want to correct. When in [[CKEditor_3.x/Developers_Guide/Translating_CKEditor#Online_Translation|online translation mode]], just use the search bar to search for the term that you want to correct. Make sure you have not limited the list to untranslated entries only by clicking the '''Untranslated''' link above the editor input field.

=== Transifex hangs on uploading a localized file ===
Sometimes when a file is malformed or uses an incorrect encoding, the upload may not succeed — it will hang without a descriptive error message. If this happens please check the following:
* Whether the file is correctly encoded. All CKEditor files are UTF-8 encoded. ANSI files will be rejected.
* Whether the file does not contain BOM.
* Whether the file structure was not altered in any way.
*; You can run <code>msgfmt -c</code> on the file to check its correctness before you attempt to upload it.

=== Transifex reports a failed file correctness check ===
On uploading the file Transifex may report that the file is malformed.

[[Image:Transifex_offline_translation_error.png|thumb|600px|center|Failed file correctness check in Transifex]]

As suggested by Transifex, check the file by running <code>msgfmt -c</code>. Possible causes of the error might be:
* BOM is present at the beginning of the file.
* The <code>.po</code> file structure was altered and is no longer compliant with the project resources.

File:Transifex signing cla.png

2013-03-01T11:05:02Z

Anna: Signing the Contribution License Agreement in Transifex

Signing the Contribution License Agreement in Transifex

File:Transifex cla error.png

2013-03-01T11:03:45Z

Anna: Contribution License Agreement error in Transifex

Contribution License Agreement error in Transifex

File:Transifex request team 02.png

2013-03-01T10:39:13Z

Anna: Anna uploaded a new version of "File:Transifex request team 02.png": Updated to Feb 2013 look

Requesting a new team in Transifex

CKEditor 3.x/Developers Guide/Technical Details of Localization

2013-02-28T15:19:25Z

Anna: /* How Can I Immediately Test New Translations? */ Updated to Feb 2013

{{#CUSTOMTITLE:Technical Details of the CKEditor Localization}} __TOC__
In the article below you will learn:
# How often translations are ported from Transifex to CKEditor;
# Why gettext <code>.po</code> files are used in the CKEditor localization project;
# How to manually test new translations.

== When Will My Translation Be Published? ==
Below is a simple diagram that shows when the language strings added in Transifex will land in a new CKEditor release.

http://a.cksource.com/c/1/inc/img/transifex/diagram.png

Once generated, the development snapshot is immediately published on the [http://nightly.ckeditor.com/ CKEditor Nightly Website].
The whole process takes up to 24 hours, so after updating the translation, the next day you can download a development snapshot that will contain updated files. You can then test if everything works as expected.
<note>Please note that the ''development shapshot'' is exactly what the name implies. For a production environment it is more advisable to wait for the next stable release with updated language files.</note>

== Why Are .PO Files Used in Tansifex? ==
CKEditor is a browser-based WYSIWYG editor written in JavaScript. The language files used by CKEditor are also JavaScript files. This is the best option performance-wise.

For many translators working with JavaScript source code was not comfortable. Storing text in plain JavaScript files meant that the translator had to know how to code in JavaScript — strings had to be escaped properly, multiline strings had to be written in a special way etc. JavaScript language files are in fact small programs, for example the language file for the <code>a11yhelp</code> plugin calls a function:
<source lang="javascript">
CKEDITOR.plugins.setLang( 'a11yhelp', 'he', {
accessibilityHelp : {
...
}
}
</source>
All the issues mentioned above as well as the very specific format of the language files used by CKEditor core and plugins lead to the conclusion that a simplified intermediate format (<code>gettext</code>) is needed to make the localization process more straightforward and the integration with Transifex easier.

=== What Does it Mean to Me? ===
In the CKEditor localization project at Transifex you only have access to the <code>gettext</code> (<code>.po</code>) files. It means that for example if you download a resource for offline translation, you will get a <code>.po</code> file, not a JavaScript file. You can load this file into your favorite <code>.po</code> file editor like [http://projects.gnome.org/gtranslator/ Gtranslator], [http://userbase.kde.org/Lokalize Lokalize], or [http://www.poedit.net/ Poedit] for offline translation, but you cannot use it directly with CKEditor.

== How Can I Immediately Test New Translations? ==
At some stage you may want to immediately check if your translation fits into the place where it is used.
As explained above, the propagation of changes between Transifex and the CKEditor nightly build takes up to 24 hours. If you have doubts regarding the string context, make sure to always check the '''Details''' tab of a language string and read the '''Developer comment''' field to understand where the string is used.

[[Image:Transifex_details_tab.png|thumb|center|800px|The Details tab of a language string in Transifex]]

If you are still unsure, you can also check the '''Key''' in the '''Details''' tab. The '''Key''' is nothing else than the name of a variable that is used inside the JavaScript language files.
For example, the <code>common.url</code> key is equal to the following object:
<source lang="javascript">
common :
{
url : '...'
}
</source>
After finding the right entry in the appropriate CKEditor language file (if you are translating the core, the language file is located in the <code>lang</code> folder), you may modify the string you are interested in. Save the file and launch CKEditor to see whether your translation fits the context and available space.

File:Transifex details tab.png

2013-02-28T15:17:40Z

Anna: Anna uploaded a new version of "File:Transifex details tab.png": Updated to Feb 2013 look

The "details" tab in Transifex.

CKEditor 3.x/Developers Guide/Localization Troubleshooting

2013-02-28T15:10:06Z

Anna: Updated to February 2013 look and feel

__TOC__
{{#CUSTOMTITLE:CKEditor Localization Troubleshooting}}
The following article describes some issues that may arise during the localization process. If your problem is not described here, [https://www.transifex.com/projects/p/ckeditor/ contact CKEditor project maintainers] to get support.

=== How to report disruptive team members, abuse, and vandalism ===
If you feel that there is a member of your team who is abusing the CKEditor localization project in any way, please report him or her to the project maintainers.

=== Resource was not locked after downloading it for translation ===
You can lock the resource manually by selecting the '''Lock this translation to notify others you're working with it.''' option in the language resource dialog window.

[[Image:Transifex_manual_locking.png|frame|center|Lock file option in Transifex]]

Do not forget to unlock the translation when you are done with your work.

=== Which language code should I use for a new team? ===
When you are [[CKEditor_3.x/Developers_Guide/Localization_Teams#Requesting_a_New_Team|setting up a new localization team]], you will be able to choose one from the drop-down list on Transifex page.

[[Image:Transifex_language_codes.png|thumb|center|800px|Language codes available in Transifex]]

Please note that while Transifex offers both two letter and four letter language codes, you should stick to the following CKSource rules based on ISO 639-1:
* For a ''standard variation of a language'', use a two letter language code, for example <code>pt</code> for Portuguese as used in Portugal.
* For a ''regional variant of a language only'', use a four letter language code, for example <code>pt_BR</code> for Portuguese as used in Brazil.

=== Do I still need to escape apostrophes in localized strings? ===
No. Although previously we have been working directly on JavaScript files and all apostrophes had to be escaped by using a backslash character, you no longer need to do this. Our tools will now perform all the necessary replacements in the background so just enter a correct literal string.
* '''Old version:'''
*; <code>Barre d\'emplacement des éléments de l\'éditeur</code>
* '''Current version:'''
*; <code>Barre d'emplacement des éléments de l'éditeur</code>

=== How Do I Correct Existing Localizations? ===
When using CKEditor, you might notice that some language strings are not as good as they could be. If this is the case, you can log into the CKEditor UI Translation Center at Transifex and choose the resource you want to correct. When in [[CKEditor_3.x/Developers_Guide/Translating_CKEditor#Online_Translation|online translation mode]], just use the search bar to search for the term that you want to correct. Make sure you have not limited the list to untranslated entries only by clicking the '''Untranslated''' link above the editor input field.

=== Transifex hangs on uploading a localized file ===
Sometimes when a file is malformed or uses an incorrect encoding, the upload may not succeed — it will hang without a descriptive error message. If this happens please check the following:
* Whether the file is correctly encoded. All CKEditor files are UTF-8 encoded. ANSI files will be rejected.
* Whether the file does not contain BOM.
* Whether the file structure was not altered in any way.
*; You can run <code>msgfmt -c</code> on the file to check its correctness before you attempt to upload it.

=== Transifex reports a failed file correctness check ===
On uploading the file Transifex may report that the file is malformed.

[[Image:Transifex_offline_translation_error.png|thumb|600px|center|Failed file correctness check in Transifex]]

As suggested by Transifex, check the file by running <code>msgfmt -c</code>. Possible causes of the error might be:
* BOM is present at the beginning of the file.
* The <code>.po</code> file structure was altered and is no longer compliant with the project resources.

File:Transifex language codes.png

2013-02-28T15:02:13Z

Anna: Anna uploaded a new version of "File:Transifex language codes.png": Updated to Feb 2013 look

Language codes available in Transifex

CKEditor 3.x/Developers Guide/Localization Tips

2013-02-28T14:55:18Z

Anna: Updated to February 2013 look and feel

{{#CUSTOMTITLE:CKEditor Localization Tips}}
Below are some tips that can speed up the translation process and make our workflow more understandable.
# When translating, concentrate on incomple resources first and only after they are done, attempt to correct the extisting entries.
# When using the online Transifex editor, see the list of [http://help.transifex.com/intro/translating.html#keyboard-shortcuts available keyboard shortcuts] that can make a translator's life much easier. The shortcuts list are also available in the editor when you click the [[Image:Transifex_online_translation_keyboard.png]] (keyboard) icon near the progress bar at the top of the editor.
# In translation the context is everything. The source language string might sometimes be ambiguous, so in the online editor you can open the '''Details''' tab for each source string and check its context that is described in the '''Developer comment''' field. Please use this feature often to avoid misunderstandings!
# If you are not a long-time CKEditor user or developer, we recommend you get acquainted with the [http://ckeditor.com/demo editor demo] or even [http://ckeditor.com/download download and install CKEditor] on your local computer. This will make it easier for you to understand the look and feel of the application as well as its structure and building blocks.
# Transifex includes a very useful feature called "[http://help.transifex.com/intro/translating.html#translation-suggestions suggestions]". You can use it to propose a better version of an existing translation and let the team coordinator or fellow team members decide which version should be used. Additionally, when you are unsure as to how to translate a term, you can propose several versions as suggestions and let other users vote on them. You will find the '''Suggestions''' tab for each entry in the online editor. This list also contains automatic suggestions based on the translation memory — if other similar entries are found, they will be displayed here along with the percent value for similarity.
# Use the file locking feature reasonably and do not lock a file for longer than is necessary. If you know you will not be able to finish your work in one go, you can submit a partially complete translation and come back to it when you have more time to spare.
# Each language team can use its own discussion board for all discussions regarding the translations, division of work, schedules etc. Use this feature to coordinate team work or consult fellow team members.
# Last but not least, remember that Transifex is based on team work. Treat fellow team members as you would like to be treated by them; it is not about competition, it is about cooperation with others and working together to achieve a common goal.

CKEditor 3.x/Developers Guide/Localization Teams

2013-02-28T14:45:10Z

Anna: /* Requesting a New Team */ Updated part 3

__TOC__
{{#CUSTOMTITLE:CKEditor Localization Teams}}
CKEditor translation is based on language teams. The CKEditor resources are localized by dedicated teams of users that manage the translations into their native language. Bringing CKEditor to the users all around the world and making the editor available in as many languages as possible are our priorities. This is why all CKEditor developers and users are most welcome to join our [https://www.transifex.com/projects/p/ckeditor/ localization project on Transifex] and to contribute their translations.

== Joining CKEditor Localization Team ==
CKSource is always looking for new translators willing to join the CKEditor localization project, complete existing translations, and add new language versions. If you want to contribute, proceed as described below:
# '''Register on the Transifex website.'''
#; You can [https://www.transifex.com/ sign up for free] by using the "Sign Up Free" button in the top right-hand corner of the Transifex homepage. You will be redirected to the [https://www.transifex.com/signup/ signup form page]. Fill in your personal details and register the account. You will need to confirm your account by clicking the link from the validation e-mail.
# '''[https://www.transifex.com/signin/ Log in] and complete your profile.'''
#; Go to the '''[https://www.transifex.com/settings/ User account]''' section of your dashboard (by clicking your username in the top right-hand corner) and fill in the information that can tell other contributors something more about yourself.
# '''Join a CKEditor translation team.'''
#; Go to the [https://www.transifex.com/projects/p/ckeditor/ project's site] and see the list of available language teams. If you find a suitable one, [[CKEditor_3.x/Developers_Guide/Localization_Teams#Joining_a_Team|join it]]. If a language has the "(no team yet)" caption or it is not listed, [[CKEditor_3.x/Developers_Guide/Localization_Teams#Requesting_a_New_Team|request the creation of a new team]] for your native language.
#; Your requests will need to be approved by one of the maintainers or coordinators before you can actively contribute to the project.

=== Joining a Team ===
Go to the [https://www.transifex.com/projects/p/ckeditor/ CKEditor project page] and click a language that you want to join. Click '''Join team''' to request access to an existing team.

[[Image:Transifex_join_team_01.png|thumb|center|800px|Joining an existing team in Transifex]]

After you click the '''Join language translation''' button, a notification will be sent to the team coordinator. Your user name will now appear on the waiting list and you will be able to withdraw your application by clicking the '''Withdraw''' button.

[[Image:Transifex_join_team_02.png|thumb|center|800px|Team waiting list in Transifex]]

The request will also be visible in your dashboard — see the '''Recent Events''' list.

[[Image:Transifex_recent_activity_01.png|frame|center|Recent Events list in Transifex dashboard]]

When your request is approved, you will receive an e-mail notification. Your username will also appear on the language team page.

[[Image:Transifex_team_members.png|thumb|center|800px|Team members list in Transifex]]

You can now start translating project resources within your language team.

<note>Please note that in order to join more language teams you need to apply to all of them separately.
</note>

=== Requesting a New Team ===
If a team for your native language does not exist, you can request creating a new one. Please note that two situations may occur.

CKEditor may already have some translations for your native language coming from the past, but no team coordinates these efforts on Transifex. If this is the case, the language will be listed as '''''Language'' (no team yet)''' on the [https://www.transifex.com/projects/p/ckeditor/ project page].

[[Image:Transifex_no_team.png|thumb|center|800px|Languages without a team in Transifex]]

If this is the case, choose the language and then proceed as described in the [[CKEditor_3.x/Developers_Guide/Localization_Teams#Joining_a_Team|Joining a Team]] section. Your request will be sent to project maintainers and when accepted, you will become the team coordinator.

If, however, the language of your choice is not listed, just click the '''Request language''' link above the languages list.

[[Image:Transifex_request_team_01.png|thumb|center|800px|Requesting a new team in Transifex]]

The following form will open, letting you choose a language for the team.

[[Image:Transifex_request_team_02.png|thumb|center|800px|Requesting a new team in Transifex]]

<note>Please note that CKEditor uses two-letter ISO 639-1 language codes (like <code>de</code>, <code>it</code>, <code>fi</code>) for the majority of translations. In some cases, when a regional variation is required, the four-letter language code can be used (like in <code>pt_BR</code> for Brazilian Portuguese). Please contact the project maintainers if you have any doubts in this regard.</note>

After you click the '''Request team''' button, a notification will be sent to the project maintainers. The requested team will now appear on the waiting list.

[[Image:Transifex_request_team_03.png|thumb|center|800px|Pending team requests in Transifex]]

The request will also be visible in your dashboard — see the '''Recent Events''' list.

[[Image:Transifex_recent_activity_02.png|frame|center|Recent Events list in Transifex dashboard]]

When your request is approved, you will receive an e-mail notification. The new language will also immediately become available on the main project page.

[[Image:Transifex_teams_01.png|frame|center|Language teams list in Transifex]]

File:Transifex request team 01.png

2013-02-28T14:21:34Z

Anna: Requesting a new team in Transifex

Requesting a new team in Transifex

File:Transifex no team.png

2013-02-28T13:15:03Z

Anna: The (no team yet) captions on the languages list

The (no team yet) captions on the languages list

CKEditor 3.x/Developers Guide/Localization Teams

2013-02-28T12:52:21Z

Anna: /* Joining a Team */ Updated part 2

__TOC__
{{#CUSTOMTITLE:CKEditor Localization Teams}}
CKEditor translation is based on language teams. The CKEditor resources are localized by dedicated teams of users that manage the translations into their native language. Bringing CKEditor to the users all around the world and making the editor available in as many languages as possible are our priorities. This is why all CKEditor developers and users are most welcome to join our [https://www.transifex.com/projects/p/ckeditor/ localization project on Transifex] and to contribute their translations.

== Joining CKEditor Localization Team ==
CKSource is always looking for new translators willing to join the CKEditor localization project, complete existing translations, and add new language versions. If you want to contribute, proceed as described below:
# '''Register on the Transifex website.'''
#; You can [https://www.transifex.com/ sign up for free] by using the "Sign Up Free" button in the top right-hand corner of the Transifex homepage. You will be redirected to the [https://www.transifex.com/signup/ signup form page]. Fill in your personal details and register the account. You will need to confirm your account by clicking the link from the validation e-mail.
# '''[https://www.transifex.com/signin/ Log in] and complete your profile.'''
#; Go to the '''[https://www.transifex.com/settings/ User account]''' section of your dashboard (by clicking your username in the top right-hand corner) and fill in the information that can tell other contributors something more about yourself.
# '''Join a CKEditor translation team.'''
#; Go to the [https://www.transifex.com/projects/p/ckeditor/ project's site] and see the list of available language teams. If you find a suitable one, [[CKEditor_3.x/Developers_Guide/Localization_Teams#Joining_a_Team|join it]]. If a language has the "(no team yet)" caption or it is not listed, [[CKEditor_3.x/Developers_Guide/Localization_Teams#Requesting_a_New_Team|request the creation of a new team]] for your native language.
#; Your requests will need to be approved by one of the maintainers or coordinators before you can actively contribute to the project.

=== Joining a Team ===
Go to the [https://www.transifex.com/projects/p/ckeditor/ CKEditor project page] and click a language that you want to join. Click '''Join team''' to request access to an existing team.

[[Image:Transifex_join_team_01.png|thumb|center|800px|Joining an existing team in Transifex]]

After you click the '''Join language translation''' button, a notification will be sent to the team coordinator. Your user name will now appear on the waiting list and you will be able to withdraw your application by clicking the '''Withdraw''' button.

[[Image:Transifex_join_team_02.png|thumb|center|800px|Team waiting list in Transifex]]

The request will also be visible in your dashboard — see the '''Recent Events''' list.

[[Image:Transifex_recent_activity_01.png|frame|center|Recent Events list in Transifex dashboard]]

When your request is approved, you will receive an e-mail notification. Your username will also appear on the language team page.

[[Image:Transifex_team_members.png|thumb|center|800px|Team members list in Transifex]]

You can now start translating project resources within your language team.

<note>Please note that in order to join more language teams you need to apply to all of them separately.
</note>

=== Requesting a New Team ===
If a team for your native language does not exist, you can request creating a new one.

Go to the translation [https://www.transifex.net/projects/p/ckeditor/teams/ teams page] on the project's site and click the '''Request a new team''' button. The following form will open, letting you choose a language for the team.

[[Image:Transifex_request_team_02.png|thumb|center|800px|Requesting a new team in Transifex]]

<note>Please note that CKEditor uses two-letter ISO 639-1 language codes (like <code>de</code>, <code>it</code>, <code>fi</code>) for the majority of translations. In some cases, when a regional variation is required, the four-letter language code can be used (like in <code>pt_BR</code> for Brazilian Portuguese). Please contact the project maintainers if you have any doubts in this regard.</note>

After you click the '''Request Team''' button, a notification will be sent to the project maintainers. The requested team will now appear on the waiting list.

[[Image:Transifex_request_team_03.png|thumb|center|800px|Pending team requests in Transifex]]

The request will also be visible in your profile — see the '''Recent activity''' list.

[[Image:Transifex_recent_activity_02.png|frame|center|Recent activity list in Transifex profile]]

When your request is approved, you will receive an e-mail notification. The new team will also immediately appear on the main project teams page.

[[Image:Transifex_teams_01.png|frame|center|Language teams list in Transifex]]

File:Transifex recent activity 01.png

2013-02-28T12:50:12Z

Anna: Anna uploaded a new version of "File:Transifex recent activity 01.png": Updated to Feb 2013 look

Recent activity list in Transifex profile

File:Transifex join team 02.png

2013-02-28T12:48:21Z

Anna: Anna uploaded a new version of "File:Transifex join team 02.png": Updated to Feb 2013 look

Team waiting list in Transifex

File:Transifex join team 01.png

2013-02-28T12:45:19Z

Anna: Anna uploaded a new version of "File:Transifex join team 01.png": Updated to Feb 2013 look

Joining an existing team in Transifex

File:Transifex team members.png

2013-02-28T12:42:39Z

Anna: Anna uploaded a new version of "File:Transifex team members.png": Updated to Feb 2013 look

Team members list in Transifex

File:Transifex join team 01.png

2013-02-28T12:34:40Z

Anna: Anna uploaded a new version of "File:Transifex join team 01.png": Updated to Feb 2013 look

Joining an existing team in Transifex

CKEditor 3.x/Developers Guide/Localization Teams

2013-02-28T12:21:51Z

Anna: Updated part 1

__TOC__
{{#CUSTOMTITLE:CKEditor Localization Teams}}
CKEditor translation is based on language teams. The CKEditor resources are localized by dedicated teams of users that manage the translations into their native language. Bringing CKEditor to the users all around the world and making the editor available in as many languages as possible are our priorities. This is why all CKEditor developers and users are most welcome to join our [https://www.transifex.com/projects/p/ckeditor/ localization project on Transifex] and to contribute their translations.

== Joining CKEditor Localization Team ==
CKSource is always looking for new translators willing to join the CKEditor localization project, complete existing translations, and add new language versions. If you want to contribute, proceed as described below:
# '''Register on the Transifex website.'''
#; You can [https://www.transifex.com/ sign up for free] by using the "Sign Up Free" button in the top right-hand corner of the Transifex homepage. You will be redirected to the [https://www.transifex.com/signup/ signup form page]. Fill in your personal details and register the account. You will need to confirm your account by clicking the link from the validation e-mail.
# '''[https://www.transifex.com/signin/ Log in] and complete your profile.'''
#; Go to the '''[https://www.transifex.com/settings/ User account]''' section of your dashboard (by clicking your username in the top right-hand corner) and fill in the information that can tell other contributors something more about yourself.
# '''Join a CKEditor translation team.'''
#; Go to the [https://www.transifex.com/projects/p/ckeditor/ project's site] and see the list of available language teams. If you find a suitable one, [[CKEditor_3.x/Developers_Guide/Localization_Teams#Joining_a_Team|join it]]. If a language has the "(no team yet)" caption or it is not listed, [[CKEditor_3.x/Developers_Guide/Localization_Teams#Requesting_a_New_Team|request the creation of a new team]] for your native language.
#; Your requests will need to be approved by one of the maintainers or coordinators before you can actively contribute to the project.

=== Joining a Team ===
Go to the translation [https://www.transifex.net/projects/p/ckeditor/teams/ teams page] on the project's site and click a team that you want to join. Accept the contributor license agreements and click '''Join this Team''' to request access to an existing team.

[[Image:Transifex_join_team_01.png|thumb|center|800px|Joining an existing team in Transifex]]

After you click the '''Join this Team''' button, a notification will be sent to the team coordinator. Your user name will now appear on the waiting list and you will be able to withdraw your application by clicking the '''Withdraw''' button.

[[Image:Transifex_join_team_02.png|thumb|center|800px|Team waiting list in Transifex]]

The request will also be visible in your profile — see the '''Recent activity''' list.

[[Image:Transifex_recent_activity_01.png|frame|center|Recent activity list in Transifex profile]]

When your request is approved, you will receive an e-mail notification. Your user name will also appear on the language team page.

[[Image:Transifex_team_members.png|thumb|center|800px|Team members list in Transifex]]

You can now start translating project resources within your language team.

<note>Please note that in order to join more language teams you need to apply to all of them separately.
</note>

=== Requesting a New Team ===
If a team for your native language does not exist, you can request creating a new one.

Go to the translation [https://www.transifex.net/projects/p/ckeditor/teams/ teams page] on the project's site and click the '''Request a new team''' button. The following form will open, letting you choose a language for the team.

[[Image:Transifex_request_team_02.png|thumb|center|800px|Requesting a new team in Transifex]]

<note>Please note that CKEditor uses two-letter ISO 639-1 language codes (like <code>de</code>, <code>it</code>, <code>fi</code>) for the majority of translations. In some cases, when a regional variation is required, the four-letter language code can be used (like in <code>pt_BR</code> for Brazilian Portuguese). Please contact the project maintainers if you have any doubts in this regard.</note>

After you click the '''Request Team''' button, a notification will be sent to the project maintainers. The requested team will now appear on the waiting list.

[[Image:Transifex_request_team_03.png|thumb|center|800px|Pending team requests in Transifex]]

The request will also be visible in your profile — see the '''Recent activity''' list.

[[Image:Transifex_recent_activity_02.png|frame|center|Recent activity list in Transifex profile]]

When your request is approved, you will receive an e-mail notification. The new team will also immediately appear on the main project teams page.

[[Image:Transifex_teams_01.png|frame|center|Language teams list in Transifex]]