Исходный код вики Работа с документацией в xwiki
Версия 22.5 от Андрей Ганьков на 2025/07/14 13:06
Скрыть последних авторов
author | version | line-number | content |
---|---|---|---|
![]() |
22.4 | 1 | = Общие рекомендации = |
2 | |||
![]() |
22.5 | 3 | * Оформляйте вики однообразно. Пытаемся в месте выработать единый стиль, поэтому смотрите больше как оформлены аналогичные вещи. Если что-то не нравится в оформлении других, давайте обс |
![]() |
22.4 | 4 | |
![]() |
7.1 | 5 | = Использование готовых шаблонов = |
6 | |||
![]() |
22.2 | 7 | Для статей с однотипной информацией — например, описаний установленной 1С у разных клиентов, имеющих схожую структуру и набор данных — рекомендуется использовать шаблон при создании статьи. |
![]() |
7.1 | 8 | |
9 | Для того чтобы использовать установленный шаблон, при создании страницы его надо выбрать из шаблонов (см. снимок). | ||
10 | |||
![]() |
22.2 | 11 | [[image:Создание с использованием шаблона.png||data-xwiki-image-style-alignment="center"]] |
![]() |
7.1 | 12 | |
13 | (% class="wikigeneratedid" %) | ||
14 | По нажатии кнопки создать. Можно приступать к заполнению данных, в подготовленной статье. При отсутствии каких то полей не стесняйтесь их добавлять. | ||
15 | |||
![]() |
12.1 | 16 | = Вставить изображение в статью = |
17 | |||
18 | 1. Устанавливаем курсор редактирования на то место в статье куда надо вставить изображение | ||
![]() |
15.1 | 19 | 1. Нажимаем кнопку вставить картинку((( |
![]() |
22.2 | 20 | [[image:Кнопка вставить изображение.png||data-xwiki-image-style-alignment="center"]] |
![]() |
15.1 | 21 | |
22 | |||
23 | ))) | ||
24 | 1. Если изображение уже прикреплено к любой статье его можно просто выбрать в пункте "Вложение", если нет переключаемся на вкладку "Загрузка файла"((( | ||
![]() |
22.2 | 25 | [[image:Вкладка загрузить файл.png||data-xwiki-image-style-alignment="center"]] |
![]() |
15.1 | 26 | |
27 | |||
28 | ))) | ||
![]() |
12.1 | 29 | 1. Выбираем файл для загрузки кнопка "Обзор" |
![]() |
15.1 | 30 | 1. Обязательно! нажимаем кнопку "Загрузить на сервер" |
31 | 1. Перескакиваем на первую вкладку. Здесь можно установить дополнительный параметры, например задать размеры, или расположение по центру.((( | ||
![]() |
22.2 | 32 | [[image:Параметры изображения.png||data-xwiki-image-style-alignment="center"]] |
![]() |
15.1 | 33 | |
34 | |||
35 | ))) | ||
![]() |
12.1 | 36 | 1. "Ок" изображение вставлено в статью. |
37 | |||
![]() |
22.2 | 38 | = Работа с заголовками = |
39 | |||
40 | |||
![]() |
8.1 | 41 | = Работа с таблицами = |
42 | |||
43 | {{info}} | ||
44 | Пожалуйста без надобности не меняйте размеры колонок вручную, табличка сама подстроит размеры колонок под содержимое и экран пользователя. Установив фиксированные размеры под свой экран, не даст возможность отображать адекватно таблицу на мобильных устройствах. Так же установка размеров пропишет в каждой ячейки атрибут ~(% style="width:180px" %) что значительно усложняет читаемость и редактирование таблицы в вики разметке. | ||
45 | {{/info}} | ||
46 | |||
47 | (% class="wikigeneratedid" %) | ||
48 | В вики разметке таблица выглядит так: | ||
49 | |||
50 | {{code language="xwiki"}} | ||
51 | |= Заголовок колонки 1 |= Заголовок колонки 2 |= Заголовок колонки 3 | ||
52 | |Строка 1 ячека 1| Строка 1 ячека 2| Строка 1 ячека 3 | ||
53 | |Строка 2 ячека 1| Строка 2 ячека 2| Строка 2 ячека 3 | ||
54 | {{/code}} | ||
55 | |||
56 | (% class="wikigeneratedid" %) | ||
57 | Достаточно просто, поэтому иногда удобнее работать с табличками в вики разметке. Чтобы переключится в момент редактирования на вики разметку, нужно нажать кнопку "Источник" на панели редактирования. | ||
58 | |||
59 | (% class="wikigeneratedid" %) | ||
60 | Добавлять и удалять строки и колонки можно через меню правой кнопкой мыши. | ||
61 | |||
![]() |
16.1 | 62 | == Очистка любого форматирования таблиц == |
63 | |||
64 | Часто бывает так что случайными движением мыши вставляются размеры в каждую строку таблицы или при копировании данных из Excel. Таблица вся завалена тегами форматирования, что практически убивает возможность ее удобного редактирования в виде исходника. Очистить форматирование можно, открыв исходник страницы, скопировав текст любой сервис замены по Regexp например [[этот>>https://www.freeformatter.com/regex-tester.html]]. Вставляем наш текст. Далее указываем шаблон поиска {{code language="regexp"}}\(\%.*?\%\){{/code}}. Обязательно проставляем параметр /g для тех сервисов в которых можно это указать галочкой, или добавляем его в конец выражения если галки нет. Выполняем замену на пустое место. И получаем очищенный от форматирования вариант таблицы. | ||
65 | |||
![]() |
19.1 | 66 | = Работа со ссылками = |
![]() |
1.1 | 67 | |
![]() |
19.1 | 68 | [[Официальная документация ~>~>>>https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/Features/XWikiSyntax/?syntax=2.1§ion=Links]] |
69 | |||
70 | == Внутренняя ссылка == | ||
71 | |||
![]() |
20.1 | 72 | Внутренние ссылки, то есть ссылки на других страницы в вике, надо создавать **не копируя **полностью ссылку **из браузера**, а помощью специального формата. Это позволяет вики при переименовании страниц, корректно заменить все ссылки на новую страницу. |
![]() |
19.1 | 73 | |
74 | === Через редактирования источника === | ||
75 | |||
76 | Следующий вариант сделает ссылку на страницу в виде ее названия. | ||
77 | |||
78 | {{code language="XWiki"}} | ||
79 | [[Название страницы на русском]] | ||
80 | {{/code}} | ||
81 | |||
82 | (% class="wikigeneratedid" %) | ||
83 | Дать ссылку с другим текстом можно следующим образом. | ||
84 | |||
85 | {{code language="Xwiki"}} | ||
86 | [[Отображаемый текст ссылки>>Название страницы на русском]] | ||
87 | {{/code}} | ||
88 | |||
89 | === Из графического редактора === | ||
90 | |||
91 | Нажимаем кнопку [[image:Значек ссылки.png]] и в появившемся диалоге пишем отображаемый текст, и выбираем из списка нужную страницу. | ||
92 | |||
![]() |
22.2 | 93 | [[image:Диалог редактирования ссылки.png||data-xwiki-image-style-alignment="center"]] |
![]() |
19.1 | 94 | |
95 | == Ссылка на заголовок раздела внутри страницы == | ||
96 | |||
![]() |
21.1 | 97 | (% class="box infomessage" %) |
98 | ((( | ||
99 | Если цель дать кому-то ссылку на раздел страницы в чате, то ее можно скопировать из правой панели "Содержимое". | ||
100 | ))) | ||
101 | |||
![]() |
1.1 | 102 | Вообще ссылка на заголовок делается на той же странице следующим кодом: |
103 | |||
104 | {{code language="xwiki"}} | ||
105 | [[разделе по смене пароля>>||anchor="HTitle"]] | ||
106 | {{/code}} | ||
107 | |||
108 | Где Title название самого заголовка. | ||
109 | |||
110 | Но это работает только для английских заголовков. Для русских Title выглядит иначе. Например так "H42143C43543D43043F43044043E43B44F" для заголовка "Смена пароля". | ||
111 | |||
112 | {{code language="xwiki"}} | ||
113 | [[разделе по смене пароля>>||anchor="H42143C43543D43043F43044043E43B44F"]] | ||
114 | {{/code}} | ||
115 | |||
![]() |
5.1 | 116 | Узнать какие же цифры писать в ссылке в Firefox можно следующим образом: |
117 | |||
118 | 1. В браузере на сохраненой странице выделяем искомый заголовок, в контекстном меню вызываем исследовать элемент (или вызываем инспектор F12 и ищем заголовок в ручную)((( | ||
![]() |
22.2 | 119 | [[image:Контекстное меню на странице.png||data-xwiki-image-style-alignment="center"]] |
![]() |
5.1 | 120 | |
121 | |||
122 | ))) | ||
123 | 1. Чуть выше выбранного span с текстом интересующего заголовка будет тег h1((( | ||
![]() |
22.2 | 124 | [[image:Выделенный span.png||data-xwiki-image-style-alignment="center"]] |
![]() |
5.1 | 125 | |
126 | |||
127 | ))) | ||
128 | 1. Копируем значение его атрибута id через контекстное меню, это и есть наш якорь.((( | ||
![]() |
22.2 | 129 | [[image:Контекстное меню атрибута.png||data-xwiki-image-style-alignment="center"]] |
![]() |
5.1 | 130 | |
131 | |||
132 | ))) | ||
![]() |
22.1 | 133 | |
134 | = Работа с диаграммами = | ||
135 | |||
136 | Диаграммы из графического редактора вставляются через кнопку + и выбор макроса Chart(График) или напрямую в код страницы. Детальная документация по нем у [[здесь>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Chart Macro]]. | ||
137 | |||
138 | График может как содержать встроенную таблицу с данными так и обращаться к имеющейся таблице. Для того чтобы обратиться к имеющейся таблицы, ей нежно указать id, через меню свойства таблицы или через код: | ||
139 | |||
140 | {{code language="xwiki"}} | ||
141 | (%id="table_revenue"%) | ||
142 | |=|=X|=Y|=Z | ||
143 | |Q1|1.2|3.4|1.3 | ||
144 | {{/code}} | ||
145 | |||
146 | Теперь создавай диаграмму к ней можно обратится: | ||
147 | |||
148 | {{code language="xwiki"}} | ||
149 | {{chart type="line" params="document:Цели.2021 год.Компания.WebHome;table:table_revenue;range:B2-B20;series:columns;" width="700"}}{{/chart}} | ||
150 | {{/code}} | ||
151 | |||
152 | В параметрах необходимо заполнить минимальные настройка: | ||
153 | |||
154 | * **document** - внутренний адрес страницы, не является обязательным если табличка на той же страницы. Узнать адрес можно через меню страницы "три точки" -> "Информация" | ||
155 | * **table** - id таблицы | ||
156 | * **range** - колонки данных, обратите внимание что **добавляя** **новую** **строку** в таблицу **диапазон** нужно тоже **редактировать**. | ||
157 | |||
158 |