Благодарим за загрузку Database Help Framework

Если загрузка не началась автоматически, воспользуйтесь прямой ссылкой.

Быстрый старт

Database Help Framework позволяет создавать документацию баз данных SQL Server в Microsoft Excel.

Вы можете оценить примеры документации на наших проектах:

В папке workbooks вы найдете примеры рабочей книги для редактирования документации.

Для работы с книгами требуется установленный плагин SaveToDB (в бесплатной редакции).

Скачать плагин SaveToDB

Установка Database Help Framework

Для установки, обновления или удаления Database Help Framework:

  1. Разархивируйте загруженный архив в папку на локальном диске.
  2. Откройте папку setup.
  3. Запустите файл setup.exe и выберите необходимые опции установки или удаления.

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

Для редактирования документации создайте рабочую книгу:

  1. Откройте Microsoft Excel.
  2. Запустите мастер плагина SaveToDB "База данных", "Мастера", "Мастер создания книг приложений".
  3. Подключитесь к вашей базе данных и выберите книгу database_help.xlsx.

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

После ввода комментариев, сохраняйте ваши изменения кнопкой "Сохранить".

Для редактирования многострочных комментариев рекомендуем использовать редактор ячеек.
Его можно включить в меню "Настройка", "Показать редактор ячеек".

Создание выходной документации

Для создания документации используйте папки make-single-page-help и make-multiple-page-help.

Перед запуском файла make-help.cmd, измените строку подключения в файле gsqlcmd.exe.config.

Также вам потребуется изменить регулярные выражения преобразования ссылок в файле make-help.mak.

Поддержка

Если у вас есть вопросы, пишите нам на .

Будем рады!