update 0.4.4

- update документация - промт для ии полу конфигурируемый
2026-09-06 11:04:01 +03:00
parent 638fd38d7f
commit 818a044aa1
26 changed files with 1987 additions and 457 deletions
@@ -0,0 +1,58 @@
+# CLI и GUI
+
+Движок один: GUI собирает те же параметры, что и аргументы `python -m md2gost`.
+
+## Основные команды
+
+```bash
+python -m md2gost                          # GUI
+python -m md2gost --gui report.md
+python -m md2gost report.md -o out.docx --type coursework --check --strict
+python -m md2gost report.docx --check-pages   # только проверка вёрстки готового DOCX
+```
+
+Справка: `python -m md2gost -h`.
+
+## Соответствие флагов и GUI
+
+| CLI | Где в GUI | Смысл |
+|-----|-----------|--------|
+| `--type` | Основные → тип | practice, coursework, vkr, PIS_custom, APID_coursework |
+| `-o` / `--output` | Выходной DOCX | путь результата |
+| `--heading-numbering` | Основные | `manual` (цифры в md) / `auto` (Word) |
+| `--toc` | Основные | `native` (поле Word) / `manual` (собирает md2gost) |
+| `--emdash-to-hyphen` | Галочка «—» → «-» | по умолчанию выкл. |
+| `--hr-pagebreak` | Галочка --- → разрыв | по умолчанию `---` игнорируется |
+| `--title` / `--assignment` / `-t` | Настройки → Файлы | титул, задание, шаблон |
+| `--check` / `--check-only` / `--strict` | Галочки проверки ТЗ | замечания по структуре и источникам |
+| `--check-pages` | Проверить вёрстку в Word | эвристика полупустых страниц (Word + pywin32) |
+| `--table-continuation` | Основные | `word` (по умолчанию), `off`, `legacy`, `caption`, `soft` |
+| `--listing-continuation` | Основные | то же для листингов |
+| `--table-repeat-header` | Галочка | шапка на фрагментах после word-split |
+| `--plantuml-jar` / `--kroki-url` | Настройки → Диаграммы | локальный рендер |
+| `--diagram-fallback` | Диаграммы | `remote` / `local` / `off` |
+| `--diagram-format` | Диаграммы | `png` / `svg` |
+| `--diagram-scale` | Диаграммы | качество PNG PlantUML (по умолчанию 2) |
+| `--schemes` | файл схем / Шаблоны UML | путь к `md2gost.schemes.json` |
+| `--styles` | Настройки → Файлы → Стили JSON | оверлей `md2gost.styles.json` (также рядом с `.md`); см. [styles.md](styles.md) |
+| `--syntax-highlighting` | (CLI) | подсветка в листингах |
+| `--debug` | меню Дебаг | отладочные данные в документе (на одну сборку в GUI) |
+
+## Продолжение таблиц и листингов
+
+DOCX не умеет сам писать «Продолжение Таблицы N» только со 2-й страницы. Режим **`word`** (по умолчанию): после сохранения Word COM режет по реальной пагинации. Нужны Windows + Word + pywin32. Без Word: `--table-continuation off` (и то же для листингов).
+
+## Меню GUI
+
+- **Настройки → Файлы** — шаблон, титул, задание, стили JSON, выходной путь
+- **Настройки → Диаграммы** — PlantUML, Kroki, формат, кэш includes
+- **Шаблоны UML** — редактор `md2gost.schemes.json`
+- **Справка → Инструкция / Документация / Схемы / Промпт для ИИ**
+  (Документация — встроенный просмотр `docs/*.md`, вшито в exe)
+
+## Другие форматы
+
+```bash
+python -m md2fodt report.md -o report.fodt   # LibreOffice
+# PDF через LaTeX — см. md2latex/
+```