Топ-100
 

Хранилище документов

СОДЕРЖАНИЕ

Описание таблиц "User manual"

Просмотр данных в таблицах возможен через встроенный редактор запросов для баз "SQLite"

 

Хранилище документов позволяет систематизировать документацию, инструкции по работе с разными СУБД (Oracle, PostgreSQL и другими), настройки серверов, любых других документов в виде структурированного дерева с поддержкой внутренних ссылок. Хранилище версионное, т.е. при каждом изменении документа создается новый снимок состояния.

Документация хранится в защищенном хранилище построенном на базе базы SQLite

Открытие редактора документов

Главное окно программы - Editors - Documents editor 

 
CerebroSQL: start documents editor.jpg
 
Создание узлов дерева документов
  1. Нажать кнопку "Create new key in catalog"

  2. Ввести названия узла в поле  "Value"

  3. Нажать кнопку "Save"

CerebroSQL - Create new key in catalog.j
CerebroSQL - catalog editor.jpg
 
Формирование дерева документов 

 

Создание корневых записей дерева

  1. Нажать кнопку "Insert parent in tree"

  2. В выпадающем списке "Parent name" выбрать "root line" и дважды нажать на нужную запись в поле "Parent list"

CerebroSQL - Insert parent in tree.jpg
CerebroSQL - add parent row in tree.jpg
 
Создание дочерних узлов в дереве
  1. Выбрать узел в дереве "Tree the documentation"

  2. Нажать кнопку "Insert parent the tree"

  3. Дважды нажать на нужную запись в списке "Parent list"

CerebroSQL - Insert parent in tree.jpg
CerebroSQL - Insert children in tree.jpg
 
Создание нового документа
  1. Выбрать узел в дереве "Tree the documentation"

  2. Нажать кнопку "Create new document"

  3. Заполнить поле "Caption" - имя документа, отображается в дереве

  4. Ввести текст документа

  5. Сохранить документ нажав кнопку "Save"

CerebroSQL - create new document.jpg
Дополнительные параметры документа
  1. Нажать кнопку "Parameter"

  2. Флаг "Exported" - разрешить экспорт документа

  3. Флаг "Locked" - флаг запрета на изменение.

  4. "Key list" - список ключевых слов для поиска

  5. "Information"

    1. Произвольный набор записей вида "name = value

Создание гиперссылок на другие документы

Гиперссылки служат для открытия других документов из текущего.

  1. Есть два способа получения ссылки на документ

  2. Открыть окно поиска документов (Кнопка - Search document)

  3. Выбрать нужный документ в списке

  4. Нажать кнопку "Copy link and close" - ссылка на документ будет скопирована в буфер обмена

  5. В документа выделить текст и в контекстном меню выбрать "hyperlink"

  6. В поле "Address" вставить скопированный ключ

 
 
CerebroSQL - hyperlink document.jpg
 
Просмотр версий документа
  1. Выбрать документ в дереве

  2. В основном окне раскрыть выпадающий список "Version"

  3. Выбрать старый снимок документа

  4. Документ отобразится в основном окне

CerebroSQL - document version.jpg
 
Контроль количества версий документов и их удаление

Контроль количества версий документов

Из выпадающего меню кнопки "Delete document" выбрать "Number of document versions"

CerebroSQL - number of document version.
CerebroSQL - number of document version
 
Удаление версий документов
  1. Выделить в дереве документ, версии которого необходимо удалить или директорию (запрещено удалять не пустые директории)

  2. Нажать кнопку "Delete documnet/parent row"

  3. В открывшемся мастере удаления документов установить чеки напротив документов которые необходимо удалить

  4. Нажать кнопку "Delete selected document"

  5. Статус удаления каждого документа отображается в поле "Status"

 
CerebroSQL  - delete documents.jpg
Перенос документа/узла в другой узел
  1. Выбрать документ/узел в дереве

  2. Нажать кнопку "Move document"

  3. В открывшемся окне выбрать новый узел

  4. Нажать кнопку "Move" для переноса

CerebroSQL - move document.jpg
Шаблоны документов

Создание шаблона документа

  1. Выбрать узел в дереве

  2. Нажать кнопку "Create new document"

  3. Ввести название документа в поле "Caption"

  4. Создать документ произвольной структуры

  5. Указать имя родителя шаблона (используется для группировки шаблонов в дереве, меню)

  6. Сохранить шаблон нажатием кнопки "Save document as template"

 
CerebroSQL - Example document template.jpg
 

Изменение шаблона

  1. Нажать кнопку "List template

  2. В списке шаблонов найти и выбрать шаблон который требуется изменить

  3. Нажать кнопку "Open"

  4. Не меняя значения в полях "Caption" и "Template owner" внести изменения в текст шаблона

  5. Сохранить изменения

Удаление шаблона

  1. Нажать кнопку "List template

  2. В списке шаблонов найти и выбрать шаблон который требуется удалить

  3. Нажать кнопку "Delete"