Основные требования гост к текстовым документам: Оформление текстовых документов: новые требования ГОСТ

Содержание

Как оформлять текстовые документы. Новые требования ГОСТ

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

Основные сведения о требованиях к оформлению текстовых документов

Летом 2020 года Федеральным агентством по техническому регулированию были введены два новшества, которые касаются составления специализированной документации. Нововведения регламентированы приказом ведомства, зарегистрированным под номером 175-ст в апреле 2019 года.

В отношении национального стандарта прекращает свое действие ГОСТ 2.105-95. Однако при составлении межгосударственных документов правила остаются обязательными для применения.

Начиная с 2020 года национальными нормативами написания специализированной документации считаются правила, утвержденные ГОСТом Р 2.105-2019. Кроме двух основных новшеств, было принято решение о введении дополнительных коррективов.

  1. Росстандарт утвердил систему конструкторских текстовых документов, содержащихся в ГОСТе Р 2.106-2019. Правки регламентированы Приказом ведомства, зарегистрированного под номером 176-ст.
  2. Приказом 177-ст, Росстандарт регламентировал единую систему конструкторской документации, предназначенной для эксплуатации. Нормы содержаться в ГОСТе Р 2.601-2019.
  3. Кроме того, Росстандарт разработал свод нормативов, касающихся особенностей составления конструкторской эксплуатационной документации. Он закреплен в ГОСТе Р 2.610-2019.
  4. Согласно утвержденным нормам, специализированная документация может быть разделена на несколько частей. Нормы распределения долей содержаться в ГОСТе Р 2.711-2019 и регламентированы приказом Росстандарта под номером 178-ст.

Важно! Соблюдение норм, описанных ГОСТами, на территории РФ является добровольным условием. Именно поэтому, зачастую техническая документация составляется с учетом требований заказчика. Единая система конструкторской документации используется крайне редко.

Составляя специализированные бумаги, эксперты, рекомендуют соблюдать несколько не сложных  правил.

  1. Для оформления документации, предназначенной для сотрудничества с российскими компаниями, лучше всего применять нормы, описанные в межгосударственном стандарте.
  2. Если фирма работает только с зарубежными организациями, то специализированную документацию рекомендуется составлять с учетом национального ГОСТа.
  3. Бывает и так, что бизнесмен работает, как на российском рынке, так и сотрудничает со странами ЕАЭС. В таком случае, эксперты рекомендуют каждый раз отображать наименование стандартизированных норм на этапе подготовки к составлению документации.

Варианты заполнения документов

Специализированная документация может быть составлена несколькими методами:

  • при помощи печатной машинки;
  • от руки;
  • на компьютере;
  • в электронном виде.

В первом случае, составляя документы, рекомендуется придерживаться нормативам, закрепленным в  ГОСТе 13.

1.002-2003. Если бумаги заполняются от руки, то можно использовать ГОСТ 2.304-81, а документы, составленные при помощи компьютерной техники, должны соответствовать нормам, содержащимся в ГОСТ 2.004-88. Компании имеют право представлять готовую документацию, как в бумажном, так и в электронном виде.

Важно! Росстандарт разрешил создавать бумаги при помощи специализированных программ. При этом, конкретная информация может быть введена ответственным сотрудником, либо сгенерирована в автоматическом режиме.

Общие требования к техническому оформлению

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

Стандарт, используемый при составлении документации Значение стандарта, используемого при составлении межгосударственной документации
Значение стандарта, используемого при составлении национальной документации
Шрифт Times New Roman или Arial
Размер шрифта 11, 13, 14 (10, 12 для приложений)
Высота символов 2,5 мм
Боковой колонтитул 3 мм
Красная строка 15 – 17 мм 12,5 – 17 мм
Нижний и верхний колонтитул 10 мм
Междустрочный интервал 8 мм Полуторный или двойной
Интервал между заголовками, подзаголовками и основным текстом 3 – 4 интервалов 4 высоты шрифта основного текста
Интервал между заголовками, подзаголовками и основным текстом, если документ составляется от руки 15 мм
Интервал между разделом и подразделом двойной Равный значению интервала, используемого в основном тексте
Интервал между разделом и подразделом при составлении документа от руки 8 мм 15 мм

Важно! Гост разрешает выполнять копии технической документации.

Подготовить второй вариант бумаги можно при помощи использования:

  • электрографической техники;
  • ксерокса;
  • светокопировального устройства;
  • аппарата для микрофильмирования;
  • сканера (при необходимости использования электронного варианта бумаги).

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

  • В первом случае, каждой части в обязательном порядке присваивается наименование. Но начальная может быть обозначена просто номером.
  • Каждая книга должна быть пронумерована и иметь собственное название.
  • Разделы, так же, нумеруются. Наименование и цифровое обозначение должно быть разделено точкой. Запрещено ставить точку в конце названия и переносить слова.
  • Нужно отметить, что каждый новый раздел обязательно начинать с другой страницы, а наименование и порядковый    номер отражать в верхней части листа.
  • Все подразделы должны иметь порядковые номера. Они присваиваются в зависимости от раздела, к которому относятся. Например, первый подраздел третьего раздела обозначается как 3.1, где 3 – это порядковый номер раздела, а 1 подраздела.

Оформление текстового документа (правила)

Требования ЕСКД относительно недопустимых элементов текста

При составлении документации с учетом правил ЕСКД, нужно обратить внимание на некоторые аспекты, которые запрещены для использования в тексте. К ним относятся:

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

В соответствии с нормами ЕСКД, установленными ГОСТом, при составлении специализированной документации нельзя:

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

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

Пример оформления текстового документа

В качестве примера рассмотрим составление технического документа по межгосудасрвтенным стандартам.

  1. Внутренней рамкой листа называют границы страницы. Расстояние от нее до текста должно составлять 5 мм, а до наименования раздела 15 мм.
  2. Далее нумеруем раздел и присваиваем ему название. Точка между наименованием и число не ставится.
  3. Основной текст начинается с красной строки 15 – 17 мм от границы страницы.
  4. Каждый новый раздел начинаем с другой страницы. Подразделы можно продолжать после основного текста с использованием двойного интервала.
  5. Прописываем наименование подраздела, начиная с нумерации. Заголовок отражается с заглавной буквы, точка в конце не проставляется.
  6. Основной текст подраздела начинаем через 15 мм от его наименования. Используем 8 мм междустрочный интервал.
  7. Пункты текста подраздела нумеруем, начиная с обозначения подраздела. Наименование можно не присваивать.
  8. Перечисления внутри пунктов, подпунктов можно отражать порядковой нумерацией или строчной буквой со скобкой.
  9. Основной текст после перечисления начинаем через 15 мм.
  10. Нижний и верхний колонтитул не может быть меньше 10 мм.

Таким образом, любая техническая документация может быть составлена с учетом ГОСТов. Однако российское законодательство разрешает использовать требования заказчика.

И если он не желает стандартизировать документацию, то придерживаться ГОСТу не обязательно.

Пример составления технической документации

Ответы на часто задаваемые вопросы

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

Вопрос 1. Согласно ГОСТу отражать отрицательные числа при помощи арифметического знака « — » нельзя. В связи с этим возникает вопрос, как в специализированных бумагах отражать цифры с отрицательным значением?

Ответ 1. В текстовых документах, составляемых с учетом стандартизированных правил, содержащихся в ГОСТе, отрицательные числовые значения отражаются словом «минус».

Вопрос 2. Если мы работаем и с компаниями стран ЕАЭС и с российскими фирмами, при составлении технической документации какие стандарты нам рекомендовано использовать.

Ответ 2. Требования к составу, структуре и содержанию документа может предъявлять заказчик. Использование стандартизированных норм не обязательно. Но при их применении нужно учитывать все правила. Например, для межгосударственной документации применяется ГОСТ 2.105-95, а для составления национальных бумаг — ГОСТ Р 2.105-2019. Если компания сотрудничает и с зарубежными фирмами и с российскими, то при формировании документации на первом этапе обязательно указанием используемого стандарта.

Типичные ошибки

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

Ошибка 1. ООО «Стандарт-Форм» сотрудничает с российской компанией ООО «Мега-Фром». При составлении строительной документации Стандарт-форм для основного текста использовала шрифт Times New Roman 11 размера, а для приложений 12.

Решение 1. Во-первых, при составлении технической документации межгосударственного назначения используются стандарты ГОСТа 2.105-95. Во-вторых, размер шрифта основного текста должен быть больше, чем размер шрифта приложения. Допускаются одинаковые значения.

Ошибка 2. ООО «Транс-строй» в срочном порядке понадобилось составить проектную документацию по строительству жилого дома. Часть документа работник компании набрал на компьютере, а другую часть от руки.

Решение 2. Согласно стандартизированным нормам формирования специализированной документации, бумаги могут быть составлены при помощи компьютерной техники, печатной машинки и от руки. Однако запрещено сочетать несколько вариантов одновременно.

Ошибка 3. Проектная документация на строительство жилого комплекса представлена в трех книгах. Каждый том пронумерован и имеет название. Однако основной текст одной книги был набран шрифтом Times New Roman размером 11, а две другие Arial размером 14.

Решение 3. Если книги сформированы в рамках одного документа, то они должны составляться с применением одинаковых правил. То есть, если первая книга имеет шрифт Times New Roman размером 11, то и текст двух других должен набираться одиннадцатым шрифтом Times New Roman.

Правила оформления текстовых документов

1.1 Текстовые документы выполняют на форматах, установленных стандартами Единой системы конструкторской документации (ЕСКД).

Основным стандартом при оформлении текстовых документов является ГОСТ 2.105-95. Общие требования к текстовым документам.

1.2 Страницы текста и приложений должны соответствовать формату А4 (210×297).

1.3 Выполнение текстовых документов осуществляется с применением печатающих и графических устройств вывода ЭВМ.

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

Высота букв и цифр должна быть не менее 2,5 мм.

1.5 Опечатки, описки допускается исправлять закрашиванием белой краской

чёрными чернилами или чёрной гелеевой пастой.

1.6 Текст печатается на одной стороне листа белой бумаги.

Шрифт текста 14пт Times New Roman без наклона с полуторным межстрочным интервалом. Шрифт, используемый в иллюстративном материале (таблицы, графики, диаграммы и т.п.), при необходимости может быть меньше, но не менее 12пт.

1.7 Расстояние от рамки до границ текста в начале и в конце строк – не менее 3мм.

Расстояние от верхней или нижней строки текста до верхней или нижней рамки должно быть не менее 12 мм.

Абзацы в тексте начинают отступом , равным 15 – 17мм.

Пример заполнения текстового документа приведён в приложении Ж.

1.8 Текст документа при необходимости разделяют на разделы и подразделы.

Разделы должны иметь порядковые номера в пределах всего документа,

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

Наименования подразделов записывают с абзаца строчными буквами (кроме первой прописной) шрифтом 14пт.

1.9 Заголовки разделов и подразделов следует располагать в середине строки без точки в конце, не подчёркивая. Переносы слов в заголовках не допускаются.

1.10 Каждый раздел следует начинать с нового листа.

Пример выполнения заголовков раздела и подраздела.

1 ОБЗОР МЕТОДОВ ПОСТРОЕНИЯ СИСТЕМ УПРАВЛЕНИЯ

    1. Метод программного управления

1.11 Слово СОДЕРЖАНИЕ записывают в виде заголовка (симметрично тексту) прописными буквами. Наименования, включённые в содержание, записывают строчными буквами, начиная с прописной.

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

1.13 Наименования, приводимые в тексте документа и на иллюстрациях, должны быть одинаковыми.

1.14 Текст документа должен быть кратким, чётким и не допускать различных толкований.

1.15 Все подписи и даты на титульном листе, в задании, в основных надписях выполняют чёрными чернилами или чёрной гелеевой пастой.

2 Оформление иллюстраций

2.1 Чертежи, графики, диаграммы, схемы, иллюстрации, помещаемые в отчете, должны соответствовать требованиям государственных стандартов Единой системы конструкторской документации (ЕСКД).

2.2 Иллюстрации, за исключением иллюстраций приложений, следует нумеровать арабскими цифрами сквозной нумерацией.

Если рисунок один, то он обозначается «Рисунок 1». Слово «рисунок» и его наименование располагают посередине строки. После наименования рисунка точка не ставится.

2.3 Допускается нумеровать иллюстрации в пределах раздела. В этом случае номер иллюстрации состоит из номера раздела и порядкового номера иллюстрации, разделенных точкой. Например – Рисунок 1.1.

2.4 Иллюстрации, при необходимости, могут иметь наименование и пояснительные данные (подрисуночный текст). Слово «Рисунок» и наименование помещают после пояснительных данных и располагают следующим образом:

Рисунок 1 — Триггер

2.5 При ссылках на иллюстрации следует писать «…в соответствии с

рисунком 1» при сквозной нумерации и «… в соответствии с рисунком 1.2» при нумерации в пределах раздела.

Публикация основных концепций — Ghost Developer Docs

Сообщения являются основным типом записей в Ghost и обычно представляют большую часть хранимых данных.

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

Обзор

Сообщения создаются в Ghost-Admin с помощью редактора для определения основного содержания вашего сайта. Внутри них находятся все поля, которые вы могли бы ожидать, такие как заголовок, описание, слаг, метаданные, авторы, теги и так далее.

Кроме того, сообщения имеют поля Code Injection , которые означают, что вы можете зарегистрировать дополнительные стили, скрипты или другой контент для внедрения непосредственно перед или на любом конкретном URL-адресе, где это необходимо.

Вот пример поста в теме Ghost по умолчанию:

Создание контента

Создание контента в Ghost осуществляется с помощью редактора Ghost, который для многих людей и привлекает их в первую очередь. Однако редактор Ghost представляет собой нечто большее, чем просто глянцевый интерфейс, он обеспечивает оптимизированный рабочий процесс как для авторов, так и для разработчиков.

Опыт письма

Опыт письма в Ghost будет хорошо знаком большинству людей, которые проводили время с веб-инструментами для разработки. Обычно это требует опыта, подобного Medium, которого хотят писатели.

Писать простой контент очень просто, но есть и множество мощных ярлыков. Вы можете писать открытый текст, активируя параметры форматирования с помощью мыши или сочетаний клавиш. Но вы также можете писать в Markdown, если хотите, и редактор будет преобразовывать его по мере ввода — мгновенный предварительный просмотр.

Кроме того, редактор содержит интеллектуальную логику вставки. Вы можете копировать и вставлять из большинства источников, и они будут правильно преобразованы в читаемый контент без какой-либо специальной обработки. (Вперед, попробуйте скопировать содержимое этой страницы прямо в редактор!) — Вы также можете делать такие вещи, как вставка URL-адреса поверх любого выделенного текста, чтобы создать ссылку.

Динамические карты

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

Содержимое Ghost поставляется с расширяемыми мультимедийными объектами, называемыми карточками. Самый простой способ думать о них — это как интегрировать Slack в ваш контент.

Например: Нажав кнопку + или набрав / , вы можете активировать интеграцию Unsplash, чтобы найти и вставить бесплатную фотографию для своего поста.

В настоящее время доступно лишь несколько простых карт, но более активная поддержка карт (а также поддержка пользовательских карт) находится в активной разработке.

Хранение документов

Редактор Ghost получил много похвал от авторов за то, что его приятно использовать, но разработчики обнаружат, что встроенный стандартизированный формат хранения документов на основе JSON создает не менее приятные впечатления, когда дело доходит до работы с данными.

Весь контент сообщений в Ghost сохраняется в MobileDoc, а затем преобразуется в окончательную форму в зависимости от пункта назначения доставки.

Поскольку MobileDoc — это Просто JSON ™️, он чрезвычайно портативный и может быть преобразован в несколько форматов. Это особенно эффективно, потому что преобразовать ваш контент в HTML для отображения в Интернете так же просто, как и перенести тот же контент в мобильное приложение, используя совершенно другой синтаксис.

Даже упомянутые выше динамические карточки являются частью MobileDoc! Это быстро развивающийся открытый стандарт, который используется Ghost, Bustle и многими другими популярными платформами и публикациями.

Данные API

Вот пример объекта публикации из Ghost Content API

 {
  "сообщения": [
    {
      "слаг": "приветствие-коротко",
      "id": "5ddc9141c35e7700383b2937",
      "uuid": "a5aa9bd8-ea31-415c-b452-3040dae1e730",
      "title": "Добро пожаловать",
      "html": "

👋 Добро пожаловать, мы рады видеть вас здесь.

", "comment_id": "5ddc9141c35e7700383b2937", "feature_image": "https://static. ghost.org/v3.0.0/images/welcome-to-ghost.png", "feature_image_alt": ноль, "feature_image_caption": ноль, «избранное»: ложь, "видимость": "общедоступный", "created_at": "2019-11-26T02:43:13.000+00:00", "updated_at": "2019-11-26T02:44:17.000+00:00", "published_at": "2019-11-26T02:44:17.000+00:00", "custom_excerpt": ноль, "codeinjection_head": ноль, "codeinjection_foot": ноль, "пользовательский_шаблон": ноль, "канонический_url": ноль, "url": "https://docs.ghost.io/welcome-short/", "except": "👋 Добро пожаловать, здорово, что вы здесь.", "время_чтения": 0, "доступ": правда, "og_image": ноль, "og_title": ноль, "og_description": ноль, "twitter_image": ноль, "twitter_title": ноль, "twitter_description": ноль, "meta_title": ноль, "meta_description": ноль, "email_subject": ноль } ] }

Страницы

Страницы — это подмножество сообщений, которые исключаются из всех каналов.

В то время как сообщения используются для сгруппированного контента, который обычно публикуется регулярно, например сообщения в блогах или эпизоды подкастов, страницы служат отдельным объектом для статического и в целом независимого контента, такого как страница About или Contact .

Чем отличаются страницы?

Страницы всегда публикуются только в слаге, который им дается, и не появляются автоматически где-либо на вашем сайте. Хотя сообщения отображаются в коллекции индексов, в RSS-каналах, а также в архивах авторов и тегов, страницы полностью независимы. Единственный способ, которым люди находят их, — это создавать ссылки на них вручную либо в вашем контенте, либо в вашей навигации.

Вот пример страницы с темой Ghost по умолчанию:

Пользовательские шаблоны

При использовании одной из стандартных тем Ghost Handlebars обычно используется для страниц предоставление им пользовательских шаблонов.

Помимо обычного шаблона по умолчанию page. hbs , вы также можете создавать универсальные повторно используемые настраиваемые шаблоны, такие как page-wide.hbs , или шаблоны для конкретных страниц на основе определенного ярлыка, например page-about.hbs. — чтобы у вас был точный контроль над тем, какая разметка используется для отображения ваших данных.

Больше о страницах говорить нечего, давайте двигаться дальше.

Теги

Теги — это основная таксономия в Ghost для фильтрации и организации взаимосвязей между вашим контентом.

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

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

Обычный тег

Все теги имеют собственный объект данных и могут иметь заголовок, описание, изображение и метаданные. Темы Ghost Handlebars автоматически генерируют страницы архива тегов для любых тегов, назначенных активным сообщениям. Например, все сообщения с тегом News будут отображаться на example.com/tag/news/ , а также в автоматически сгенерированной карте сайта XML.

Первичный тег

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

Внутренний тег

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

Пример использования

В качестве быстрого примера того, как вы можете использовать теги, давайте рассмотрим голливудский новостной сайт, который публикует сообщение о том, что Райан Рейнольдс объявлен главной героиней нового фильма под названием «Сын Дэдпула». ».

Здесь пост содержит 4 метки:

  • Breaking News Primary TAG
  • Райан Рейнольдс – Регулярная тега
  • Новые религи – ARTER TAG
  • 5 5 5 5 5 5 5 5 5 5 5 5 5 5 5 5 5 5 5 5 5 5 5 5 внутренний тег

Внешний интерфейс сайта настроил вращающийся баннер на главной странице, чтобы извлекать последние 3 сообщения из категории Главные новости и выделять их прямо вверху страницы с помощью Последние новости Этикетка рядом с автором.

Теги Ryan Reynolds и New Releases создают архивы, чтобы читатели могли просматривать другие статьи в тех же категориях, а также свои собственные карты сайта.

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

Вы можете увидеть этот вариант использования в действии в основном блоге Ghost. Вот обычный пост, а вот #feature. Дизайн поста реагирует на теги.

Архивы тегов

Все активно используемые общедоступные теги (то есть те, у которых нет префикса # ) автоматически создают архивы тегов в темах Ghost Handlebars. Архивы тегов автоматически добавляются в карту сайта Google XML и имеют собственную нумерацию страниц и RSS-каналы.

Вот пример архива тегов в теме Ghost по умолчанию:

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

Данные API

Вот пример объекта тега из Ghost Content API:

 {
  "метки": [
    {
      "слаг": "начало",
      "id": "5ddc9063c35e7700383b27e0",
      "name": "Начало работы",
      "описание": ноль,
      "feature_image": ноль,
      "видимость": "общедоступный",
      "meta_title": ноль,
      "meta_description": ноль,
      "og_image": ноль,
      "og_title": ноль,
      "og_description": ноль,
      "twitter_image": ноль,
      "twitter_title": ноль,
      "twitter_description": ноль,
      "codeinjection_head": ноль,
      "codeinjection_foot": ноль,
      "канонический_url": ноль,
      "accent_color": ноль,
      "url": "https://docs. ghost.io/tag/getting-started/"
    }
  ]
}
 

Призрак Оден Документация | Biron Themes

Информация о теме

 Название: Auden
Описание: Тема членства и журнала Ghost
Дата выхода: 03.04.2020
Создатель: Biron Themes 
Требования

Загрузите файл route.yaml


Установите тему

  • Настройки Войдите в раздел администратора публикации по адресу yourblog.com/ghost/signin 4 из меню администратора
  • Под Темы раздел щелкните Загрузить тему
  • Щелкните внутри поля загрузки, чтобы выбрать Auden.zip , или перетащите Auden.zip в поле загрузки
  • Если вы хотите активировать тему немедленно, нажмите Активировать сейчас или Закрыть , если вы хотите сделать это позже

Настройки публикации

Некоторые основные настройки публикации:

Язык

Чтобы установить язык публикации, выполните следующие действия.

  • Войдите в раздел администратора публикации по адресу yourblog.com/ghost/signin
  • Перейдите к General из меню администратора
  • В разделе Publication Language нажмите Разверните язык/локаль и установите для использования на сайте. По умолчанию установлен английский (en).
Язык публикации
  • Нажмите Сохранить настройки

Ссылка на код языка


Значок

Чтобы загрузить новый значок, выполните следующие действия:

  • Войдите в раздел администратора публикации по адресу yourblog.com/ghost/signin
  • Нажмите Дизайн в меню настроек.
  • под Бренд> Иконка публикации , нажмите Загрузить изображение и выберите свой Icon
  • Наконец, щелкните Настройки Сохранить

, чтобы загрузить новый лог. раздел администратора публикации по адресу yourblog.com/ghost/signin

  • Нажмите Design в меню настроек.
  • под Бренд> Логотип публикации , нажмите Загрузить изображение и выберите свой логотип
  • Наконец, щелкните Настройки сохранения

  • . раздел администратора публикации по адресу
    yourblog.com/ghost/signin
  • Нажмите Design в меню настроек.
  • В разделе Бренд > Обложка публикации нажмите Загрузить изображение и выберите обложку
  • Наконец, нажмите Сохранить настройки

  • Навигация

    Чтобы добавить пункты меню в публикацию, выполните приведенные ниже шаги.

    • Войдите в раздел администратора публикации по адресу yourblog.com/ghost/signin
    • Нажмите Навигация и введите метку для пункта меню в поле метки
    • В поле URL-адреса введите место назначения для элемента меню, чтобы связать его. Чтобы активировать функцию, выполните следующие действия.

      • Войдите в раздел администратора публикации по адресу yourblog.com/ghost/signin
      • Нажмите Настройки > Членство .
      • Установить доступ к подписке и другие настройки, предоставляемые Ghost

      Помимо этой конфигурации, вам также необходимо загрузить файл route.yaml (его можно найти в корневой папке темы).

      Чтобы получить доступ к обзору участников, нажмите Members в меню администратора.


      Маршруты

      Маршрутизация — это система, которая сопоставляет шаблоны URL с данными и шаблонами в Ghost. Маршрутизация для участников не добавляется по умолчанию, поэтому требуется загрузка. Базовая конфигурация с включенными функциями участника:

       маршруты:
        /регистрация/: участники/регистрация
        /вход/: участники/вход
        /аккаунт/: участники/аккаунт
      коллекции:
        /:
          постоянная ссылка: /{slug}/
          тип: индекс
      таксономии:
        тег: /tag/{слаг}/
        автор: /author/{slug}/ 

      Интеграции

      Вы можете получить доступ к Интеграциям в разделе администратора. Интеграции можно использовать для подключения встроенных или пользовательских функций к Ghost. Как создать пользовательскую интеграцию:

      • Войдите в свой раздел администратора публикации в yourblog.com/ghost/signin
      • Щелкните Настройки > Интеграции .
      • В разделе Пользовательские интеграции нажмите Добавить пользовательскую интеграцию
      • Укажите для нее имя
      • Добавьте описание
      • Создан ключ Content API , который потребуется пользовательской функции для доступа к данным Ghost.

      Индивидуальная настройка

      Пользовательские настройки темы

      Начиная с Ghost 4.20.0, вы можете выполнять большую часть настройки из пользовательского интерфейса администратора.

      Настройки разделены на 2 категории ( Общий сайт , Сообщение ) Вот доступные настройки:

      • Общие настройки
        • Дополнительный цвет - вы можете изменить дополнительный цвет (основной цвет находится в настройках Марка -> Акцентный цвет)
        • Цветовая схема по умолчанию - это может быть System (по умолчанию), Light и Dark
        • Typography - Есть 5 различных шрифтов, которые вы можете выбрать
        • URL-адрес поиска — вставьте сюда URL-адрес пользовательского API интеграции (подробнее о поиске)
        • Ключ поиска — вставьте сюда ваш ключ пользовательского API-интерфейса интеграции
        • 4 — включите поиск — 1 в контенте search в содержании
        • Включить прокрутку вверх - включить кнопку прокрутки вверх
      • Домашняя страница настройки
        • Домашняя страница показана вверху пост
        • Макет главной страницы — изменить макет с сетки с боковой панелью, списка с боковой панелью или просто сетки сообщений
        • Темы главной страницы — отображать теги или нет (теги с наибольшим количеством сообщений)
        • Баннер боковой панели - добавить баннер на сайдбар
        • Ссылка на баннер на сайдбаре - добавить ссылку на баннер
      • Пост настройки
        • Включить лайтбокс изображения - включить лайтбокс изображения в постах
        • Включить индикатор выполнения — включить индикатор выполнения в сообщениях
        • Открывать внешние ссылки в новой вкладке — Включить открытие внешних ссылок в новой вкладке
      Content API

      тема использует Content API v3, поэтому, чтобы воспользоваться всеми функциями темы, убедитесь, что используется Content API v3, это установлено в теме по умолчанию.

      Вы можете проверить это в теме package.json файл:

       {
        "имя": "...",
        "описание": "...",
        "демо": "...",
        "версия": "...",
        "двигатели": {
          "призрак": ">=4.0.0",
          "призрачный API": "v4"
        },
        ... 

      Сообщений на страницу

      Из Ghost 1.0 настройки «Сообщений на страницу» были перенесены из администратора Ghost в тему. Вы можете установить его в package.json темы:

       "config": {
        "сообщений_на_странице": 10
      } 

      Для Auden значение по умолчанию равно 10 , вы можете изменить его на любое подходящее значение.


      Ghost Search

      Собственная функция поиска интегрирована с версией v2.8.0 , это работает из коробки, настройка не требуется.

      Оден использует плагин Ghost Search.

      Создайте новую настраиваемую интеграцию и обновите параметры поиска в пользовательском интерфейсе администратора (Настройки > Дизайн > Для всего сайта).

      Пожалуйста, обратитесь к официальному руководству по созданию пользовательской интеграции.

      • Скопируйте URL-адрес API из пользовательской интеграции и вставьте его в поле URL-адрес поиска в области пользовательских настроек темы (для всего сайта).
      • Скопируйте ключ API контента из пользовательской интеграции и вставьте его в поле Ключ поиска в области пользовательских настроек темы (для всего сайта).
      • Включить или отключить поиск в контенте (если у вас много постов, это может повлиять на производительность)

      Убедитесь, что ваш URL-адрес не заканчивается на / .

      Другие возможные варианты добавления поиска в темы Ghost CMS.


      Шрифты Google

      Auden поставляется со встроенными шрифтами Google, использующими следующие шрифты:

      • Poppins
      • Open Sans
      • Дисплей Playfair
      • необходимо изменить шрифт по умолчанию. файл .

         
        
        
        {{!-- Нет Js --}}
         

        Перейдите в Google Fonts и выберите нужный шрифт и стиль. Затем нажмите Embed и скопируйте предоставленную ссылку и замените текущую default.hbs .

        Затем откройте файл settings.css , расположенный в папке assets/css/settings . Замените настройку шрифта новым шрифтом:

         --font-family-serif: 'Playfair Display', Times, Georgia, serif;
        --font-family-sans-serif: «Поппинс», Tahoma, Arial, без засечек;
        --font-family-secondary: 'Open Sans', Tahoma, Arial, без засечек; 

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

        Ознакомьтесь с этим руководством, чтобы получить более подробное руководство по шрифтам Google с Ghost.


        Post шаблоны

        Auden поставляется с 3 -оглавление с оглавлением

      При создании нового сообщения автоматически назначается шаблон сообщения по умолчанию. Вы можете изменить его, перейдя в Настройки публикации и в разделе Шаблон выберите шаблон, который вы хотите для публикации.

      Статические страницы

      Помимо сообщений, вы также можете создавать страницы. Для этого:

      • Войдите в раздел администратора публикации по адресу yourblog.com/ghost/signin
      • Перейдите по адресу Управление > Страницы .
      • Щелкните Новая страница .
      • Добавьте имя страницы (которое также будет слагом/адресом страницы).
      • Добавьте контент для страницы.
      • Щелкните Опубликовать .
      Пользовательские страницы

      Auden поставляются с несколькими пользовательскими страницами по умолчанию:

      • Контакт Страница
      • Теги. раздел выше.

        Страница контактов

        Чтобы создать страницу контактов, сделайте следующее:

        • Создайте новую страницу и назовите ее Contact .
        • Убедитесь, что URL-адрес страницы равен контакту .
        • Щелкните Опубликовать .

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

        https://formspree.io/f/moqppoep

        Откройте page-contact.hbs в корневой папке темы и замените действие значение с вашей ссылкой formpree.

         

        Вы также можете заменить форму на свою, если она у вас есть.

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

        Чтобы создать страницу тегов, сделайте следующее:

        • Создайте новую страницу и назовите ее Теги .
        • Убедитесь, что URL-адрес страницы имеет теги .
        • Щелкните Опубликовать .
        Страница авторов

        Чтобы создать страницу авторов, сделайте следующее:

        • Создайте новую страницу и назовите ее Authors .
        • Убедитесь, что URL-адрес страницы равен авторов .
        • Щелкните Опубликовать .
        Страница членства

        Чтобы создать страницу членства, сделайте следующее:

        • Создайте новую страницу и назовите ее Membership .
        • Убедитесь, что URL страницы соответствует членству .
        • Щелкните Опубликовать .
        Страница архива

        Чтобы создать страницу архива (на ней будут перечислены все сообщения), сделайте следующее:

        • Создайте новую страницу и назовите ее Архив .
        • Убедитесь, что URL страницы является архивом .
        • Щелкните Опубликовать .

        Translation

        Auden поддерживает Ghost i18n и поставляется с translations for the following languages:

        • en for English
        • de for German
        • fr for French
        • es for Spanish
        • it for Italian
        • pr for Portuguese

        Чтобы изменить язык публикации на один из доступных языков, проверьте это руководство.

        Редактирование переводов

        Файлы перевода хранятся в папке локалей внутри папки темы.

         |-- локали
        | |-- de.json
        | |__ru.json
        | |__es.json
        | |__fr.json 

        Откройте файл для языка, который вы хотите отредактировать. Пример en.json :

         {
          "load_more_posts": "Загрузить больше сообщений",
          "load_comments": "Загрузить комментарии",
          "отправить": "Отправить",
          ...
        } 

        Каждая строка состоит из пары ключ-значение.

         "ключ": "значение" 

        Ключ находится с левой стороны и его надо менять а не (то же самое в все файлы) и правильное значение, которое при необходимости можно изменить.

        Если у вас есть предложения по улучшению перевода или добавлению нового языка, Напишите нам.

        Добавление нового языка

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

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

        И добавьте переводы для каждого значения ключа .

        Для получения более подробной информации см. официальную документацию Ghost.


        Ссылки на социальные сети хранятся в частичном файле partials/social-media.hbs .

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

      • Перейдите к Общие из меню администратора
      • Нажмите Разверните под Социальные учетные записи и введите URL-адреса для ваших Facebook и Twitter.
      • Нажмите Сохранить настройки

      Чтобы изменить другие социальные ссылки, выполните следующие действия. Откройте social-media.hbs файл и измените значение href на URL вашего профиля для этой конкретной социальной платформы.

       ...
        {{!-- Инстаграм --}}
        <а
           href="https://instagram. com" target="_blank" title="Instagram" aria-label="Instagram">
          {{>название значка="Инстаграм"}}
        
        ...
       

      Например, чтобы изменить ссылку Instagram , необходимо изменить существующее значение href:

       href="https://instagram.com" 

      Добавьте ссылку на свой аккаунт Instagram, например:

       href="https ://instagram.com/bironthemes" 

      Оден поддерживает собственные комментарии Призрака.

      Для работы собственной системы комментариев требуется версия Ghost не ниже 5.9.0. Вы должны включить его в Настройки > Членство > Комментирование . По умолчанию собственные комментарии не активны, поэтому вам нужно выбрать либо Все участники или Только платные участники

      Кроме того, Auden поставляется с Cove и Disqus.

      3 макета постов, с которыми поставляется тема:

      • post.hbs
      • custom-no-sidebar.hbs
      • custom-with-table-of-contents

        35 In

        3. hbs

        3 thess используется помощник {{comments}} , и вы можете изменить его на {{> cove_comments.hbs}} или {{> disqus_comments}} вместо этого.

        Cove

        Cove — это платформа для комментариев, созданная на основе функции членства Ghost.

        Чтобы комментарии работали, вам необходимо создать учетную запись на cove.chat и изменить файл cove_comments.hbs в папке partials:

          

        Заменить значение для публикация с той, что из вашей учетной записи Cove.

        Оден также поставляется с комментариями Disqus.

        Убедитесь, что вы зарегистрировали свой веб-сайт в Disqus и знаете свое disqus_shortname .

        Откройте файл theme-config. hbs , расположенный в папке partials . Измените значение biron-demo , чтобы оно соответствовало короткому имени вашей учетной записи Disqus.

         <скрипт>
          ...
          // Базовая конфигурация
          константная конфигурация = {
            ...
            /* Замените «biron-demo» на короткое имя вашей учетной записи disqus */
            disqus_shortname: 'biron-demo'
          }
         

        Вот и все, теперь комментарии Disqus должны работать.

        Если вы не хотите, чтобы комментарии disqus отображались, удалите файл disqus_comments.hbs , расположенный в папке частей. И удалите следующий раздел из post.hbs , custom-no-sidebar.hbs , custom-with-table-of-contents.hbs файлы, расположенные в корневой папке темы:

         {{!-- Включить комментарии --}}
        {{> disqus_comments}} 

        Google Analytics

        Чтобы добавить Google Analytics в Ghost, выполните следующие действия. учебник из нашего блога.


        Прогрессивное веб-приложение

        Прогрессивное веб-приложение позволяет установить ваш веб-сайт кому угодно, где угодно и когда угодно. любое устройство с единой кодовой базой.

        Для настройки внешнего вида необходимо изменить следующие файлы.

        • default.hbs
        • manifest.webmanifest

        В default.hbs это соответствующий раздел для PWA.

         {{!-- PWA --}}
        
        
         

        Измените содержимое темы-цвета на основной цвет и замените значок -192x192.png со своей иконкой (она должна быть 192x192 пикселя).

        Затем откройте файл manifest.webmanifest :

         {
          "name":"Тема призрака Одена",
          "short_name":"Оден",
          "description":"Оден — тема призрака для журнала и членства",
          "язык":"en",
          "start_url":"/",
          "background_color":"#ffffff",
          "отображение":"автономный",
          "тема_цвет":"#e50b4f",
          "значки": [
             {
                "источник":"/активы/icon-48x48. png",
                "размеры": "48x48",
                "тип":"изображение/png"
             },
             {
              "src": "/assets/icon-192x192.png",
              "тип": "изображение/png",
              "размеры": "192x192"
            },
            {
              "src": "/assets/icon-512x512.png",
              "тип": "изображение/png",
              "Размеры": "512x512"
            }
          ]
        } 

        Замените всю соответствующую информацию, такую ​​как имя , короткое_имя и описание . Также замените все иконки на свои.

        Вот и все, об остальном позаботятся.

        Посетите наш блог, чтобы узнать больше о Progressive Web App for Ghost Themes.


        Раздел рекламы является частью файла partials/sidebar.hbs . Чтобы активировать его, просто создайте внутренний тег с именем #sidebar-ad .

        Изображение тега будет отображаться на боковой панели, а описание используется как URL-адрес элемента ссылки.

        Кроме того, чтобы реклама отображалась в отдельной публикации, необходимо присвойте ему тег #sidebar-ad .

        С версией v2.6.0 баннер можно изменить в настройках администратора. Перейдите в «Настройки» > «Дизайн» > «Домашняя страница» и загрузите изображение для баннера боковой панели . и предоставьте ссылку для этого, используя поле Ссылка на баннер боковой панели .


        Разработка тем

        Auden подходит для разработчиков. воспользоваться преимуществами задач Gulp, которые настроены для компиляция Javascript и PostCSS.

        Все активы объединены и минимизированы для повышения скорости и производительности. Чтобы настроить тему, убедитесь, что у вас установлен Node.js. и установлен нпм.

        Руководство по установке Ghost.

        Запустите следующие команды в каталоге темы Auden:

         npm install 

        Это установит все зависимости для темы

        Затем запустите:

        Это скомпилирует PostCSS и javascript и будет следить за изменениями. Поэтому, когда вы редактируете файл .