Skip to content

Процесс разработки

Anton Angelgardt edited this page Oct 18, 2024 · 4 revisions

Создание локальной копии репозитория

Fork

Clone

Branch

Все указанные команды предполагают, что консоль смотрит в корень проекта — директорию wlm-sdarp, несмотря на то, что папка проекта книги — это book. Решено не загромождать папку book файлами, не относящимися непосредственно к книге.

В шаблонах запись <smth> (<part>, , , `) подразумевает, что вместо неё будет указано соответствующее название.

dev-скрипты

Создать новое

Новый блок — часть, глава, квиз или листок — создается с помощью скрипта dev/run/new.sh вызываемого по следующим шаблонам:

  • для создания новой части
dev/run/new.sh part <part name>
  • для создания новой главы
dev/run/new.sh chapter <chapter name> <part name>
  • для создания квиза
dev/run/new.sh quiz <quiz name>
  • для создания листка
dev/run/new.sh sheet <sheet name>

Вызвать описание шаблоны команд можно с помощью dev/run/new.sh help.

Что происходит?

При создании новой части:

  • Копируется шаблон dev/_templates/part.qmd в файл book/part-<part name>.qmd
  • Создается папка для картинок book/img/part-<part name>
  • Создается папка для таблиц book/tbl/part-<part name>

Если файл с названием book/part-<part name>.qmd уже существует, новая часть создана не будет.

При создании новой главы:

  • Копируется шаблон dev/_templates/chapter.qmd в файл book/<part name>-<chapter name>.qmd
  • Создается папка для картинок book/img/<part name>-<chapter name>
  • Создается папка для таблиц book/tbl/<part name>-<chapter name>

Если в вызове команды отсутствует название главы, новая глава создана не будет.

Если файл с названием book/<part name>-<chapter name>.qmd уже существует, новая глава создана не будет.

При создании нового квиза:

  • Копируется шаблон dev/_templates/quiz.qmd в файл book/quiz-<quiz name>.qmd
  • Создается папка для картинок book/img/quiz-<quiz name>
  • Создается папка для таблиц book/tbl/quiz-<quiz name>

Если файл с названием book/quiz-<quiz name>.qmd уже существует, новый квиз создан не будет.

При создании нового листка:

  • Копируется шаблон dev/_templates/sheet.qmd в файл book/sheet-<sheet name>.qmd
  • Создается папка для картинок book/img/sheet-<sheet name>
  • Создается папка для таблиц book/tbl/sheet-<sheet name>

Если файл с названием book/quiz-<quiz name>.qmd уже существует, новый квиз создан не будет.

Отправить в архив

dev/run/archive_part.sh

dev/run/archive_chapter.sh

dev/run/archive_quiz.sh

dev/run/archive_sheet.sh