Text Markup

Заголовки

Используйте елемент h 2-4 уровней.

<h2>Заголовок раздела</h2>
<h3>Заголовок подраздела</h3>
<h4>Самый маленький заголовок</h4>
<b>Жирный текст, если четвёртого уровня не хватило</b>

Транслитерация, термины

Используйте елемент i (документация).

Элемент i представляет отрывок текста c альтернативным произношением или настроением, или с отклонением от обычной прозы, которое указывает на другое качество текста. Например:

  • таксономический термин;

  • технический термин;

  • идиоматическое выражение из другого языка;

  • транслитерация;

  • мысль или название корабля в западном письме.

В этом примере транслитерации выделены элементом i:

...высочайший аспект уровня <i>адхокшаджа</i> — это <i>апракрита-лила</i> Кришны...

Языковые термины, на языке отличного от основного текста, следует обозначать атрибутом lang, указывая язык термина 2-символьным кодом по стандарту ISO 639-1. Данная подсказка может использоваться программами синтеза речи, для правильного произношения, соответственно языку термина.

Применение атрибута lang.

Душа (<i lang='la'>élan vital</i> — «жизненный порыв») ищет счастья, исполненности желаний.

Таймкоды

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

  • Метки задаются в формате #чч:мм:сс#.

  • Метки должны располагаться в начале параграфа, и отделяться от последующего текста пробелом.

#00:03:45# Параграф текста...

Параграф текста...

#00:04:30# Параграф текста...

#00:06:20# <blockquote>...

Citations

Full verse citations

Use blockquote element for full verse citations. Use <cite> element right after blockqoute element to refer to citation source.

<blockquote>
На всех ярится смерть — царя, любимца славы,
Всех ищет грозная... и некогда найдет;
Всемощныя судьбы незыблемы уставы:
И путь величия ко гробу нас ведет!
</blockquote>
<cite>(Томас Грей, элегия написанная на сельском кладбище)</cite>
<blockquote>
бхидйате хр̣дайа-грантхиш, 
чхидйанте сарвва-самшайах 
кшийанте часйа карммани, 
майи дрште ‛кхилатмани 
</blockquote>
<cite>(«Шримад-Бхагаватам», 11.20.30)</cite>

Verse citations within running text

Use q element for vers ecitations within running text.

<q>Chintāmaṇi-prakara-sadmasu…</q> <cite>(Brahma-saṁhitā 5.29)</cite>

Стихи на бенгали

Для разметки стихов с особым бенгальским метром используйте елемент verse, и елемент gap для обозначения промежутков.

<verse>
кршна се томара, <gap>кршна дите паро,
томара шакати ачхе
ами то кангала, <gap>кршна кршна’ боли
дхаи тава пачхе пачхе
</verse>

Строчное цитирование

Цитаты внутри строки оформляются следующим образом.

Рупа Госвами говорит: «Ахер ива гатих премнах свабхава-кутила бхавет» («Шри Чайтанья-чаритамрита», Мадхья, 8.111) — «Божественная любовь движется зигзагом, не прямо».

Визуальное выделение

Используйте елемент b (документация) для визуального выделения без смысловой нагрузки.

Элемент b представляет отрывок текста, внимание к которому привлекается для утилитарных целей без придания какой-либо подчёркнутой важности и изменения интонации или настроения. Например:

  • ключевые слова в документе;

  • названия продуктов в обзоре;

  • вступительное предложение к статье.

В следующем примере элемент b используется для выделения участников диалога:

<b>Преданный:</b> У меня есть вопрос.
<b>Махарадж:</b> Какой?

Другая ситуация где уместен элемент b, это вступительное предложение (или параграф) в статье.

<b>Вступительная часть</b>
Остальной текст...

Даты

Используйте елемент time (документация) для разметки дат в тексте.

Элемент time используется для представления дат и времени в тексте. Дата указывается как текстовое содержимое элемента time, или как значение атрибута datetime. Допустимые форматы даты описаны в документации.

Эта статья была впервые опубликована в 7-ом номере журнала «The Harmonist» в <time>1936</time> году.

В следующем примере формат указываемой даты отличается от допустимого, поэтому используется атрибут datetime с заданием даты в машинно-читаемом формате.

Наша первая встреча произошла в <time datetime="2012-02-12">Субботу<time>

Сноски

Используйте елемент fn для оформления сносок.

Элемент fn (от англ. footnote — сноска) предназначен для обозначения содержимого сноски. Этот элемент следует располагать непосредственно после слова к которому относится сноска.

В обработанном тексте, содержимое сноски, как правило, переносится в конец документа, а элемент fn будет заменён ссылкой на сноску.

...необходимо преодолеть все самскары <fn>Самскара описывается как сохранившиеся в памяти впечатления, ментальные образы или воспоминания о действиях, совершенных в предыдущей форме существования.</fn>, что держат наш ум в футляре предубеждений и недоверия.

Выдержки

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

Рекомендуемый размер выдержки примерно 55 слов.

<excerpt>Текст выдержки</excerpt>

Изображения

Для вставки изображений в текст используйте следующий синтаксис:

![Альтернативное описание](Путь к файлу "Подпись")

Для картинок обязательно указывайте альтернативные описания — то есть что на них изображено.

Как понять, что хорошо описали картинку? Прочтите описание, не глядя на изображение. Если смогли понять, что изображено, то это хорошее описание.

Обратите внимание, что описание:

  • не начинается со слов «картинка», «иллюстрация»;

  • не содержит дополнительные факты, ссылки, эмодзи и всё, что не относится к картинке;

  • не повторяет то, что уже есть в тексте, а ещё подпись к картинке;

Неправильно: ![Картинка с пончиками](images/donuts.png)

Правильно: ![На столе стоит тарелка с двумя пончиками. Один покрыт розовой глазурью, а другой посыпан сахарной пудрой.](images/donuts.png)

Ссылки

Чтобы вставить ссылку используйте следующий формат:

[Текст ссылки](URL)

Аббревиатуры

Используйте елемент abbr (документация) для разметки аббревиатур.

Элемент abbr представляет аббревиатуру или акроним. Атрибут title может использоваться для предоставления расшифровки аббревиатуры.

<abbr title="Шри Чайтанья Сарасват Матх">ШЧСМ</abbr>

Обозначение важности

Используйте елемент strong (документация) для обозначения важности, серьёзности или срочности содержимого.

Элемент strong может использоваться в заголовках, подписях или абзацах для выделения более важной части содержимого среди более детализированных частей.

Изменение важности текста элементом strong не меняет значения всего предложения.

Элемент strong не является средством придания "жирности" тексту, хотя чаще всего он отображается более жирным начертанием.

В следующем примере слово "Глава" и номер главы являются фактически стереотипными, а реальное название главы выделено лементом strong:

<h1>Глава 1: <strong>Знакомство</strong></h1>

Пример предупреждения в игре:

<strong>Внимание.</strong> Это подземелье опасно.

Смысловой акцент

Используйте елемент em (документация) для обозначения акцента, влияющего на смысл содержимого.

Документация: оригинал, перевод.

Элемент em (от англ. emphasis — подчёркивание, ударение) представляет подчёркивание, ударение или акцент не своём содержимом.

Размещение такого ударения меняет смысл предложения. Точный способ применения выделения зависит от языка.

В следующем примере показано, как применение выделения меняет смысл сказанного. Вот общее утверждение, без выделения:

Коты милые животные.

Далее, выделяя первое слово, мы подчёркиваем, какие именно животные являются предметом обсуждения (может быть, кто-то считает, что собаки — милые):

<em>Коты</em> милые животные.

Перенеся выделение на прилагательное, мы подчёркиваем верность всего утверждения (кто-то может считать, что кошки совсем не милые):

Коты <em>милые</em> животные.

ПРИМЕЧАНИЯ:

  • Элемент em не является средством обозначения текста "курсивом", хотя в большинстве случаев такой текст отображается наклонным начертанием. Если текст просто должен выделяться из абзаца, тогда элемент i подходит больше.

  • Элемент em также не предназначен для передачи важности; для этого больше подходит элемент strong.

Источники

При укзании источника, он берётся в «круглые скобки». Следует придерживаться следующих форматов:

  • «Произведение», Раздел, Глава.стих

  • Сокращение, Раздел, Глава.стих

Пример

... («Чайтанья-чаритамрита», Ади, 5.208)  
... (Ч.ч., Антья, 4.192–193)  
... (Б.р.с., Пурва, 1.17)

Сокращения

Ниже приведён список принятых сокращений. При использовании их в тексте, в конце содержимого будет автоматически формироваться секция «Список сокращений».

Сокращение
Расшифровка

Б.г.

«Бхагавад-гита»

Бхаг.

«Шримад Бхагаватам»

Ч.ч.

«Чайтанья-чаритамрита»

Б.р.с.

«Бхакти расамрита синдху»

Списки

Списки оформляются с новой строки. Поддерживаются упорядоченные и неупорядоченные списки.

Упорядоченный список представляет список пунктов, где пункты намеренно упорядочены таким образом, что изменение их порядка изменяет смысл документа.

Для формирования упорядоченных списков в качестве маркеров используются числа с точкой. Упорядоченные списки всегда следует начинать с единицы. За маркером должен следовать пробел.

Девять ступеней <i>бхакти-йоги</i>:
1. Шраддха — вера в процесс преданного служения.
2. Садху-санга — общение с преданными.
3. Бхаджана-крийа — выполнение преданного служения
4. Анартха-нивритти — избавление от нежелательных качеств.
5. Ништха — обретение постоянства в преданном служении.
6. Ручи — вкус к преданному служению
7. Асакти — любовная привязанность к преданному служению.
8. Бхава — стадия, предшествующая любви к Богу
9. Према — чистая любовь к Богу.

Неупорядоченный список представляет список пунктов, где порядок пунктов не важен — то есть, где изменение порядка не изменяет в целом смысл документа.

Для формирования неупорядоченных списков в качестве маркеров используются дефисы. За маркером должен следовать пробел.

«Чайтанья Чаритамрита» приводит описание 24 типов Гуру, среди которых:
- <i>шикша-гуру</i>;
- <i>дикша-гуру</i>;
- <i>чайтья-гуру</i>.

Last updated