mirror of
https://github.com/StepanovPlaton/SSAUGenerator.git
synced 2026-10-31 10:18:29 +04:00
92 lines
5.4 KiB
Markdown
92 lines
5.4 KiB
Markdown
# План проекта `example`
|
||
|
||
Демонстрационный проект: показывает возможности генераторов DOCX и PPTX на одном
|
||
наборе общих ресурсов. План согласован с пользователем до начала наполнения
|
||
проекта.
|
||
|
||
## Реквизиты
|
||
|
||
| Поле | Значение |
|
||
|------|----------|
|
||
| Студент | Иванов Иван Иванович |
|
||
| Группа | 6201-090301D |
|
||
| Дисциплина | Технологии подготовки отчётных документов |
|
||
|
||
## Тема и цель
|
||
|
||
**Тема:** демонстрация возможностей генератора отчётных документов SSAU Generator.
|
||
|
||
**Цель:** показать полный набор поддерживаемых элементов оформления в одном
|
||
документе и одной презентации, собранных из Markdown-исходников.
|
||
|
||
## Структура документа (DOCX)
|
||
|
||
Файл: `content/example/example.docx`, исходники — `content/example/docx/`.
|
||
|
||
| № | Раздел | Тип (`sections`) | Файл |
|
||
|---|--------|------------------|------|
|
||
| — | Оглавление | `toc` | — |
|
||
| — | Введение | `structural` | `01-introduction.md` |
|
||
| 1 | Возможности генератора | `numbered` | `02-features.md` |
|
||
| 2 | Примеры таблиц | `numbered` | `03-tables.md` |
|
||
| — | Заключение | `structural` | `04-conclusion.md` |
|
||
| — | Список использованных источников | `bibliography` | `05-bibliography.md` |
|
||
| — | Приложение А. Демонстрационные материалы | `appendix` | `06-appendix-a.md` |
|
||
|
||
### Краткое содержание
|
||
|
||
- **Введение** — назначение документа, перечень частей и групп возможностей.
|
||
- **1 Возможности генератора** — заголовки и абзацы; списки, в том числе
|
||
многоуровневые; таблицы обычные и с подписью; рисунки (готовые PNG и схемы
|
||
PlantUML); формулы с пояснениями; примечания и определения; перекрёстные ссылки.
|
||
- **2 Примеры таблиц** — варианты оформления таблиц и подписей.
|
||
- **Заключение** — итоги демонстрации, перечень проверенных возможностей.
|
||
- **Список источников** — стандарты оформления и учебное пособие.
|
||
- **Приложение А** — сводные демонстрационные материалы, буквенная нумерация
|
||
объектов.
|
||
|
||
## Структура презентации (PPTX)
|
||
|
||
Файл: `content/example/example.pptx`, исходники — `content/example/pptx/slides/`.
|
||
|
||
| № | Слайд | Тип | Файл |
|
||
|---|-------|-----|------|
|
||
| 1 | Титульный | `title` | `00-title.md` |
|
||
| 2 | Текст и форматирование | `content` | `01-text.md` |
|
||
| 3 | Списки | `content` | `02-lists.md` |
|
||
| 4 | Таблица | `content` | `03-table.md` |
|
||
| 5 | Изображение | `content` | `04-image.md` |
|
||
| 6 | Схема PlantUML | `content` | `05-puml.md` |
|
||
| 7 | Метрики | `content` | `06-metrics.md` |
|
||
| 8 | Схема-цепочка | `content` | `07-flow.md` |
|
||
| 9 | Диаграмма | `content` | `08-chart.md` |
|
||
| 10 | Две колонки | `content` | `09-columns.md` |
|
||
| 11 | Заметки докладчика | `content` | `10-notes.md` |
|
||
| 12 | Разделитель | `section` | `11-section.md` |
|
||
| 13 | Завершающий | `final` | `12-final.md` |
|
||
|
||
### Краткое содержание
|
||
|
||
Презентация повторяет состав документа: титул, основные блоки разметки (текст,
|
||
списки, таблица, рисунок, PlantUML, метрики, схема-цепочка, диаграмма,
|
||
двухколоночная вёрстка, заметки докладчика), разделитель и финальный слайд.
|
||
|
||
## Источники (согласованы)
|
||
|
||
1. ГОСТ 7.32-2017. Отчёт о научно-исследовательской работе. Структура и правила
|
||
оформления.
|
||
2. ГОСТ Р 7.0.5-2008. Библиографическая ссылка. Общие требования и правила
|
||
составления.
|
||
3. Иванов, И. И. Оформление отчётных документов : учебное пособие. — Самара :
|
||
Изд-во Самарского университета, 2019.
|
||
4. ГОСТ 8.417-2002. Государственная система обеспечения единства измерений.
|
||
Единицы величин.
|
||
|
||
## Нюансы
|
||
|
||
- Общие ресурсы (титульный лист, задники, изображения, `.puml`) лежат в
|
||
`content/example/assets/` и используются обоими генераторами.
|
||
- Оформление — по СТО 02068410-004-2018; полужирный и курсив в документе
|
||
отключены.
|
||
- После правок исходников пересобирать `docx` и `pptx`.
|