Оглавление

Manual. Руководство пользователя

Введение

 

 

XS2™ Technology. Назначение и обзор возможностей

 

Система XS2™ (название является акронимом английской фразы "access to") является принципиально новым направлением развития технологий создания сайтов.

Система XS2™ имеет два основных отличия от систем, представленных в данном сегменте рынка в настоящее время. От множества имеющихся CMS-систем ее отличает принципиально другой подход к решению проблемы: XS2™ одновременно является и средой для разработки подобных систем, и системой управления контентом. Такой подход позволяет намного проще и оперативнее решать задачи, связанные с изменением структуры создаваемых данных. Кроме того, управляя одновременно несколькими веб-проектами, можно создавать под каждый из них свою CMS-систему, не покидая единого редакторского интерфейса.

Многие существующие CMS-системы навязывают разработчикам свою "картину мира", заставляя при планировании функциональности создаваемого сайта учитывать особенности выбранной системы. Второе важное отличие системы XS2™ заключается именно в возможности создавать системы управления контентом, максимально удобные для решения каждой отдельной задачи. Абсолютная гибкость системы XS2™ объясняется возможностью создавать произвольные типы объектов, настраивать связи между ними, а также управлять отображением объектов на сайте. При этом для решения стандартных задач (новости, каталог товаров, текстовые страницы, блоги, управление пользователями и др.) в системе предусмотрены предустановленные (общие) модули, которые также можно при необходимости модифицировать по своему усмотрению. Разработчики планируют постоянно пополнять библиотеку не только за счет собственных модулей, но и за счет лучших решений, созданных пользователями системы.

XS2™ представляет собой клиент-серверное веб-приложение, работающее на серверах под управлением Unix-подобных ОС. Управление системой осуществляется через веб-интерфейс, поддерживаемый большинством современных браузеров. При разработке системы использовалась технология популярная технология AJAX, позволяющая при выполнении многих операций избежать перезагрузки страницы, что также ускоряет процесс работы в системе.

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

вверх

 

Как работать с документацией

 

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

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

вверх

 

Условные обозначения

 

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

Обозначение Смысл
Процессор Термин в контексте определения или в таком контексте, что читатель может его перепутать со словом, имеющим иное значение.
Выберите в ветке Модули... Заголовки окон, названия пунктов меню и других элементов пользовательского интер-фейса.
Введите значение 15. Строки, вводимые пользователем с клавиатуры, отображаемые на экране, а также листинги, команды, имена файлов и каталогов.

Для того чтобы создать документ:

  1. Выберите в меню Файл...
Описание действий, выполняемых пользователем.
Заметьте... Важное замечание.
Вот хороший совет... Совет по работе с системой.
Таблица 1. Условные обозначения.

вверх

 

Комплект поставки

 

Разработчиками рекомендуется также ознакомиться со следующими документами:

вверх

 

Техническая поддержка

 

Если при использовании системы XS2™ у вас возникнут какие-либо проблемы, Вы можете обратиться за консультациями по тел. +7 (095) 585 0833 или по электронной почте: support@xs2.ru

вверх

 

1. Авторизация в системе

 

После загрузки страницы www.xs2.ru, на экране отобразится страница авторизации (рис. 1). В полях на этой странице следует ввести установленные для пользователя логин (учетная запись) и пароль.

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

Рисунок 1. Страница авторизации

вверх

 

2. Интерфейс системы

 

 

2.1. Общие сведения

 

После авторизации в системе (см. гл. 1) в браузере отобразится рабочее окно XS2™ (рис. 2).

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

Рисунок 2. Рабочее окно XS2™

В левой части экрана расположена панель управления проектами, представленная в виде иерархического дерева (рис. 3):

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

Рисунок 3. Структура панели управления

Под панелью управления, располагается область управления контентом, в которой отображаются модули и объекты текущего проекта в процессе работы с ними редактора. Подробнее о ней см. гл. 5.

Правую часть рабочего окна системы XS2™ занимает рабочая область, в которой отображается объект, выбранный в текущий момент в панели управления. При запуске системы в рабочей области отображается текст "Лицензионного соглашения".

вверх

 

2.2. Используемая терминология

 

Структура создаваемого проекта и его наполнение (данные) представлены в системе в виде объектов, которые объединяются в модули.

Объекты – это экземпляры некоторого типа, то есть элементы, хранящие порцию данных (например, папка, новость, картинка). Внутри каждого типа структура этих данных одинакова.

В системе предусмотрено два основных типа модулей:

Подробнее о работе с модулями и объектами см. гл. 4.

вверх

 

2.3. Навигация в системе

 

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

При навигации в панели управления следует учитывать следующие правила:

вверх

 

3. Работа с пользователями

 

Для того чтобы добавить нового пользователя,

  1. В ветке Проекты выберите проект, доступ к редактирования которого необходимо предоставить новому пользователю.
  2. В ветке Пользователи этого проекта выберите группу, в которую необходимо добавить нового пользователя или создайте новую группу. Группа служит для облегчения управления пользователями, принадлежность пользователя к различным группам не влияет на его права.
    Не стоит без необходимости предоставлять пользователям права администратора, это может быть небезопасно.
  3. Щелкните по названию выбранной группы правой клавишей мыши и в контекстном меню выберите пункт Добавить пользователя.
  4. После этого в рабочей области отобразится форма добавления нового пользователя. Обязательными для заполнения являются поля Логин и Пароль.
    Логин и пароль могут состоять только из маленьких букв латинского алфавита, цифр (не в начале слова) и знака подчеркивания. В случае некорректного ввода данных после сохранения данных над формой появится предупреждение.
  5. В разделе Компетенции можно указать категорию пользователя (администратор или редактор) при работе во всех доступных для него проектах и принадлежность его к различным группам.
  6. Для сохранения в системе данных о пользователе, нажмите на кнопку Сохранить.

Рисунок 4. Форма добавления нового пользователя

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

вверх

 

4. Модули и объекты

 

 

4.1. Общие сведения

 

Перед началом работы с системой следует тщательно продумать структуру создаваемого сайта. Чем тщательнее будет продуман план на этапе формирования модульной структуры, тем проще потом будет работать с ней и администраторам, и редакторам сайта.

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

Основное достоинство общих модулей заключается в том, что в них уже созданы все необходимые типы объектов, а также так называемые "скелеты" — шаблоны и процессоры с уже реализованной логикой хранения и вывода данных (см. п. 4.4).

Кроме того, разработчики XS2™ постоянно развивают функциональность общих модулей и все изменения, производящиеся со структурой объектов общего модуля, автоматически появляются во всех проектах, к которым подключен этот модуль.

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

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

вверх

 

4.2. Добавление модуля

 

Для того чтобы добавить в проект новый модуль,

  1. Щелкните правой клавишей мыши по ветке Модули данного проекта и в контекстном меню выберите пункт Добавить модуль. После этого в правой части экрана отобразится форма добавления модуля (рис. 5).
  2. В разделе Добавить модуль можно выбрать какой-либо из общих модулей. В поле Тип модуля следует указать, будет ли этот модуль использоваться как общий, либо как собственный (см. п. 4.1).
  3. Если планируется создать новый модуль, в разделе Создать модуль укажите:
    • Названия модуля - только маленькие буквы латинского алфавита, цифры (не в начале слова) и знак подчеркивания;
    • Псевдоним - название модуля, которое будет отображаться в редакторском интерфейсе;
    • Описание - произвольное описание модуля.
  4. Для сохранения модуля в системе нажмите на кнопку Создать.

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

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

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


Рисунок 5. Добавление модуля

вверх

 

4.3. Типы объектов

 

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

вверх

 

4.3.1. Добавление типа объектов

 

Для того чтобы добавить новый тип объекта,

  1. Щелкните правой клавишей мыши по названию собственного модуля, в который нужно добавить новый тип объекта, и в контекстном меню выберите пункт Добавить тип объекта. После этого в рабочей области отобразится форма создания нового типа объектов.
  2. В разделе Основные свойства типа объекта (рис. 6) укажите:
    • Название — название создаваемого типа (только маленькие буквы латинского алфавита, цифры (не в начале слова) и знак подчеркивания);
    • Псевдоним — название типа, которое будет отображаться в редакторском интерфейсе;
    • Поля сортировки — название полей создаваемого типа объекта, по которым будет осуществляться сортировка;
    • Является группой — установите этот флажок, если объекты создаваемого типа могут содержать дочерние объекты. После этого в окне отобразится список ранее созданных объектов данного модуля (рис. 7). Установите флажки рядом с теми из них, которые могут быть дочерними для объектов данного типа;
    • Учитывать время жизни — если установить этот флажок, то в свойства объектов данного типа добавятся два поля: Дата начала показа и Дата конца показа. Это свойство объекта может, например, понадобиться при отображении новостей.
    В поле Поля сортировки можно указывать также тип сортировки. Например, если при создании типа объектов "Новость", в этом поле можно сразу указать, что новости должны всегда сортироваться по дате создания, в обратном порядке (свежие новости вверху) — CDate desc. Можно указать несколько полей сортировки через запятую. Например: CDate desc, NName – в данном случае новости будут сортироваться по дате создания в обратном порядке, новости с одинаковыми датами будут сортироваться по наименованию в алфавитном порядке.
    Рисунок 6. Форма создания нового типа объектов. Основные свойства. Рисунок 7. Настройка типов дочерних объектов
  3. В разделе Дополнительные свойства типа объектов можно настроить номенклатуру и свойства полей для объектов данного типа.
    У всех типов объектов есть набор обязательных полей, которые создаются автоматически. Подробнее см. п. 4.3.2.
  4. Чтобы создать новое поле, необходимо нажать на кнопку Добавить поле. После этого под кнопкой появится новая строка (рис. 8), в котором следует задать:
    • Название - название создаваемого типа (только буквы латинского алфавита, цифры (не в начале слова) и знак подчеркивания);
    • Псевдоним - название поля, которое будет отображаться в редакторском интерфейсе;
    • Тип - выберите один из типов поля, предусмотренных системой (подробнее о типах полей (см. п. 4.3.3);
    • Значение по умолчанию - заполните это поле, если по умолчанию ему необходимо присваивать какое-либо значение;
    • Обязательное поле - установите этот флажок, если создаваемое поле должно быть обязательно для заполнения.
  5. В блоке Шаблон представления в дереве объектов можно задать шаблон для отображения объектов данного типа в дереве объектов. Для написания шаблонов используется язык Smarty ("Руководство" по этому языку поставляется отдельно). Для доступа к свойствам узла используется переменная $node. Так, если необходимо, чтобы новости в дереве объектов отображались в виде наименования и даты создания, нужно написать в поле Шаблон представления в дереве объектов следующую конструкцию: {$node.NName} – {$node.CDate}.
  6. Для сохранения созданного типа объектов нажмите на кнопку Сохранить.

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

Рисунок 8. Форма создания нового типа объектов. Дополнительные свойства.

вверх

 

4.3.2. Обязательные поля объекта

 

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

вверх

 

4.3.3. Типы полей

 

В системе XS2™ предусмотрены следующие типы полей:

вверх

 

4.4. Методы, шаблоны и процессоры

 

 

4.4.1. Общие сведения

 

Обработка данных и формирование страниц создаваемого веб-проекта определяется в методах. Методы выполняют двойную функцию: с одной стороны, это именованная пара из процессора и шаблона. С другой стороны — методы определяют структуру адресов (URL) веб-проекта.

Процессоры и шаблоны используются для вывода содержания проекта на сайте. Шаблоны представляют собой обычный HTML c вкраплениями команд языка Smarty ("Руководство" по этому языку поставляется отдельно). Процессор - это файл с кодом PHP, в котором могут подготавливаться данные для шаблона. При этом во многих случаях нет необходимости в его использовании, так как простые действия с данными не требуют отдельного файла (процессора) с кодом PHP.

Таким образом, метод - это название и файлы-шаблоны, а страницы сайта являются результатом выполнения метода. Методы можно подсоединять как ко всему проекту в целом, к конкретному модулю или к конкретному типу объектов.

Вместе с общими модулями (см. п. 4.1) к проекту подключаются их шаблоны и процессоры. Для их использования в своем проекте достаточно их отредактировать и добавить необходимый HTML-код.

вверх

 

4.4.2. Добавление, редактирование и удаление метода

 

Процедуры управления методами проекта, модуля и типа объектов абсолютно идентичны. Рассмотрим их на примере методов модуля.

вверх

 

4.4.2.1. Добавление метода

 

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

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

Значок  в полях Шаблон и Процессор означает, что для этого метода данный элемент уже загружен в систему, значок  - что этот элемент отсутствует.

Рисунок 9. Форма управления методами

Для того чтобы добавить метод к модулю,

  1. Нажмите не кнопку Добавить. После этого в рабочей области отобразится форма добавления метода (рис. 10)
  2. В этой форме заполните поля:
    • Название - название создаваемого метода (только маленькие буквы латинского алфавита, цифры (не в начале слова) и знак подчеркивания);
    • Шаблон - установите этот флажок, если необходимо настроить шаблон метода и в отобразившемся поле укажите путь к файлу шаблона;
    • Процессор - установите этот флажок, если необходимо настроить процессор для метода и в отобразившемся поле укажите путь к файлу процессора;
    Хотя бы одно из полей Шаблон или Процессор обязательно для заполнения. Следует внимательно относится к именованию методов, так как их имена отображаются в URL страниц создаваемого сайта (см. п. 4.4.3).
  3. Чтобы сохранить метод в системе, нажмите на кнопку ОК.

Рисунок 10. Форма добавления метода

вверх

 

4.4.2.2. Редактирование и удаление метода

 

Для того чтобы отредактировать свойства метода,

  1. Щелкните по значку или шаблона или процессора метода. После этого под строкой метода отобразится форма редактирования (рис. 11)
  2. Устанавливая флажки в разделах этой формы можно выполнять следующие операции:
    • Добавить - добавить процессор или шаблон (появляется только если для текущего метода еще не определен процессор или шаблон);
    • Заменить - заменить файл шаблона и/или процессора на новый;
    • Удалить - удалить шаблон и/или процессор;
    • Скачать - загрузить файл шаблона и/или процессора на жесткий диск локального компьютера;
    • Назвать - переименовать метод.
    Если одновременно удалить шаблон и процессор какого-либо метода, будет удален и сам метод.
  3. Для того чтобы сохранить произведенные операции, нажмите на кнопку ОК.

Рисунок 11. Форма редактирования метода

вверх

 

4.4.3. Система адресации

 

Чтобы избежать отображения в строке адреса (URL) страниц веб-проекта неудобочитаемых GET-параметров, в системе XS2™ реализована следующая схема адресации страниц проектов. Так как содержание каждой страницы - это результат выполнения какого-либо метода, то ее адрес в общем виде будет выглядеть следующим образом:

http://домен/модуль/объект/метод/атрибуты.htm

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

Метод может содержать строку атрибутов (в коде процессора она доступна в виде массива $_THE['PARAMS'] или {$_THE.PARAMS} в шаблоне Smarty), которая получается из фрагментов строки атрибута, соединенных точками. В нее не включаются сами точки и окончание htm, которым обязательно завершается строка атрибутов, чтобы система могла отличить ее от имени метода.

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

Приведем несколько примеров:

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

Например, необходимо сообщить шаблону, что требуется показать страницу с идентификатором 5. Передать этот параметр можно следующим образом: http://домен/articles/page/show/5.htm

В шаблоне все переданные параметры доступны в виде массива с именем {$_THE.PARAMS}. Соответственно, наш параметр 5, будет доступен в шаблоне через конструкцию $_THE.PARAMS[0] — так как это первый и единственный параметр.

Реализованная в XS2™ система адресации страниц позволяет создавать веб-проекты с легко запоминающимися адресами, которые так же повышают качество индексирования сайта поисковыми системами. Однако чтобы посетители вашего сайта могли воспользоваться этой возможностью и по достоинству ее оценить, следует внимательно относиться к системе имен модулей, объектов и методов.

вверх

 

4.5. Работа с ресурсами

 

 

4.5.1. Общие сведения

 

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

вверх

 

4.5.2. Добавление, редактирование и удаление ресурсов

 

Процедуры управления ресурсами проекта, модуля и типа объектов абсолютно идентичны. Рассмотрим их на примере ресурсов модуля.

вверх

 

4.5.2.1. Добавление ресурса

 

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

После этого в рабочей области отобразится форма управления ресурсами (рис. 12). Если для данного метода ранее были созданы ресурсы, то их список отобразится в табличном виде.

Для того чтобы добавить новый ресурс,

  1. Нажмите на кнопку Добавить. После этого на экране отобразится форма добавления ресурса (рис. 13).
  2. В этой форме укажите путь к файлу ресурса на локальном диске.
  3. Для сохранения ресурса в системе нажмите на кнопку ОК.

Рисунок 13. Форма добавления ресурса

вверх

 

4.5.2.2. Редактирование и удаление ресуса

 

Для того чтобы изменить ресурс,

  1. Щелкните мышью по названию ресурса. После этого под строкой метода отобразится форма редактирования (рис. 14).
  2. Устанавливая флажки в разделах этой формы можно выполнять следующие операции:
    • Заменить - заменить файл ресурса на новый;
    • Удалить - удалить ресурс;
    • Скачать - загрузить файл ресурса на жесткий диск локального компьютера;
    • Назвать - переименовать ресурс.
  3. Для того чтобы сохранить произведенные операции, нажмите на кнопку ОК.

Рисунок 14. Форма редактирования ресурса

вверх

 

4.5.3. Использование ресурсов

 

Для того, чтобы в шаблон при выводе данных был вставлен путь к ресурсу, необходимо в шаблоне в том месте, где должен вывестись путь, вставить следующую команду: {xs2Src mod="модуль" obj="объект" name="имя ресурса"}

Параметры команд:

вверх

 

5. Интерфейс редактора

 

 

5.1. Общие сведения

 

Если в систему XS2™ осуществляет вход пользователь, относящегося к категории редакторы (рис. 15), он может выполнять следующие операции:

Рисунок 15. Рабочее окно редактора проекта

Для того чтобы начать редактировать данные в каком-либо модуле,

  1. В панели управления в ветви Модули щелкните правой клавишей мыши по названию модуля, который необходимо загрузить для редактирования, и в контекстном ме-ню выберите пункт Загрузить. После этого дерево объектов модуля отобразится под панелью управления. Если модуль открывается на редактирование в первый раз, отобразится только его название.
  2. Выполнение большинства доступных редактору операций осуществляется через контекстное меню объектов. Всего из контекстного меню доступно выполнение четырех операций:
    • Редактировать - загрузить объект на редактирование;
    • Табличный вид - просмотреть дерево объектов модуля в табличном виде;
    • Добавить объект - добавить дочерний объект;
    • Удалить - удалить объект.

Кроме того, редактор может копировать и перемещать объекты внутри модуля.

вверх

 

5.2. Добавление объекта

 

Для того чтобы добавить новый объект,

  1. Необходимо в контекстном меню загруженного на редактирование модуля (либо его дочернего объекта) выбрать пункт Добавить объект. После этого откроется окно со списком допустимых для текущего объекта списком дочерних типов (рис. 16). Список дочерних типов определяется в процессе конструирования модуля администратором системы (см. гл. 4).
  2. Щелкните мышью по названию объекта, который необходимо добавить. После этого в рабочей области отобразится форма редактирования выбранного объекта.

Рисунок 16. Список доступных дочерних объектов

вверх

 

5.3. Табличное представление объектов

 

 

5.3.1. Общие сведения

 

Выбрав в контекстном меню пункт Табличный вид, можно перейти к отображению дерева объектов в табличном виде (рис. 17).

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

Чтобы перейти на верхний уровень, необходимо нажать на кнопку Наверх.

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

вверх

 

5.4. Редактирование объектов

 

 

5.4.1. Основные свойства объекта

 

После открытия любого объекта на редактирование, в верхней части рабочей области отображается форма редактирования основных свойств объекта (рис. 18).

В этой форме для редактирования по умолчанию доступны два поля

Кроме того, если для редактируемого типа объекта был установлен признак Учитывать время жизни (см. гл. 4), то в этой форме также будут отображаться поля Дата начала показа и Дата конца показа.

Остальные поля этой формы заполняются и изменяются системой автоматически.

Рисунок 18. Основные свойства объекта

вверх

 

5.4.2. Дополнительные свойства объекта

 

Так как номенклатура полей объекта и их тип полностью определяются администратором проекта в процессе конструирования модулей (см. гл. 4), вид объектов в каждом проекте может существенно отличаться (рис. 19).

Рисунок 19. Дополнительные свойства объекта "Товар"

Однако все объекты представляют собой комбинацию из 14 полей, которые предусмотрены в системе:

Для редактирования этих полей необходимы начальные навыки работы в веб-приложениях.

вверх