Skip to content

Latest commit

 

History

History
66 lines (47 loc) · 6.08 KB

File metadata and controls

66 lines (47 loc) · 6.08 KB

Журнал "Интегральная философия"

Этот проект представляет собой систему публикации научного журнала "Интегральная философия", основанную на LaTeX, модульной архитектуре и автоматизированной системе сборки на базе `Make' . Цель проекта — обеспечить структурированный научный объект с семантикой, воспроизводимостью и возможностью архивирования, а не просто "хороший PDF".

Обзор проекта

Система обеспечивает полный цикл издания академического журнала, включая:

  • Модульную систему конфигурации: Каждый аспект оформления отделен в свой конфигурационный файл (cfg/).
  • Автоматическую генерацию метаданных: Скрипты и Makefile задачи помогают поддерживать актуальность метаданных.
  • Комплексную систему сборки: Makefile автоматизирует все рутинные операции, от компиляции до проверки и очистки.
  • Поддержку библиографии, глоссариев и указателей: Интегрировано с использованием biber, makeglossaries и makeindex.
  • Непрерывную компиляцию (watch): Для удобства редактирования и мгновенного просмотра изменений.

Сборка и запуск

Проект использует Make для автоматизации задач.

Основные команды

  • make или make build: Собирает финальный PDF-документ (main.pdf).
  • make watch: Запускает непрерывную компиляцию. Любые изменения в исходных файлах автоматически вызывают пересборку PDF. Используйте в отдельном терминале.
  • make view: Открывает сгенерированный main.pdf в системном просмотрщике.
  • make clean: Удаляет все временные файлы, сгенерированные в процессе компиляции, оставляя PDF.
  • make distclean: Выполняет полную очистку, включая удаление сгенерированного main.pdf.
  • make help: Отображает список всех доступных команд Make с описаниями.

Ключевые файлы и директории

  • main.tex: Основной файл документа LaTeX, который собирает все части журнала.
  • preamble.tex: Содержит общие настройки LaTeX, используемые в проекте.
  • journal.cls: Пользовательский класс документа LaTeX, определяющий стиль и макет журнала.
  • journal.yml: Конфигурация выпуска журнала в формате YAML.
  • metadata.yml: Метаданные журнала (например, название, авторы, выпуск), которые могут генерироваться автоматически.
  • references.bib: Библиографическая база данных для статей.
  • Makefile: Главный файл системы сборки, содержащий все команды автоматизации.
  • cfg/: Директория, содержащая модульные конфигурационные файлы LaTeX (например, для шрифтов, типографики, метаданных).
  • chapters/: Директория, где хранятся отдельные главы и статьи журнала.
  • scripts/: Вспомогательные скрипты, например, для генерации метаданных.
  • docs/: Документация по проекту.

Типовой рабочий процесс

  1. Начало работы: cd Journal/Main
  2. Запуск непрерывной компиляции (в отдельном терминале): make watch
  3. Редактирование: Вносите изменения в файлы .tex, .yml или .bib. PDF будет автоматически пересобираться.
  4. Проверка качества: make check (проверяет ссылки и цитирования). Также доступны make warnings, make errors, make boxes для отладки.
  5. Финальная сборка и просмотр: make build и make view.
  6. Очистка (перед коммитом/архивацией): make clean или make distclean.

Технологии и зависимости

  • LaTeX: Основной язык разметки для создания документов.
  • Biber: Используется для обработки библиографии.
  • MakeIndex/MakeGlossaries: Для создания указателей и глоссариев.
  • Make: Система автоматизации сборки.

Установка зависимостей

Вы можете проверить зависимости, выполнив make check-deps.

Команды, специфичные для журнала

  • make update-metadata: Интерактивно обновляет номер выпуска и год в файлах конфигурации.
  • make new-article: Создает новую статью из шаблона, запрашивая фамилию автора.