Руководство по оформлению записей на сайте

Далее слова «запись» и «пост» считаются синонимичными1.

Обложка (ранее — миниатюра) записи

Для каждой записи желательно наличие изображения в шапке. Задается в блоке «Изображение записи» в правой колонке на странице редактирования записи. Изображения должны быть строго размера 770х270. Предпочтительнее flat-стиль. Картинки не должны нарушать копирайты.

На обложке размещать какие-либо надписи крайне нежелательно! Для проверки наличия текста на изображении можно использовать инструмент от Facebook.

Заголовок и подзаголовки

Заголовок записи должен передавать суть записи, из него должно быть понятно, о чём она. Длина не ограничивается, но должна быть в пределах разумного. Если очень нужно распространить заголовок, можно использовать дополнительное поле «Анонс» — оно разместит дополнительный текст курсивом между заголовком и обложкой.

В тексте используются заголовки второго и третьего уровней (h2 и h3 соответственно). В конце заголовков и подзаголовков точки не ставятся.

Текст

В качестве кавычек используются французские «ёлочки». Учтите, что машинописные кавычки "" в тексте автоматически заменяются на «ёлочки», но всегда рассчитывать на это не стоит. При вложенности кавычек засовывайте „лапки“ в «ёлочки»: «Я точно хочу нажать „Отправить“?»

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

Проверяйте корректное написание официальных названий, зарегистрированных товарных знаков: «Android» — это не «android», «GitHub» — это не «Github».

Обращение «вы» пишем с маленькой буквы.

Правила оформления перечней (если не открывается, смотрите тут) обязательны к прочтению.

Кавычки нужно включать в ссылки: вот «так», а не вот «так».

Знаки препинания и конца предложения не нужно включать в ссылки: «конец предложения.», а не «конец предложения.»

Все знаки валют ставятся после суммы и отбиваются неразрывными ( ) пробелами: 100 $, 549 €, 1000 рублей.

Вместо самодельных символов используйте юникод: не ->, а →. Вот таблица символов с поиском по ключевому слову.

Тире, короткое тире, дефис и минус

Общие правила:

— Знак минуса — «-» — ставится ТОЛЬКО в математических формулах и уравнениях, и его вполне можно заменить дефисом: «-».
— Короткое тире — «–» — ставится в диапазонах чисел: 1–5, 9–15 и т. д. Пробелами не отбивается.
— Тире — «—» — ставится в предложениях по правилам пунктуации: «Вот эта фраза — пример такого использования». ВСЕГДА отбивается пробелами, пробел после тире имеет смысл делать неразрывным:   в HTML.
— Дефиc ставится в остальных случаях, согласно правилам орфографии: «кое-какой». Пробелами не отбивается.

Поставить длинное тире:

  • На Маке: Alt + Shift + –
  • На Виндоусе: Alt + 0151 (на цифровой клавиатуре)
  • В раскладке Бирмана: Alt + –

Если у вас Мак, проще всего запомнить хоткей. Если Виндоус, поставить типографскую раскладку Бирмана (она и с «ёлочками» поможет).

Сейчас на сайте настроена автозамена трёх дефисов на длинное тире, так что если вам очень нужно отобразить именно несколько дефисов подряд, вставляйте их с помощью HTML-кодов.

Код

Для оформления кода используется кнопка <> на панели задач. Весь код (в частности, ключевые слова языков программирования), который попадается отдельно в тексте, нужно выделять тегом <code>. Для него есть хоткей — Alt+Shift+X.

Технические тонкости

Цитаты оформляются WP-тегом quote. Если нужно указать автора и его должность, к тегу добавляются атрибуты author_name="Имя Фамилия" и author_job="должность".

Внешние ссылки обязательно открывать в новой вкладке (target='_blank'), для этого достаточно поставить соответствующую галочку у первой ссылки, нажав на шестеренку.

Если вы вставляете в запись текст, предварительно написанный в другом текстовом редакторе, делайте это через raw-редактор («Текст»), а затем работайте в визуальном редакторе. В противном случае могут подцепиться лишние HTML-теги и CSS-стили.

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

Источник

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

  • Для новостей (пример):
    Источник: <a href="ссылка_на_статью-источник">название_сайта-источника</a>
  • Для переводов (пример):
    Перевод статьи <a href="ссылка_на_статью">«название_статьи»</a>

Кроме того, в статьях, в которых ведётся повествование от 1 лица, первая строка должна быть такого же формата, как в этом или этом (а лучше всего — как в этом) примерах.

Рубрика

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

Метки

Метки (теги) должны помогать фильтровать посты, т.е. нести смысловую нагрузку: для записи нужно выбирать такие метки, что при фильтрации материалов по этой теме вы будете ожидать увидеть эту запись. Всегда нужно стараться использовать существующие. Добавлять новые можно, только если недостаточно текущих, и только по согласованию с главным редактором. Пример плохих меток: «Подборка», «Видео». Пример хороших меток: «Java», «Для начинающих».

Выставляются метки в отдельной панели в правой колонке инструментов в окне редактирования записи.

URL-адрес

Поле редактирования URL-адреса записи появляется после добавления заголовка записи в соответствующем поле. URL-адрес должен содержать ключевые английские слова, соответствующие записи. Дублировать URL-адрес исходной статьи или переводить заголовок записи не обязательно. Удачный пример: «Указатели в C++: зачем нужны, когда использовать и чем отличаются от обращения к объекту напрямую» (URL-адрес /cpp-pointers — короткий и содержит ключевые слова). Не допускаются ссылки транслитом или кириллицей.

Гостевые материалы

Если материал спонсирован, к нему добавляется плашка «Партнерский материал».

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

Чек-лист перед сдачей материала

  • Проверить орфографию, инструмент умеет проверять страницы по ссылке.
  • Выставить корректную рубрику.
  • Дать записи корректный URL-адрес.
  • Добавить метки.
  • Проверить на работоспособность ссылки в записи.
  • Проверить, что все картинки залиты к нам, то есть не ведут на внешние сайты.

Алексей Михайлишин специально для «Типичного программиста»

  1. Проверка сносок