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

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

Редактировал(а) Андрей Ганьков 2025/07/14 13:35
От версии 24.6
отредактировано Андрей Ганьков
на 2025/07/14 13:20
Изменить комментарий: К данной версии нет комментариев
К версии 8.1
отредактировано Андрей Ганьков
на 2020/09/23 11:03
Изменить комментарий: Добавил про работу с таблицами.

Сводка

Подробности

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