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

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

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

Сводка

Подробности

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