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

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

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

Для каждой записи желательно наличие изображения в шапке. Задается в блоке «Изображение записи» в правой колонке на странице редактирования записи. Изображения должны быть строго размера 770х270. Предпочтительнее flat-стиль. С целью минимизации размера файлов для фотографий используйте формат JPEG (progressive), для рисунков — PNG. Картинки не должны нарушать копирайты.

На обложке размещать какие-либо надписи крайне нежелательно!

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

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

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

Пример короткой цитаты прямо в тексте.

Текст

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

Правила оформления перечней (если не открывается, смотрите тут) обязательны к прочтению. Короткие цитаты в тексте WP-тегом pullquote, длинные — blockquote. Внешние ссылки обязательно открывать в новой вкладке (target=’_blank’), для этого достаточно поставить соответствующую галочку у первой ссылки. Обращение «вы» пишем с маленькой буквы.

Учтите, что машинописные кавычки "" в тексте автоматически заменяются на «ёлочки», но всегда рассчитывать на это не стоит.

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

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

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

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

Источник

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

  • Для новостей (пример):

    Источник: <a href="ссылка_на_статью-источник">название_сайта-источника</a>

  • Для переводов (пример):

    Перевод статьи <a href="ссылка_на_статью">«название_статьи»</a>

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

Рубрика

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

Метки

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

URL-адрес

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

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

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

Кроме того, все гостевые материалы помечаются тегом «Материалы от друзей Tproger».

Публикация ссылки ВКонтакте

У каждого поста автоматически прописываются OpenGraph теги. Картинка подцепляется из обложки, заголовок из названия, описание из первых символов текста. Если ВКонтакте уже закешировал информацию про пост, можно использовать инструмент для очистки кеша. Публиковать ссылки на посты желательно с подцепленными тегами, т.е. без дополнительной прикреплённой картинки. Если у поста на сайте обложки нет (не подходит ни одна, либо все с копирайтами), то картинку необходимо добавить в SEO-модуле внизу страницы редактирования записи. Для ВКонтакте подтянется та же картинка, что для Facebook.

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

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

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

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