Хранилище документов | CerebroSQL
top of page
CerebroSQL

Локальное хранилище документов

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

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

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

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

Manual general

Меню

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

Якорь 1

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

Show document editor
Якорь 2

Создание узлов дерева документов

 

  • Нажать кнопку "Create new key in catalog"

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

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

 

CerebroSQL - Create new key in catalog.j
CerebroSQL - catalog editor
Якорь 3

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

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

 

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

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

 

CerebroSQL - Insert parent in tree
CerebroSQL - add parent row in tree
Якорь 4

Создание дочерних узлов в дереве

 

  • Выбрать узел в дереве "Tree the documentation"

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

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

 

CerebroSQL - Insert parent in tree
CerebroSQL - Insert children in tree
Якорь 5

Создание нового документа

 

  • Выбрать узел в дереве "Tree the documentation"

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

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

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

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

 

CerebroSQL - create new document
Якорь 6

Дополнительные параметры документа

 

  • Нажать кнопку "Parameter"

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

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

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

  • "Information"

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

 

Якорь 7

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

 

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

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

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

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

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

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

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

CerebroSQL - hyperlink document

Просмотр версий документа

Якорь 8

 

  • Выбрать документ в дереве

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

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

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

 

CerebroSQL - document version
Якорь 9

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

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

CerebroSQL - number of document version.
CerebroSQL - number of document version
Якорь 10

Удаление версий документов

 

  • Выделить в дереве документ, версии которого необходимо удалить или директорию (запрещено удалять не пустые директории)

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

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

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

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

 

CerebroSQL  - delete documents
Якорь 11

Перенос документа/узла в другой узел

 

  • Выбрать документ/узел в дереве

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

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

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

 

CerebroSQL - move document
Якорь 12

Шаблоны документов

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

 

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

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

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

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

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

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

 

CerebroSQL - Example document template
Якорь 13

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

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

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

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

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

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

Якорь 14

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

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

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

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

bottom of page