Codul sursă wiki pentru Установка и настройка XWiki - Windows+Oracle+Glassfish
Modificat de Eugen Colesnicov la 2011/02/26 18:21
Afișează ultimii autori
author | version | line-number | content |
---|---|---|---|
1 | {{box cssClass="floatinginfobox" title="**Содержание**"}} | ||
2 | {{warning}}Translation to Romanian not finished yet!{{/warning}} | ||
3 | |||
4 | {{toc start="2" depth="2"/}} | ||
5 | |||
6 | {{/box}} | ||
7 | |||
8 | == Вступление == | ||
9 | Данная инструкция содержит последовательное описание процесса первоначальной установки и оптимальной настройки XWiki Enterprise в варианте под Windows + GlassFish + OracleXE. | ||
10 | |||
11 | Исходным материалом послужили инструкции по инсталляции с сайта xwiki.org. Однако они являются более абстрактными и часто не учитывают специфики настроек под русские условия. Именно это и послужило стимулом к написанию данной инструкции. | ||
12 | |||
13 | Инструкция делалась "под себя" - для обеспечения простой возможности повторить быстрое развертывание системы (в т.ч. другими администраторами). Инструкция составлена не по принципу "если - то" (как например, составлены инструкции по инсталляции на xwiki.org), а более жестко - "делать так" - поэтому многие вещи указываются без подробных объяснений, почему именно так. | ||
14 | |||
15 | Имеется [[старая версия данной инструкции>>UNA.XWikiInstalationJetty&Glassfish]], которая начинала писаться еще когда XWiki была версией 2.0 или 2.1 и под Jetty, потом туда добавился GlassFish. Но все равно там осталось много не используемого сейчас. Новый вариант инструкции писался под версию XWiki - 2.7, 3.0. | ||
16 | |||
17 | Из нового варианта инструкции убрано много лишнего, в 1-ую очередь - все что касается Jetty. Изначально я пытался развертывать XWiki в варианте Windows + Jetty + OracleXE, но потом понял, что Jetty не годится для рабочей эксплуатации. Из принципиальных минусов - зависания сервиса и медленная скорость работы с аттачами. | ||
18 | |||
19 | Потом стал искать что-то вместо Jetty - и остановился на GlassFish. Понравилось - web-интерфейс настройки, то что не надо так сильно тюннить его как Jetty, ну и конечно скорость - файлы аттачились почти со скоростью, как если бы они копировались в локалке (jetty раз в 10 хуже)! | ||
20 | |||
21 | Новый вариант инструкции пока не полный. Еще будут добавляться разделы касаемо настройки LDAP, настройки соединения со сторонней базой Oracle и пр. Также планируется перевод на английский и румынский языки. | ||
22 | |||
23 | == ПО, необходимое для загрузки == | ||
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]]**. | ||
40 | {{info}} | ||
41 | Следует закачивать т.н. //Universal//-версию OracleXE для обеспечения поддержки UTF-8 (мультиязычности) на уровне БД. | ||
42 | {{/info}} | ||
43 | |||
44 | |||
45 | |||
46 | == Установка базового набора приложений == | ||
47 | **Оглавление раздела:** | ||
48 | |||
49 | {{toc start="5" depth="5" scope="local"/}} | ||
50 | |||
51 | ===== **OracleXE** (если будем использовать локальную БД). ===== | ||
52 | * просто инсталлируем через Setup. | ||
53 | {{info}} | ||
54 | В OracleXE, при инсталляции, отсутствуют возможности настройки языковых параметров БД. А для XWiki, для обеспечения мультиязычности, нужно чтобы они были настроены в UTF8 (например, ##NLS_CHARACTERSET## должен быть ##AL32UTF8##). Для этого необходимо чтобы OracleXE устанавливалась на версию Windows, где изначально все языковые настройки были сделаны в English. При этом недостаточно, чтобы эти настройки были настроены перед установкой OracleXE - они должны быть изначально такими именно при инсталляции Windows. Попытки настройки "по ходу дела" не дали результата. | ||
55 | {{/info}} | ||
56 | |||
57 | |||
58 | ===== **Java Development Kit (JDK)** ===== | ||
59 | * Запускаем installer | ||
60 | * JavaDB можно отключить | ||
61 | * дальше все автоматически | ||
62 | |||
63 | |||
64 | ===== **GlassFish application server** ===== | ||
65 | * запускаем installer | ||
66 | * должен найти установленную версию JDK | ||
67 | * дополнительный компонент Update Tool выбираем | ||
68 | * меняем порт по умолчанию, т.к. он пересекается с портом web-консоли Oracle (8080). Ставим, например - //8008//. | ||
69 | * дальше все автоматически | ||
70 | |||
71 | |||
72 | == Установка XWiki Enterprise == | ||
73 | **Оглавление раздела:** | ||
74 | |||
75 | {{toc start="5" depth="5" scope="local"/}} | ||
76 | |||
77 | ===== **Установка XWiki в GlassFish** ===== | ||
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 | |||
85 | ===== **Настройка соединения с Oracle** ===== | ||
86 | * создаем схему для XWiki: | ||
87 | ** подключаемся к Oracle dba-юзером | ||
88 | ** создаем схему ##create user xwiki identified by xwiki;## | ||
89 | ** назначаем привелегии ##grant all privileges to xwiki;## | ||
90 | {{info}} | ||
91 | Можно не назначать полные привилегии, а оставить //по умолчанию//. Полные привилегии могут потребоваться для режима multi-wiki (когда устанавливается XEM) (пока в точности не известно). | ||
92 | {{/info}} | ||
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). | ||
100 | {{info}} | ||
101 | Если локально установлен OracleXE можно ничего не менять - а только разкомментировать и закомментировать соответствующие места. | ||
102 | {{/info}} | ||
103 | |||
104 | * Возможно еще следует включить UTF-8 для Oracle (точно не известно насколько это нужно или нет) | ||
105 | ** Открываем файл настроек соединения XWiki с БД ##\xwiki\WEB-INF\hibernate.cfg## | ||
106 | ** перед строкой ##<mapping resource="xwiki.oracle.hbm.xml"/>## добавляем 2 строки: | ||
107 | {{code language="none"}} | ||
108 | <property name="connection.useUnicode">true</property> | ||
109 | <property name="connection.characterEncoding">UTF-8</property> | ||
110 | {{/code}} | ||
111 | |||
112 | * Перезапускаем GlassFish командами ##stop-domain## и ##start-domain##. | ||
113 | |||
114 | ===== **Дополнительная настройка GlassFish и запуск как windows-сервис** ===== | ||
115 | **Дополнительная настройка GlassFish** | ||
116 | * Следует добавить дополнительную опцию для JVM ##-Xrs## | ||
117 | {{info}} | ||
118 | Данная настройка необходима, т.к. в противном случае, GlassFish windows-сервис будет завершаться всегда при logout пользователя на сервере. | ||
119 | {{/info}} | ||
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 | |||
131 | **Установка GlassFish как windows-сервиса** | ||
132 | * Останавливаем GlassFish командой ##stop-domain## | ||
133 | |||
134 | * Затем установить GlassFish как windows-сервис командой ##asadmin create-service##. | ||
135 | {{info}} | ||
136 | Для выполнения этой команды на компьютере должен быть установлен Net Framework v.2. | ||
137 | {{/info}} | ||
138 | |||
139 | * И запустить GlassFish через стандартную оснастку windows - управление сервисами. | ||
140 | {{info}} | ||
141 | Помимо windows-оснастки, управление сервисом можно осуществлять из командной строки, следующими командами: | ||
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 | ||
147 | {{/code}} | ||
148 | {{/info}} | ||
149 | |||
150 | * Пробуем открыть xwiki: ##{{{http://localhost:8008/xwiki}}}##. Если все нормально, то откроется начальная страница xwiki. | ||
151 | {{info}} | ||
152 | - GlassFish в реальности запускается не сразу после старта windows-сервиса - следует подождать еще 2-5 минут. | ||
153 | - Если вместо начальной страницы XWiki открылась страница с сообщениями об ошибках - то следует устранить ошибку и обязательно перезапустить GlassFish. | ||
154 | - Из типовых проблем можно выделить: а) забыли jdbc-драйвер Oracle; b) неправильно отредактировали файл настроек соединения с БД; c) не так как нужно для XWiki настроены языковые параметры (NLS) Oracle (см. комменты по этому поводу выше). | ||
155 | {{/info}} | ||
156 | |||
157 | ===== **Импорт xar-файла с базовыми страницами XWiki** ===== | ||
158 | * На открывшейся после установки XWiki Enterprise странице, вверху, выбираем меню ##Wiki##, а затем ##Administration##. | ||
159 | |||
160 | * Откроется страница Import, с возможностью выбора файла с диска. Выбираем с диска xar-файл от xwiki и нажимаем ##Upload##. | ||
161 | |||
162 | * Ваш xar-пакет с начальными страницами XWiki появиться в списке ##Available packages##. Кликаем на него. | ||
163 | |||
164 | * После клика, через некоторое время, в правой части будет открыт список страниц, содержащихся внутри xar-пакета, а внизу него кнопка ##Import##. Жмем на нее. | ||
165 | |||
166 | * После завершения импорта начального xar-файла следует залогиниться для продолжения работы. | ||
167 | {{info}} | ||
168 | первоначально логиниться следует под пользователем ##Admin##, а пароль ##admin##. | ||
169 | {{/info}} | ||
170 | |||
171 | ===== **Начальные настройки wiki** ===== | ||
172 | * Для группы, куда входит юзер Admin (это группа ##XWikiAdminGroup##) следует дать права на programming (в разделе ##Administration##, ##Rights##) | ||
173 | |||
174 | * Также следует настроить XWiki на работу в MultiLanguage режиме. | ||
175 | ** Выберите раздел ##Administration##, ##General## | ||
176 | ** На открывшейся странице установите ##true## для опции ##Multilingual## | ||
177 | ** В поле languages установите перечень желаемых языков через запятую, например ##en,ru,ro## | ||
178 | |||
179 | == Установка и настройка сервера OpenOffice.org == | ||
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 | |||
188 | Каждый из этих способов следует рассматривать отдельно. Нами будет приведен internal-вариант, как более простой. | ||
189 | |||
190 | ===== **Установка OpenOffice.org и настройка для XWiki в варианте internal** ===== | ||
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 | |||
203 | == Дополнительный тюннинг XWiki == | ||
204 | **Оглавление раздела:** | ||
205 | |||
206 | {{toc start="5" depth="5" scope="local"/}} | ||
207 | |||
208 | ===== **Настройка длинны имен прикрепленных файлов** ===== | ||
209 | * Если требуется чтобы имена прикрепленных файлов показывались полностью (по умолчанию показывается только 1-ые 25 символов), следует в attachmentsinline.vm в папке templates добавить первую строку ###set($maxnamelength = 256)## | ||
210 | |||
211 | ===== **Настройка элементов в Print preview** ===== | ||
212 | * Для того, **чтобы в Print preview показывалось только собственно содержимое страницы** и ничего более следует открыть файл ##print.css## в папке с используемым скином и в раздел ##/* Hide unneeded stuff */##, после строки ###globallinks, #footerglobal,## добавить строку: | ||
213 | |||
214 | {{code language="none"}} | ||
215 | #headerglobal, #hierarchy, #document-title, #document-info, #xdocFooter, #docextrapanes, | ||
216 | {{/code}} | ||
217 | |||
218 | ===== **Настройка иконок в wysiwyg-редакторе** ===== | ||
219 | * Для того, **чтобы вывести все иконки на тулбар в wysiwyg-редакторе** необходимо: | ||
220 | ** открываем ##templates\macros.vm## | ||
221 | ** находим строку ##plugins: '$xwiki.getXWikiPreference("wysiwyg.plugins",## - в этой строке указываются те плагины, которые будут подгружаться, но сам вид тулбаров настраивается ниже. | ||
222 | ** в найденную строку добавляем через пробелы (место не имеет значения) - ##color font justify## - только этих трех плагинов нету в варианте по умолчанию. | ||
223 | ** Теперь в строке ##toolbar: '$xwiki.getXWikiPreference("wysiwyg.toolbar"## добавляем сами иконки. Вот полный вариант: | ||
224 | |||
225 | {{code language="none"}} | ||
226 | bold italic underline strikethrough teletype | subscript superscript | justifyleft justifycenter justifyright justifyfull | unorderedlist orderedlist | | ||
227 | outdent indent | undo redo | format | fontname fontsize forecolor backcolor | hr removeformat symbol | paste | ||
228 | {{/code}} | ||
229 | |||
230 | - символ "|" означает строчный разделитель, символ "/" - разбивает тулбар на несколько строк. | ||
231 | |||
232 | ===== **Настройка сортировки прикрепленных файлов** ===== | ||
233 | * Для того, **чтобы обеспечить сортировку прикрепленных файлов по дате изменения**, следует в файле attachmentsinline.vm в папке templates после строки ###set($attachments = $doc.attachmentList)## (и соответственно перед ##<div id="attachmentscontent" class="xwikiintracontent">##) добавить: | ||
234 | |||
235 | {{code language="none"}} | ||
236 | #set($attachmentsMap = $util.hashMap) | ||
237 | #foreach($a in $attachments) | ||
238 | #if(!$attachmentsMap.containsKey($a.date)) | ||
239 | #set($discard = $attachmentsMap.put($a.date, $util.arrayList)) | ||
240 | #end | ||
241 | #set($discard = $attachmentsMap.get($a.date).add($a)) | ||
242 | #end | ||
243 | #set($dates = $util.arrayList) | ||
244 | #foreach($date in $attachmentsMap.keySet()) | ||
245 | #set($discard = $dates.add($date)) | ||
246 | #end | ||
247 | #set($dates = $util.sort($dates)) | ||
248 | #set($dates = $util.reverseList($dates)) | ||
249 | #set($attachments = $util.arrayList) | ||
250 | #foreach($date in $dates) | ||
251 | #set($discard = $attachments.addAll($attachmentsMap.get($date))) | ||
252 | #end | ||
253 | {{/code}} | ||
254 | |||
255 | ===== **Настройка совместимости в IE для форматов MSOffice2007 и OpenOffice.org** ===== | ||
256 | * **Аттачи-файлы MS Office 2007 и OpenOffice в IE сохраняются как zip-архивы (с расширением zip).** Проблема имеет место только в IE. Решение такое - в файл web.xml, который лежит в папке WEB-INF приложения добавить в соответствующем месте (поискать по ##mime##) содержимое из [[приложенного текстового файла>>attach:MIMETypes4XWiki.txt]]. В XWiki последних версий в файле web.xml уже вставлены MIME-типы под некоторые форматы файлов, но далеко не под все. | ||
257 | |||
258 | * **Проблемы с импортом 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##. | ||
259 | {{info}} | ||
260 | В версии XWiki 3.0 данной проблемы уже не возникло. | ||
261 | {{/info}} | ||
262 | |||
263 | ===== **Настройка максимального размера прикрепляемых файлов** ===== | ||
264 | * **Ограничение в 10MB для upload-а**. В XWiki имеется ограничение на upload. Для его регулирования следует: | ||
265 | ** 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 | ||
266 | ** edit the XWiki.XWikiPreferences object and specify the desired maximum attachment size (in bytes) | ||
267 | |||
268 | |||
269 | == Настройка соединения со сторонней базой Oracle == | ||
270 | {{info}} | ||
271 | Сторонняя база данных может использоваться, например, как источник информации, для визуализации на страницах XWiki (при необходимости можно выполнять и update данных). | ||
272 | {{/info}} | ||
273 | |||
274 | ===== Настройка GlassFish ===== | ||
275 | |||
276 | * Необходимо скопировать ojdc-драйвер Oracle (тот же файл, что и при инсталляции XWiki - ##ojdbc5.jar##) в папку ##\glassfishv3\glassfish\domains\domain1\lib\ext##, а затем перезапустить GlassFish. | ||
277 | |||
278 | * Далее открываем admin-консоль GlassFish (##http://server:4848##) и выбираем в дерева справа ##Resources##, затем ##JDBC##, затем ##Connection Pools## и на открывшейся странице нажимаем ##New##. | ||
279 | |||
280 | * Будет отрыт интерфейс добавления нового Connection Pool, где: в поле ##Name## вводим ##OraclePool##, в поле ##Resource Type## выбираем ##javax.sql.CoonectionPoolDataSource##, а в поле ##Database Vendor## выбираем ##Oracle## и нажимаем ##Next##. | ||
281 | |||
282 | * На следующем шаге настройки, следует включить ##Ping## (даст возможность потом протестировать соединение), а в разделе ##Additional Properties## необходимо заполнить следующие параметры: ##user## и ##password## - пишется имя схемы Oracle и пароль к ней, а в поле ##URL## - пишется стринг соединения в формате jdbc (точно также он записывался и в конфигурационном файле, где настраивали базу данных для XWiki). Пример - ##jdbc:oracle:thin:@localhost:1521:XE##. После заполнения этих полей нажимаем ##Finish##. | ||
283 | |||
284 | * Connection Pool создан и мы можем протестировать соединение. В дереве слева кликаем на ##OraclePool## - и на открывшейся странице кликаем на кнопку ##Ping## - должно появиться сообщение ##Ping Succeeded##. | ||
285 | |||
286 | * Если тест успешный, то слева в дереве кликаем на ##JDBC Resources## и на открывшейся странице нажимаем ##New##. В поле ##JNDI Name## вводим ##jdbc/ora1##, а в ##Pool Name## выбираем ##OraclePool## и нажимаем ##Ok##. На этом конфигурирование GlassFish закончено. | ||
287 | |||
288 | ===== Настройка XWiki ===== | ||
289 | Далее необходимо выполнить настройку XWiki. | ||
290 | |||
291 | * Необходимо добавить ссылку на созданное соединение в файл ##\xwiki\WEB-INF\web.xml##. Почти в самом конце файла уже есть шаблон блока, который следует разкомментировать и вписать туда имя нашего JDBC-соединения: | ||
292 | {{code}} | ||
293 | <resource-ref> | ||
294 | <description>DB Connection</description> | ||
295 | <res-ref-name>jdbc/ora1</res-ref-name> | ||
296 | <res-type>javax.sql.DataSource</res-type> | ||
297 | <res-auth>Container</res-auth> | ||
298 | </resource-ref> | ||
299 | {{/code}} | ||
300 | |||
301 | * Следующим шагом следует добавить специальный плагин, который повышает удобство работы с внешними данными. Домашний сайт - http://xwikisql.gradsoft.ua/docs/XWikiSqlPluginGuide.html. Скачиваем плагин и копируем его в папку ##\xwiki\WEB-INF\lib##. | ||
302 | |||
303 | * Затем следует в файле ##\xwiki\WEB-INF\xwiki.cfg## найти раздел с перечислением плагинов (по ключевому слову ##xwiki.plugins##) и добавить туда строку ##ua.gradsoft.xwikisql.SqlPlugin##. | ||
304 | |||
305 | * Для завершения настройки следует перезапустить GlassFish. Подробная информация по использованию плагина для извлечения информации из сторонней базы данных и визуализации на страницах XWiki на сайте плагина - http://xwikisql.gradsoft.ua/docs/XWikiSqlPluginGuide.html. Обращение к источнику данных по имени - ##jdbc/ora1## (так настроили в нашем примере). | ||
306 | |||
307 | == Дополнительные макросы и приложения == | ||
308 | Содержит краткий список дополнительных полезных макросов и приложений, не входящих в основную поставку XWiki Enterprise и используемых автором данного руководства. Источник большинства из них - http://extensions.xwiki.org. Устанавливать их необходимо после установки и настройки XWiki Enterprise. | ||
309 | |||
310 | **Оглавление раздела:** | ||
311 | |||
312 | {{toc start="5" depth="5" scope="local"/}} | ||
313 | |||
314 | {{info}} | ||
315 | Обычно макросы и приложения для платформы XWiki реализуются в виде xar-файлов, которые следует импортировать в XWiki стандартным образом, через раздел ##Administration##, а потом ##Import## - для таких доп. компонентов специального описания процесса установки приводиться не будет. Также, некоторые из добавок имеют доп. компоненты или же им требуется доп. настройка - в этом случае в описании также будут приведены краткие инструкции по установке. | ||
316 | {{/info}} | ||
317 | |||
318 | ===== **Admin Tools** - содержит список различных добавок для администраторов: статистика, экспорт и пр. ===== | ||
319 | * http://extensions.xwiki.org/xwiki/bin/view/Extension/AdminTools | ||
320 | * Установка - стандартно | ||
321 | * Домашняя страница ##Admin.Tools## | ||
322 | * Ставиться в раздел Admin, для которого отсутствует WebHome. Имеет смысл создать WebHome и вынести на него другие полезные функции, связанные с администрированием (удаление разделов, копирование разделов и пр.) | ||
323 | |||
324 | ===== **LDAP Tools** - содержит утилиты для работы с LDAP: а) настройка взаимодействия, job для синхронизации ===== | ||
325 | * http://extensions.xwiki.org/xwiki/bin/view/Extension/LDAP+Tools | ||
326 | * Установка стандартно, но после установки обязательно открыть ##XWiki.AdminLdapSyncSheet## или ##XWiki.AdminLdapSheet## (не помню точно) для того чтобы в ##Administration## добавился соответствующий раздел | ||
327 | * Управлять - через ##Administration##, где после установки будет специальный раздел ##LDAP-tools## | ||
328 | |||
329 | ===== **PlantUML Macro** - макрос для построения UML-диаграмм. ===== | ||
330 | * http://extensions.xwiki.org/xwiki/bin/view/Extension/PlantUML+Macro | ||
331 | |||
332 | * Установка: | ||
333 | ** Качаем **Grapviz** отсуда http://www.graphviz.org/Download_windows.php и устанавливаем на сервере (нужно для некоторых типов диаграмм) | ||
334 | ** Добавляем в переменные окружения Windows переменную ##GRAPHVIZ_DOT## со значением ##C:\Program Files\Graphviz2.26.3\bin\dot.exe## (путь к файлу dot.exe) | ||
335 | ** Также пришлось перезагрузить сервер (возможно - будет достаточно перезапустить GlassFish) а то в дальнейшем эта переменная окружения была не видна. | ||
336 | ** Дальше стандартно устанавливаем xar-файл. | ||
337 | ** на странице Macros.plantUMLMacro можно убедиться хорошо ли все поставилось. | ||
338 | |||
339 | * Использование PlantUML: | ||
340 | {{code}} | ||
341 | {{plantuml}} | ||
342 | content here... | ||
343 | {{/plantuml}} | ||
344 | {{/code}} | ||
345 | Полное описание plantUML языка смотрите на http://plantuml.sourceforge.net/, а в разделе ##Downloads## есть даже [[pdf-вариант>>http://freefr.dl.sourceforge.net/project/plantuml/PlantUML%20Language%20Reference%20Guide.pdf]] | ||
346 | |||
347 | * Кстати, есть даже вариант PlantUML для MS Word! (в виде word-макроса). | ||
348 | * Еще кстати, есть другой макрос для рисования UML-диаграмм в XWiki, [[UML Macro>>http://extensions.xwiki.org/xwiki/bin/view/Extension/YUML+Macro]], однако он имеет ряд недостатков: а) работает только при наличии online-соединения с сайтом http://www.yuml.me/ b) варианты диаграмм ограничены (только самые основные) | ||
349 | |||
350 | ===== **Tabs Macro** - макрос для визуализации на странице табов ===== | ||
351 | * http://extensions.xwiki.org/xwiki/bin/view/Extension/Tabs+Macro | ||
352 | * Установка - стандартно | ||
353 | * Добавляет раздел ##Macro##, а в нем домашнюю страничку ##Macro.TabsMacro## - где описан синтаксис | ||
354 | |||
355 | * Использование: | ||
356 | {{code}} | ||
357 | {{tabs idsToLabels='tabId11=My xwiki-wide tabs, tabId12=My working tabs :)' /}} | ||
358 | (%id="tabId11"%)((({{box cssClass="tabId11div"}} | ||
359 | First tab! | ||
360 | {{/box}} | ||
361 | I can post any content here | ||
362 | ))) | ||
363 | |||
364 | (%id="tabId12"%)((({{box cssClass="tabId12div"}} | ||
365 | Second tab! | ||
366 | {{/box}} | ||
367 | And here too | ||
368 | ))) | ||
369 | {{/code}} | ||
370 | |||
371 | |||
372 | ===== **LiveTable Macro** - макрос для удобного построения таблиц по технологии LiveTable ===== | ||
373 | * http://extensions.xwiki.org/xwiki/bin/view/Extension/Livetable+Macro+2.0 | ||
374 | * Установка - стандартно | ||
375 | * Домашняя страничка ##Macros.LiveTable## - где описан синтаксис | ||
376 | |||
377 | * Использование: | ||
378 | {{code}} | ||
379 | {{livetable classname="XWiki.XWikiUsers" fields="first_name,last_name,doc.name,address" tags="false" | ||
380 | selectedColumn="first_name" defaultOrder="desc" rowCount="11" maxPages="9" resultPage="" /}} | ||
381 | {{/code}} | ||
382 | |||
383 | * В составе макроса также имеется страничка ##Macros.LiveTableScriptGenerator## - которая позволяет сгенерировать полный скрипт построения LiveTable - что удобно для использования в собственных разработках | ||
384 | |||
385 | |||
386 | ===== **Calc Macro** - макрос для простых подсчетов в таблицах XWiki ===== | ||
387 | * http://extensions.xwiki.org/xwiki/bin/view/Extension/Calc+Macro | ||
388 | * Установка - стандартно | ||
389 | * фактически состоит из 3-х макросов: ##calc## macro, ##sum## macro, ##summary## macro. Синтаксис каждого из макросов - на соответствующей странице в разделе ##Macros##. | ||
390 | |||
391 | ===== **Todo Macro** - макрос для добавления прямо на страницы списков дел ===== | ||
392 | * http://extensions.xwiki.org/xwiki/bin/view/Extension/Todo+Macro | ||
393 | * Установка - стандартно, после - посетить страницу - ##XWiki.TodoMacroInstall## для завершения инсталляции. | ||
394 | * Примеры использования - ##Todo.WebHome##. | ||
395 | |||
396 | |||
397 | ===== **Spoiler Macro** - макрос для добавления на страницу скрытых элементов ===== | ||
398 | * http://extensions.xwiki.org/xwiki/bin/view/Extension/Spoiler+Macro | ||
399 | * Установка - стандартно. | ||
400 | * Домашняя страница ##Macros.Spolier## | ||
401 | * Использование: | ||
402 | {{code}} | ||
403 | {{spoiler title="Show me the truth"}} | ||
404 | I am your father | ||
405 | {{/spoiler}} | ||
406 | {{/code}} | ||
407 | |||
408 | |||
409 | ===== **Lightbox Macro** - макрос создает презентацию из картинок ===== | ||
410 | * http://extensions.xwiki.org/xwiki/bin/view/Extension/Lightbox+Macro | ||
411 | * Установка - стандартно. | ||
412 | * Домашняя страница ##XWiki.LightboxMacro## | ||
413 | * Использование: | ||
414 | {{code}} | ||
415 | {{lightbox image="cat.jpg" group="g0" /}} | ||
416 | {{lightbox image="cat2.jpg" group="g0" /}} | ||
417 | {{/code}} | ||
418 | |||
419 | |||
420 | ===== **MBox, MCode, MNote Macros** - макросы создающие специальные box-ы с красивым видом ===== | ||
421 | * http://asiri.rathnayake.org/xwiki/ | ||
422 | * Установка - стандартно. | ||
423 | * Домашние страницы ##Macro.MBox##, ##Macro.MNote##, ##Macro.MCode## | ||
424 | * Использование MBox: | ||
425 | {{code}} | ||
426 | {{mbox title="A Title" subTitle="An Optional **Sub-Title**"}} | ||
427 | Any **xwiki** content. | ||
428 | {{/mbox}} | ||
429 | {{/code}} | ||
430 | |||
431 | |||
432 | ===== **Copy Space Snippet** - данный код позволяет скопировать Раздел в другой Раздел ===== | ||
433 | * http://extensions.xwiki.org/xwiki/bin/view/Extension/Copy+Space+Snippet | ||
434 | * для использования - скопируйте представленный код на любую страницу | ||
435 | |||
436 | |||
437 | ===== **Delete Space Snippet** - данный код позволяет выполнить удаление разделов ===== | ||
438 | * http://extensions.xwiki.org/xwiki/bin/view/Extension/Delete+Space | ||
439 | * для использования - скопируйте представленный код на любую страницу | ||
440 | |||
441 | |||
442 | ===== **SpaceExplorer Panel Application** - добавляет панельку, с деревом разделов и страниц в них ===== | ||
443 | * http://extensions.xwiki.org/xwiki/bin/view/Extension/Space+Explorer+Panel+Application | ||
444 | * Установка - стандартно, а для вывода панели на экран - используйте ##Panel Wizard## в ##Administration## |