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

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

Редактировал(а) Андрей Ганьков 2025/07/14 13:35
От версии 25.2
отредактировано Андрей Ганьков
на 2025/07/14 13:29
Изменить комментарий: К данной версии нет комментариев
К версии 4.1
отредактировано Андрей Ганьков
на 2020/05/06 09:57
Изменить комментарий: Загрузить новое вложение Контекстное меню атрибута.png

Сводка

Подробности

Свойства страницы
Родительский документ
... ... @@ -1,1 +1,1 @@
1 -Для пользователя.WebHome
1 +Инструкции.Для сисадмина.WebHome
Теги
... ... @@ -1,1 +1,0 @@
1 -XWiki
Содержимое
... ... @@ -1,123 +1,5 @@
1 -= Общие рекомендации =
1 += Дать ссылку на заголовок раздела внутри страницы =
2 2  
3 -* Оформляйте вики однообразно. Пытаемся в месте выработать единый стиль, поэтому смотрите больше как оформлены аналогичные вещи. Если что-то не нравится в оформлении других, давайте обсуждать.
4 -* Увидел не точность, в документации сразу исправляй.
5 -
6 -= Использование готовых шаблонов =
7 -
8 -Для статей с однотипной информацией — например, описаний установленной 1С у разных клиентов, имеющих схожую структуру и набор данных — рекомендуется использовать шаблон при создании статьи.
9 -
10 -Для того чтобы использовать установленный шаблон, при создании страницы его надо выбрать из шаблонов (см. снимок).
11 -
12 -[[image:Создание с использованием шаблона.png||data-xwiki-image-style-alignment="center"]]
13 -
14 -(% class="wikigeneratedid" %)
15 -По нажатии кнопки создать. Можно приступать к заполнению данных, в подготовленной статье. При отсутствии каких то полей не стесняйтесь их добавлять.
16 -
17 -= Вставить изображение в статью =
18 -
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 -{{warning}}
47 -После сохранения страницы содержимой правой панели не обновляется. Чтобы увидеть новую структуру, иногда надо обновить страницу вручную F5.
48 -{{/warning}}
49 -
50 -Также не рекомендуется применять к заголовкам дополнительные стили, такие как усиленное жирное начертание, чтобы сохранить их единообразный и аккуратный внешний вид.
51 -
52 -Заголовки удобно выбирать если вы начинаете новый абзац с символа  "/", возникает всплывающее меню, в котором можно выбрать уровень заголовка. Кстати так можно вводить не только заголовки.
53 -
54 -[[image:Быстрый выбор форматирования.png||data-xwiki-image-style-alignment="center"]]
55 -
56 -= Работа с тегами =
57 -
58 -Теги позволяют внести еще один уровень систематизации в вики.
59 -
60 -= Работа с таблицами =
61 -
62 -{{info}}
63 -Пожалуйста без надобности не меняйте размеры колонок вручную, табличка сама подстроит размеры колонок под содержимое и экран пользователя. Установив фиксированные размеры под свой экран, не даст возможность отображать адекватно таблицу на мобильных устройствах. Так же установка размеров пропишет в каждой ячейки атрибут ~(% style="width:180px" %) что значительно усложняет читаемость и редактирование таблицы в вики разметке.
64 -{{/info}}
65 -
66 -(% class="wikigeneratedid" %)
67 -В вики разметке таблица выглядит так:
68 -
69 -{{code language="xwiki"}}
70 -|= Заголовок колонки 1 |= Заголовок колонки 2 |= Заголовок колонки 3
71 -|Строка 1 ячека 1| Строка 1 ячека 2| Строка 1 ячека 3
72 -|Строка 2 ячека 1| Строка 2 ячека 2| Строка 2 ячека 3
73 -{{/code}}
74 -
75 -(% class="wikigeneratedid" %)
76 -Достаточно просто, поэтому иногда удобнее работать с табличками в вики разметке. Чтобы переключится в момент редактирования на вики разметку, нужно нажать кнопку "Источник" на панели редактирования.
77 -
78 -(% class="wikigeneratedid" %)
79 -Добавлять и удалять строки и колонки можно через меню правой кнопкой мыши.
80 -
81 -== Очистка любого форматирования таблиц ==
82 -
83 -Часто бывает так что случайными движением мыши вставляются размеры в каждую строку таблицы или при копировании данных из Excel. Таблица вся завалена тегами форматирования, что практически убивает возможность ее удобного редактирования в виде исходника. Очистить форматирование можно, открыв исходник страницы, скопировав текст любой сервис замены по Regexp например [[этот>>https://www.freeformatter.com/regex-tester.html]]. Вставляем наш текст. Далее указываем шаблон поиска {{code language="regexp"}}\(\%.*?\%\){{/code}}. Обязательно проставляем параметр /g для тех сервисов в которых можно это указать галочкой, или добавляем его в конец выражения если галки нет. Выполняем замену на пустое место. И получаем очищенный от форматирования вариант таблицы.
84 -
85 -= Работа со ссылками =
86 -
87 -[[Официальная документация ~>~>>>https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/Features/XWikiSyntax/?syntax=2.1&section=Links]]
88 -
89 -== Внутренняя ссылка ==
90 -
91 -Внутренние ссылки, то есть ссылки на других страницы в вике, надо создавать **не копируя **полностью ссылку **из браузера**, а помощью специального формата. Это позволяет вики при переименовании страниц, корректно заменить все ссылки на новую страницу.
92 -
93 -=== Через редактирования источника ===
94 -
95 -Следующий вариант сделает ссылку на страницу в виде ее названия.
96 -
97 -{{code language="XWiki"}}
98 -[[Название страницы на русском]]
99 -{{/code}}
100 -
101 -(% class="wikigeneratedid" %)
102 -Дать ссылку с другим текстом можно следующим образом.
103 -
104 -{{code language="Xwiki"}}
105 -[[Отображаемый текст ссылки>>Название страницы на русском]]
106 -{{/code}}
107 -
108 -=== Из графического редактора ===
109 -
110 -Нажимаем кнопку [[image:Значек ссылки.png]] и в появившемся диалоге пишем отображаемый текст, и выбираем из списка нужную страницу.
111 -
112 -[[image:Диалог редактирования ссылки.png||data-xwiki-image-style-alignment="center"]]
113 -
114 -== Ссылка на заголовок раздела внутри страницы ==
115 -
116 -(% class="box infomessage" %)
117 -(((
118 -Если цель дать кому-то ссылку на раздел страницы в чате, то ее можно скопировать из правой панели "Содержимое".
119 -)))
120 -
121 121  Вообще ссылка на заголовок делается на той же странице следующим кодом:
122 122  
123 123  {{code language="xwiki"}}
... ... @@ -132,46 +132,3 @@
132 132  [[разделе по смене пароля>>||anchor="H42143C43543D43043F43044043E43B44F"]]
133 133  {{/code}}
134 134  
135 -Узнать какие же цифры писать в ссылке в Firefox можно следующим образом:
136 -
137 -1. В браузере на сохраненой странице выделяем искомый заголовок, в контекстном меню вызываем исследовать элемент (или вызываем инспектор F12 и ищем заголовок в ручную)(((
138 -[[image:Контекстное меню на странице.png||data-xwiki-image-style-alignment="center"]]
139 -
140 -
141 -)))
142 -1. Чуть выше выбранного span с текстом интересующего заголовка будет тег h1(((
143 -[[image:Выделенный span.png||data-xwiki-image-style-alignment="center"]]
144 -
145 -
146 -)))
147 -1. Копируем значение его атрибута id через контекстное меню, это и есть наш якорь.(((
148 -[[image:Контекстное меню атрибута.png||data-xwiki-image-style-alignment="center"]]
149 -
150 -
151 -)))
152 -
153 -= Работа с диаграммами =
154 -
155 -Диаграммы из графического редактора вставляются через кнопку + и выбор макроса Chart(График) или напрямую в код страницы. Детальная документация по нем у [[здесь>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Chart Macro]].
156 -
157 -График может как содержать встроенную таблицу с данными так и обращаться к имеющейся таблице. Для того чтобы обратиться к имеющейся таблицы, ей нежно указать id, через меню свойства таблицы или через код:
158 -
159 -{{code language="xwiki"}}
160 -(%id="table_revenue"%)
161 -|=|=X|=Y|=Z
162 -|Q1|1.2|3.4|1.3
163 -{{/code}}
164 -
165 -Теперь создавай диаграмму к ней можно обратится:
166 -
167 -{{code language="xwiki"}}
168 -{{chart type="line" params="document:Цели.2021 год.Компания.WebHome;table:table_revenue;range:B2-B20;series:columns;" width="700"}}{{/chart}}
169 -{{/code}}
170 -
171 - В параметрах необходимо заполнить минимальные настройка:
172 -
173 -* **document** - внутренний адрес страницы, не является обязательным если табличка на той же страницы. Узнать адрес можно через меню страницы "три точки" -> "Информация"
174 -* **table** - id таблицы
175 -* **range** - колонки данных, обратите внимание что **добавляя** **новую** **строку** в таблицу **диапазон** нужно тоже **редактировать**.
176 -
177 -
Быстрый выбор форматирования.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.gav
Размер
... ... @@ -1,1 +1,0 @@
1 -78.6 KB
Содержимое
Вкладка загрузить файл.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.gav
Размер
... ... @@ -1,1 +1,0 @@
1 -28.1 KB
Содержимое
Диалог редактирования ссылки.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.gav
Размер
... ... @@ -1,1 +1,0 @@
1 -63.2 KB
Содержимое
Значек ссылки.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.gav
Размер
... ... @@ -1,1 +1,0 @@
1 -7.5 KB
Содержимое
Кнопка вставить изображение.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.gav
Размер
... ... @@ -1,1 +1,0 @@
1 -6.2 KB
Содержимое
Параметры изображения.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.gav
Размер
... ... @@ -1,1 +1,0 @@
1 -47.6 KB
Содержимое
Создание с использованием шаблона.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.gav
Размер
... ... @@ -1,1 +1,0 @@
1 -66.2 KB
Содержимое