1

docs/_build/html/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: d8d20e36a836a728d649f11811c12b21
+config: b3b22d7211beab530c4664e412cee129
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/_build/html/_sources/admin.rst.txt

@@ -1,9 +1,38 @@
 Администратор
 =============
 
+Рассмотрение Заявки на создание Устава
+--------------------------------------
+
+Права доступа
+~~~~~~~~~~~~~
+Открыто для Администратора
+
+Алгоритм
+~~~~~~~~
+	1. Пользователь выбирает раздел меню "Уставщик - Уставы".
+	2. В открывшемся окне Пользователь выбирает действие "Рассмотреть" для одного из элементов в списке Уставов, со статусом "Ожидает утверждения".
+	3. В открывшемся окне доступны для чтения поля Заявки:
+		a. Наименование 
+		b. Системное имя 
+		c. Описание 
+		d. Шаблон
+		e. Язык по умолчанию
+	4. Возможны следующие действия:
+		a. Утвердить заявку:
+			i. Создается задача на создание новой Сущности Устава с версией в статусе "Черновик", скопированной с Устава-Шаблон
+			ii. Заявке на создание Устава назначется статус "В процессе создания"
+			iii. Система возвращает сообщение об успешной инициации процесса создания сущности Устава
+			iv. По окончании процесса создания сущности Устава удаляется Заявка на создание Устава
+		b. Отклонить заявку:
+			i. Заявке на создание Устава назначется статус "Отклонена"
+
+
+Импорт / экспорт 
+----------------
 
 Экспорт Устава
---------------
+~~~~~~~~~~~~~~
 
 Права доступа
 """""""""""""
@@ -22,13 +51,14 @@
 	* 2 (Архив - date)
 	* 3 (Опубликована - date)
 	* 4 (Черновик - date)
-	, где date - дата Создания (CDate)
+
+	где date - дата Создания Версии Устава (CDate)
 3. Нажимая кнопку Экспортировать запускается алгоритм экспортирования Устава, включающего его выбранную Версию.
 4. По успешном окончании пользователю загружается xml-файл с сериализованным Уставом, имеющем одну (выбранную) Версию Устава.
 
 
 Импорт Устава
--------------
+~~~~~~~~~~~~~
 
 Права доступа
 """""""""""""
@@ -48,9 +78,6 @@
 6. По успешном окончании и сохрании Устава в БД пользователю становится доступен данный Устав.
 
 
-Импорт / экспорт Текстов
-------------------------
-
 Экспорт текстов
 ~~~~~~~~~~~~~~~
 

docs/_build/html/_sources/editor.rst.txt

@@ -2,3 +2,192 @@
 ========
 
 
+Описание
+--------
+
+Роль пользователя в системе Типикон.онлайн
+Позволяет выполнять следующие задачи:
+
+* Подача заявки на создание нового Устава 
+* Редактирование свойств Устава
+* Добавление/удаление Редакторов Устава
+* Публикация Устава
+
+
+Подача заявки на создание нового Устава
+---------------------------------------
+
+Права доступа
+~~~~~~~~~~~~~
+Открыто для Уставщика и Администратора
+
+Условия
+~~~~~~~
+Открыто для зарегистрированного пользователя
+
+Алгоритм
+~~~~~~~~~~~~~
+
+1. Пользователь выбирает раздел меню "Уставщик - Уставы".
+2. В открывшемся окне Пользователь выбирает действие "Создать новый Устав"
+3. В открывшемся окне заполняются поля:
+	a. Наименование (обязательно)
+		Отображающееся Имя Устава (многоязычное)
+	b. Системное имя (обязательно)
+		Уникальное в рамках системы имя для Устава, по которому будет усществляться доступ к расписанию для внешних систем
+	c. Описание (обязательно)
+		Описание Устава (многоязычное), более подробно описывающее Устав
+	d. Шаблон (обязательно)
+		Устав, который будет взят для основы при создании черновика создаваемого Устава
+	e. Язык по умолчанию (обязательно)
+		Язык по умолчанию при отображении расписания
+4. Пользователь выбирает действие "Создать Устав".
+5. Создается Заявка на создание Устава со статусом "Ожидает утверждения".
+6. Система возвращает сообщение об успешном завершении процесса.
+7. В случае каких-либо ошибок, система возвращает сообщение об ошибке.
+
+Для получения доступа к редактированию свойств Устава заявка должна быть утверждена Администратором системы.
+
+Удаление Заявки на создание Устава
+----------------------------------
+
+Права доступа
+~~~~~~~~~~~~~
+Открыто для Уставщика (владельца Заявки) и Администратора
+
+Условия
+~~~~~~~
+Доступно для Заявки со статусами:
+	• Ожидает утверждения
+	• Отклонена
+
+Алгоритм
+~~~~~~~~
+	1. Пользователь выбирает раздел меню "Уставщик - Уставы".
+	2. В открывшемся окне Пользователь выбирает действие "Удалить" для одного из элементов в списке Уставов, являющимся Заявкой.
+	3. Для удаления требуется подтверждение действия.
+	4. Заявка удаляется.
+	5. Система возвращает сообщение об успешном завершении процесса.
+	6. В случае каких-либо ошибок, система возвращает сообщение об ошибке.
+
+
+
+Редактирование свойств Устава
+-----------------------------
+
+Условия
+~~~~~~~
+Заявка на создание нового Устава должна быть утверждена Администратором системы.
+
+Права доступа
+~~~~~~~~~~~~~
+Открыто для Уставщика (владельца Устава и включенных в Редакторы Устава) и Администратора.
+
+Описание
+~~~~~~~~
+Для редактирования открыты свойства:
+	* Наименование
+	* Язык по умолчанию
+	* Является ли Шаблоном
+
+Алгоритм
+~~~~~~~~
+	1. Изменения сохраняются в БД.
+
+
+Редактирование переменных Устава
+--------------------------------
+
+Права доступа
+~~~~~~~~~~~~~
+Открыто для Уставщика (владельца Устава и включенных в Редакторы Устава) и Администратора.
+
+Описание
+~~~~~~~~
+В случае, если Версия Устава не является Шаблоном, то коллекция Переменных Устава открыта для того, чтобы задать им значения. В заголовке закладки должно отображаться количество переменных Устава (при их наличии публикация Устава невозможна).
+Если Версия Устава является Шаблоном, то в дополнение к возможности задать значение Перемнной Устава,
+Добавляется возможность редактирования описания Переменных Устава.
+
+Например:
+Переменная с именем [eveningservice_nosign] будет иметь описание "Время проведения вечернего богослужения для службы без знака".
+
+Алгоритмы
+~~~~~~~~~
+
+Редактирование описания
+"""""""""""""""""""""""
+	1. Изменения сохраняются в БД.
+
+Присваивание значения переменной
+""""""""""""""""""""""""""""""""
+	1. Происходит валидация вводимого значения в соответствии с типом Переменной.
+	2. Во всех Правилах из коллекции Ссылок на Правила происходит замена обозначения переменной на ее введенное значение.
+	3. Переменная удаляется.
+	4. Изменения сохраняются в БД.
+
+
+
+Редактирование вложенных коллекций Устава
+-----------------------------------------
+
+Права доступа
+~~~~~~~~~~~~~
+Открыто для Уставщика (владельца Устава и включенных в Редакторы Устава) и Администратора.
+
+Описание
+~~~~~~~~
+Редактируется версия черновика Устава, изменения вступают в силу только после публикации Устава.
+
+Для редактирования открыты свойства:
+	* Коллекция Знаков служб
+	* Коллекция Общих правил
+	* Коллекция Правил Минеи
+	* Коллекция Правил Триоди
+	* Коллекция Кафизм
+
+Алгоритм
+~~~~~~~~
+	1. Изменение/добавление/удаление сохраняются в БД.
+	2. В случае изменения Определения Знака службы/Правил производится работа с Переменными Устава:
+		a. В новом Определении находятся все указанные имена Переменных Устава
+		b. Полученная коллекция сравнивается и синхронизируется с Коллекцией Переменных Устава, связанных с этим Знаком службы/Правилом.
+	3. При изменении/добавлении/удалении свойств Устава открывается возможность публикации Устава.
+	4. Вносится запись об изменении Правила в Журнал изменений Версии Устава (не реализовано).
+	5. Производится проверка коллекции Переменных Устава. Все Переменные, на которые не ссылается ни одно Правило, удаляются.
+
+Изменение списка редакторов Устава
+----------------------------------
+
+Права доступа
+~~~~~~~~~~~~~
+Открыто для Уставщика (владельца Устава) и Администратора.
+
+Алгоритм
+~~~~~~~~~~~~~
+1.	На странице редактирования Устава Пользователь выбирает закладку «Редакторы». В случае, если Пользователь не является создателем Устава или не «Администратор», закладка недоступна.
+2.	Отображается таблица с именами Пользователей, которые являются Редакторами данного Устава. Напротив каждого имеется кнопка «Исключить», по нажатию на которую Пользователь исключается из Редакторов Устава.
+3.	Внизу таблицы находится поле для ввода. При внесении данных в поле производится поиск Пользователей, с указанным именем или электронной почтой.
+4.	При выборе Пользователя становится доступной кнопка «Добавить», по нажатию на которую Пользователь добавляется в Редакторы Устава.
+
+
+
+Публикация Устава
+-----------------
+
+Права доступа
+~~~~~~~~~~~~~
+Открыто для Уставщика (владельца Устава и включенных в Редакторы Устава) и Администратора.
+
+Условия
+~~~~~~~
+Должны быть соблюдены все условия:
+	1. Черновик должен находиться в измененном состоянии (хотя бы единожды должна быть произведена операция редактирования свойств, переменных или вложенных коллекций Устава).
+	2. Если версия Устава указана как НЕ ШАБЛОН, то должны отсутствовать Переменные Устава.
+
+
+Алгоритм
+~~~~~~~~
+	1. Идет обращение к функции Службы Typicon/Publish с указанием данных Пользователя для авторизации.
+	2. Служба возвращает сообщение об успешной инициации процесса.
+
+В случае каких-либо ошибок, Служба возвращает сообщение об ошибке.

docs/_build/html/_sources/glossary.rst.txt

@@ -0,0 +1,41 @@
+.. glossary::
+   :sorted:
+
+   Трансценденция
+      Философский термин, характеризующий то, что
+      принципиально недоступно опытному познанию
+      или не основано на опыте.
+
+   Пользователь
+      Пользователь системы.
+
+   Роль
+      Роль, назначаемая Пользователям.
+
+   Администратор
+      Роль, позволяющая редактировать Пользователей и утверждать или отклонять Заявки Пользователей.
+
+   Заявка
+      Заявленное действие Пользователей, которое требуется заверения Администратором
+
+   Уставщик
+      Роль, позволяющая создавать, редактировать и удалять Уставы
+
+   Устав
+      Корневая сущность, описывающая особенности богослужений для Шаблона Устава, храма или монастыря
+
+   Шаблон Устава
+      Предустановленный Устав, имеющий типовые характеристики богослужений
+
+   Версия Устава
+      Набор Правил для формирования последовательности богослужений. Относится к Уставу. 
+      Может быть в трех состояниях:
+         * Черновик
+         * Опубликован
+         * Архивный
+
+   Владелец Устава
+      Пользователь, создавший Устав
+
+   Редактор Устава
+      Пользователь, получивший права на редактирование Устава