Исходный код вики Расширение Глоссария для XWiki
Редактировал(а) Coluns 17.12.2022
Скрыть последних авторов
author | version | line-number | content |
---|---|---|---|
![]() |
1.1 | 1 | (% style="text-align:center" %) |
![]() |
4.2 | 2 | [[image:Глоссарий.svg||alt="Глоссарий в XWiki" height="600" width="600"]] |
![]() |
1.1 | 3 | |
![]() |
1.3 | 4 | Расширение **Глоссария** позволяет добавить в вашу вики, специальный словарь. |
![]() |
1.1 | 5 | |
![]() |
1.3 | 6 | (% class="box" %) |
7 | ((( | ||
8 | **Глосса́рий** (лат. glossarium «собрание глосс») — словарь узкоспециализированных терминов в какой-либо отрасли знаний с толкованием, иногда переводом на другой язык, комментариями и примерами. | ||
9 | ))) | ||
![]() |
1.1 | 10 | |
![]() |
1.3 | 11 | Данная функция будет очень полезна для проектных организаций. |
12 | |||
13 | Добавляя в глоссарий термины или описание сокращений, можно существенно повысить качество обмена информацией между сотрудниками. | ||
14 | |||
![]() |
1.4 | 15 | Данное расширение обладает возможностью автоматически добавлять на страницу ссылки на элементы глоссария. |
![]() |
1.3 | 16 | |
![]() |
1.4 | 17 | Это позволяет "связывать" страницы с терминами и сокращениями и их описаниями незаметно для пользователя. |
18 | |||
19 | {{cl-plate-advice}} | ||
20 | Так как глоссарий является словарём сложных терминов, не следует включать в глоссарий все термины, которые встречаются в проекте. | ||
21 | |||
22 | {{/cl-plate-advice}} | ||
23 | |||
![]() |
1.5 | 24 | Как же добавить расширение глоссария в ваш экземпляр XWiki? |
![]() |
1.4 | 25 | |
![]() |
1.5 | 26 | Для начала необходимо установить расширение **Glossary Application **которое имеет id: org.xwiki.contrib.glossary:application-glossary-ui |
27 | |||
28 | (% class="box" %) | ||
29 | ((( | ||
30 | Для установки расширений обратитесь к [[руководству>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Extension%20Manager%20Application]] на систему или [[к нам>>mailto:info@corpwiki.ru]]. | ||
31 | ))) | ||
32 | |||
![]() |
1.6 | 33 | После установки, перейдите к настройкам глоссария (1), (2), (3) |
![]() |
1.5 | 34 | |
![]() |
1.7 | 35 | (% style="text-align:center" %) |
36 | [[image:image-20221217152511-1.png||alt="Настройки глоссария в XWiki" height="486" width="1000"]] | ||
![]() |
1.6 | 37 | |
![]() |
1.7 | 38 | Включите добавление ссылок в глоссарий при сохранении страниц (4) и\или создание ссылок периодически по расписанию (5). |
39 | |||
![]() |
1.8 | 40 | Также вы можете указать разделы в которых должны добавляться ссылки (6) и нужно ли при автоматическом добавлении ссылок создавать новую версию страницы (7). |
![]() |
1.7 | 41 | |
![]() |
1.8 | 42 | (% class="box" %) |
43 | ((( | ||
44 | Про версии и их применение при создании документов в XWiki мы писали ранее в статье: [[Версии страниц в XWiki>>doc:Stati.Funktsii-XWiki.Versii-stranits-v--XWiki.WebHome]] | ||
45 | ))) | ||
46 | |||
47 | После сохранения настроек ваш глоссарий начнет работать. | ||
48 | |||
![]() |
1.9 | 49 | По умолчанию, глоссарий расположен по адресу вида [[https:~~/~~/corpwiki.ru/bin/view/Glossary/>>https://corpwiki.ru/bin/view/Glossary/]] |
![]() |
1.8 | 50 | |
![]() |
1.9 | 51 | На главной странице глоссария вы можете выполнить поиск по глоссарию (1), добавить новый элемент (2) и экспортировать глоссарий в офисный формат таблицы (3). |
52 | |||
53 | Все элементы располагаются в удобной таблице (4) | ||
54 | |||
![]() |
1.8 | 55 | (% style="text-align:center" %) |
![]() |
4.2 | 56 | [[image:image-20221217153242-2.png||alt="Главная страница глоссария в XWiki" height="354" width="1000"]] |
![]() |
1.8 | 57 | |
![]() |
1.9 | 58 | Страница термина это обычная страница к которой в скрытом режиме прикреплены объекты преобразующие ее в элемент глоссария. |
59 | |||
60 | Работа с термином проста: Нужно добавить сам термин (1) и его описание (2) | ||
61 | |||
62 | (% style="text-align:center" %) | ||
![]() |
4.2 | 63 | [[image:image-20221217153825-3.png||alt="Добавление элемента глоссария в XWiki" height="468" width="1000"]] |
![]() |
1.9 | 64 | |
![]() |
2.1 | 65 | (% class="box warningmessage" %) |
66 | ((( | ||
67 | Концепция "В XWiki всё является страницей" работает и здесь. | ||
68 | ))) | ||
![]() |
1.9 | 69 | |
![]() |
2.1 | 70 | После добавления термина, при сохранении страницы или периодически (в зависимости от настроек) система будет на страницах, где встречается термин вставлять специальный макрос, который при просмотре будет преобразовываться в ссылку на страницу глоссария. |
71 | |||
![]() |
4.1 | 72 | Например, мы добавили термин {{glossaryReference glossaryId="Glossary" entryId="corpwiki"}}corpwiki{{/glossaryReference}} и когда сохранили эту страницу, система добавила к этому слову макрос-ссылку на страницу глоссария с этим термином. |
![]() |
2.1 | 73 | |
![]() |
4.2 | 74 | И вот как это выглядит в режиме вики-редактирования: |
75 | |||
76 | (% style="text-align:center" %) | ||
77 | [[image:image-20221217154508-1.png||alt="Добавленный макрос глоссария к странице XWiki" height="476" width="1000"]] | ||
78 | |||
![]() |
5.1 | 79 | Таким образом данное расширение позволяет создать удобный проектный глоссарий в вашей XWiki, что конечно упростит жизнь вашим сотрудникам. |
80 | |||
81 | {{cl-plate-advice}} | ||
82 | К сожалению, расширение не переведено на русский язык и некоторые элементы интерфейса на английском. | ||
83 | Но вы можете обратиться к нам и мы вам поможем. | ||
84 | {{/cl-plate-advice}} | ||
85 | |||
![]() |
1.1 | 86 | ---- |
87 | |||
88 | {{cl-plate-help/}} |