Docs RU

Version 9 (Troex Nevelin, 19.03.2010 04:55)

1 1
h1. Документация
2 1
3 1
Подключение jquery, jquery-ui и плагинов jquery.form и jquery.metadata:
4 1
5 1
jquery и jquery-ui необходимы для elRTE и elFinder.
6 1
jquery.form и jquery.metadata необходимы для elFinder.
7 9 Troex Nevelin
<pre><code class="html">
8 1
<script src="js/jquery.min.js" type="text/javascript" charset="utf-8"><script>
9 1
<script src="js/jquery-ui.min.js" type="text/javascript" charset="utf-8"><script>
10 8 Troex Nevelin
<link rel="stylesheet" href="css/ui-themes/base/ui.all.css" type="text/css" media="screen" charset="utf-8">
11 9 Troex Nevelin
</code></pre>
12 6 Troex Nevelin
13 1
Если вы не используете в своем проекте jquery-ui в полном объеме, можно собрать минимальную версию jquery-ui, включающую только dialog и tabs.
14 9 Troex Nevelin
<pre><code class="html">
15 1
<script type="text/javascript" charset="utf-8">
16 1
	$().ready(function() {
17 1
		var opts = {
18 1
			lang : 'ru',
19 1
			styleWithCss : false,
20 1
			height  : 400,
21 1
			toolbar : 'maxi',
22 1
			fmAllow  : true,
23 1
			fmOpen   : function(callback) {
24 1
				$('<div />').elfinder({
25 1
					url : 'connector/connector.php',
26 1
					lang : 'en',
27 1
					dialog : { width : 900, modal : true },
28 1
					editorCallback : callback
29 1
				})
30 1
			}
31 1
		};
32 1
		// создаем редактор
33 1
		$('#our-element').elrte(opts);
34 1
35 1
		// или так
36 1
		var editor = new elRTE(document.getElementById('our-element'), opts);
37 1
	});
38 1
<script>
39 9 Troex Nevelin
</code></pre>
40 1
41 8 Troex Nevelin
#our-element - id элемента, на котором будет создан редактор, может быть textarea или любым html элементом, содержащем текст (будет заменен на textarea перед отправкой формы)
42 1
43 3 Troex Nevelin
h2. Опции elRTE
44 3 Troex Nevelin
45 2 Troex Nevelin
*doctype* doctype окна редактора (iframe). По умолчанию - HTML 4.01 Transitional
46 2 Troex Nevelin
*cssClass* класс для редактора
47 2 Troex Nevelin
*cssfiles* массив url css файлов, подключаемых в окно редактора (iframe)
48 2 Troex Nevelin
*absoluteURLs* false/true. Приводить адреса ссылок и изображений к абсолютным
49 2 Troex Nevelin
*allowSource* false/true. Разрешает редактирование HTML
50 2 Troex Nevelin
*lang* язык интерфейса (требует подключения языковых файлов, если язык отличен от английского)
51 2 Troex Nevelin
*styleWithCss* если true - текст будет оформляться тегами span с аттрибутом style, в противном случае - семантическими тегами strong, em и тд
52 2 Troex Nevelin
*height* высота окна редактора в пикселях
53 2 Troex Nevelin
*fmAllow* разрешить использование файлового менеджера
54 1
*fmOpen* функция, которая будет вызвана, чтобы открыть файловый менеджер.
55 1
Аргумент callback - функция, которую редактор передает файловому менеджеру при открытии. Файловый менеджер должен вызвать эту функцию, передав ей url выбранного файла
56 3 Troex Nevelin
*toolbar* имя панели инструментов. Панели состоят из именованных групп кнопок. Редактор содержит некоторое кол-во предопределенных панелей инструментов. Если необходим набор кнопок, которого нет в предопределенных панелях, вы можете определить свои собственные группы кнопок и панелей.
57 3 Troex Nevelin
*buttons* имена кнопок (должен быть дополнен при добавлении новых кнопок)
58 3 Troex Nevelin
*panels* Объект. Ключ - имя группы, значение - массив кнопок в этой группе
59 3 Troex Nevelin
*toolbars* Объект. Ключ - имя панели инструментов, значение - массив групп кнопок в него входящих.
60 1
На данный момент существуют следующие toolbars:
61 4 Troex Nevelin
* tiny: только кнопки изменения стиля текста (жирный, наклонный, подчеркнутый, перечеркнутый, subscript, superscript)
62 4 Troex Nevelin
* compact: тоже, что и tiny + сохранить, отмена/повтор, выравнивание, списки, ссылки, полноэкранный режим
63 4 Troex Nevelin
* normal: тоже, что и compact + копировать/вставить, цвета, отступы, элементы, изображения
64 4 Troex Nevelin
* complite: тоже, что и normal + форматирование, размер и стиль шрифта
65 4 Troex Nevelin
* maxi: тоже, что и complite + таблицы
66 1
67 2 Troex Nevelin
h2. Создание своего toolbar для редактора
68 2 Troex Nevelin
69 1
Способ 1. После подключения файлов elRTE:
70 2 Troex Nevelin
<pre>
71 1
<script type="text/javascript" charset="utf-8">
72 1
elRTE.prototype.options.toolbars.newToolbar = [
73 1
	// имена групп кнопок на нашем toolbar (см src/elrte/elRTE.options.js)
74 1
	'save', 'copypaste', 'style', 'colors', 'tables', 'fullscreen'
75 1
];
76 1
<script>
77 2 Troex Nevelin
</pre>
78 1
Теперь, при создания редактора в параметре toolbar передаем имя нашей панели инструментов.
79 1
80 1
Способ 2. Во время создания нового редактора:
81 2 Troex Nevelin
<pre>
82 1
<script type="text/javascript" charset="utf-8">
83 1
var opts = {
84 1
	...
85 1
	toolbars : {
86 1
		newToolbar : ['save', 'copypaste', 'style', 'colors', 'tables', 'fullscreen']
87 1
	},
88 1
	toolbar : 'newToolbar',
89 1
	...
90 1
	}
91 1
};
92 1
// создаем редактор
93 1
$('#our-element').elrte(opts);
94 1
95 1
<script>
96 1
</pre>