Перейти к содержимому

Изменения документа Работа с документацией в xwiki

Редактировал(а) Андрей Ганьков 2025/07/14 13:35
От версии 7.1
отредактировано Андрей Ганьков
на 2020/09/23 09:01
Изменить комментарий: Добавил ифу об использовании шаблонов
К версии 23.18
отредактировано Андрей Ганьков
на 2025/07/14 13:14
Изменить комментарий: К данной версии нет комментариев

Сводка

Подробности

Свойства страницы
Родительский документ
... ... @@ -1,1 +1,1 @@
1 -Инструкции.Для сисадмина.WebHome
1 +Для пользователя.WebHome
Содержимое
... ... @@ -1,18 +1,107 @@
1 -(% class="wikigeneratedid" %)
1 += Общие рекомендации =
2 +
3 +* Оформляйте вики однообразно. Пытаемся в месте выработать единый стиль, поэтому смотрите больше как оформлены аналогичные вещи. Если что-то не нравится в оформлении других, давайте обсуждать.
4 +* Увидел не точность, в документации сразу исправляй.
5 +
2 2  = Использование готовых шаблонов =
3 3  
4 -Для статей с однотипной информацией, например для описания 1С установленной у разных клиентов, но по сути имеющие одинаковый набор данных, для создания статьи необходимо использовать шаблон.
8 +Для статей с однотипной информацией — например, описаний установленной 1С у разных клиентов, имеющих схожую структуру и набор данных — рекомендуется использовать шаблон при создании статьи.
5 5  
6 6  Для того чтобы использовать установленный шаблон, при создании страницы его надо выбрать из шаблонов (см. снимок).
7 7  
8 -(% style="text-align:center" %)
9 -[[image:Создание с использованием шаблона.png]]
12 +[[image:Создание с использованием шаблона.png||data-xwiki-image-style-alignment="center"]]
10 10  
11 11  (% class="wikigeneratedid" %)
12 12  По нажатии кнопки создать. Можно приступать к заполнению данных, в подготовленной статье. При отсутствии каких то полей не стесняйтесь их добавлять.
13 13  
14 -= Дать ссылку на заголовок раздела внутри страницы =
17 += Вставить изображение в статью =
15 15  
19 +1. Устанавливаем курсор редактирования на то место в статье куда надо вставить изображение
20 +1. Нажимаем кнопку вставить картинку(((
21 +[[image:Кнопка вставить изображение.png||data-xwiki-image-style-alignment="center"]]
22 +
23 +
24 +)))
25 +1. Если изображение уже прикреплено к любой статье его можно просто выбрать в пункте "Вложение", если нет переключаемся на вкладку "Загрузка файла"(((
26 +[[image:Вкладка загрузить файл.png||data-xwiki-image-style-alignment="center"]]
27 +
28 +
29 +)))
30 +1. Выбираем файл для загрузки кнопка "Обзор"
31 +1. Обязательно! нажимаем кнопку "Загрузить на сервер"
32 +1. Перескакиваем на первую вкладку. Здесь можно установить дополнительный параметры, например задать размеры, или расположение по центру.(((
33 +[[image:Параметры изображения.png||data-xwiki-image-style-alignment="center"]]
34 +
35 +
36 +)))
37 +1. "Ок" изображение вставлено в статью.
38 +
39 += Работа с заголовками =
40 +
41 +Вики и вообще любая документация, это в первую очередь про структурирование информации, а во вторую уже оформление. Поэтому **никогда** не используйте **заголовки** как способ задать **размер** **шрифта**. Заголовки с стать нужны не для этого, они описывают структуру документа, из них формируется вложенность разделов и блоков информации. Из них формируется блок содержимого страницы в правой панели. Проверяйте чтобы структура(содержание) в страницы в правой панели было логичным.
42 +К заголовкам очень желательно не применять дополнительных стилей таких ка более жирный текст. Чтобы они были однообразные.
43 +
44 += Работа с таблицами =
45 +
46 +{{info}}
47 +Пожалуйста без надобности не меняйте размеры колонок вручную, табличка сама подстроит размеры колонок под содержимое и экран пользователя. Установив фиксированные размеры под свой экран, не даст возможность отображать адекватно таблицу на мобильных устройствах. Так же установка размеров пропишет в каждой ячейки атрибут ~(% style="width:180px" %) что значительно усложняет читаемость и редактирование таблицы в вики разметке.
48 +{{/info}}
49 +
50 +(% class="wikigeneratedid" %)
51 +В вики разметке таблица выглядит так:
52 +
53 +{{code language="xwiki"}}
54 +|= Заголовок колонки 1 |= Заголовок колонки 2 |= Заголовок колонки 3
55 +|Строка 1 ячека 1| Строка 1 ячека 2| Строка 1 ячека 3
56 +|Строка 2 ячека 1| Строка 2 ячека 2| Строка 2 ячека 3
57 +{{/code}}
58 +
59 +(% class="wikigeneratedid" %)
60 +Достаточно просто, поэтому иногда удобнее работать с табличками в вики разметке. Чтобы переключится в момент редактирования на вики разметку, нужно нажать кнопку "Источник" на панели редактирования.
61 +
62 +(% class="wikigeneratedid" %)
63 +Добавлять и удалять строки и колонки можно через меню правой кнопкой мыши.
64 +
65 +== Очистка любого форматирования таблиц ==
66 +
67 +Часто бывает так что случайными движением мыши вставляются размеры в каждую строку таблицы или при копировании данных из Excel. Таблица вся завалена тегами форматирования, что практически убивает возможность ее удобного редактирования в виде исходника. Очистить форматирование можно, открыв исходник страницы, скопировав текст любой сервис замены по Regexp например [[этот>>https://www.freeformatter.com/regex-tester.html]]. Вставляем наш текст. Далее указываем шаблон поиска {{code language="regexp"}}\(\%.*?\%\){{/code}}. Обязательно проставляем параметр /g для тех сервисов в которых можно это указать галочкой, или добавляем его в конец выражения если галки нет. Выполняем замену на пустое место. И получаем очищенный от форматирования вариант таблицы.
68 +
69 += Работа со ссылками =
70 +
71 +[[Официальная документация ~>~>>>https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/Features/XWikiSyntax/?syntax=2.1&section=Links]]
72 +
73 +== Внутренняя ссылка ==
74 +
75 +Внутренние ссылки, то есть ссылки на других страницы в вике, надо создавать **не копируя **полностью ссылку **из браузера**, а помощью специального формата. Это позволяет вики при переименовании страниц, корректно заменить все ссылки на новую страницу.
76 +
77 +=== Через редактирования источника ===
78 +
79 +Следующий вариант сделает ссылку на страницу в виде ее названия.
80 +
81 +{{code language="XWiki"}}
82 +[[Название страницы на русском]]
83 +{{/code}}
84 +
85 +(% class="wikigeneratedid" %)
86 +Дать ссылку с другим текстом можно следующим образом.
87 +
88 +{{code language="Xwiki"}}
89 +[[Отображаемый текст ссылки>>Название страницы на русском]]
90 +{{/code}}
91 +
92 +=== Из графического редактора ===
93 +
94 +Нажимаем кнопку [[image:Значек ссылки.png]] и в появившемся диалоге пишем отображаемый текст, и выбираем из списка нужную страницу.
95 +
96 +[[image:Диалог редактирования ссылки.png||data-xwiki-image-style-alignment="center"]]
97 +
98 +== Ссылка на заголовок раздела внутри страницы ==
99 +
100 +(% class="box infomessage" %)
101 +(((
102 +Если цель дать кому-то ссылку на раздел страницы в чате, то ее можно скопировать из правой панели "Содержимое".
103 +)))
104 +
16 16  Вообще ссылка на заголовок делается на той же странице следующим кодом:
17 17  
18 18  {{code language="xwiki"}}
... ... @@ -30,20 +30,43 @@
30 30  Узнать какие же цифры писать в ссылке в Firefox можно следующим образом:
31 31  
32 32  1. В браузере на сохраненой странице выделяем искомый заголовок, в контекстном меню вызываем исследовать элемент (или вызываем инспектор F12 и ищем заголовок в ручную)(((
33 -(% style="text-align:center" %)
34 -[[image:Контекстное меню на странице.png]]
122 +[[image:Контекстное меню на странице.png||data-xwiki-image-style-alignment="center"]]
35 35  
36 36  
37 37  )))
38 38  1. Чуть выше выбранного span с текстом интересующего заголовка будет тег h1(((
39 -(% style="text-align:center" %)
40 -[[image:Выделенный span.png]]
127 +[[image:Выделенный span.png||data-xwiki-image-style-alignment="center"]]
41 41  
42 42  
43 43  )))
44 44  1. Копируем значение его атрибута id через контекстное меню, это и есть наш якорь.(((
45 -(% style="text-align:center" %)
46 -[[image:Контекстное меню атрибута.png]]
132 +[[image:Контекстное меню атрибута.png||data-xwiki-image-style-alignment="center"]]
47 47  
48 48  
49 49  )))
136 +
137 += Работа с диаграммами =
138 +
139 +Диаграммы из графического редактора вставляются через кнопку + и выбор макроса Chart(График) или напрямую в код страницы. Детальная документация по нем у [[здесь>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Chart Macro]].
140 +
141 +График может как содержать встроенную таблицу с данными так и обращаться к имеющейся таблице. Для того чтобы обратиться к имеющейся таблицы, ей нежно указать id, через меню свойства таблицы или через код:
142 +
143 +{{code language="xwiki"}}
144 +(%id="table_revenue"%)
145 +|=|=X|=Y|=Z
146 +|Q1|1.2|3.4|1.3
147 +{{/code}}
148 +
149 +Теперь создавай диаграмму к ней можно обратится:
150 +
151 +{{code language="xwiki"}}
152 +{{chart type="line" params="document:Цели.2021 год.Компания.WebHome;table:table_revenue;range:B2-B20;series:columns;" width="700"}}{{/chart}}
153 +{{/code}}
154 +
155 + В параметрах необходимо заполнить минимальные настройка:
156 +
157 +* **document** - внутренний адрес страницы, не является обязательным если табличка на той же страницы. Узнать адрес можно через меню страницы "три точки" -> "Информация"
158 +* **table** - id таблицы
159 +* **range** - колонки данных, обратите внимание что **добавляя** **новую** **строку** в таблицу **диапазон** нужно тоже **редактировать**.
160 +
161 +
Вкладка загрузить файл.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.gav
Размер
... ... @@ -1,0 +1,1 @@
1 +28.1 KB
Содержимое
Диалог редактирования ссылки.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.gav
Размер
... ... @@ -1,0 +1,1 @@
1 +63.2 KB
Содержимое
Значек ссылки.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.gav
Размер
... ... @@ -1,0 +1,1 @@
1 +7.5 KB
Содержимое
Кнопка вставить изображение.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.gav
Размер
... ... @@ -1,0 +1,1 @@
1 +6.2 KB
Содержимое
Параметры изображения.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.gav
Размер
... ... @@ -1,0 +1,1 @@
1 +47.6 KB
Содержимое