Перейти к содержанию

required-element-missing

Отсутствует обязательный структурный элемент.

Категория Структура отчёта
Источник требования стандарт
Пункты ГОСТ 7.32-2017 п. 4
ГОСТ Р 2.105-2019 п. 6.1.2
Уровень по умолчанию error
Объявлено в nk.rules.structure.required_elements
Фикстуры tests/fixtures/required-element-missing/
Автоисправление нет

Проверяет наличие структурных элементов, обнаружимых по исходникам: реферата, содержания, введения, заключения и списка использованных источников. Содержание засчитывается и по команде его генерации, список источников — по окружению библиографии: заголовок ему во многих шаблонах печатает сам класс документа. Титульный лист и основная часть заголовка структурного элемента не имеют и не проверяются. Правило работает только на полном документе.

Состав задаётся параметрами: required — весь перечень целиком, excluded — что выбросить из него, не переписывая остальное. Опечатка в наименовании оставляет лишнюю находку, а не отключает проверку молча.

Почему это нарушение

Перечисленные элементы обязательны: отчёт без любого из них неполон безотносительно к качеству остального текста.

Как исправить

Добавить недостающий элемент на положенное ему место — заголовком без номера, прописными буквами.

Параметры

Параметр По умолчанию
excluded []
required ["РЕФЕРАТ", "СОДЕРЖАНИЕ", "ВВЕДЕНИЕ", "ЗАКЛЮЧЕНИЕ", "СПИСОК ИСПОЛЬЗОВАННЫХ ИСТОЧНИКОВ"]

Нарушение

\begin{document}

\section*{ВВЕДЕНИЕ}
Актуальность темы.

\section{Выбор направления исследований}
Основная часть.

\end{document}

Как правильно

\newcommand{\ssr}[1]{\section*{\centering #1}}

\begin{document}

\ssr{РЕФЕРАТ}
Отчёт 45 с., 3 рис.

\tableofcontents

\ssr{ВВЕДЕНИЕ}
Актуальность темы.

\chapter{Выбор направления исследований}
Основная часть.

\ssr{ЗАКЛЮЧЕНИЕ}
Краткие выводы.

\begin{thebibliography}{}
    \bibitem{lit1} Источник.
\end{thebibliography}

\end{document}

Настройка

Отключить правило либо изменить его уровень профилем:

disable = ["required-element-missing"]

[rules."required-element-missing"]
severity = "info"

[rules."required-element-missing".params]
excluded = []