Локальное хранилище документов
Хранилище документов позволяет систематизировать документацию, инструкции по работе с разными СУБД (Oracle, PostgreSQL и другими), настройки серверов, любых других документов в виде структурированного дерева с поддержкой внутренних ссылок. Хранилище версионное, т.е. при каждом изменении документа создается новый снимок состояния.
Документация хранится в защищенном хранилище построенном на базе базы SQLite.
Описание таблиц "User manual"
Просмотр данных в таблицах возможен через встроенный редактор запросов для баз "SQLite"
Меню
Открытие редактора документов
Главное окно программы - Editors - Documents editor
Создание узлов дерева документов
-
Нажать кнопку "Create new key in catalog"
-
Ввести названия узла в поле "Value"
-
Нажать кнопку "Save"
Формирование дерева документов
Создание корневых записей дерева
-
Нажать кнопку "Insert parent in tree"
-
В выпадающем списке "Parent name" выбрать "root line" и дважды нажать на нужную запись в поле "Parent list"
Создание дочерних узлов в дереве
-
Выбрать узел в дереве "Tree the documentation"
-
Нажать кнопку "Insert parent the tree"
-
Дважды нажать на нужную запись в списке "Parent list"
Создание нового документа
-
Выбрать узел в дереве "Tree the documentation"
-
Нажать кнопку "Create new document"
-
Заполнить поле "Caption" - имя документа, отображается в дереве
-
Ввести текст документа
-
Сохранить документ нажав кнопку "Save"
Дополнительные параметры документа
-
Нажать кнопку "Parameter"
-
Флаг "Exported" - разрешить экспорт документа
-
Флаг "Locked" - флаг запрета на изменение.
-
"Key list" - список ключевых слов для поиска
-
"Information"
-
Произвольный набор записей вида "name = value"
-
Создание гиперссылок на др угие документы
Гиперссылки служат для открытия других документов из текущего.
-
Есть два способа получения ссылки на документ
-
Открыть окно поиска документов (Кнопка - Search document)
-
Выбрать нужный документ в списке
-
Нажать кнопку "Copy link and close" - ссылка на документ будет скопирована в буфер обмена
-
В документа выделить текст и в контекстном меню выбрать "hyperlink"
-
В поле "Address" вставить скопированный ключ
Просмотр версий документа
-
Выбрать документ в дереве
-
В основном окне раскрыть выпадающий список "Version"
-
Выбрать старый снимок документа
-
Документ отобразится в основном окне
Контроль количества версий документов
Из выпадающего меню кнопки "Delete document" выбрать "Number of document versions"
Удаление версий документов
-
Выделить в дереве документ, версии которого необходимо удалить или директорию (запрещено удалять не пустые директории)
-
Нажать кнопку "Delete documnet/parent row"
-
В открывшемся мастере удаления документов установить чеки напротив документов которые необходимо удалить
-
Нажать кнопку "Delete selected document"
-
Статус удаления каждого документа отображается в поле "Status"
Перенос документа/узла в другой узел
-
Выбрать документ/узел в дереве
-
Нажать кнопку "Move document"
-
В открывшемся окне выбрать новый узел
-
Нажать кнопку "Move" для переноса
Шаблоны документов
Создание шаблона документа
-
Выбрать узел в дереве
-
Нажать кнопку "Create new document"
-
Ввести название документа в поле "Caption"
-
Создать документ произвольной структуры
-
Указать имя родителя шаблона (используется для группировки шаблонов в дереве, меню)
-
Сохранить шаблон нажатием кнопки "Save document as template"
Изменение шаблона
-
Нажать кнопку "List template"
-
В списке шаблонов найти и выбрать шаблон который требуется изменить
-
Нажать кнопку "Open"
-
Не меняя значения в полях "Caption" и "Template owner" внести изменения в текст шаблона
-
Сохранить изменения
Удаление шаблона
-
Нажать кнопку "List template"
-
В списке шаблонов найти и выбрать шаблон который требуется удалить
-
Нажать кнопку "Delete"