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

Стандарт оформления текстов для онлайн-библиотеки «Заря»⚓︎

1. Порядок оформления текстов⚓︎

1.1. Метаинформация⚓︎

В начале каждого файла необходимо размещать метаданные текста с помощью YAML:

---
title: 
subtitle: 
author: 
source: 
publisher: 
transcribed by: 
standartised by: 
proofread by: 
annotation:
---

title — название текста

subtitle — подзаголовок текста

author — автор текста

source — данные бумажного издания, из которого сформирован данный текст

publisher — данные издателя бумажного первоисточника

transcribed by — данные (Фамилия Имя) того, кто осуществлял первичный перевод и первичную вычитку текста в формате markdown.

proofread by — данные (Фамилия Имя) того, кто осуществлял вторичную вычитку текста, проверку в формате markdown.

Можно добавлять другие поля.

В метаданных запрещено использовать знак двоеточие.

1.2. Заголовок текста⚓︎

1.2.1. Заголовок текста должен состоять из фамилии и инициалов автора и следующим за ними названием произведения. Если издание не первое, то это должно быть отражено в заголовке через запятую, с указанием дополнений («доп.», «испр.», «переработ.» и т. д.)

Рубин И. Очерки по теории стоимости Маркса, изд. 2, перераб. и доп.

1.3. Библиографическая информация⚓︎

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

1.3.2. Данный блок информации оформляется тремя бэктиками (обратными кавычками) перед текстом и тремя бэктиками после текста

```
Текст
```

1.3.3. Для текста, написанного одним автором, в случае, если наименование текста не отличается от наименования издания, в библиографическом блоке через запятую указываются:

  1. Город (или аббревиатура города: в зависимости от того, как это указано в первоисточнике), в котором находится издательство
  2. Наименование издательства
  3. Год издания
  4. Количество страниц.

Такую информацию можно получить на сайте РГБ или других библиотек.

М., Гос. изд-во, 1924, 211 с.

1.3.4. Для текста, написанного одним автором, в случае, если наименование текста не совпадает с наименованием издания, в библиографическом блоке через запятую указываются:

  1. Фамилия и инициалы автора.
  2. Формат издания («Собрание сочинений», «Избранные произведения», «Сборник статей» и т. п.)
  3. Наименование издания (если таковое имеется)
  4. Номер издания, с указанием дополнений («доп.», «испр.», «переработ.» и т. д.), если это не первое издание
  5. Том (если таковой имеется)
  6. Часть (если таковая имеется)
  7. Год издания, если таковой имеется
  8. Диапазон страниц, которые текст занимает в издании
Маркс К. Энгельс Ф. Собрание сочинений, изд. 2, т. 25, ч. 2, 1962, с. 3—458

1.3.5. Для текста, написанного автором в издании, в котором принимали участие другие авторы, через запятую указываются:

  1. Название формата («Сборник», «Журнал», «Газета» и т. д.)
  2. Наименование издания
  3. Год издания
  4. Порядковый номер для периодических изданий
  5. Диапазон страниц, занимаемый данным текстом в издании
Журнал «Под знаменем марксизма», 1929, № 4, с. 81—108

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

Журнал «Под знаменем марксизма», 1929, № 4, с. 81—108; № 5, с. 51—82

1.4. Пагинация (нумераця страниц) бумажного первоисточника⚓︎

1.4.1. Нумерацию страниц бумажного первоисточника необходимо указывать с помощью символа «решетка», пробела и номера страницы, заключенных в квадратные скобки ([# 3], [# 21], [# 123] и т. д.).

1.4.2. Если разрыв страницы приходится на начало абзаца, то нужно в самом начале абзаца указать соответствующий номер страницы, вставить пробел и далее написать текст абзаца.

[# 8] В настоящее время, когда методологическое освещение конкретной исследовательской работы в области нейрофизиологии и психологии является реальным и повседневным инструментом исследователя, диалектика, поставленные выше вопросы не могут остаться без ответа. Гносеологической ясности этого вопроса должна соответствовать столь же убедительная и обоснованная аргументация и со стороны позитивных наук об организме.

1.4.3. Если разрыв страницы расположен между двумя словами, то номер страницы указывается в соответствуюем месте с вставкой пробелов, по обеим сторонам от номера страницы.

Передача информации в живых и технических объектах обычно происходит с исключительно большим числом специфических звеньев, однако она подчиняется одному важному [# 9] закону: между начальным и конечным звеном этой передачи должна быть точная и адекватная информационная эквивалентность.

1.4.4. Если разрыв страницы находится внутри слова, то номер страницы указывается в соответствющем месте. В таком случае, пробелы не нужны.

Нет опасности в том, что первичные свойства предмета «исказятся», например, на уровне фотохимических про[# 14]цессов сетчатки или в процессе распространения нервных импульсаций по отдельным волокнам зрительного нерва.

1.4.5. Если новая страница начинается с заголовка, то номер страницы указывается в начале ближайшего следующего абзаца основного текста, в соответствии с п. 1.3.2.

# Анохин П. Теория отражения и современная наука о мозге

## Общие предпосылки

[#3] Едва ли кто решится отрицать ту огромную роль, которую теория отражения сыграла в прогрессе всестороннего научного познания природы, в понимании последней как объективно существующего движения материи, адекватно отражающегося в сознании человека.

1.4.6 Если новая страница начинается с рисунка или таблицы или какого-либо другого элемента, не перечисленного выше, то номер страницы ставится в конце предшествующего основного текста.

Получаем теперь следующее соотношение между стоимостью и ценой годового продукта каждого предприятия:[# 85]

<Таблица>

2. Стандарты разметки текста⚓︎

2.1. Абзацы⚓︎

2.1.1. Абзацы отделяются друг от друга пустой строкой.

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

Сомнение, как следует из вышесказанного, индуцирует гедонизм. Катарсис преобразует дедуктивный метод. Любовь творит непредвиденный дуализм. Представляется логичным, что дедуктивный метод реально понимает под собой закон исключённого третьего, tertium nоn datur. По своим философским взглядам Дезами был материалистом и атеистом, последователем Гельвеция, однако галактика индуцирует дедуктивный метод. Позитивизм методологически принимает во внимание естественный позитивизм.

Ощущение мира индуктивно преобразует мир. Актуализация трансформирует данный гравитационный парадокс. Дедуктивный метод, как принято считать, неоднозначен. Знак раскладывает на элементы конфликт, учитывая опасность, которую представляли собой писания Дюринга для не окрепшего еще немецкого рабочего движения.

2.2. Заголовки⚓︎

2.2.1. Заголовки начинаются с символа решётки #. Количество символов определяет уровень заголовка.

# Заголовок первого уровня

## Заголовок второго уровня

### Заголовок третьего уровня

#### Заголовок четвертого уровня

##### Заголовок пятого уровня

###### Заголовок шестого уровня

2.2.2. Заголовки книг начинаются со второго уровня. Заглавие книги формируется из поля title метаданных;

2.2.3. Заголовки должны идти без пропусков с соблюдением вложенности, за заголовком уровня n должен следовать заголовок уровня n+1;

2.2.4. После последнего символа # должен находиться один пробел;

2.2.5. Существует только 6 уровней заголовков;

2.2.6. Заголовок не должен завершаться символами :,..

2.3. Выделение текста⚓︎

2.3.1. Выделение текста в бумажном первоисточнике (курсив, разрядка, подчеркивание и др.) в файле текста всегда оформляется курсивом. Для этого, в начале и в конце выделяемого текста ставятся звездочки *.

Этот текст *написан курсивом*.

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

2.4. Списки⚓︎

2.4.1. Между символом маркировки списка и текстом всегда должен быть один пробел.

2.4.2. Маркированные списки⚓︎

2.4.2.1. Маркированные списки оформляются звёздочкой и пробелом в начале строки.

* Апельсины
* Лимоны
* Яблоки

2.4.3. Нумерованные списки⚓︎

2.4.3.1. Нумерованные списки оформляются цифрой, точкой и пробелом в начале строки.

1. Апельсины
2. Лимоны
3. Яблоки

2.4.3.2. Если абзац начинается с цифры и не является элементом списка, то используйте символ экранирования (\) перед точкой.

1\. это начало абзаца, а не список

2.4.4. Вложенные списки⚓︎

2.4.4.1. Списки могут быть вложенные, для каждого уровня маркированного списка добавляйте два пробела, а для нумерованного три:

* Инструменты
  * Молоток
  * Отвёртка

1. Кружок M3
  1. Участник 1
  1. Участник 2

2.5. Цитаты⚓︎

2.5.1. Цитаты выделяются символом больше (>) и пробелом в начале строки. Пробел всегда должен быть один.

> Люди всегда были и всегда будут глупенькими жертвами обмана и самообмана в политике, пока они не научатся за любыми нравственными, религиозными, политическими, социальными фразами, заявлениями, обещаниями разыскивать интересы тех или иных классов.

2.5.2. Если одна цитата содержит несколько абзацев, то необходимо добавлять пустую строку с символом > между абзацами.

> Первый абзац
>
> Второй абзац

2.5.3. Если имеется список нескольких цитат подряд, то разделение на отдельные цитаты оформляется так же как и в основном тексте (см. п. 2.1.1.) с помощью пустых пробелов.

> Первая цитата

> Вторая цитата

2.5.4. Если цитата — это стихотворенье, то для того, чтобы строки отображались с межстрочным интервалом (а не межабзацным), используйте придельный перевод строки внутри абзаца. Для этого добавьте в конце строки пробел и слеш:

Стихотворение:

> Ешь ананасы, \
> рябчиков жуй, \
> день твой последний \
> приходит, буржуй.

2.6. Сноски (примечания)⚓︎

2.6.1. Для оформления сносок используются квадратные скобки и крышечка (^):

И дальше: «Надо создать в России изучение и преподавание системы Тейлора, систематическое испытание и приспособление ее»[^3]. Конечно, ударение в работе по увеличению продуктивности живого человеческого труда в условиях Советского государства мы должны делать на повышении квалификации труда и улучшении его качества путем применения добытых наукой и практикой приемов работ, экономящих затрату человеческой энергии.

[^3]: В. И. Ленин. Поли. собр. соч., т. 36, с. 180, 190.

2.6.2. Если сносок несколько, то разделяйте их пустой строкой.

[^1]: первая сноска.

[^2]: вторая сноска.

2.6.3. Виды сносок⚓︎

2.6.3.1. Различаются два вида сносок

  • Авторские (Авт.)
  • Редакторские (Ред.)

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

[^1]: авторское примечание. Авт.

[^2]: редакторское примечание. Ред.

2.6.3.4. Регистр символов и форматирование не учитывается, следующие определения равнозначны

[^1]: авторское примечание. авт.

[^1]: авторское примечание. *Авт.*

[^1]: авторское примечание. **Авт.**

2.6.3.5. Если тип сноски не указан явно, то она считается редакторской.

2.6.4. Многострочные сноски⚓︎

2.4.6.4.1. Иногда текст сноски содержит несколько абзацев. В этом случае второй и последующие абзацы сноски начните с четырёх пробелов. Между абзацами добавляйте пустую строку.

Эта книга предлагает новую интерпретацию рождения, эволюции и смерти СССР. В значительной степени мы полагаемся на имеющуюся литературу. Однако «излишковая»[^2] теория класса, которую мы находим у Маркса и используем для анализа советской истории, резко отличается от теорий, используемых как ее защитниками, так и ее критиками.

[^2]: В оригинале «the «surplus» theory of class». По всей видимости, в англоязычной литературе помимо категорий «surplus value» (прибавочная стоимость), «surplus product» (прибавочный продукт), «surplus labour» (прибавочный труд) и т. д. имеется понятие «surplus», являющееся *родовым* по отношению к вышеупомянутым понятиям. Как мы видим, в русскоязычной марксистской литературе на сегодняшний день сложилась норма перевода прилагательного «surplus» как «прибавочный (-ая)» и в этом смысле понятие «the „surplus“ theory of class» стоило перевести как «„прибавочная“ теория класса».

    Однако, как читатель увидит далее, эта теория класса, развиваемая Резником и Вольфом, получила свое название из-за того, что она, в отличие от других теорий класса, во главу угла ставит «social organization of the surplus» — общественный способ того, как в том или ином обществе организованы производство и распределение результатов труда, которые остаются за вычетом того, что требуется для простого воспроизводства этого общества. Как мы видим, в данном контексте «surplus» используется как существительное.

    Поскольку Резник и Вольф говорят об этой категории в смысле общего как для капитализма, так и для коммунизма, то нами принято решение везде в тексте переводить «surplus», когда оно употребляется как существительное, как «излишек», когда оно употребляется как прилагательное в устойчивых выражениях (surplus value, surplus product, surplus labour etc.), — как «прибавочный (-ая)»; и наконец, когда оно употребляется как прилагательное в неологизмах (surplus theory of class), — как «излишковый».

2.6.5. Бибилографические сноски⚓︎

2.6.5.1. Библиографическая сноска — это сноска, которая указывает на источник цитаты или идеи, изложенной в основном тексте.

2.6.5.2. Библиографическая сноска должна содержать:

  • Фамилию и инициалы автора
  • Название произведения
  • Указание источника, в котором содержится указанное произведение

2.6.5.2. Фамилия и иницалы автора обрамляются знаками звездочка *.

2.6.5.3. Если источник бумажный, то его наименование отделяется от названия произведения двойным слешом //. Автор (составитель, главные редактор, ответственный редактор и т. п.) так же обрамляется знаками звездочка *.

[^1]: *Маркс К., Энгельс Ф.* Манифест коммунистической партии // *Маркс К., Энгельс Ф.* Собрание сочинений, изд. 2, т. 4, с. 419—459.

2.6.5.4. Если источник электронный, то он оформаляется как ссылка, идущая от наименования произведения к адресу источника.

[^1]: *Маркс К., Энгельс Ф.* [Манифест коммунистической партии](https://www.esperanto.mv.ru/Marksismo/Manifesto/manifesto.html).

2.7. Разделение с помощью трех звездочек⚓︎

2.7.1. Если в первоисточнике встречается разделение с помощью трех звезд, то рекомендуется оформлять их с помощью специального html-кода

<p style="text-align: center;"><sup>*</sup> <sub>*</sub> <sup>*</sup></p>

2.8. Формулы⚓︎

2.8.1. Для встраивания формул используется LaTeX. Возможны два вида встраивания формулы: внутри строки и отдельным блоком.

2.8.2. Для встраивания формулы внутри строки формула оборачивается знаком доллара $:

Квадратное уровнение $x^2 + x + 3 = 2$ демонстрирует зависмость между...

2.8.3. Для встраивания формулы отдельным блоком формула оборачивается двумя знаками доллара $$:

$$
\frac{K+p'K}{K_1+p'K_1} = \frac{K(1+p')}{K_1(1+p')} = \frac{K}{K_1}
$$

2.8.4. Краткую справку по оформлению формул можно найти здесь.

2.9. Изображения⚓︎

2.9.1.Синтаксис добавления изображений:

![Заголовок_изображения](имя_файла_изображения "подпись_изображения")

2.9.2. Изображения должны храниться в папке, расположенной в той же директории, что и сам файл текста. Название папки с изображением, должно совпадать с названием файла текста и в конце содержать .assets.

Пример

![1. Схема товарного обращения по Кенэ](Рубин%20Исаак%20Ильич.%20История%20экономической%20мысли.assets/kene-1.png "1. Схема товарного обращения по Кенэ")

2.10. Нельзя использовать⚓︎

2.10.1. Нельзя использовать элементы разметки, не описанные выше (например, подчеркнутый текст). Если в процессе работы вы столкнулись с тем, что вам все-таки необходимо использовать какой-либо элемент, не описанный выше, то вам нужно согласовать его использование в бибилиотеке «Заря» путем предложения по изменению данного стандарта.

3. Типографский стандарт оформления текста⚓︎

3.1. Кавычки⚓︎

3.1.1. По умолчанию в качестве кавычек используются кавычки-елочки: « и ».

В статье «Добыча золота и дороговизна» Бауэр остается на той же точке зрения.

3.1.2. В случае вложенных кавычек (когда необходимо указать кавычки внутри уже «закавыченного» текста), следует использовать кавычки-лапки: “ (Alt+0147) и ” (Alt+0148).

Пол Суизи в своем пользующемся большой популярностью классическом учебнике «Теория капиталистического развития» утверждал: «Маркс начинает с анализа “простого товарного производства”...» (Обратите внимание на кавычки, которые используются несмотря на то, что, как и у Манделя, они не подкреплены никакими фактическими ссылками).

3.2. Многоточие⚓︎

3.2.1. Для обозначения многоточия в тексте используется отдельный знак «многоточние» …, а не три точки подряд.