Работа с документацией в 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"]]

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

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

59

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

60

61

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

62

63

64

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

65

66

67

(% class="wikigeneratedid" %)

68

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

69

70

71

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

72

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

73

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

74

75

76

(% class="wikigeneratedid" %)

77

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

78

79

(% class="wikigeneratedid" %)

80

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

81

82

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

83

84

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

85

86

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

87

88

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

89

90

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

91

92

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

93

94

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

95

96

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

97

98

99

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

100

101

102

(% class="wikigeneratedid" %)

103

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

104

105

106

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

107

108

109

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

110

111

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

112

113

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

114

115

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

116

117

(% class="box infomessage" %)

118

(((

119

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

120

)))

121

122

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

123

124

125

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

126

127

128

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

129

130

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

131

132

133

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

134

135

136

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

137

138

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

139

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

)))

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

144

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

)))

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

149

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

)))

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

155

156

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

157

158

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

159

160

161

(%id="table_revenue"%)

|=|=X|=Y|=Z

|Q1|1.2|3.4|1.3

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

167

168

169

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

170

171

172

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

173

174

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

175

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

176

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

177

178

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