Правила работы с XWiki
Правила находятся в процессе разработки
1 Создание Новых Страниц/Разделов
При создании страниц или разделов в вики необходимо помнить следующее:
- При создании нового раздела в поле название раздела задается ИМЯ_РАЗДЕЛА.
- По умолчанию, домашней страницей раздела с именем ИМЯ_РАЗДЕЛА является страница ИМЯ_РАЗДЕЛА.WebHome. В адресной строке браузера она представляется в виде http://<Имя_Сервера>/ИМЯ_РАЗДЕЛА/WebHome или http://<Имя_Сервера>/ИМЯ_РАЗДЕЛА/
- При создании страницы в разделе задается название страницы, которое представляет собой запись вида ИМЯ_РАЗДЕЛА.ИМЯ_СТРАНИЦЫ
- При создании новой страницы в качестве страницы родителя задается название страницы, вида ИМЯ_РАЗДЕЛА.ИМЯ_СТРАНИЦЫ (в некоторых случаях страница-родитель определяется автоматически).
- В адресной строке браузера ссылка на страницу вики представляется в виде http://<Имя_Сервера>/ИМЯ_РАЗДЕЛА/ИМЯ_СТРАНИЦЫ
- Имя страницы и Заголовок страницы не одно и тоже. Заголовок страницы задается при редактировании страницы. Имя страницы задается при ее создании.
1.1 Имя Страницы/Раздела
Для того, чтобы дальнейшая работа со страницами в вики (а именно, поиск, сортировка, установка ссылок) была легкой и удобной рекомендуем пользоваться следующими правилами для выбора имени страницы и раздела:
- Имя страницы/раздела должно быть компактным и лаконичным 1-2-3 слова (чем меньше слов и чем меньше длина, - тем лучше) и выражать суть документа.
- Не рекомендуется использовать длинные фразы, формулировки, текст из заголовка (имя страницы и заголовок - не одно и то же).
- Для названий допустимо использовать латинские буквы и русские буквы (верхнего и нижнего регистра), цифры и некоторые символы: ("A-Z", "a-z","А-я","а-я", "0-9", "_", "-")
- Для разделения слов нельзя использовать знак пробел " ", его можно заменить символом "_" (нижнее подчеркивание).
- В качестве формата для имени раздела или страницы можно использовать следующие: Word1Word2Word3, (например ITSystemProject), либо Word1_Word2_Word3
2 Вложение Файлов
Русскоязычная версия XWiki поддерживает использование русских букв в названиях файлов-вложений.
2.1 Имя Файла-Вложения
Необходимо помнить, что прикрепляемый к документу файл-вложение должен соответствовать следующим требованиям:
- Размер файла-вложения не должен превышать максимального установленного размера для файлов-вложений.
- В имени файла допустимо использовать латинские буквы и русские буквы (верхнего и нижнего регистра), цифры и некоторые символы ("A-Z", "a-z","А-я","а-я", "0-9", "_", "-")
- Имя файла не должно содержать символов пробел " ". Символы пробел " " можно заменить знаком "_" (нижнее подчеркивание).
3 Вставка Стороннего Содержимого в Страницу Вики
При редактировании страниц у пользователя имеется возможность вставить содержимое, скопированное из других источников, например, из файлов Office (MS WORD) или из других веб-страниц.
3.1 Вставка Содержимого через Визуальный WYSIWYG Редактор
Для избежания некорректной стилистической обработки (и возникновения возможных проблем с дальнейшей работой над документом), вставлять в область редактирования содержимого из сторонних источников посредством прямого копирования из буфера обмена (копирование Ctrl+C , вставка Ctrl+V) не рекомендуется.
Для вставки в редактор содержимого из файлов Office (или других источников) необходимо воспользоваться опцией "Office Content (Copy/Paste)" из раздела меню Import:
- В открывшемся диалоговом окне в область Content(Required) (содержимое, обязательное поле) вставить скопированный текст
- Галочка Filter Styles (фильтрация стилей) должна быть включена.
Использование данного метода предотвращает возможное возникновение ошибок, связанных с отображением вставленного содержимого и позволяет вести дальнешую работу с документом (редактировать, экспортировать в другие форматы и т.д)
При использовании данного метода, внешний вид (соответствие оригиналу, источнику), возможно не сохранится. Для коррекции внешнего вида (оформления), документа воспользуйтесь инструментами визуального редактора XWiki.