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

= Общие рекомендации =

* Оформляйте вики однообразно. Пытаемся в месте выработать единый стиль, поэтому смотрите больше как оформлены аналогичные вещи. Если что-то не нравится в оформлении других, давайте обсуждать.

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"]]

)))

1. Если изображение уже прикреплено к любой статье его можно просто выбрать в пункте "Вложение", если нет переключаемся на вкладку "Загрузка файла"(((

26

[[image:Вкладка загрузить файл.png||data-xwiki-image-style-alignment="center"]]

)))

1. Выбираем файл для загрузки кнопка "Обзор"

31

1. Обязательно! нажимаем кнопку "Загрузить на сервер"

32

1. Перескакиваем на первую вкладку. Здесь можно установить дополнительный параметры, например задать размеры, или расположение по центру.(((

33

[[image:Параметры изображения.png||data-xwiki-image-style-alignment="center"]]

)))

1. "Ок" изображение вставлено в статью.

38

39

= Работа с заголовками =

40

41

**Вики и любая документация — это в первую очередь про структуру, а уже во вторую — про оформление.**

42

Не используйте заголовки для изменения размера шрифта — они предназначены не для этого. Заголовки определяют логическую структуру документа: они создают иерархию разделов и блоков информации, формируют содержимое страницы в правой панели.

43

44

Убедитесь, что структура заголовков логична и отражает смысловое деление текста — это поможет читателю быстро ориентироваться.

45

46

47

После сохранения страницы содержимой правой панели не обновляется. Чтобы увидеть новую структуру, иногда надо обновить страницу вручную F5.

48

49

50

Также не рекомендуется применять к заголовкам дополнительные стили, такие как усиленное жирное начертание, чтобы сохранить их единообразный и аккуратный внешний вид.

51

52

Заголовки удобно выбирать если вы начинаете новый абзац с символа "/", возникает всплывающее меню, в котором можно выбрать уровень заголовка. Кстати так можно вводить не только заголовки.

53

54

[[image:Быстрый выбор форматирования.png||data-xwiki-image-style-alignment="center"]]

= Работа с тегами =

**Теги — это дополнительный уровень систематизации информации в вики, дополняющий основную структуру расположения страниц.**

59

Каждая страница может содержать несколько тегов, описывающих её содержание. Например, если на сервере установлен Apache и страница помечена соответствующим тегом, то по тегу //Apache// легко найти все серверы с установленным Apache — даже если они находятся в разных разделах и относятся к разным клиентам.

60

61

Во многих верхнеуровневых страницах размещается виджет **«Облако тегов»**, который позволяет:

62

— быстро понять, какие теги используются в данном разделе;

63

— найти нужные страницы по теме, кликнув на соответствующий тег.

64

65

= Работа с таблицами =

66

67

68

Пожалуйста без надобности не меняйте размеры колонок вручную, табличка сама подстроит размеры колонок под содержимое и экран пользователя. Установив фиксированные размеры под свой экран, не даст возможность отображать адекватно таблицу на мобильных устройствах. Так же установка размеров пропишет в каждой ячейки атрибут ~(% style="width:180px" %) что значительно усложняет читаемость и редактирование таблицы в вики разметке.

69

70

71

(% class="wikigeneratedid" %)

72

В вики разметке таблица выглядит так:

73

74

75

|= Заголовок колонки 1 |= Заголовок колонки 2 |= Заголовок колонки 3

76

|Строка 1 ячека 1| Строка 1 ячека 2| Строка 1 ячека 3

77

|Строка 2 ячека 1| Строка 2 ячека 2| Строка 2 ячека 3

78

79

80

(% class="wikigeneratedid" %)

81

Достаточно просто, поэтому иногда удобнее работать с табличками в вики разметке. Чтобы переключится в момент редактирования на вики разметку, нужно нажать кнопку "Источник" на панели редактирования.

82

83

(% class="wikigeneratedid" %)

84

Добавлять и удалять строки и колонки можно через меню правой кнопкой мыши.

85

86

== Очистка любого форматирования таблиц ==

87

88

Часто бывает так что случайными движением мыши вставляются размеры в каждую строку таблицы или при копировании данных из Excel. Таблица вся завалена тегами форматирования, что практически убивает возможность ее удобного редактирования в виде исходника. Очистить форматирование можно, открыв исходник страницы, скопировав текст любой сервис замены по Regexp например [[этот>>https://www.freeformatter.com/regex-tester.html]]. Вставляем наш текст. Далее указываем шаблон поиска {{code language="regexp"}}\(\%.*?\%\){{/code}}. Обязательно проставляем параметр /g для тех сервисов в которых можно это указать галочкой, или добавляем его в конец выражения если галки нет. Выполняем замену на пустое место. И получаем очищенный от форматирования вариант таблицы.

89

90

= Работа со ссылками =

91

92

[[Официальная документация ~>~>>>https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/Features/XWikiSyntax/?syntax=2.1&section=Links]]

93

94

== Внутренняя ссылка ==

95

96

Внутренние ссылки, то есть ссылки на других страницы в вике, надо создавать **не копируя **полностью ссылку **из браузера**, а помощью специального формата. Это позволяет вики при переименовании страниц, корректно заменить все ссылки на новую страницу.

97

98

=== Через редактирования источника ===

99

100

Следующий вариант сделает ссылку на страницу в виде ее названия.

101

102

103

[[Название страницы на русском]]

104

105

106

(% class="wikigeneratedid" %)

107

Дать ссылку с другим текстом можно следующим образом.

108

109

110

[[Отображаемый текст ссылки>>Название страницы на русском]]

111

112

113

=== Из графического редактора ===

114

115

Нажимаем кнопку [[image:Значек ссылки.png]] и в появившемся диалоге пишем отображаемый текст, и выбираем из списка нужную страницу.

116

117

[[image:Диалог редактирования ссылки.png||data-xwiki-image-style-alignment="center"]]

118

119

== Ссылка на заголовок раздела внутри страницы ==

120

121

(% class="box infomessage" %)

122

(((

123

Если цель дать кому-то ссылку на раздел страницы в чате, то ее можно скопировать из правой панели "Содержимое".

124

)))

125

126

Вообще ссылка на заголовок делается на той же странице следующим кодом:

127

128

129

[[разделе по смене пароля>>||anchor="HTitle"]]

130

131

132

Где Title название самого заголовка.

133

134

Но это работает только для английских заголовков. Для русских Title выглядит иначе. Например так "H42143C43543D43043F43044043E43B44F" для заголовка "Смена пароля".

135

136

137

[[разделе по смене пароля>>||anchor="H42143C43543D43043F43044043E43B44F"]]

138

139

140

Узнать какие же цифры писать в ссылке в Firefox можно следующим образом:

141

142

1. В браузере на сохраненой странице выделяем искомый заголовок, в контекстном меню вызываем исследовать элемент (или вызываем инспектор F12 и ищем заголовок в ручную)(((

143

[[image:Контекстное меню на странице.png||data-xwiki-image-style-alignment="center"]]

)))

1. Чуть выше выбранного span с текстом интересующего заголовка будет тег h1(((

148

[[image:Выделенный span.png||data-xwiki-image-style-alignment="center"]]

)))

1. Копируем значение его атрибута id через контекстное меню, это и есть наш якорь.(((

153

[[image:Контекстное меню атрибута.png||data-xwiki-image-style-alignment="center"]]

)))

= Работа с диаграммами =

159

160

Диаграммы из графического редактора вставляются через кнопку + и выбор макроса Chart(График) или напрямую в код страницы. Детальная документация по нем у [[здесь>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Chart Macro]].

161

162

График может как содержать встроенную таблицу с данными так и обращаться к имеющейся таблице. Для того чтобы обратиться к имеющейся таблицы, ей нежно указать id, через меню свойства таблицы или через код:

163

164

165

(%id="table_revenue"%)

|=|=X|=Y|=Z

|Q1|1.2|3.4|1.3

Теперь создавай диаграмму к ней можно обратится:

171

172

173

{{chart type="line" params="document:Цели.2021 год.Компания.WebHome;table:table_revenue;range:B2-B20;series:columns;" width="700"}}{{/chart}}

174

175

176

В параметрах необходимо заполнить минимальные настройка:

177

178

* **document** - внутренний адрес страницы, не является обязательным если табличка на той же страницы. Узнать адрес можно через меню страницы "три точки" -> "Информация"

179

* **table** - id таблицы

180

* **range** - колонки данных, обратите внимание что **добавляя** **новую** **строку** в таблицу **диапазон** нужно тоже **редактировать**.

181

182

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