Правила оформления

Эта страница содержит правила оформления этого сайта и не является частью учебного материала. Если вы случайно попали сюда, то можете посмотреть почему тут всё так оформлено.

Если вы один из редакторов, пожалуйста, ознакомьтесь внимательно.

Размер текста

Для основного текста и примеров используйте, пожалуйста 12pt. По умолчанию в шаблоне сайта используется 11pt. Это мелковато для обучающего материала.

Размеры для заголовков и подзаголовков используйте из шаблона. С ними всё в порядке.

Ширина текста

Широкие тексты труднее читать и понимать. Особенно, если материал сложноват.

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

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

Если к низу монитора приклеить полоску от sticky note, то выравнивание
пойдёт быстрее.

Страницы секции Vocabulary оформлены по-другому. Они не «прижаты» влево, а отцентрированы. Это сделано потому, что карусели картинок лучше работают в этом случае и на десктопе, и на планшетах, и на мобилах.

Оформление примеров

Примеры английского текста оформляются на сером фоне, сдвинутым вправо на два уровня отступа (Increase indent), непропорциональным шрифтом:

This is how we demo an English text around here.

Кавычки вокруг английских слов

В рабочей переписке мы usually mix английские слова в русский текст. В подобном «суржике» слова латинице и кирилицей нами воспринимаются как семантически равноправные.

На этом сайте мы выделяем английские слова, которые являются предметом обучения, чтобы они были виднее читателю:

  • в кавычки ёлочки («»), когда текст вокруг на русском;

  • в кавычки лапки (“”) в тексте на английском;

  • with bold font, если слово нуждается в дополнительном внимании в рамках примера или основного текста:

Sometimes you have to be bold.

One Heading — One Section

Section — такая широкая полоска с content, слева от которой показываются кнопки выбора цвета фона, операцией копирования и удаления.

Заголовок оформляется как отдельный Text box.

Параграф текста прижимается к нему в рамках одной секции.

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

Следующий заголовок первого уровня должен идти в своей собственной секции.

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

Содержание страницы

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

Примените Style 2 (серый фон) к этой секции.

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

... вместо пустых параграфов. Таким образом текст будет на всех страницах оформлен аккуратно и единообразно.

Пополнение Vocabulary

Если вы планируете пополнение материала раздела Vocabulary, пожалуйста, учтите следующее:

  1. Компонент Image carousel показывает ограниченное количество картинок.

  2. Мы не рассчитываем на то, что читатели будут сидеть и учить слова в карусели.

  3. Карусели призваны заинтересовать читателя скачать архив и использовать его содержимое для самостоятельного обучения.

  4. На этот ZIP архив ведут кнопки «Download» под каруселями.

Процедура обновления архива selected-vocabulary.zip

2. Добавьте в него новые материалы.

3. Удалите из архива папку __MACOSX, если вы работаете под macOS:

zip -d selected-vocabulary.zip __MACOSX/\*

4. Обновите архив на Google Drive:

5. Проверьте, что новая версия скачивается с опубликованного сайта.

Давайте немного «воздуха» в конце страницы

Основной текст идёт на белом фоне. Потом в самом конце страницы идёт «подвал» с тёмно-серым фоном. Чтобы текст не обрывался слишком внезапно, вставляйте текстовый блок содержащий один пробел в последней секции страницы.

Обновляйте Release Note секцию

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