NewIndex » Учебные материалы » Руководство Пользователя

Руководство Пользователя

Изменил последним Максим Дерюгин 2010/07/09 11:35

XWikiUserManual.jpg

Оглавление

1 Общие сведения

Данное руководство предназначено для начинающих пользователей системы управления знаниями XWiki. Цель данного руководства - дать начальный объем знаний, который необходим для быстрого старта работы в системы.

Все данные (скриншоты экранов, названия меню, и др.), используемые в данном руководстве, взяты из стандартной поставки XWiki Enterprise версии 2.2.* (русифицированная версия).

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

При невозможности воспроизведения некоторых действий, описанных в данном руководстве, вы можете обратиться к Администратору Системы для выяснения причин и получения более подробной информации.

1.1 Что такое Вики?

Вики представляет собой веб-сайт, содержимое которого можно редактировать в режиме онлайн.

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

В дополнение к стандартному набору возможностей, большинство Вики систем содержат дополнительные функциональные возможности, такие как система управления правами доступа и система уведомлений.

Основное отличие Вики систем от традиционных Систем Управления Cодержимым (Content Management System, CMS) и Cистем Управления Информацией Предприятия (Enterprise Content Management systems, ECM) заключается в гибкости и простоте, с которой можно создавать новые страницы и ссылаться на них.

1.2 Для чего может быть использована Вики?

Благодаря гибкости и простоте использования, вики системы могут применяться для выполнения широкого круга задач:

  • Размещение информации по определенной тематике для общего доступа (база знаний, каталог продукции, документация) 
  • Управление проектом (планирование событий, разработка продукта, настройка нового инструмента)
  • Общение с другими людьми или сотрудниками (как веб-сайт, интранет или экстранет) 
  • Другие задачи

В основном, вики система может быть использована для создания гибкой платформы по сбору и хранению информации, доступной для других людей. Система представляется как легкая замена электронной почте, в случае, когда каждый участник может обмениваться информацией с каждым участником (отношения many-to-many), информация для обмена должна располагаться в одном источнике и быть доступной для всех участников.

1.3 Что особенного в XWiki?

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

XWiki предлагает как возможности профессиональных вики систем (мощная система управления правами доступа и пользователями), так и возможность создавать свои приложения на платформе системы. Это значит, что вы можете достаточно просто расширять текущий набор функциональных возможностей вики.

1.4 Основные функциональные возможности XWiki

  • edit_select_all.png Редактор страниц
  • edit_find_replace.png Поддержка полного жизненного цикла документа
  • document_open.png Система контроля версии документа
  • edit_redo.png Экспорт документа в различные форматы
  • mail_attachment.png Прикрепление файлов-вложений к документу
  • applications_internet.png Разделы для хранения документов
  • user_groups_management.png Управление пользователями и группами пользователей
  • system_lock_screen.png Система распределения прав
  • x_office_spreadsheet.png Интегрированная система статистики
  • black_rss.png Система уведомлений

2 Начало работы

Для начала работы с системой XWiki вам необходимо:

  1. Зарегистрироваться в системе и получить персональный логин и пароль.
    2. Ознакомиться с правилами работы в системе, а также с дополнительными регламентами  и требованиями по работе в системе (в случае использования корпоративной базы знаний, если соответствующие регламенты и требования существуют) 

Смотрите "Приложение C. Правила и рекомендации по использованию XWiki"

В некоторых случаях, самостоятельная регистрация пользователя в системе может быть не предусмотрена, т.е. Логин и Пароль учетной записи пользователя XWiki выдается непосредственно Администратором Системы. Для получения более подробной информации обратитесь к Администратору Системы.

3 Вход в систему

В зависимости от локальных настроек системы XWiki и особенностей инфраструктуры вашего предприятия (поддержка доменных имен, единая система аутентификации пользователей внутри предприятия), вам, возможно, не потребуется отдельно регистрироваться в системе XWiki и вход в систему XWiki будет осуществляться по вашей учетной записи в системе предприятия. Для получения более подробной информации обратитесь к Администратору Системы.

3.1 Основные понятия

Логин – ваше уникальное регистрационное имя, по которому система идентифицирует вас и ваши ресурсы.

Пароль – секретное слово, используемое совместно с логином, для идентификации пользователя. Пароль знаете только вы, даже администратор системы не может узнать ваш пароль, т.к. он хранится в закодированном виде без возможности декодирования.
Пароль придумывается каждым пользователем системы самостоятельно.

3.2 Безопасность системы

Для избежания кражи пароля, следуйте правилам составления пароля:

  • Пароль должен состоять из 8 - 12 символов,
  • При составлении пароля используйте только буквы английского алфавита, цифры и знаки: a-z A-Z 0-9 % ! @ $ ^ & * - _ = + | . , / ? ; :
  • В пароле не должно присутствовать знака пробела,
  • При составлении пароля избегайте часто используемые слова и сочетания. Например: имена, фамилии, год рождения, адреса, телефонные номера; слова: password, login, 123, qwertyui, zxcvbbnm; наборы одинаковых комбинаций, например: 111 или 5555 и т.п.
  • Настоятельно не рекомендуется использовать в качестве пароля ваш логин!
  • Не используйте даты,
  • Не используйте слова компьютерной терминологии, такие как, например, команды операционной системы,
  • В пароле используйте комбинации букв верхнего и нижнего регистров, цифр и символов,
  • Если вы используете слова, то сочетайте несколько слов или добавьте хотя бы одну-две цифры – это затруднит подбор.

Некоторые примеры правильных паролей:

  • nji0g2j0gj
  • af3g^vzq2
  • adqeGqe&tp1Ojf

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

  1. Придумайте ваш пароль, например: Steve Jobs,
  2. Измените чередование строчных и прописных знаков, используйте вместо пробела знак подчеркивания: stEVe_jO,
  3. Наберите этот пароль на клавиатуре, "сдвинувшись" на одну клавишу, например, вправо: dyRBr_kPnD

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

Злоумышленники могут получить ваш пароль следующими способами:

  • Через открытые ресурсы
    Если вы на жестком диске храните в текстовом файле ваш логин и пароль, следует отключить совместное использование дисков и принтеров на вашем компьютере, убрав соответствующие галочки в разделе Доступ к файлам и принтерам.
    Запишите ваши пароли в персональный блокнот и храните его в сохранном месте. Это может оказаться необходимым в случае поломки жесткого диска вашего компьютера, потери памяти или при других неприятностях.
  • Рассылка обманных писем
    Иногда злоумышленники рассылают письма пользователям якобы от имени технических служб. В письмах содержится просьба или требование прислать на указанный в письме адрес свой логин и пароль. Делается это под разными предлогами: под видом перерегистрации, для сверки данных и т.д. Не отвечайте на такие письма, т.к. система никогда не направляет в адрес своих пользователей писем подобного содержания.
  • Пароль могут подсмотреть при наборе на клавиатуре или установить программу – клавиатурный перехватчик
  • Наиболее популярный метод – подбор пароля
    Для избежания, следуйте правилам составления пароля.
  • Перехват пароля с помощью icq, e-mail и т.д.
    По этой причине настоятельно рекомендуется хранить пароль в тайне и не передавать другим лицам. Постарайтесь не передавать пару логин-пароль по открытым каналам связи (icq, e-mail, телефон, наклейки на мониторе и т.п.)

3.3 Вход в систему с помощью логина и пароля пользователя вики

  1. Получив адрес-ссылку на вики (и другие реквизиты, такие как ваш логин и пароль для входа в систему) у Администратора Системы, откройте соответствующую страницу в браузере.
    Если вход не был осуществлен ранее, щелкните  по ссылке для входа в систему "Вход" ("LOG-IN").
    При этом вы попадете в окно входа в систему, которое выглядит как показано на Рис. 3.3-1.

    Рис. 3.3-1. Авторизация логином и паролем
    XWikiLoginForm.png

  1. В поле Имя пользователя (Username) укажите свой логин (или имя пользователя).
  2. В поле Пароль (Password) укажите пароль вашей учетной записи.
  3. Поставьте галочку запомнить меня на этом компьютере (Remember me on this computer) для автоматической авторизации, если требуется.
  4. Нажмите кнопку ВХОД (LOG-IN).

3.4 Вход в систему с использованием корпоративных учетных данных пользователя

Если в вашей организации существует единая система аутентификации пользователей для доступа к различным внутренним информационным ресурсам (единая учетная запись пользователя или работника), XWiki может быть настроена таким образом, чтобы вход в систему XWiki осуществлялся на основе данных вашей учетной записи. 

Для получения более подробной информации о том, как настроена и работает система аутентификации XWiki в вашей организации, обратитесь к Администратору Системы.

4 Общий интерфейс системы

После входа в систему XWiki, вы попадете на домашнюю страницу. В зависимости от локальных настроек системы, внешний вид, а также расположение некоторых функциональных элементов, могут отличаться. Общий схематический вид домашней страницы (для стандартной поставки XWiki) представлен на Рис. 4-1.

Рис. 4-1. Общий вид домашней страницы
XWikiHomePage.png

5 Жизненный цикл документа вики

Документ (страница) представляет собой элементарную единицу информации в Вики. XWiki поддерживает полный жизненный цикл документа. Под жизненным циклом подразумевается набор действий, которые пользователь может осуществить c документом в вики, а именно:

  • Создание
  • Редактирование
  • Просмотр
  • Вывод на Печать (Экспорт)
  • Удаление
  • Копирование
  • Перемещение
  • Переименование

5.1 Создание

Для создания новой страницы можно воспользоваться следующими способами:

  • Вы можете  отредактировать существующую страницу и создать в ней ссылку на новую страницу (это можно сделать используя Wiki редактор или визуальный WYSIWYG редактор). Созданная ссылка на странице будет отмечена маркером вопроса, который означает, что страницы, на которую ведет ссылка, пока не существует. Перейдите по ссылке, чтобы создать страницу (Рис. 5.1-1.)

    Рис. 5.1-1. Создание новой страницы по ссылке
    create_page_1.png

    Данный подход к созданию новых страниц в вики является рекомендуемый, так как он позволяет создавать одновременно и страницы и навигацию.

  • Для создания страницы в текущем разделе можно воспользоваться опцией из меню, расположенного сверху страницы. Наведите указатель мыши на название текущего раздела и выберите в разворачивающемся списке "Создать Страницу" ("Create") (Рис. 5.1-2.)

    Рис. 5.1-2. Создание новой страницы в текущем разделе
    create_page_2.png

    Убедитесь в том, что заданы Имя Раздела и Имя Страницы в первом поле, добавьте название родительской страницы во второе поле. Нажмите кнопку "Создать" ("Create") и можете сразу приступить к редактированию созданной страницы.(Рис. 5.1-3.)

    Рис. 5.1-3. Форма ввода данных новой страницы
    create_page_3.png

  • Для создания страницы можно ввести название новой страницы в адресную строку браузера. Например, http://locahost:8080/xwiki/bin/view/Имя_Раздела/Имя_Страницы. Если раздела (в данном случае, Имя_Раздела) или страницы (в данном случае, Имя_Страницы) не существует в вики, вы получите сообщение о том, что данная страница не создана и предложение создать страницу перейдя по ссылке (Рис. 5.1-4.)

    Рис. 5.1-4. Сообщение о несуществующем в вики документе
    create_page_4.png

5.2 Редактирование

Редактирование позволяет вносить изменения в страницу.
Все страницы XWiki могу быть отредактированы (в случае, если имеются соответствующие права на редактирование документа). Для того, чтобы приступить к редактированию страницу, нажмите кнопку "Правка" (Edit"), которая обычно располагается в меню просматриваемой страницы (Рис. 5.2-1.)

Рис. 5.2-1. Переход в режим редактирования страницы
edit_page_1.png

5.2.1 Простой и Расширенный режимы

XWiki предоставляет два режима редактирования: Простой ("Simple") и Расширенный ("Advanced"). По умолчанию, для новых пользователей определен Простой режим редактирования. Расширенный режим используется продвинутыми пользователями, например, для написания собственных приложений в вики. Описание возможностей по разработке собственных приложений выходит за рамки данного руководства.

5.2.1.1 Возможности Простого режима

После нажатия кнопки "Правка" ("Edit") в Простом режиме редактирования, XWiki автоматически открывает документ в обычном редакторе (WYSIWYG редактор или Wiki редактор) для стандартных страниц, а для страниц, которые содержат шаблоны и формы - в редакторе для Правки Форм. В Простом режиме редактирования доступны 2 типа редактора:

5.2.1.2 Возможности Расширенного режима

Расширенный режим редактирования могут использовать только опытные пользователи (Рис. 5.2.1.2-1.)

Рис. 5.2.1.2-1. Выбор редактора
edit_page_2.png

В расширенном режиме вам доступны дополнительно следующие типы редактора:

  • Редактор вложенной Формы
  • Редактор Объекта
  • Редактор Класса
  • Редактор Управления Правами Доступа

Описание редакторов выходит за рамки данного руководства.

5.2.2 Общие действия

Все режимы редактирования имеют все или некоторые элементы, которые показаны на Рис. 5.2.2-1.

Рис. 5.2.2-1. Выбор редактора
edit_page_3.png

5.2.2.1 Несущественные изменения

Установленный флажок несущественное изменение (minor edit), говорит о том, что внесенные текущей правкой в документ изменения являются незначительными (или несущественными). К такого рода изменениям могут относиться, например: устранение орфографических ошибок, переорганизация текста, изменение форматирования. Ответственность и определение того, являются ли внесенные пользователем правки в документ несущественными или существенными целиком и полностью лежит на пользователе, который их вносит.

Напоминание: версия документа представляет собой запись формата "Число"."Число", т.е. состоит из двух чисел. Сохранение существенных правок в документе увеличит на единицу первое число в записи и сбросит второе число в записи до "1". Сохранение незначительных изменений увеличит только вторую цифру в записи версии документа.

5.2.2.2 Комментарии

Поле Комментарий (comment) позволяет оставлять небольшое пояснения к внесенным изменениям, которые будут соответствовать новой сохраненной версии документа. Он отображается у каждой версии документа в закладке История и позволяет быстро ознакомиться с историей развития документа.

5.2.2.3 Отмена внесенных изменений

Кнопка Отмена (Cancel) отменяет внесенные в ходе текущего сеанса редактирования изменения в документе и открывает его в режиме просмотра.

5.2.2.4 Предварительный просмотр

Кнопка Предварительный просмотр (Preview ) показывает, как будет выглядеть документ с учетом внесенных изменений, без сохранения в нем внесенных правок. Из режима предварительный просмотра пользователь может отменить внесенные изменения, вернуться к редактированию или сохранить изменения. Данная кнопка доступна не во всех режимах редактирования.

5.2.2.5 Сохранение изменений

Кнопка Сохранить и Продолжить (Save & Continue) сохраняет внесенные изменения и возвращает в режим редактирования.

Кнопка Сохранить и Просмотреть (Save & View) сохраняет внесенные изменения и открывает документ в режиме просмотра.

5.2.3 WYSIWYG редактор

Визуальный WYSIWYG редактор идеально подходит для начинающих пользователей или для тех, кто не хочет использовать Вики разметку.
Визуальный редактор напоминает обычный офисный текстовый редактор, в котором все внесенные изменения сразу отображаются в поле редактирования (Рис. 5.2.3-1.) 

Рис. 5.2.3-1. Визуальный WYSIWYG редактор
edit_page_4.png

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

Смотрите Приложение B. Визуальный WYSIWYG редактор для подробного изучения возможностей редактора.

5.2.4 Wiki редактор

Для работы с Wiki редактором вы должны иметь навыки использования вики.
В Wiki редакторе вам необходимо вводить текст используя Wiki форматирование (Рис. 5.2.4-1.)

Рис. 5.2.4-1. Редактор Wiki
edit_page_5.png

Смотрите Приложение A. XWiki Синтаксис для подробного изучения Синтаксиса XWiki.

Cсылка на документацию по вики разметке располагается справа в разделе Справка по синтаксису XWiki, когда используете данный режим редактирования.

5.2.5 Полноэкранный Режим Редактирования

Во время редактирования страницы как в Wiki редакторе, так и в визуальном WYSIWYG редакторе, нажатие зеленой кнопки (Рис. 5.2.5-1.), которая расположена справа сверху редактируемой области, переведет редактор в полноэкранный режим редактирования (Рис. 5.2.5-2.) Повторное нажатие кнопки переведет редактор в обычный режим редактирования.

Рис. 5.2.5-1. Кнопка перехода в полноэкранный режим
show_page_4.png

Рис. 5.2.5-2. Редактирование страницы в полноэкранном режиме
show_page_5.png

5.3 Просмотр

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

5.3.1 Код

Вы можете просмотреть содержимое (исходный код) страницы, не имея при этом возможности ее редактировать. Для этого вам нужно навести указатель мыши на раздел "Дополнительно" ("MORE ACTIONS") и выбрать "Исходный код" ("View Source") из разворачивающегося списка (Рис. 5.3.1-1.)

Рис. 5.3.1-1. Просмотр исходного кода
show_page_1.png

Эта опция доступна только в Расширенном режиме.

5.3.2 Комментарии

Любой пользователь вики может оставить комментарий к любой странице (если у него имеются соответствующие права) (Рис. 5.3.2-1.)

Рис. 5.3.2-1. Комментарии
show_page_2.png

5.3.3 Файлы

Страница может содержать вложенные файлы. Смотрите раздел Файлы-вложения.

5.3.4 История

Отображает историю изменений текущей страницы. Смотрите раздел История изменений документа.

5.4 Печать

Возможны несколько опций печати (опции могут различаться, в зависимости от локальных настроек вики):

  • Печать: вызывает функцию печати в вашем браузере для печати текущей страницы.
  • Предварительный просмотр: создает предварительно отформатированную страницу для дальнейшего вывода на печать используя функцию печати в вашем браузере (Рис. 5.4-1.)
  • Экспорт в PDF, RTF, XAR, HTML: смотрите раздел Экспорт для получения подробной информации (Рис. 5.4-2.)

Рис. 5.4-1. Предварительный просмотр
show_page_3.png

Рис. 5.4-2. Экспорт
export_1.png

5.5 Удаление

Действие удаляет страницу (Рис. 5.5-1.) Перед удалением страницы запрашивается подтверждение. Это действие необратимо, будьте осторожны при его использовании.

Рис. 5.5-1. Удаление страницы
delete_page_1.png

5.6 Копирование

Возможность копирования (Рис. 5.6-1.) страницы доступна только в Расширенном режиме.

Рис. 5.6-1. Копирование страницы
copy_page_1.png

5.7 Перенос/Переименование

В зависимости от локальных настроек вики, данное действие может быть недоступно для обычных пользователей. Для получения подробной информации обратитесь к Администратору Системы

Cмысл переименования страницы вики заключается в изменении названия страницы. После переименования вы получаете http://<server>/xwiki/bin/View/НовыйРаздел/НовоеИмяСтраницы заместо http://<server>/xwiki/bin/View/СтарыйРаздел/СтароеИмяСтраницы и все обратные ссылки на новый адрес. Это означает, что вы легко можете перемещать страницу из одного раздела вики в другой, не теряя при этом внутренние связи между страницами.

Для использование этой функции нажмите "Переименовать" в разделе меню "Дополнительно" ("More Actions") (Рис. 5.7-1.).

Рис. 5.7-1. Переименование документа
rename_page_1.png

После выбора данной опции, вам необходимо будет выбрать Имя Раздела и задать Новое Имя Страницы для выбранного документа (Рис. 5.7-2.). Для того, чтобы узнать, как правильно выбирать Имя для раздела или страницы, смотрите Приложение C. Правила и рекомендации по использованию XWiki.

Рис. 5.7-2. Новый раздел и имя страницы для документа
rename_page_2.png

Теперь вы можете размещать ссылки на страницу используя новое Название Документа.

Существует несколько замечаний, которые необходимо учитывать при осуществлении данного действия:

  • флажок для обратных ссылок (backlinks) должен быть включен (по умолчанию он включен, но если он будет снят, то обратные ссылки на документ не будут переименованы и вам придется провести процедуру заново, чтобы сохранить обратные ссылки).
  • обратные ссылки хранятся для сохраненной в базе страницы, таким образом, может случиться так, что для новой базы данных XWiki обратные ссылки не сохранятся. В этом случае, вам необходимо обратиться к Администратору Системы.

6 История изменений документа

Любые правки, внесенные в документ вики, находятся под Системой Контроля Версии. Вы можете увидеть текущую версию документа в закладке "История" ("History"), которая расположена внизу страницы. Например, версия документа, представленного на Рис. 6-1. и Рис. 6-2., составляет 3.3 и последний раз модифицировалась пользователем "Administrator":

Рис. 6-1. Автор последних изменений документа
version_control_1.png

Рис. 6-2. История изменений документа
version_control_2.png

Как показано на Рис. 6-2., версия документа состоит из двух чисел, разделенных точкой: <Существенные Изменения>.<Несущественные Изменения> (<Major>.<Minor>).Система контроля версии документа XWiki позволяет определять существенные и несущественные правки.

В процессе редактирования страницы, пользователь может определить, являются ли вносимые им правки существенными или несущественными. Сохранение правок, как существенных, увеличит первую компоненту (<Major>) в записи версии и сбросит вторую компоненту <Minor> до "1". Сохранение правок, как несущественных (флажок "несущественные изменения" включен) увеличивает вторую компоненту <Minor> на "1".

Выбрав закладку "История" ("History") в режиме просмотра документа, вы увидите все предыдущие сохраненные версии документа.

Кроме просмотра списка версий документа, закладка истории документа позволяет выполнить следующие действия:

  • сравнить две любые версии документа
  • установить более старую версию документа в качестве текущей (откат); действие доступно только для пользователей, имеющих соответствующие права на документ
  • удалить версию документа из истории (полезная опция, например, для удаления СПАМа); действие доступно только для пользователей, имеющих права администрирования

По умолчанию, несущественные правки не отображаются в истории документа. Опция "Показать несущественные правки" ("show minor edits") раскроет список всех версий документа, включая документы с несущественными правками.
 

6.1 Сравнение двух версий документа

Сравнение двух версий документа показывает различия между ними, сгруппированные в зависимости от того, на какую часть документа они влияют: содержимое, метаданные, вложения, комментарии, объекты, определение классов:

Для того, чтобы сравнить две версии документа вам нужно установить переключатель, соответствующий версии, относительно которой будет происходить сравнение. Эти переключатели расположены в колонке "С" ("From"). Далее вам нужно выбрать переключатель, соответствующий версии документа, которая будет сравниваться с уже выбранной (из колонки "С"). Эти переключатели располагаются в колонке "До" ("To"). Вы можете сравнивать документы с несущественными правками. После выбора двух версий для сравнения необходимо нажать "Сравнить выбранные версии" ("Compare selected versions"). В зависимости от внесенных в документ правок, вы получите результат, похожий на Рис. 6.1-1.

Рис. 6.1-1. Сравнение выбранных версий документа
version_control_3.png

7 Файлы-вложения

Страница (документ) вики может содержать вложенные файлы, на которые, в дальнейшем, можно будет  ссылаться со страницы. Эту функциональную возможность можно использовать, например, для того, чтобы прикрепить изображения к странице и отобразить их.

7.1 Вложение файла

Существуют несколько способов вложения файла:

7.1.1 Используя вкладку "Файлы" снизу страницы

Откройте страницу, к которой вы хотите присоединить файлы (в режиме просмотра), и выберите закладку "Файлы" ("Attachments") (Рис. 7.1.1-1.)

Рис. 7.1.1-1. Список файлов-вложений
attachements_1.png

7.1.2 Используя визуальный WYSIWYG редактор

Перейдите в режим редактирования страницы, к которой вы хотите прикрепить файл, выбрав в качестве редактора - WYSIWYG редактор. Выберите опцию "Вложенный файл" ("Attached file") в разделе "Ссылка" ("Link") в панели инструментов редактора, далее выберите "Загрузить новый файл" ("Upload new file"). Вы также можете выбрать "Вставить/Редактировать изображение" ("Insert/Edit Image") в разделе "Изображение" ("Image") в панели инструментов и нажать "Загрузить новые изображение" ("Upload new image"). Диалоговое окно представлено на Рис. 7.1.2-1.:

Рис. 7.1.2-1. Диалоговое окно для загрузки нового изображения
attachements_2.png

С помощью диалогового окна можно также создать ссылку на вложенный файл.

Смотрите Приложение А для подробного изучения возможностей редактора.

7.2 Ссылка на вложенные файл/изображение

Если вы используете визуальный WYSIWYG редактор, воспользуйтесь разделом "Ссылка" ("Link"), из списка выберите "Вложенный файл" ("Attached file") или "Изображение" ("Image"), далее выберите "Вставить изображение" ("Insert Image") в разделе "Изображение" ("Image") как показано на Рис.8.

 Дополнительную информацию по вставке ссылок, используя визуальный WYSIWYG редактор можнон найти в руководстве по визуальному WYSIWYG редактору

7.3 Ссылка на внешний файл/изображение

Если ваш файл расположен на удаленном сервере и вы хотите поставить ссылку на него с вашей страницы вики, используйте URL адрес файла в качестве содержимого вашей вики ссылки. Например, используя wiki редактор можно написать:

  • XWiki Syntax 2.0: [[текст метки>>http://адрес_удаленного_сервера/путь/к/файлу]]

Для вставки изображения, расположенного на удаленном сервере, используйте следующий фрагмент HTML-кода:

  • XWiki Syntax 2.0: image:http://адрес_удаленного_сервера/путь/к/изображению

Для изучения языка разметки смотрите Приложение Б.

8 Экспорт страниц

XWiki предоставляет возможность экспорта одной или набора страниц вики в несколько форматов. Для осуществления экспорта страницы необходимо перейти на нужную страницу, выбрать раздел "Экспорт" "Export" и формат, в котором будет представлена экспортируемая страница, как это показано на Рис. 8-1.

Рис. 8-1. Выбор формата для экспорта страницы вики
export_1.png

Для получения подробной информации о том, как одновременно экспортировать набор страниц смотрите Экспорт

9 Разделы

Раздел вики представляет собой хранилище для страниц. Другими словами, раздел - это набор страниц сгруппированных вместе под одним именем. Как вы могли заметить ранее, названия страниц в вики имеют вид: [ИМЯ_РАЗДЕЛА.ИМЯ_СТРАНИЦЫ]. Это ссылка на страницу с именем "ИМЯ_СТРАНИЦЫ", которая размещена в разделе с именем "ИМЯ_РАЗДЕЛА". Таким образом, страница вики однозначно идентифицируется по имени страницы и по имени раздела, в котором она находится.

Такой тип размещения страниц помогает организовать систематику, в которой у вас появляется возможность создавать смысловые подразделения (т.е., server.name/Wiki/XWiki). Это, в свою очередь, облегчает управление правами доступа  (Рис. 9-1.) и навигацию (Рис. 9-2.)   

Рис. 9-1. Управление правами доступа
spaces_1.png

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

Рис. 9-2. Созданные разделы в вики
spaces_2.png

9.1 Создание разделов

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

Разделы создаются неявно и автоматически, в процессе создания страницы с названием, в котором указывается имя раздела для страницы. Например, если вы разместите ссылку  NewSpace.Page на новую страницу в новом разделе и перейдете по этой ссылке для создания страницы, то раздел с именем "NewSpace" будет создан автоматически и страница с именем "Page" будет размещена внутри него. 

Вы также можете создавать разделы с домашней страницы вики выбрав в списке "Создать новый раздел" ("Create a new space"), как показано  на Рис. 9.1-1.

Рис. 9.1-1. Создание раздела в вики
spaces_3.png

Для создания раздела  можно выбрать опцию "Создать раздел" ("Space") раздела меню "XWiki" (Рис. 9.1-2.) 

Рис. 9.1-2. Создание раздела в вики из меню
spaces_4.png

Напишите название домашней страницы раздела и нажмите "Создать" ("Create") (Рис. 9.1-3.)

Рис. 9.1-3. Страница создания нового раздела
spaces_5.png

9.2 Удаление разделов

Для того чтобы удалить раздел, вам необходимо удалить все страницы, содержащиеся в данном разделе.

Для удаления страниц и разделов у вас должны иметься соответствующие права в системе.

10 Встроенные приложения XWiki

Встроенные приложения XWiki позволяют расширить существующий функционал системы и делают вашу работу в вики более простой и удобной. В данном руководстве будут рассмотрены только основные и наиболее полезные для начинающего пользователя приложения.

10.1 Поиск

search_6.png Поиск позволяет производить поиск по документам, разделам, RSS лентам и другим объектам вики.

В зависимости от локальный настроек вики, поиск можно осуществить со специальной Страницы поиска (Main.WebSearch), либо из панели поиска (Рис. 10.1-1.)

Рис. 10.1-1. Панель для быстрого поиска
search_1.png

10.1.1 Результат поиска

При отсутствии прав администрирования, результат поиска будет представлять собой список вики страниц, соответствующий критериям поиска (Рис. 10.1.1-1.)

Рис. 10.1.1-1. Результат поиска
search_2.png

При наличии прав администрирования, в результат поиска будут включены дополнительные (доступные только для администраторов) страницы.

10.1.2 Ограничение области поиска

Вы можете ограничить область поиска выбрав соответствующий раздел из раскрывающегося списка (Рис. 10.1.2-1.)

Рис. 10.1.2-1. Выбор раздела для поиска
search_3.png

Вы также можете подписаться на RSS ленту по запросу поиска и далее получать уведомления, если в списке поиска по данному запросу появятся новые документы (Рис. 10.1.2-2.)

Рис. 10.1.2-2. RSS лента по результату поиска
search_4.png

10.1.3 Поиск с использованием движка Lucene

XWiki позволяет использовать более продвинутый механизм поиска Lucene Plugin (Рис. 10.1.3-1.) Этот плагин индексирует содержимое вики и имеет некоторые преимущества по сравнению со стандартной системой поиска, а именно:

  • индексирует содержимое файлов-вложений (например, файлы PDF или MS Word ). При этом страница результата поиска не заменяется содержимым из файлов, но плагин позволяет расширить область поиска на содержимое файлов-вложений.
  • обеспечивает процентную оценку релевантности страницы (соответствие поисковому запросу).
  • обеспечивает пагинацию (разбиение результата поиска на отдельные страницы) в случае большого количества страниц в списке результата.
  • хорошо масштабируется для обработки большого числа документов в вики
  • поддерживает мультивики
  • поддерживает расширенный язык запроса

В зависимости от локальных настроек вики, Lucene Plugin может быть использован в качестве основного инструмента поиска.

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

Рис. 10.1.3-1. Результат поиска с помощью Lucene Plugin
search_5.png

Для получения подробной информации о том, какая система поиска настроена для использования по умолчанию в вашей  вики, обратитесь к Администратору Системы

10.2 Теги (метки)

tag_1.png Теги позволяют присваивать странице метки (ключевые слова), которые соответствуют основному содержимому страницы. После того, теги установлены, вы сможете осуществлять выборку страниц по соответствующим тегам или подписаться на RSS ленту по определенному тегу (в этом случае пользователь будет получать уведомление каждый раз, когда будет создана новая страница с соответствующим тегом).

Функция тегирования в XWiki позволяет добавлять ключевые слова к страницам, и отыскивать страницы с которыми ассоциированы определенные ключевые слова. Xwiki поддерживает 2 типа тегирования: структурированное, неструктурированное.

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

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

По умолчанию в XWiki используется неструктурированное тегирование, когда пользователь сам определяет ключевые слова для своего документа. Для получения более подробной информации обратитесь к Администратору Системы

10.2.1 Неструктурированное тегирование

Тип тегирования, который используется в вики по умолчанию. Добавить тег к странице (документу) вики очень просто. Использование тегов позволит вам создать свой внутренний словарь терминов в вашей вики 

Для добавления тега необходимо нажать "+" рядом со словом "Теги" внизу просматриваемой страницы (Рис. 10.2.1-1.)

Рис. 10.2.1-1. Кнопка для добавления тегов
tag_2.png

После нажатия раскроется выпадающее окно в поле ввода которого можно вводить ключевые слова, отделяя их запятой. Введите ключевые слова и нажмите "Добавить" для добавления тегов. Для отмены функции нажмите "Отмена" (Рис. 10.2.1-2.)

Рис. 10.2.1-2. Выпадающая панель для ввода тегов
tag_3.png

В процессе ввода ключевого слова может возникнуть всплывающая подсказка, которая отображает уже используемые теги, которые возможно, подойдут к вашей странице (Рис. 10.2.1-3.)

Рис. 10.2.1-3. Всплывающая подсказка по тегам
tag_4.png

Для удаления тега нажмите на крестик "X" рядом с соответствующим тегом (появляется при наведении курсора) (Рис. 10.2.1-4.)

Рис. 10.2.1-4. Удаление тега
tag_5.png

10.2.2 Структурированное тегирование

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

Подробнее о том, какой тип тегирования используется в вашей вики, вы можете узнать у Администратора Системы

10.2.3 Доступ к тегам

После того, как для некоторых страниц будут установлены теги, вы можете посмотреть список общий список тегов на странице Main.Tags (Рис. 10.2.3-1.). В зависимости от локальных настроек системы список тегов также может быть отображен на домашней странице Main.WebHome (Рис. 10.2.3-2.) или вынесен в отдельную функциональную панель (слева или справа от основной области) (Рис. 10.2.3-3.)

Рис. 10.2.3-1. Список тегов на странице тегов
tag_6.png

Рис. 10.2.3-2. Список тегов на домашней страницы
tag_7.png

Рис. 10.2.3-3. Список тегов в панели Облако тегов
tag_8.png

10.2.4 Просмотр страниц по тегу

После выбора тега из списка тегов, откроется список страниц, которые соответствуют данному тегу. В дополнение к этому, вы можете подписаться на RSS ленту для просмотра изменений по страницам, которые соответствуют выбранному тегу(Рис. 10.2.4-1.)

Рис. 10.2.4-1. Список страниц по тегу
tag_9.png

10.3 Список наблюдения

watchlist_0.png Список наблюдения позволяет пользователям сформировать персональный список наблюдения, добавив в него определенные страницы или разделы. Пользователь может подписаться на получение уведомлений по e-mail или через RSS, когда на страницах из созданного списка происходят изменения.

10.3.1 Слежение за страницами и разделами

Для того чтобы добавить текущую страницу в список наблюдения , необходимо нажать Следить за этой странией (WATCH) (Рис. 10.3.1-1.)

Рис. 10.3.1-1. Добавление страницы в персональный список наблюдения
watchlist_1.png

Когда страница добавится в список звездочка изменит цвет.
Для того, чтобы убрать текущую страницу из списка наблюдения, необходимо нажать Отменить слежение за текущей страницей (*UNWATCH*). (Рис. 10.3.1-2.)

Рис. 10.3.1-2. Убрать страницу из персонального списка наблюдения
watchlist_2.png

Для того, чтобы добавить раздел в список наблюдения, необходимо нажать Следить за разделом  (Watch space) в меню текущего раздела. (Рис. 10.3.1-3.)

Рис. 10.3.1-3. Добавление раздела в список наблюдения
watchlist_3.png

Для того, чтобы добавить всю вики в список наблюдения, необходимо нажать Следить за WIKI  (Watch Wiki) в меню вики. (Рис. 10.3.1-4.)

Рис. 10.3.1-4. Добавление вики в список наблюдения
watchlist_4.png

Для управления списком наблюдения, необходимо нажать Список наблюдения  (Watchlist) в меню пользователя. (Рис. 10.3.1-5.)

Рис. 10.3.1-5. Управление списком наблюдения
watchlist_5.png

10.3.2 Управление списком наблюдения

После нажатия кнопки Список наблюдения  (Watchlist) в меню пользователя, вы попадете на страницу управления списком наблюдения, где можно устанавливать персональные настройки (Рис. 10.3.2-1.) На странице настроек Вы можете:

  • подписаться на рассылку изменений по email. При этом можно выбрать частоту рассылки писем: Scheduler.WatchListDailyNotifier - ежедневно, Scheduler.WatchListWeeklyNotifier - еженедельно, Scheduler.WatchListHourlyNotifier - почасовая.
  • Подключиться на RSS ленту (RSS-лента последних изменений по списку наблюдения)
  • Удалить страницы или разделы разделы из списка.

Рис. 10.3.2-1. Управление списком наблюдения
watchlist_6.png

11 Приложение A. XWiki Синтаксис

Сморите XWiki Синтаксис - основы

12 Приложение B. Визуальный WYSIWYG редактор

Смотрите Визуальный WYSIWYG редактор.

13 Приложение C. Правила и рекомендации по использованию XWiki

Смотрите Правила использования

14 Приложение D. Встроенные макросы XWiki

Смотрите Полезные Макросы


This wiki is licensed under a Creative Commons 2.0 license
XWiki Enterprise 2.7-comsoft-5 - Documentation