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

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

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

Сводка

Подробности

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