Skip to content

YARD.md

Latest commit

 

History

History
169 lines (120 loc) · 10.6 KB

YARD.md

File metadata and controls

169 lines (120 loc) · 10.6 KB

Описание языка разметки ЯРД

Введение

ЯРД (Язык Разметки Документов) - язык разметки для формирования документов, на основе шаблонов. Основная задача создания ЯРДа - сделать язык разметки простой для понимания как HTML, но комплексный и гибкий как LaTeX для российской аудитории, удобный для русской раскладки.

// ?

1. Переменные

Переменные хранят строковое значение которое можно использовать в тексте (за исключением класса документа), тогда на выходе значение переменной подставится вместо её имени. Инициализация переменных происходит ДО описания контента документа. Переменные не имеют различия в типах, не требуют их спецификации и их значения являются строками по умолчанию.

  • Инициализация переменной: !*имя переменной* *строковое значение*

  • Пример инициализации: !я Студент ДИПРБ-41

  • Использование переменной: %-*имя переменной*

  • Пример использованя: %-проверяющий

// ?

1.1. Глобальные переменные

Глобальные переменные не зависят от выбранного шаблона и являются допустимыми/обязательными для использования в любом документе, начинаются с символа "!" и разделяются символом '\n' (нажатием Enter). Они используются для обозначения важной информации документа и могут не отражаться во внешнем виде документа (если не были использованы в качестве переменной).

1.1.1 Класс документа

  • ПЕРЕМЕННАЯ: !класс
  • Определение: определяет шаблон документа, иначе говоря определяет стиль форматирования
  • Использование: !класс ВКР

1.1.2 Автор

  • ПЕРЕМЕННАЯ: !автор
  • Определение: автор документа
  • Использование: !автор Сафонов А.Д.

1.1.3 Дата

  • ПЕРЕМЕННАЯ: !дата
  • Определение: задаёт дату написания документа (может отображаться в самом документе), НЕ связанную с датой редактирования или создания документа
  • Использование: !дата 22.01.2024

1.1.4 Название

  • ПЕРЕМЕННАЯ: !название
  • Определение: название документа, отражается в названии файла и может использоваться как переменная
  • Использование: !название 333я версия записки КП

2. Тэги

Тэги являются спецификаторами, выделяющие различные структурные элементы текста, в зависимости от тэга текст будет иметь различные характеристики форматирования (шрифт, кегль и т.п.).

При этом тэги могут быть:

  • Однострочными (например раздел, подраздел) - тогда они не требуют закрывающего тэга
  • Многострочными (например список, параграф) - тогда они требуют закрывающий тэг

2.1 Тэги шаблонов КП/ВКР/ЛР

2.1.1 Разделы

  • Определение: первая ступень деления, должны иметь заголовки и порядковые номера и начинаться с новой страницы
  • Шрифт: Times New Roman, 12 пт., полужирный
  • Форматирование: по центру, отступ - нет, интервал после 18 пт, междустрочный интервал - одинарный, все буквы капсом
  • ТЭГ: \раздел или \з1
  • Использование: \раздел Техническое задание или \з1 Техническое задание

2.1.2 Подразделы

  • Определение: вторая ступень деления, должны иметь нумерацию состоящую из номера раздела и номера подзраздела, разделённых точкой
  • Шрифт: Times New Roman, 12 пт, полужирный
  • Форматирование: по левому краю, отступ первой строки 0,5 см, междустрочный интервал - одинарный, отступы перед и после - 12 пт
  • ТЭГ: \праздел или \з2
  • Использование: \праздел Анализ предметной области или \з2 Анализ предметной области

2.1.3 Пункт

  • Определение: часть раздела или подраздела, обозначенная номером, может иметь заголовок. включает номер раздела подраздела и порядковый номер пункта.
  • Шрифт: Times New Roman, 12 пт, полужирный
  • Форматирование: по левому краю, отступ первой строки 0,75 см, междустрочный инт. - одинарный, отступы перед и после - 6 пт
  • ТЭГ: \пункт или \з3
  • Использование: \з3 Матрица

2.1.4 Подпункт

  • Определение: часть пункта, обозначенная номером может иметь заголовок, включает номер раздела пункта и порядковый номер
  • Шрифт: Times New Roman, 12 пт, полужирный
  • Форматирование: по левому краю, отступ первой строки 1,0 см, междустрочный инт. - одинарный, отступы перед и после - 6 пт
  • ТЭГ: \ппункт или \з4
  • Использование: \з4 Умножение матриц

2.1.5 Абзац

  • Определние: логически выделенная часть текста, не имеющая номера.
  • Шрифт: Times New Roman, 12 пт
  • Форматирование: по ширине листа, нулевые интервалы после и перед абзацем, междустрочный интервал 1,5
  • ТЭГ: \а
  • Использование: \a Lorem ipsum... или Lorem ipsum...
  • Внимание: Текст, находящийся в документе и не являющийся переменной, который не имеет тэга будет считываться как Абзац

2.1.6 Перечисление

  • Определение: содержащиеся в тексте пункта или подпункта перечисления, могут быть маркированы или нумерованы, каждый пункт начинается с нового абзаца
  • Шрифт: Times New Roman, 12 пт
  • Форматирование: по ширине, нулевые интервалы после и перед абзацем, междустрочный интервал 1,5
  • ТЭГ: \л * или \л 1 или \л
  • Использование: \л * FedoraOS \л Ubuntu \л Manjaro - создаёт список из 3 пунктов отмеченных точкой; \л 1 i3wm \л swaywm \л dmenu - создаёт нумерованый список из 3 пунктов с цифрами перед словами; тэг \л продолжает тэг с двумя скобками который указывает маркер в виде точки (\л * ) или нумерацию (\л 1 ) которая будет продолжаться автоматически

2.1.7 Таблицы

...

2.1.8 Иллюстрации

...

3. Переменные

3.1 Hello, world 

!класс Статья
!автор Давид Кнут
!дата сегодня 
!название Helloworld

\з1 Hello, world!

3.2 Список дел 

!класс Статья
!автор Роберт Мартин
!дата сегодня
!название Дела

\з1 Список дел на сегодня и завтра

\з2 Сегодня

\л 1 Почистить зубы
\л Застелить кровать
\л Убраться дома

\з2 Завтра

\л * Вытащить мясо на разморозку
\л Купить специи
\л Почистить картошку