- Add\Rework UI - Add Split Table and Listing - Add Support Customazeble schems
This commit is contained in:
@@ -54,6 +54,7 @@
|
||||
Правила заголовков:
|
||||
|
||||
- Спецразделы **без номера**: `# *СОДЕРЖАНИЕ`, `# *ВВЕДЕНИЕ`, `# *ЗАКЛЮЧЕНИЕ`, `# *СПИСОК ИСПОЛЬЗОВАННЫХ ИСТОЧНИКОВ`, `# *ПРИЛОЖЕНИЯ` — ПРОПИСНЫМИ.
|
||||
- По центру в DOCX будут только «СОДЕРЖАНИЕ» и «СПИСОК…»; Введение / Заключение / ПРИЛОЖЕНИЯ — слева с отступом 1,25 см.
|
||||
- Нумерованные разделы основной части: `# 1 …`, `## 1.1 …` (или без цифр в тексте — нумерацию даст конвертер/Word; предпочтительно осмысленные названия без точки в конце).
|
||||
- В конце названия заголовка точка не ставится.
|
||||
|
||||
@@ -99,9 +100,9 @@
|
||||
| ^ | Требование 2 |
|
||||
```
|
||||
|
||||
### Диаграмма (UML / BPMN / C4)
|
||||
### Диаграмма (PlantUML / Mermaid / схемы)
|
||||
|
||||
Перед fenced-блоком с языком `uml`, `plantuml`, `bpmn` или `c4` — `%id Подпись`. Конвертер рисует PNG как **Рисунок**. Опционально `+listing` — ещё и **Листинг** с исходником.
|
||||
Перед fenced-блоком с языком `uml`, `plantuml`, `c4`, `uml-c4`, `usecase`, `bpmn` / `uml-bpmn`, `mermaid` / `mmd` и т.п. — `%id Подпись`. Конвертер рисует **Рисунок** (PNG; опционально SVG через `--diagram-format svg`). Опционально `+listing` — ещё и **Листинг** с исходником; `+landscape` — альбомная страница под широкий рисунок/таблицу. Схемы (`c4`, `bpmn`, …) берутся из `md2gost.schemes.json` (создаётся при первом запуске). Mermaid идёт через Kroki (не PlantUML). **IDEF0** не рисуется — вставляйте готовый PNG.
|
||||
|
||||
~~~markdown
|
||||
См. @Рисунок:usecase1 и @Листинг:usecase1.
|
||||
@@ -114,6 +115,28 @@ actor Student
|
||||
Student --> (Login)
|
||||
@enduml
|
||||
```
|
||||
|
||||
%arch C4 контейнеры
|
||||
|
||||
```uml-c4
|
||||
Person(user, "Студент")
|
||||
System(app, "Портал")
|
||||
Rel(user, app, "логин")
|
||||
```
|
||||
|
||||
%bpmn1 Процесс заявки
|
||||
|
||||
```bpmn
|
||||
StartMessage(s, "заявка")
|
||||
UserTask(t, "Проверить")
|
||||
XOR(gw, "ок?")
|
||||
End(e_ok)
|
||||
End(e_no)
|
||||
Flow(s, t)
|
||||
Flow(t, gw)
|
||||
CondFlow(gw, e_ok, "да")
|
||||
DefaultFlow(gw, e_no)
|
||||
```
|
||||
~~~
|
||||
|
||||
### Листинг
|
||||
@@ -170,15 +193,27 @@ $$
|
||||
```markdown
|
||||
# *ПРИЛОЖЕНИЯ
|
||||
|
||||
## Приложение А Название
|
||||
Приложение А — Листинг модуля
|
||||
Приложение Б — Графический материал
|
||||
|
||||
## Приложение А Листинг модуля
|
||||
|
||||
…
|
||||
|
||||
## Приложение Б Графический материал
|
||||
|
||||
…
|
||||
```
|
||||
|
||||
Буквы: А, Б, В, Г, Д, Е, Ж, И, К… **Нельзя:** Ё, З, Й, О, Ч, Ь, Ы, Ъ.
|
||||
- Раздел `# *ПРИЛОЖЕНИЯ` — ПРОПИСНЫМИ, **слева** (как H1), не по центру.
|
||||
- При нескольких приложениях сразу после заголовка — **перечень** основным текстом.
|
||||
- Каждое `## Приложение А Название` конвертер оформит как «Приложение А» (H3, по центру) + название следующей строкой.
|
||||
- Буквы: А, Б, В, Г, Д, Е, Ж, И, К… **Нельзя:** Ё, З, Й, О, Ч, Ь, Ы, Ъ.
|
||||
|
||||
## Оформление текста (смысловые правила markdown)
|
||||
|
||||
- Кавычки русские: «…».
|
||||
- Тире в предложениях: «—» (с пробелами). Дефис в сложных словах и диапазонах: «-» без пробелов (100-150).
|
||||
- Тире в предложениях: «—» (с пробелами). Дефис в сложных словах и диапазонах: «-» без пробелов (100-150). **Не заменяйте «—» на «-»** (в md2gost по умолчанию тире сохраняется).
|
||||
- Пробел после знака препинания, не перед ним; без пробела после «» и перед «».
|
||||
- Маркированный список: единообразный маркер; пункты со **строчной** буквы, в конце `;`, у последнего `.`.
|
||||
- Нумерованный список: с **прописной**, в конце `.`.
|
||||
|
||||
@@ -49,7 +49,7 @@
|
||||
|
||||
Листинг: `%id Название` + fenced code.
|
||||
|
||||
Диаграмма (Рисунок из PlantUML/BPMN/C4):
|
||||
Диаграмма (Рисунок из PlantUML / Mermaid / схем):
|
||||
|
||||
```
|
||||
%usecase1 Диаграмма прецедентов +listing
|
||||
@@ -62,7 +62,7 @@ User --> (Login)
|
||||
```
|
||||
```
|
||||
|
||||
Языки fence: `uml`, `plantuml`, `bpmn`, `c4`. Флаг `+listing` в строке `%` добавляет ещё Листинг с исходником.
|
||||
Языки fence: `uml`, `plantuml`, `mermaid` / `mmd`, `c4` / `uml-c4`, `usecase`, `bpmn` / `uml-bpmn` и другие id из `md2gost.schemes.json`. Mermaid — через Kroki. IDEF0 не поддерживается. Флаг `+listing` в строке `%` добавляет ещё Листинг с исходником; `+landscape` — альбомная страница.
|
||||
Ссылки: `@Рисунок:usecase1`, `@Листинг:usecase1`.
|
||||
|
||||
Формула (обычно работа №8): `$$ … $$` с `%eq_id` и ссылкой `@Формула:eq_id`.
|
||||
|
||||
Reference in New Issue
Block a user