Last modified by Eugen Colesnicov on 2011/02/26 18:18

Hide last authors
Eugen Colesnicov 13.1 1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{warning}}translation to English not finished yet!{{/warning}}
3
Eugen Colesnicov 5.8 4 {{toc start="2" depth="2"/}}
Eugen Colesnicov 13.1 5
Eugen Colesnicov 4.1 6 {{/box}}
Eugen Colesnicov 1.1 7
Eugen Colesnicov 13.1 8 == Introduction ==
9 This instruction contains the step-by-step description of XWiki Enterprise initial installation and optimal tuning under Windows+GlassFish+OracleXE.
Eugen Colesnicov 6.1 10
Eugen Colesnicov 13.1 11 I used as my starting point the installation instructions from xwiki.org site. However they are more abstract and, frequently, do not take into accout the pecularitites of installation in Russian (and other non-English) conditions.
Eugen Colesnicov 1.1 12
Eugen Colesnicov 13.1 13 I wrote this instructions primariuly for my personal use: to be able to repeat the installation quickly (and, possibly, by other administrators). The instruction does not describe "if - then" like the instructions from xwiki.org but more decisevely "to do this and that". That's why I omit long reasoning.
Eugen Colesnicov 1.1 14
Eugen Colesnicov 13.1 15 There is and old (Russian) version ot this instruction. That old version was initiated for XWiki version 2.0 or 2.1 under Jetty, and later I added Glassfish. Many recommendations from there are now inapplicable. The new (current) variant of the Instruction supposes XWiki 2.7 and 3.0.
Eugen Colesnicov 1.1 16
Eugen Colesnicov 13.1 17 I deleted from the old variant many things, mainly those concerning Jetty. From the very beginning I tried to install XWiki under Windows+Jetty+OracleXE, but later I realized that Jetty is not a proper tool for industrial use. The main shortcomings are the service hang and slow work with attachments.
Eugen Colesnicov 1.1 18
Eugen Colesnicov 13.1 19 Searching for replacement for Jetty, I selected Glassfish. I was positively impressed by the Web interface for the configuration, relatively small tuning, and the speed. The file can be attached almost as quick as local copying (Jetty is ten times slower).
Eugen Colesnicov 1.1 20
Eugen Colesnicov 13.1 21 This new variant of the Instruction is not finished. I will add sections on LDAP tuning, on configuring the connection with an external Oracle database, etc. I plan also translations in English and Romanian.
Eugen Colesnicov 1.1 22
Eugen Colesnicov 13.1 23 == Downloading the necessary software ==
Eugen Colesnicov 1.1 24
25 * **[[XWiki Enterprise>>http://www.xwiki.org/xwiki/bin/view/Main/Download#HXWikiEnterprise]]**:
26 ** берем war-файл - собственно само приложение,
27 ** и также xar-файл - содержит начальные настройки и базовые страницы wiki.
28
29 * **[[Java Development Kit (JDK)>>http://www.oracle.com/technetwork/java/javase/downloads/index.html]]** - необходимо для работы сервера приложений.
30
31 * **[[Glassfish Application Server>>http://glassfish.java.net/]]** - сервер приложений.
32
33 * **[[Oracle JDBC Drivers>>http://www.oracle.com/technology/software/tech/java/sqlj_jdbc/index.html]]** - оптимальный выбор **ojdbc5.jar** от Oracle 11G.
34
35 * Для работы приложения "импорт офисных документов" требуется:
36 ** **[[OpenOffice>>http://download.openoffice.org/index.html]]** - офисный пакет, используемый для конвертации.
37 ** **[[windows server 2003 resource kit>>http://go.microsoft.com/fwlink/?LinkId=4544]]** - позволяет создать сервис.
38
39 * В случае, если СУБД Oracle будет устанавливаться локально, то также будет необходимо **[[Oracle Database Express Edition>>http://www.oracle.com/technology/software/products/database/xe/index.html]]**.
Eugen Colesnicov 13.1 40 {{info}}
41 Следует закачивать т.н. //Universal//-версию OracleXE для обеспечения поддержки UTF-8 (мультиязычности) на уровне БД.
42 {{/info}}
Eugen Colesnicov 3.2 43
Eugen Colesnicov 1.1 44
Eugen Colesnicov 13.1 45
46 == Installing the base application set ==
Eugen Colesnicov 5.19 47 **Оглавление раздела:**
48
49 {{toc start="5" depth="5" scope="local"/}}
50
51 ===== **OracleXE** (если будем использовать локальную БД). =====
Eugen Colesnicov 1.1 52 * просто инсталлируем через Setup.
Eugen Colesnicov 13.1 53 {{info}}
54 В OracleXE, при инсталляции, отсутствуют возможности настройки языковых параметров БД. А для XWiki, для обеспечения мультиязычности, нужно чтобы они были настроены в UTF8 (например, ##NLS_CHARACTERSET## должен быть ##AL32UTF8##). Для этого необходимо чтобы OracleXE устанавливалась на версию Windows, где изначально все языковые настройки были сделаны в English. При этом недостаточно, чтобы эти настройки были настроены перед установкой OracleXE - они должны быть изначально такими именно при инсталляции Windows. Попытки настройки "по ходу дела" не дали результата.
55 {{/info}}
Eugen Colesnicov 1.1 56
Eugen Colesnicov 13.1 57
Eugen Colesnicov 6.1 58 ===== **Java Development Kit (JDK)** =====
Eugen Colesnicov 1.1 59 * Запускаем installer
60 * JavaDB можно отключить
61 * дальше все автоматически
62
Eugen Colesnicov 13.1 63
Eugen Colesnicov 6.1 64 ===== **GlassFish application server** =====
Eugen Colesnicov 1.1 65 * запускаем installer
66 * должен найти установленную версию JDK
67 * дополнительный компонент Update Tool выбираем
68 * меняем порт по умолчанию, т.к. он пересекается с портом web-консоли Oracle (8080). Ставим, например - //8008//.
69 * дальше все автоматически
70
71
Eugen Colesnicov 13.1 72 == Installing XWiki Enterprise ==
Eugen Colesnicov 5.18 73 **Оглавление раздела:**
74
75 {{toc start="5" depth="5" scope="local"/}}
76
77 ===== **Установка XWiki в GlassFish** =====
Eugen Colesnicov 1.1 78 * запускаем GlassFish командой ##C:\glassfishv3\bin\asadmin start-domain## (останавливать командой ##stop-domain##).
79 * В браузере набираем http://localhost:4848 и заходим в админ-консоль GlassFIsh (имя и пароль задаются при инсталляции, например, как в XWiki - //Admin/admin//).
80 * Выбираем в дереве слева ##Applications## а в правой части - ##Deploy##.
81 * Открываем с диска war-файл XWiki.
82 * Устанавливаем: ##Type = Web Application, Context Root = xwiki, Application name = xwiki##.
83 * Остальные параметры можно не менять и жмем OK.
84
Eugen Colesnicov 13.1 85 ===== **Настройка соединения с Oracle** =====
Eugen Colesnicov 1.1 86 * создаем схему для XWiki:
87 ** подключаемся к Oracle dba-юзером
88 ** создаем схему ##create user xwiki identified by xwiki;##
89 ** назначаем привелегии ##grant all privileges to xwiki;##
Eugen Colesnicov 13.1 90 {{info}}
91 Можно не назначать полные привилегии, а оставить //по умолчанию//. Полные привилегии могут потребоваться для режима multi-wiki (когда устанавливается XEM) (пока в точности не известно).
92 {{/info}}
Eugen Colesnicov 1.1 93
94 * Копируем файл JDBC-драйвера (##ojdbc5.jar##) в ##\xwiki\WEB-INF\lib## (подпапка в папке приложений GlassFish для домена1).
95
96 * Редактируем файл настроек соединения XWiki с БД ##\xwiki\WEB-INF\hibernate.cfg##:
97 ** Закомментировать строки не относящиеся к Oracle (general database).
98 ** Разкомментировать ту часть, где касается Oracle.
99 ** Указываем параметры коннекта к базе (SID и host).
Eugen Colesnicov 13.1 100 {{info}}
101 Если локально установлен OracleXE можно ничего не менять - а только разкомментировать и закомментировать соответствующие места.
102 {{/info}}
Eugen Colesnicov 1.1 103
104 * Возможно еще следует включить UTF-8 для Oracle (точно не известно насколько это нужно или нет)
105 ** Открываем файл настроек соединения XWiki с БД ##\xwiki\WEB-INF\hibernate.cfg##
106 ** перед строкой ##<mapping resource="xwiki.oracle.hbm.xml"/>## добавляем 2 строки:
Eugen Colesnicov 13.1 107 {{code language="none"}}
108 <property name="connection.useUnicode">true</property>
109 <property name="connection.characterEncoding">UTF-8</property>
110 {{/code}}
Eugen Colesnicov 1.1 111
112 * Перезапускаем GlassFish командами ##stop-domain## и ##start-domain##.
113
Eugen Colesnicov 5.20 114 ===== **Дополнительная настройка GlassFish и запуск как windows-сервис** =====
115 **Дополнительная настройка GlassFish**
Eugen Colesnicov 1.1 116 * Следует добавить дополнительную опцию для JVM ##-Xrs##
Eugen Colesnicov 13.1 117 {{info}}
118 Данная настройка необходима, т.к. в противном случае, GlassFish windows-сервис будет завершаться всегда при logout пользователя на сервере.
119 {{/info}}
Eugen Colesnicov 1.1 120 ** Заходим в админ-консоль GlassFish
121 ** В дереве слева выбираем ##Configuration##, ##JVM Settings##
122 ** На открывшейся страничке выбираем закладку вверху ##JVM Options##
123 ** Откроется страница с параметрами JVM. Нажимаем кнопку вверху списка параметров ##Add JVM Options##
124 ** В добавленном поле пишем -Xrs и нажимаем на ##Save##
125
126 * Еще одна необходимая вещь - настройка UTF-8 в GlassFish
127 ** Также из admin-консоли, в дереве слева выбираем ##Enterprise Server##
128 ** На открывшейся странице выбираем закладку вверху ##Advanced##, a потом подзакладку ##Domain attributes##
129 ** В поле ##Locale## пишем ##en_US.UTF-8##
130
Eugen Colesnicov 5.20 131 **Установка GlassFish как windows-сервиса**
Eugen Colesnicov 1.1 132 * Останавливаем GlassFish командой ##stop-domain##
133
134 * Затем установить GlassFish как windows-сервис командой ##asadmin create-service##.
Eugen Colesnicov 13.1 135 {{info}}
136 Для выполнения этой команды на компьютере должен быть установлен Net Framework v.2.
137 {{/info}}
Eugen Colesnicov 1.1 138
139 * И запустить GlassFish через стандартную оснастку windows - управление сервисами.
Eugen Colesnicov 13.1 140 {{info}}
141 Помимо windows-оснастки, управление сервисом можно осуществлять из командной строки, следующими командами:
Eugen Colesnicov 1.1 142 {{code language="none"}}
143 Start Command: C:\glassfishv3\glassfish\domains\domain1\bin\domain1Service.exe start
144 Stop Command: C:\glassfishv3\glassfish\domains\domain1\bin\domain1Service.exe stop
145 Uninstall Command: C:\glassfishv3\glassfish\domains\domain1\bin\domain1Service.exe uninstall
146 Install Command: C:\glassfishv3\glassfish\domains\domain1\bin\domain1Service.exe install
Eugen Colesnicov 13.1 147 {{/code}}
148 {{/info}}
Eugen Colesnicov 1.1 149
Eugen Colesnicov 13.1 150 * Пробуем открыть xwiki: ##{{{http://localhost:8008/xwiki}}}##. Если все нормально, то откроется начальная страница xwiki.
151 {{info}}
152 - GlassFish в реальности запускается не сразу после старта windows-сервиса - следует подождать еще 2-5 минут.
Eugen Colesnicov 1.1 153 - Если вместо начальной страницы XWiki открылась страница с сообщениями об ошибках - то следует устранить ошибку и обязательно перезапустить GlassFish.
Eugen Colesnicov 13.1 154 - Из типовых проблем можно выделить: а) забыли jdbc-драйвер Oracle; b) неправильно отредактировали файл настроек соединения с БД; c) не так как нужно для XWiki настроены языковые параметры (NLS) Oracle (см. комменты по этому поводу выше).
155 {{/info}}
Eugen Colesnicov 1.1 156
Eugen Colesnicov 5.22 157 ===== **Импорт xar-файла с базовыми страницами XWiki** =====
Eugen Colesnicov 1.1 158 * На открывшейся после установки XWiki Enterprise странице, вверху, выбираем меню ##Wiki##, а затем ##Administration##.
159
160 * Откроется страница Import, с возможностью выбора файла с диска. Выбираем с диска xar-файл от xwiki и нажимаем ##Upload##.
161
162 * Ваш xar-пакет с начальными страницами XWiki появиться в списке ##Available packages##. Кликаем на него.
163
164 * После клика, через некоторое время, в правой части будет открыт список страниц, содержащихся внутри xar-пакета, а внизу него кнопка ##Import##. Жмем на нее.
165
166 * После завершения импорта начального xar-файла следует залогиниться для продолжения работы.
Eugen Colesnicov 13.1 167 {{info}}
168 первоначально логиниться следует под пользователем ##Admin##, а пароль ##admin##.
169 {{/info}}
Eugen Colesnicov 1.1 170
Eugen Colesnicov 5.18 171 ===== **Начальные настройки wiki** =====
Eugen Colesnicov 1.1 172 * Для группы, куда входит юзер Admin (это группа ##XWikiAdminGroup##) следует дать права на programming (в разделе ##Administration##, ##Rights##)
173
174 * Также следует настроить XWiki на работу в MultiLanguage режиме.
175 ** Выберите раздел ##Administration##, ##General##
176 ** На открывшейся странице установите ##true## для опции ##Multilingual##
177 ** В поле languages установите перечень желаемых языков через запятую, например ##en,ru,ro##
178
Eugen Colesnicov 13.1 179 == Installing and tuning OpenOffice.org server ==
Eugen Colesnicov 1.1 180 {{warning}}
181 XWiki поддерживает работу с версиями OpenOffice.org 3.0x, 3.1x, 3.2x. Версия 3.3 на текущий момент не поддерживается.
182 {{/warning}}
183
184 Установка OpenOffice.org и настройка на работу с XWiki возможна 2 способами:
185 * internal - XWiki непосредственно работает с установленной версией OpenOffice.org
186 * external - OpenOffice.org запускается как windows-сервис, а XWiki работает уже с ним
187
Eugen Colesnicov 5.17 188 Каждый из этих способов следует рассматривать отдельно. Нами будет приведен internal-вариант, как более простой.
Eugen Colesnicov 1.1 189
Eugen Colesnicov 5.17 190 ===== **Установка OpenOffice.org и настройка для XWiki в варианте internal** =====
Eugen Colesnicov 1.1 191 * Запускаем инсталлятор, отвечаем на вопросы, путь по умолчанию лучше не менять.
192 * После завершения запускаем Openoffice хотя бы один раз, чтобы выполнился мастер регистрации.
193
194 * Заходим в опции OpenOffice.org, раздел ##Open/Save##, дальше ##HTML Compatibility##
195 * Устанавливаем параметр ##Character set## в ##UTF-8## и сохраняем
196
197 * Открываем файл ##\xwiki\WEB-INF\xwiki.properties##, разкоментируем и меняем в нем следующие переменные:
198 ** переменную ##openoffice.autoStart=true##
199 ** а также ##openoffice.profilePath=C:/Documents and Settings/Administrator/Application Data/OpenOffice.org/3## - это путь куда пишутся настройки для текущего пользователя - именно они и будут использоваться в дальнейшем.
200
201 * Теперь надо перезапустить GlassFish и в XWiki, ##Administration## открыть раздел ##OpenOffice Server##. Если все нормально - в поле ##server state## будет стоять ##Connected##.
202
Eugen Colesnicov 6.1 203
Eugen Colesnicov 13.1 204
205 == Additional XWiki tuning ==
Eugen Colesnicov 5.16 206 **Оглавление раздела:**
Eugen Colesnicov 1.1 207
Eugen Colesnicov 5.16 208 {{toc start="5" depth="5" scope="local"/}}
Eugen Colesnicov 1.1 209
Eugen Colesnicov 5.16 210 ===== **Настройка длинны имен прикрепленных файлов** =====
211 * Если требуется чтобы имена прикрепленных файлов показывались полностью (по умолчанию показывается только 1-ые 25 символов), следует в attachmentsinline.vm в папке templates добавить первую строку ###set($maxnamelength = 256)##
212
213 ===== **Настройка элементов в Print preview** =====
Eugen Colesnicov 1.1 214 * Для того, **чтобы в Print preview показывалось только собственно содержимое страницы** и ничего более следует открыть файл ##print.css## в папке с используемым скином и в раздел ##/* Hide unneeded stuff */##, после строки ###globallinks, #footerglobal,## добавить строку:
215
216 {{code language="none"}}
Eugen Colesnicov 13.1 217 #headerglobal, #hierarchy, #document-title, #document-info, #xdocFooter, #docextrapanes,
Eugen Colesnicov 1.1 218 {{/code}}
219
Eugen Colesnicov 5.16 220 ===== **Настройка иконок в wysiwyg-редакторе** =====
Eugen Colesnicov 1.1 221 * Для того, **чтобы вывести все иконки на тулбар в wysiwyg-редакторе** необходимо:
222 ** открываем ##templates\macros.vm##
223 ** находим строку ##plugins: '$xwiki.getXWikiPreference("wysiwyg.plugins",## - в этой строке указываются те плагины, которые будут подгружаться, но сам вид тулбаров настраивается ниже.
224 ** в найденную строку добавляем через пробелы (место не имеет значения) - ##color font justify## - только этих трех плагинов нету в варианте по умолчанию.
225 ** Теперь в строке ##toolbar: '$xwiki.getXWikiPreference("wysiwyg.toolbar"## добавляем сами иконки. Вот полный вариант:
226
227 {{code language="none"}}
228 bold italic underline strikethrough teletype | subscript superscript | justifyleft justifycenter justifyright justifyfull | unorderedlist orderedlist |
229 outdent indent | undo redo | format | fontname fontsize forecolor backcolor | hr removeformat symbol | paste
230 {{/code}}
231
232 - символ "|" означает строчный разделитель, символ "/" - разбивает тулбар на несколько строк.
233
Eugen Colesnicov 5.16 234 ===== **Настройка сортировки прикрепленных файлов** =====
Eugen Colesnicov 1.1 235 * Для того, **чтобы обеспечить сортировку прикрепленных файлов по дате изменения**, следует в файле attachmentsinline.vm в папке templates после строки ###set($attachments = $doc.attachmentList)## (и соответственно перед ##<div id="attachmentscontent" class="xwikiintracontent">##) добавить:
236
237 {{code language="none"}}
238 #set($attachmentsMap = $util.hashMap)
239 #foreach($a in $attachments)
240 #if(!$attachmentsMap.containsKey($a.date))
241 #set($discard = $attachmentsMap.put($a.date, $util.arrayList))
242 #end
243 #set($discard = $attachmentsMap.get($a.date).add($a))
244 #end
245 #set($dates = $util.arrayList)
246 #foreach($date in $attachmentsMap.keySet())
247 #set($discard = $dates.add($date))
248 #end
249 #set($dates = $util.sort($dates))
250 #set($dates = $util.reverseList($dates))
251 #set($attachments = $util.arrayList)
252 #foreach($date in $dates)
253 #set($discard = $attachments.addAll($attachmentsMap.get($date)))
254 #end
255 {{/code}}
256
Eugen Colesnicov 5.16 257 ===== **Настройка совместимости в IE для форматов MSOffice2007 и OpenOffice.org** =====
Eugen Colesnicov 1.1 258 * **Аттачи-файлы MS Office 2007 и OpenOffice в IE сохраняются как zip-архивы (с расширением zip).** Проблема имеет место только в IE. Решение такое - в файл web.xml, который лежит в папке WEB-INF приложения добавить в соответствующем месте (поискать по ##mime##) содержимое из [[приложенного текстового файла>>attach:MIMETypes4XWiki.txt]]. В XWiki последних версий в файле web.xml уже вставлены MIME-типы под некоторые форматы файлов, но далеко не под все.
259
260 * **Проблемы с импортом xar-файлов, проявляющиеся на версиях XWiki 2.3, 2.4 на Glassfish v.3** (выдается ошибка: //number 0 in 11: Uncaught exception Wrapped Exception: org.apache.commons.codec.binary.Base64)//, связаны с тем, что Glassfish и XWiki имеют разные версии одной и той же библиотеки. Для решения проблемы следует скопировать файл ##commons-codec-1.4.jar## из ##\xwiki\WEB-INF\lib## в папку ##\glassfishv3\glassfish\modules## а оттуда удалить ##commons-codec-repackaged.jar##.
Eugen Colesnicov 13.1 261 {{info}}
262 В версии XWiki 3.0 данной проблемы уже не возникло.
263 {{/info}}
Eugen Colesnicov 1.1 264
Eugen Colesnicov 5.16 265 ===== **Настройка максимального размера прикрепляемых файлов** =====
Eugen Colesnicov 1.1 266 * **Ограничение в 10MB для upload-а**. В XWiki имеется ограничение на upload. Для его регулирования следует:
267 ** edit the XWiki.XWikiPreferences class and add a NumberProperty field of type long, named upload_maxsize; if the field already exists, you can skip this step
268 ** edit the XWiki.XWikiPreferences object and specify the desired maximum attachment size (in bytes)
Eugen Colesnicov 5.2 269
Eugen Colesnicov 11.2 270
Eugen Colesnicov 13.1 271 == Connecting to the external Oracle datasource ==
Eugen Colesnicov 11.2 272
Eugen Colesnicov 5.36 273 {{info}}
274 Сторонняя база данных может использоваться, например, как источник информации, для визуализации на страницах XWiki (при необходимости можно выполнять и update данных).
275 {{/info}}
Eugen Colesnicov 5.16 276
Eugen Colesnicov 5.36 277 ===== Настройка GlassFish =====
278
279 * Необходимо скопировать ojdc-драйвер Oracle (тот же файл, что и при инсталляции XWiki - ##ojdbc5.jar##) в папку ##\glassfishv3\glassfish\domains\domain1\lib\ext##, а затем перезапустить GlassFish.
280
Eugen Colesnicov 13.1 281 * Далее открываем admin-консоль GlassFish (##http://server:4848##) и выбираем в дерева справа ##Resources##, затем ##JDBC##, затем ##Connection Pools## и на открывшейся странице нажимаем ##New##.
Eugen Colesnicov 5.36 282
Eugen Colesnicov 5.38 283 * Будет отрыт интерфейс добавления нового Connection Pool, где: в поле ##Name## вводим ##OraclePool##, в поле ##Resource Type## выбираем ##javax.sql.CoonectionPoolDataSource##, а в поле ##Database Vendor## выбираем ##Oracle## и нажимаем ##Next##.
Eugen Colesnicov 5.36 284
Eugen Colesnicov 5.38 285 * На следующем шаге настройки, следует включить ##Ping## (даст возможность потом протестировать соединение), а в разделе ##Additional Properties## необходимо заполнить следующие параметры: ##user## и ##password## - пишется имя схемы Oracle и пароль к ней, а в поле ##URL## - пишется стринг соединения в формате jdbc (точно также он записывался и в конфигурационном файле, где настраивали базу данных для XWiki). Пример - ##jdbc:oracle:thin:@localhost:1521:XE##. После заполнения этих полей нажимаем ##Finish##.
Eugen Colesnicov 5.36 286
Eugen Colesnicov 5.38 287 * Connection Pool создан и мы можем протестировать соединение. В дереве слева кликаем на ##OraclePool## - и на открывшейся странице кликаем на кнопку ##Ping## - должно появиться сообщение ##Ping Succeeded##.
Eugen Colesnicov 5.36 288
Eugen Colesnicov 5.38 289 * Если тест успешный, то слева в дереве кликаем на ##JDBC Resources## и на открывшейся странице нажимаем ##New##. В поле ##JNDI Name## вводим ##jdbc/ora1##, а в ##Pool Name## выбираем ##OraclePool## и нажимаем ##Ok##. На этом конфигурирование GlassFish закончено.
Eugen Colesnicov 5.36 290
291 ===== Настройка XWiki =====
Eugen Colesnicov 5.38 292 Далее необходимо выполнить настройку XWiki.
Eugen Colesnicov 5.36 293
Eugen Colesnicov 5.38 294 * Необходимо добавить ссылку на созданное соединение в файл ##\xwiki\WEB-INF\web.xml##. Почти в самом конце файла уже есть шаблон блока, который следует разкомментировать и вписать туда имя нашего JDBC-соединения:
Eugen Colesnicov 13.1 295 {{code}}
296 <resource-ref>
Eugen Colesnicov 5.38 297 <description>DB Connection</description>
298 <res-ref-name>jdbc/ora1</res-ref-name>
299 <res-type>javax.sql.DataSource</res-type>
300 <res-auth>Container</res-auth>
Eugen Colesnicov 13.1 301 </resource-ref>
302 {{/code}}
Eugen Colesnicov 5.36 303
Eugen Colesnicov 5.38 304 * Следующим шагом следует добавить специальный плагин, который повышает удобство работы с внешними данными. Домашний сайт - http://xwikisql.gradsoft.ua/docs/XWikiSqlPluginGuide.html. Скачиваем плагин и копируем его в папку ##\xwiki\WEB-INF\lib##.
Eugen Colesnicov 5.36 305
Eugen Colesnicov 5.38 306 * Затем следует в файле ##\xwiki\WEB-INF\xwiki.cfg## найти раздел с перечислением плагинов (по ключевому слову ##xwiki.plugins##) и добавить туда строку ##ua.gradsoft.xwikisql.SqlPlugin##.
Eugen Colesnicov 5.37 307
Eugen Colesnicov 5.38 308 * Для завершения настройки следует перезапустить GlassFish. Подробная информация по использованию плагина для извлечения информации из сторонней базы данных и визуализации на страницах XWiki на сайте плагина - http://xwikisql.gradsoft.ua/docs/XWikiSqlPluginGuide.html. Обращение к источнику данных по имени - ##jdbc/ora1## (так настроили в нашем примере).
Eugen Colesnicov 5.37 309
Eugen Colesnicov 6.1 310
Eugen Colesnicov 13.1 311
312 == Additional applications and macros ==
Eugen Colesnicov 5.36 313 Содержит краткий список дополнительных полезных макросов и приложений, не входящих в основную поставку XWiki Enterprise и используемых автором данного руководства. Источник большинства из них - http://extensions.xwiki.org. Устанавливать их необходимо после установки и настройки XWiki Enterprise.
Eugen Colesnicov 5.34 314
Eugen Colesnicov 5.16 315 **Оглавление раздела:**
Eugen Colesnicov 5.10 316
Eugen Colesnicov 5.13 317 {{toc start="5" depth="5" scope="local"/}}
Eugen Colesnicov 5.10 318
Eugen Colesnicov 5.2 319 {{info}}
Eugen Colesnicov 5.34 320 Обычно макросы и приложения для платформы XWiki реализуются в виде xar-файлов, которые следует импортировать в XWiki стандартным образом, через раздел ##Administration##, а потом ##Import## - для таких доп. компонентов специального описания процесса установки приводиться не будет. Также, некоторые из добавок имеют доп. компоненты или же им требуется доп. настройка - в этом случае в описании также будут приведены краткие инструкции по установке.
Eugen Colesnicov 5.2 321 {{/info}}
322
Eugen Colesnicov 5.13 323 ===== **Admin Tools** - содержит список различных добавок для администраторов: статистика, экспорт и пр. =====
Eugen Colesnicov 5.2 324 * http://extensions.xwiki.org/xwiki/bin/view/Extension/AdminTools
325 * Установка - стандартно
326 * Домашняя страница ##Admin.Tools##
327 * Ставиться в раздел Admin, для которого отсутствует WebHome. Имеет смысл создать WebHome и вынести на него другие полезные функции, связанные с администрированием (удаление разделов, копирование разделов и пр.)
328
Eugen Colesnicov 5.15 329 ===== **LDAP Tools** - содержит утилиты для работы с LDAP: а) настройка взаимодействия, job для синхронизации =====
Eugen Colesnicov 5.2 330 * http://extensions.xwiki.org/xwiki/bin/view/Extension/LDAP+Tools
331 * Установка стандартно, но после установки обязательно открыть ##XWiki.AdminLdapSyncSheet## или ##XWiki.AdminLdapSheet## (не помню точно) для того чтобы в ##Administration## добавился соответствующий раздел
332 * Управлять - через ##Administration##, где после установки будет специальный раздел ##LDAP-tools##
333
Eugen Colesnicov 5.15 334 ===== **PlantUML Macro** - макрос для построения UML-диаграмм. =====
Eugen Colesnicov 5.2 335 * http://extensions.xwiki.org/xwiki/bin/view/Extension/PlantUML+Macro
336
337 * Установка:
338 ** Качаем **Grapviz** отсуда http://www.graphviz.org/Download_windows.php и устанавливаем на сервере (нужно для некоторых типов диаграмм)
339 ** Добавляем в переменные окружения Windows переменную ##GRAPHVIZ_DOT## со значением ##C:\Program Files\Graphviz2.26.3\bin\dot.exe## (путь к файлу dot.exe)
Eugen Colesnicov 5.7 340 ** Также пришлось перезагрузить сервер (возможно - будет достаточно перезапустить GlassFish) а то в дальнейшем эта переменная окружения была не видна.
Eugen Colesnicov 5.2 341 ** Дальше стандартно устанавливаем xar-файл.
Eugen Colesnicov 5.3 342 ** на странице Macros.plantUMLMacro можно убедиться хорошо ли все поставилось.
Eugen Colesnicov 5.2 343
344 * Использование PlantUML:
Eugen Colesnicov 13.1 345 {{code}}
346 {{plantuml}}
Eugen Colesnicov 5.2 347 content here...
Eugen Colesnicov 13.1 348 {{/plantuml}}
349 {{/code}}
Eugen Colesnicov 5.5 350 Полное описание plantUML языка смотрите на http://plantuml.sourceforge.net/, а в разделе ##Downloads## есть даже [[pdf-вариант>>http://freefr.dl.sourceforge.net/project/plantuml/PlantUML%20Language%20Reference%20Guide.pdf]]
Eugen Colesnicov 5.4 351
Eugen Colesnicov 5.6 352 * Кстати, есть даже вариант PlantUML для MS Word! (в виде word-макроса).
353 * Еще кстати, есть другой макрос для рисования UML-диаграмм в XWiki, [[UML Macro>>http://extensions.xwiki.org/xwiki/bin/view/Extension/YUML+Macro]], однако он имеет ряд недостатков: а) работает только при наличии online-соединения с сайтом http://www.yuml.me/ b) варианты диаграмм ограничены (только самые основные)
Eugen Colesnicov 5.23 354
355 ===== **Tabs Macro** - макрос для визуализации на странице табов =====
356 * http://extensions.xwiki.org/xwiki/bin/view/Extension/Tabs+Macro
357 * Установка - стандартно
358 * Добавляет раздел ##Macro##, а в нем домашнюю страничку ##Macro.TabsMacro## - где описан синтаксис
359
360 * Использование:
Eugen Colesnicov 13.1 361 {{code}}
362 {{tabs idsToLabels='tabId11=My xwiki-wide tabs, tabId12=My working tabs :)' /}}
Eugen Colesnicov 5.23 363 (%id="tabId11"%)((({{box cssClass="tabId11div"}}
364 First tab!
365 {{/box}}
366 I can post any content here
367 )))
368
369 (%id="tabId12"%)((({{box cssClass="tabId12div"}}
370 Second tab!
371 {{/box}}
372 And here too
Eugen Colesnicov 13.1 373 )))
374 {{/code}}
Eugen Colesnicov 5.24 375
Eugen Colesnicov 13.1 376
Eugen Colesnicov 6.1 377 ===== **LiveTable Macro** - макрос для удобного построения таблиц по технологии LiveTable =====
Eugen Colesnicov 5.24 378 * http://extensions.xwiki.org/xwiki/bin/view/Extension/Livetable+Macro+2.0
379 * Установка - стандартно
380 * Домашняя страничка ##Macros.LiveTable## - где описан синтаксис
381
382 * Использование:
Eugen Colesnicov 13.1 383 {{code}}
384 {{livetable classname="XWiki.XWikiUsers" fields="first_name,last_name,doc.name,address" tags="false"
385 selectedColumn="first_name" defaultOrder="desc" rowCount="11" maxPages="9" resultPage="" /}}
386 {{/code}}
Eugen Colesnicov 5.24 387
388 * В составе макроса также имеется страничка ##Macros.LiveTableScriptGenerator## - которая позволяет сгенерировать полный скрипт построения LiveTable - что удобно для использования в собственных разработках
389
Eugen Colesnicov 13.1 390
Eugen Colesnicov 6.1 391 ===== **Calc Macro** - макрос для простых подсчетов в таблицах XWiki =====
Eugen Colesnicov 5.25 392 * http://extensions.xwiki.org/xwiki/bin/view/Extension/Calc+Macro
393 * Установка - стандартно
Eugen Colesnicov 5.26 394 * фактически состоит из 3-х макросов: ##calc## macro, ##sum## macro, ##summary## macro. Синтаксис каждого из макросов - на соответствующей странице в разделе ##Macros##.
Eugen Colesnicov 5.24 395
Eugen Colesnicov 5.28 396 ===== **Todo Macro** - макрос для добавления прямо на страницы списков дел =====
397 * http://extensions.xwiki.org/xwiki/bin/view/Extension/Todo+Macro
398 * Установка - стандартно, после - посетить страницу - ##XWiki.TodoMacroInstall## для завершения инсталляции.
399 * Примеры использования - ##Todo.WebHome##.
Eugen Colesnicov 5.27 400
Eugen Colesnicov 13.1 401
Eugen Colesnicov 6.1 402 ===== **Spoiler Macro** - макрос для добавления на страницу скрытых элементов =====
Eugen Colesnicov 5.28 403 * http://extensions.xwiki.org/xwiki/bin/view/Extension/Spoiler+Macro
404 * Установка - стандартно.
Eugen Colesnicov 5.29 405 * Домашняя страница ##Macros.Spolier##
Eugen Colesnicov 5.28 406 * Использование:
Eugen Colesnicov 13.1 407 {{code}}
408 {{spoiler title="Show me the truth"}}
Eugen Colesnicov 5.28 409 I am your father
Eugen Colesnicov 13.1 410 {{/spoiler}}
411 {{/code}}
Eugen Colesnicov 5.28 412
Eugen Colesnicov 13.1 413
Eugen Colesnicov 6.1 414 ===== **Lightbox Macro** - макрос создает презентацию из картинок =====
Eugen Colesnicov 5.30 415 * http://extensions.xwiki.org/xwiki/bin/view/Extension/Lightbox+Macro
416 * Установка - стандартно.
417 * Домашняя страница ##XWiki.LightboxMacro##
418 * Использование:
Eugen Colesnicov 13.1 419 {{code}}
420 {{lightbox image="cat.jpg" group="g0" /}}
421 {{lightbox image="cat2.jpg" group="g0" /}}
422 {{/code}}
Eugen Colesnicov 5.30 423
Eugen Colesnicov 13.1 424
Eugen Colesnicov 6.1 425 ===== **MBox, MCode, MNote Macros** - макросы создающие специальные box-ы с красивым видом =====
Eugen Colesnicov 5.32 426 * http://asiri.rathnayake.org/xwiki/
427 * Установка - стандартно.
428 * Домашние страницы ##Macro.MBox##, ##Macro.MNote##, ##Macro.MCode##
429 * Использование MBox:
Eugen Colesnicov 13.1 430 {{code}}
431 {{mbox title="A Title" subTitle="An Optional **Sub-Title**"}}
Eugen Colesnicov 5.32 432 Any **xwiki** content.
Eugen Colesnicov 13.1 433 {{/mbox}}
434 {{/code}}
Eugen Colesnicov 5.32 435
Eugen Colesnicov 13.1 436
Eugen Colesnicov 6.1 437 ===== **Copy Space Snippet** - данный код позволяет скопировать Раздел в другой Раздел =====
Eugen Colesnicov 5.27 438 * http://extensions.xwiki.org/xwiki/bin/view/Extension/Copy+Space+Snippet
439 * для использования - скопируйте представленный код на любую страницу
440
Eugen Colesnicov 13.1 441
Eugen Colesnicov 6.1 442 ===== **Delete Space Snippet** - данный код позволяет выполнить удаление разделов =====
Eugen Colesnicov 5.27 443 * http://extensions.xwiki.org/xwiki/bin/view/Extension/Delete+Space
444 * для использования - скопируйте представленный код на любую страницу
445
Eugen Colesnicov 13.1 446
Eugen Colesnicov 6.1 447 ===== **SpaceExplorer Panel Application** - добавляет панельку, с деревом разделов и страниц в них =====
Eugen Colesnicov 5.28 448 * http://extensions.xwiki.org/xwiki/bin/view/Extension/Space+Explorer+Panel+Application
449 * Установка - стандартно, а для вывода панели на экран - используйте ##Panel Wizard## в ##Administration##
Eugen Colesnicov 13.1 450