# Реферат (/docs/reference/abstract)

Реферат — это короткая витрина отчёта: по нему должно быть понятно, о чём работа, что в ней
сделано и по каким словам её потом искать. В `modern-g7-32` для этого есть функция `#abstract`:
она печатает структурный заголовок, собирает статистику документа и оформляет ключевые слова
прописными буквами.

<Callout type="success">
  Вам **не нужно** вручную считать количество страниц, иллюстраций, таблиц и источников. Шаблон автоматически соберет эту статистику со всего документа и вставит в первую строку реферата.
</Callout>

<Callout type="info">
  Оформление реферата происходит согласно с [ГОСТ 7.9](/documents/gost-7.9-95.pdf)
</Callout>

## Быстрый старт

Функция `#abstract` принимает ключевые слова (через запятую) и текст реферата (в блоке контента).

<TypstRender
  code={`
#abstract(
  "рецептура", "шоколадный торт", "кондитерские изделия", "выпечка", "дегустация"
)[
  Данный отчёт представляет разработку рецептуры шоколадного торта.
  Проведён анализ состава теста, режима выпечки и органолептических характеристик готового продукта.
]
`}
  image="abstract-example-simple.png"
/>

## Автоматизация

Шаблон автоматически формирует структуру реферата согласно разделу [6.12](#6.12.1,6.12.2,6.12.3) [ГОСТ 7.32-2017](/documents/gost-7.32-2017.pdf):

* Статистика отчёта (объём, количество таблиц, источников) генерируется автоматически
* Ключевые слова оформляются прописными буквами через запятую
* Текст реферата размещается с абзацными отступами для структурных частей

От пользователя требуется:

* Указать от 5 до 15 ключевых слов согласно [5.3.2.1](#5.3.2.1)
* Написать текст реферата объёмом до 850 знаков, отражающий требования [5.3.2.2](#5.3.2.2)

## Продвинутое использование

### Отключение статистики

Пример с отключением автоматизированной статистики  .

<TypstRender
  code={`
#abstract(count: false,
  "рецептура", "шоколадный торт", "кондитерские изделия", "выпечка", "дегустация"
)[
  Данный отчёт представляет разработку рецептуры шоколадного торта.
  Статистика документа отключена, потому что её добавят вручную после финальной сборки.
]
`}
  image="abstract-example-full.png"
/>

## Параметры функции

<TypeTable
  type={{
  keywords: {
    description: "Ключевые слова (от 5 до 15)",
    type: "...string"
  },
  count: {
    description: "Включена ли автоматизированная статистика",
    type: "boolean",
    default: "true"
  },
  body: {
    description: "Текст реферата (до 850 знаков)",
    type: "content"
  }
}}
/>

## Требования ГОСТ 7.32-2017

### Требования к структурным элементам отчета

<GostQuote page={8} id="5.3.1">
  5.3.1 Общие требования к реферату отчета о НИР — по [ГОСТ 7.9](/documents/gost-7.9-95.pdf).
</GostQuote>

<GostQuote page={8} id="5.3.2">
  5.3.2 Реферат должен содержать:

  * сведения об общем объеме отчета, количестве книг отчета, иллюстраций, таблиц, использованных источников, приложений;
  * перечень ключевых слов;
  * текст реферата.
</GostQuote>

<GostQuote page={8} id="5.3.2.1">
  5.3.2.1 Перечень ключевых слов должен включать от 5 до 15 слов или словосочетаний из текста отчета, которые в наибольшей мере характеризуют его содержание и обеспечивают возможность информационного поиска.
</GostQuote>

<GostQuote page={8} id="5.3.2.2">
  5.3.2.2 Текст реферата должен отражать:

  * объект исследования или разработки;
  * цель работы;
  * методы или методологию проведения работы;
  * результаты работы и их новизну;
  * область применения результатов;
  * рекомендации по внедрению или итоги внедрения результатов НИР;
  * экономическую эффективность или значимость работы;
  * прогнозные предположения о развитии объекта исследования.

  Если отчет не содержит сведений по какой-либо из перечисленных структурных частей реферата,
  то в тексте реферата она опускается, при этом последовательность изложения сохраняется.

  Оптимальный объем текста реферата — 850 печатных знаков, но не более одной страницы
  машинописного текста. Реферат следует оформлять в соответствии с [6.12](#6.12.1,6.12.2,6.12.3).
</GostQuote>

### Правила оформления отчёта

<GostQuote page={17} id="6.12.1">
  6.12.1 Сведения об общем объеме отчета, количестве книг отчета, иллюстраций, таблиц, использованных
  источников, приложений являются первой компонентой реферата и располагаются с абзацного отступа, в строку, через запятые.
</GostQuote>

<GostQuote page={17} id="6.12.2">
  6.12.2 Ключевые слова являются второй компонентой реферата. Они приводятся в именительном
  падеже и печатаются прописными буквами, в строку, через запятые, без абзацного отступа и переноса
  слов, без точки в конце перечня.
</GostQuote>

<GostQuote page={17} id="6.12.3">
  6.12.3 Текст реферата помещается с абзацного отступа после ключевых слов. Для выделения
  структурных частей реферата в соответствии с [5.3.2.2](#5.3.2.2) используются абзацные отступы.
</GostQuote>