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

Редактировал(а) Андрей Ганьков 2025/07/14 13:35

От версии 24.2
отредактировано Андрей Ганьков
на 2025/07/14 13:17
Изменить комментарий: К данной версии нет комментариев
К версии 22.1
отредактировано Андрей Ганьков
на 2022/05/04 12:23
Изменить комментарий: Добавил про работу с диаграммами

Сводка

Подробности

Свойства страницы
Содержимое
... ... @@ -1,15 +6,11 @@
1 -= Общие рекомендации =
2 -
3 -* Оформляйте вики однообразно. Пытаемся в месте выработать единый стиль, поэтому смотрите больше как оформлены аналогичные вещи. Если что-то не нравится в оформлении других, давайте обсуждать.
4 -* Увидел не точность, в документации сразу исправляй.
5 -
6 6  = Использование готовых шаблонов =
7 7  
8 -Для статей с однотипной информацией например, описаний установленной у разных клиентов, имеющих схожую структуру и набор данных рекомендуется использовать шаблон при создании статьи.
3 +Для статей с однотипной информацией, например для описания установленной у разных клиентов, но по сути имеющие одинаковый набор данных, для создания статьи необходимо использовать шаблон.
9 9  
10 10  Для того чтобы использовать установленный шаблон, при создании страницы его надо выбрать из шаблонов (см. снимок).
11 11  
12 -[[image:Создание с использованием шаблона.png||data-xwiki-image-style-alignment="center"]]
7 +(% style="text-align:center" %)
8 +[[image:Создание с использованием шаблона.png]]
13 13  
14 14  (% class="wikigeneratedid" %)
15 15  По нажатии кнопки создать. Можно приступать к заполнению данных, в подготовленной статье. При отсутствии каких то полей не стесняйтесь их добавлять.
... ... @@ -18,12 +18,14 @@
18 18  
19 19  1. Устанавливаем курсор редактирования на то место в статье куда надо вставить изображение
20 20  1. Нажимаем кнопку вставить картинку(((
21 -[[image:Кнопка вставить изображение.png||data-xwiki-image-style-alignment="center"]]
17 +(% style="text-align:center" %)
18 +[[image:Кнопка вставить изображение.png]]
22 22  
23 23  
24 24  )))
25 25  1. Если изображение уже прикреплено к любой статье его можно просто выбрать в пункте "Вложение", если нет переключаемся на вкладку "Загрузка файла"(((
26 -[[image:Вкладка загрузить файл.png||data-xwiki-image-style-alignment="center"]]
23 +(% style="text-align:center" %)
24 +[[image:Вкладка загрузить файл.png]]
27 27  
28 28  
29 29  )))
... ... @@ -30,25 +30,13 @@
30 30  1. Выбираем файл для загрузки кнопка "Обзор"
31 31  1. Обязательно! нажимаем кнопку "Загрузить на сервер"
32 32  1. Перескакиваем на первую вкладку. Здесь можно установить дополнительный параметры, например задать размеры, или расположение по центру.(((
33 -[[image:Параметры изображения.png||data-xwiki-image-style-alignment="center"]]
31 +(% style="text-align:center" %)
32 +[[image:Параметры изображения.png]]
34 34  
35 35  
36 36  )))
37 37  1. "Ок" изображение вставлено в статью.
38 38  
39 -= Работа с заголовками =
40 -
41 -**Вики и любая документация — это в первую очередь про структуру, а уже во вторую — про оформление.**
42 -Не используйте заголовки для изменения размера шрифта — они предназначены не для этого. Заголовки определяют логическую структуру документа: они создают иерархию разделов и блоков информации, формируют содержимое страницы в правой панели.
43 -
44 -Убедитесь, что структура заголовков логична и отражает смысловое деление текста — это поможет читателю быстро ориентироваться.
45 -
46 -Также не рекомендуется применять к заголовкам дополнительные стили, такие как усиленное жирное начертание, чтобы сохранить их единообразный и аккуратный внешний вид.
47 -
48 -{{warning}}
49 -После сохранения страницы содержимой правой панели не обновляется. Чтобы увидеть новую структуру,
50 -{{/warning}}
51 -
52 52  = Работа с таблицами =
53 53  
54 54  {{info}}
... ... @@ -101,7 +101,8 @@
101 101  
102 102  Нажимаем кнопку [[image:Значек ссылки.png]] и в появившемся диалоге пишем отображаемый текст, и выбираем из списка нужную страницу.
103 103  
104 -[[image:Диалог редактирования ссылки.png||data-xwiki-image-style-alignment="center"]]
90 +(% style="text-align:center" %)
91 +[[image:Диалог редактирования ссылки.png]]
105 105  
106 106  == Ссылка на заголовок раздела внутри страницы ==
107 107  
... ... @@ -127,17 +127,20 @@
127 127  Узнать какие же цифры писать в ссылке в Firefox можно следующим образом:
128 128  
129 129  1. В браузере на сохраненой странице выделяем искомый заголовок, в контекстном меню вызываем исследовать элемент (или вызываем инспектор F12 и ищем заголовок в ручную)(((
130 -[[image:Контекстное меню на странице.png||data-xwiki-image-style-alignment="center"]]
117 +(% style="text-align:center" %)
118 +[[image:Контекстное меню на странице.png]]
131 131  
132 132  
133 133  )))
134 134  1. Чуть выше выбранного span с текстом интересующего заголовка будет тег h1(((
135 -[[image:Выделенный span.png||data-xwiki-image-style-alignment="center"]]
123 +(% style="text-align:center" %)
124 +[[image:Выделенный span.png]]
136 136  
137 137  
138 138  )))
139 139  1. Копируем значение его атрибута id через контекстное меню, это и есть наш якорь.(((
140 -[[image:Контекстное меню атрибута.png||data-xwiki-image-style-alignment="center"]]
129 +(% style="text-align:center" %)
130 +[[image:Контекстное меню атрибута.png]]
141 141  
142 142  
143 143  )))