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

Редактировал(а) Андрей Ганьков 2025/07/14 13:35

От 14.1 до 13.1 От 24.3 до 24.2

От версии 24.2

отредактировано Андрей Ганьков
на 2025/07/14 13:17

Изменить комментарий: К данной версии нет комментариев

К версии 14.1

отредактировано Андрей Ганьков
на 2020/09/24 19:13

Изменить комментарий: Загрузить новое вложение Параметры изображения.png

Необработанный
Обработанный

Сводка

Свойства страницы (2 изменено, 0 добавлено, 0 удалено)
Вложения (0 изменено, 0 добавлено, 2 удалено)
- Диалог редактирования ссылки.png
- Значек ссылки.png

Подробности

Свойства страницы

Родительский документ

@@ -1,1 +1,1 @@
--Для пользователя.WebHome
++Инструкции.Для сисадмина.WebHome

Содержимое

@@ -1,54 +6,26 @@
--= Общие рекомендации =
--
--* Оформляйте вики однообразно. Пытаемся в месте выработать единый стиль, поэтому смотрите больше как оформлены аналогичные вещи. Если что-то не нравится в оформлении других, давайте обсуждать.
--* Увидел не точность, в документации сразу исправляй.
--
  = Использование готовых шаблонов =
--Для статей с однотипной информацией — например, описаний установленной 1С у разных клиентов, имеющих схожую структуру и набор данных — рекомендуется использовать шаблон при создании статьи.
++Для статей с однотипной информацией, например для описания 1С установленной у разных клиентов, но по сути имеющие одинаковый набор данных, для создания статьи необходимо использовать шаблон.
  Для того чтобы использовать установленный шаблон, при создании страницы его надо выбрать из шаблонов (см. снимок).
--[[image:Создание с использованием шаблона.png||data-xwiki-image-style-alignment="center"]]
++(% style="text-align:center" %)
++[[image:Создание с использованием шаблона.png]]
  (% class="wikigeneratedid" %)
  По нажатии кнопки создать. Можно приступать к заполнению данных, в подготовленной статье. При отсутствии каких то полей не стесняйтесь их добавлять.
++(% class="wikigeneratedid" %)
  = Вставить изображение в статью =
 . Устанавливаем курсор редактирования на то место в статье куда надо вставить изображение
--1. Нажимаем кнопку вставить картинку(((
--[[image:Кнопка вставить изображение.png||data-xwiki-image-style-alignment="center"]]
--
--
--)))
--1. Если изображение уже прикреплено к любой статье его можно просто выбрать в пункте "Вложение", если нет переключаемся на вкладку "Загрузка файла"(((
--[[image:Вкладка загрузить файл.png||data-xwiki-image-style-alignment="center"]]
--
--
--)))
++1. Нажимаем кнопку вставить картинку
++1. Если изображение уже прикреплено к любой статье его можно просто выбрать в пункте "Вложение", если нет переключаемся на вкладку "Загрузить файл"
 . Выбираем файл для загрузки кнопка "Обзор"
--1. Обязательно! нажимаем кнопку "Загрузить на сервер"
--1. Перескакиваем на первую вкладку. Здесь можно установить дополнительный параметры, например задать размеры, или расположение по центру.(((
--[[image:Параметры изображения.png||data-xwiki-image-style-alignment="center"]]
--
--
--)))
++1. Обязательно! нажимаем кнопку "Загрузить файл"
++1. Перескакиваем на первую вкладку. Здесь можно установить дополнительный параметры, например задать размеры, или расположение по центру.
 . "Ок" изображение вставлено в статью.
--= Работа с заголовками =
--
--**Вики и любая документация — это в первую очередь про структуру, а уже во вторую — про оформление.**
--Не используйте заголовки для изменения размера шрифта — они предназначены не для этого. Заголовки определяют логическую структуру документа: они создают иерархию разделов и блоков информации, формируют содержимое страницы в правой панели.
--
--Убедитесь, что структура заголовков логична и отражает смысловое деление текста — это поможет читателю быстро ориентироваться.
--
--Также не рекомендуется применять к заголовкам дополнительные стили, такие как усиленное жирное начертание, чтобы сохранить их единообразный и аккуратный внешний вид.
--
--{{warning}}
--После сохранения страницы содержимой правой панели не обновляется. Чтобы увидеть новую структуру,
--{{/warning}}
--
  = Работа с таблицами =
  {{info}}
@@ -70,46 +70,8 @@
  (% class="wikigeneratedid" %)
  Добавлять и удалять строки и колонки можно через меню правой кнопкой мыши.
--== Очистка любого форматирования таблиц ==
++= Дать ссылку на заголовок раздела внутри страницы =
--Часто бывает так что случайными движением мыши вставляются размеры в каждую строку таблицы или при копировании данных из Excel. Таблица вся завалена тегами форматирования, что практически убивает возможность ее удобного редактирования в виде исходника. Очистить форматирование можно, открыв исходник страницы, скопировав текст любой сервис замены по Regexp например [[этот>>https://www.freeformatter.com/regex-tester.html]]. Вставляем наш текст. Далее указываем шаблон поиска {{code language="regexp"}}\(\%.*?\%\){{/code}}. Обязательно проставляем параметр /g для тех сервисов в которых можно это указать галочкой, или добавляем его в конец выражения если галки нет. Выполняем замену на пустое место. И получаем очищенный от форматирования вариант таблицы.
--
--= Работа со ссылками =
--
--[[Официальная документация ~>~>>>https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/Features/XWikiSyntax/?syntax=2.1&section=Links]]
--
--== Внутренняя ссылка ==
--
--Внутренние ссылки, то есть ссылки на других страницы в вике, надо создавать **не копируя **полностью ссылку **из браузера**, а помощью специального формата. Это позволяет вики при переименовании страниц, корректно заменить все ссылки на новую страницу.
--
--=== Через редактирования источника ===
--
--Следующий вариант сделает ссылку на страницу в виде ее названия.
--
--{{code language="XWiki"}}
--[[Название страницы на русском]]
--{{/code}}
--
--(% class="wikigeneratedid" %)
--Дать ссылку с другим текстом можно следующим образом.
--
--{{code language="Xwiki"}}
--[[Отображаемый текст ссылки>>Название страницы на русском]]
--{{/code}}
--
--=== Из графического редактора ===
--
--Нажимаем кнопку [[image:Значек ссылки.png]] и в появившемся диалоге пишем отображаемый текст, и выбираем из списка нужную страницу.
--
--[[image:Диалог редактирования ссылки.png||data-xwiki-image-style-alignment="center"]]
--
--== Ссылка на заголовок раздела внутри страницы ==
--
--(% class="box infomessage" %)
--(((
--Если цель дать кому-то ссылку на раздел страницы в чате, то ее можно скопировать из правой панели "Содержимое".
--)))
--
  Вообще ссылка на заголовок делается на той же странице следующим кодом:
  {{code language="xwiki"}}
@@ -127,43 +127,20 @@
  Узнать какие же цифры писать в ссылке в Firefox можно следующим образом:
 . В браузере на сохраненой странице выделяем искомый заголовок, в контекстном меню вызываем исследовать элемент (или вызываем инспектор F12 и ищем заголовок в ручную)(((
--[[image:Контекстное меню на странице.png||data-xwiki-image-style-alignment="center"]]
++(% style="text-align:center" %)
++[[image:Контекстное меню на странице.png]]
  )))
 . Чуть выше выбранного span с текстом интересующего заголовка будет тег h1(((
--[[image:Выделенный span.png||data-xwiki-image-style-alignment="center"]]
++(% style="text-align:center" %)
++[[image:Выделенный span.png]]
  )))
 . Копируем значение его атрибута id через контекстное меню, это и есть наш якорь.(((
--[[image:Контекстное меню атрибута.png||data-xwiki-image-style-alignment="center"]]
++(% style="text-align:center" %)
++[[image:Контекстное меню атрибута.png]]
  )))
--
--= Работа с диаграммами =
--
--Диаграммы из графического редактора вставляются через кнопку + и выбор макроса Chart(График) или напрямую в код страницы. Детальная документация по нем у [[здесь>>https://extensions.xwiki.org/xwiki/bin/view/Extension/Chart Macro]].
--
--График может как содержать встроенную таблицу с данными так и обращаться к имеющейся таблице. Для того чтобы обратиться к имеющейся таблицы, ей нежно указать id, через меню свойства таблицы или через код:
--
--{{code language="xwiki"}}
--(%id="table_revenue"%)
--|=|=X|=Y|=Z
--|Q1|1.2|3.4|1.3
--{{/code}}
--
--Теперь создавай диаграмму к ней можно обратится:
--
--{{code language="xwiki"}}
--{{chart type="line" params="document:Цели.2021 год.Компания.WebHome;table:table_revenue;range:B2-B20;series:columns;" width="700"}}{{/chart}}
--{{/code}}
--
-- В параметрах необходимо заполнить минимальные настройка:
--
--* **document** - внутренний адрес страницы, не является обязательным если табличка на той же страницы. Узнать адрес можно через меню страницы "три точки" -> "Информация"
--* **table** - id таблицы
--* **range** - колонки данных, обратите внимание что **добавляя** **новую** **строку** в таблицу **диапазон** нужно тоже **редактировать**.
--
--

Диалог редактирования ссылки.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

Содержимое

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

Сводка

Подробности

Приложения

Навигация

Вики

Содержание