Docs EN

Version 1 (Troex Nevelin, 22.03.2010 08:40)

1 1
{{>toc}}
2 1
3 1
h1. Documentation
4 1
5 1
h2. Install
6 1
7 1
<pre><code class="html">
8 1
<link rel="stylesheet" href="css/ui-themes/base/ui.all.css" type="text/css" media="screen" charset="utf-8">
9 1
<link rel="stylesheet" href="css/elrte.full.css" type="text/css" media="screen" charset="utf-8">
10 1
11 1
<script src="js/jquery-1.3.2.min.js" type="text/javascript" charset="utf-8"></script>
12 1
<script src="js/jquery-ui-1.7.2.custom.min.js" type="text/javascript" charset="utf-8"></script>
13 1
<script src="js/elrte.min.js" type="text/javascript" charset="utf-8"></script>
14 1
</code></pre>
15 1
16 1
If you are not using full jQuery UI library, than make sure your _custom_ version includes *dialog* and *tabs* components.
17 1
<pre><code class="html">
18 1
<script type="text/javascript" charset="utf-8">
19 1
	$().ready(function() {
20 1
		var opts = {
21 1
			lang : 'ru',
22 1
			styleWithCss : false,
23 1
			height  : 400,
24 1
			toolbar : 'maxi',
25 1
			fmAllow  : true,
26 1
			fmOpen   : function(callback) {
27 1
				$('<div />').elfinder({
28 1
					url : 'connector/connector.php',
29 1
					lang : 'en',
30 1
					dialog : { width : 900, modal : true },
31 1
					editorCallback : callback
32 1
				})
33 1
			}
34 1
		};
35 1
		// create editor
36 1
		$('#our-element').elrte(opts);
37 1
38 1
		// or this way
39 1
		// var editor = new elRTE(document.getElementById('our-element'), opts);
40 1
	});
41 1
<script>
42 1
</code></pre>
43 1
44 1
#our-element - id of element where editor will be created, this can textarea or any HTML element that can contain text (will be replaced with textarea on form submit)
45 1
46 1
h2. Options
47 1
48 1
|_.Option|_.Type|_.Description|
49 1
|doctype|String|DocType of editor window (iframe). Default - *HTML 4.01 Transitional*|
50 1
|cssClass|String|CSS class for editor|
51 1
|cssfiles|Array|Массив css файлов, подключаемых в окно редактора (iframe)|
52 1
|absoluteURLs|Boolean|Приводить адреса ссылок и изображений к абсолютным|
53 1
|allowSource|Boolean|Разрешает редактирование HTML|
54 1
|lang|String|Язык интерфейса (требует подключения языковых файлов), если не задан от английский|
55 1
|styleWithCss|Boolean|Если true - текст будет оформляться тегами span с аттрибутом style, в противном случае - семантическими тегами strong, em и тд|
56 1
|height|Number|Высота окна редактора в пикселях|
57 1
|fmAllow|Boolean|Разрешить использование файлового менеджера|
58 1
|fmOpen|Function(callback)|Функция, которая будет вызвана, чтобы открыть файловый менеджер. Аргумент callback - функция, которую редактор передает файловому менеджеру при открытии. Файловый менеджер должен вызвать эту функцию, передав ей url выбранного файла|
59 1
|toolbar|String|Имя используемого тулбара (панели инструментов)|
60 1
61 1
h3. Тулбар (панель инструментов)
62 1
63 1
На данный момент существуют следующие тулбары:
64 1
* *tiny*: только кнопки изменения стиля текста (жирный, наклонный, подчеркнутый, перечеркнутый, subscript, superscript)
65 1
* *compact*: тоже, что и tiny + сохранить, отмена/повтор, выравнивание, списки, ссылки, полноэкранный режим
66 1
* *normal*: тоже, что и compact + копировать/вставить, цвета, отступы, элементы, изображения
67 1
* *complete*: тоже, что и normal + форматирование, размер и стиль шрифта
68 1
* *maxi*: тоже, что и complite + таблицы