mirror of
https://github.com/StepanovPlaton/SSAUGenerator.git
synced 2026-10-31 10:18:29 +04:00
StepanovPlaton
bf7816ab7c
- Move projects into content/<project>/{docx,pptx} with shared assets/
- Flatten config paths; output = project name in project folder
- Add pptx --init scaffold; remove docx exe build
- Add feature-complete content/example; ignore content/* except example
- Rewrite README and AGENTS.md
105 lines
3.8 KiB
Markdown
105 lines
3.8 KiB
Markdown
# ВОЗМОЖНОСТИ ГЕНЕРАТОРА
|
||
|
||
Раздел перечисляет все поддерживаемые элементы и показывает соответствующий
|
||
синтаксис Markdown. Нумерация заголовков, рисунков, таблиц и формул выполняется
|
||
автоматически.
|
||
|
||
## Заголовки и абзацы
|
||
|
||
Заголовок раздела задаётся одним символом `#`, подраздел — двумя `##`, пункт —
|
||
тремя `###`. Обычные абзацы разделяются пустой строкой.
|
||
|
||
### Третий уровень
|
||
|
||
Полужирный и курсив в оформлении по стандарту отключены, поэтому `**жирный**` и
|
||
`*курсив*` выводятся как обычный текст.
|
||
|
||
## Списки
|
||
|
||
- первый элемент списка;
|
||
- второй элемент с вложенными пунктами:
|
||
1. вложенный элемент, выводимый как «а)»;
|
||
2. ещё один вложенный элемент.
|
||
|
||
## Таблицы
|
||
|
||
Обычная таблица (без подписи и номера):
|
||
|
||
| Столбец A | Столбец B | Столбец C |
|
||
|---|---|---|
|
||
| 1 | 2 | 3 |
|
||
| 4 | 5 | 6 |
|
||
|
||
Таблица с подписью и автоматическим номером (ссылка — @tbl:features):
|
||
|
||
::: table "Возможности оформления" id=features note="Состав приведён условно"
|
||
| Элемент | Синтаксис | Результат |
|
||
|---|---|---|
|
||
| Таблица | `::: table` | Таблица с подписью |
|
||
| Рисунок | `::: figure` | Рисунок с подписью |
|
||
| Формула | `::: formula` | Нумерованная формула |
|
||
| Примечание | `::: note` | Примечание |
|
||
| Определения | `::: definitions` | Список терминов |
|
||
:::
|
||
|
||
## Рисунки
|
||
|
||
Готовое изображение вставляется директивой `figure`; файл ищется относительно
|
||
каталога `paths.assets`. Пример — рисунок @fig:diagram:
|
||
|
||
::: figure "Готовое изображение" id=diagram file=images/diagram.png
|
||
а) функциональные блоки;
|
||
б) направления связей.
|
||
:::
|
||
|
||
Схема PlantUML рендерится автоматически из исходного файла `.puml` — рисунок
|
||
@fig:flow:
|
||
|
||
::: figure "Схема PlantUML" id=flow file=images/flow.puml
|
||
:::
|
||
|
||
## Формулы
|
||
|
||
Формула с автоматическим номером и списком пояснений:
|
||
|
||
::: formula id=efficiency
|
||
K = (T_base - T_new)/T_base
|
||
:::
|
||
|
||
::: where
|
||
K — коэффициент снижения затрат;
|
||
T_base — исходное значение показателя;
|
||
T_new — достигнутое значение показателя.
|
||
:::
|
||
|
||
Ссылка на формулу: @eq:efficiency.
|
||
|
||
## Примечания и определения
|
||
|
||
::: note
|
||
Одиночное примечание к тексту.
|
||
:::
|
||
|
||
::: notes
|
||
- первое примечание;
|
||
- второе примечание.
|
||
:::
|
||
|
||
::: definitions
|
||
Термин — краткое определение термина;
|
||
Второй термин — ещё одно определение.
|
||
:::
|
||
|
||
## Перекрёстные ссылки
|
||
|
||
Записи @fig:diagram, @tbl:features и @eq:efficiency подставляют актуальные номера
|
||
рисунка, таблицы и формулы. Ссылки на источники оформляются как [@1] или
|
||
[@2, с. 10].
|
||
|
||
## Разрыв страницы
|
||
|
||
::: pagebreak
|
||
:::
|
||
|
||
Тематический разрыв `---` также трактуется как разрыв страницы.
|