Как отформатирован текст в курсе

Урок 3 из 135
Автор: Роберт Басыров
Сложность урока:
2 уровень - несложные понятия и действия, но не расслабляйтесь.
2 из 5
Просмотров: 414114
Дата изменения: 22.11.2024
Недоступно в лицензиях:
Текущую редакцию Вашего 1С-Битрикс можно просмотреть на странице Обновление платформы (Marketplace > Обновление платформы).
Ограничений нет

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

Всплывающие подсказки

Используются в тексте в следующих случаях:

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

Всплывающие подсказки обозначаются пунктирным подчёркиванием: пример подсказки В окне отображается подробное содержимое подсказки. Подсказка может состоять из текста и/или изображения. .

Табы (вкладки)

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

Внимание! При использовании табов поиск в браузере ищет только по открытой вкладке, а не по всему уроку.

Спойлеры, скрывающие текст

В спойлерах размещается информация, которая имеет вторичное значение, но может быть полезна «для общего развития». Для открытия спойлера кликните на «+» в спойлере:

Ознакомьтесь с простым примером как работает продукт.

Чтобы избежать лишней прокрутки экрана, в спойлерах может быть размещена большая по объёму информация.

Выделение абзаца фоном

Форматирование целых абзацев текста используется для выделения какой-либо информации с целью указать её направленность:

  • Определения каких-либо сущностей, явлений, терминов и так далее выводятся в абзацах такого вида:

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

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

    Примечание: подробное описание формы создания и редактирования теста представлено в документации по продукту.

  • Предупреждения – это информация, имеющая критическое значение для работы того или иного функционала продукта. Например:

    Важно! Если курс был деактивирован, то результаты тестов и сертификаты по этому курсу будут недоступны пользователям. Если курс был удален, то результаты тестов и сертификаты этого курса будут также удалены.

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

Форматирование текста

Стиль Назначение Пример использования
Жирный шрифт Для выделения важных в смысловом значении слов, фраз, терминов, названий элементов интерфейса. В поле Идентификатор введите краткое название латинскими буквами.
Курсив и подчёркивание Для названий продуктов компании 1С-Битрикс, сторонних программ и платформ. Также для названий методов, событий, классов, пространств имён в D7, если нет их описания в API. После изучения теоретического курса будет полезным выполнить практические задания по работе с "1С-Битрикс: Управление сайтом".
Серый фонДля выделения путей в рамках файловой системы, атрибутов, HTML-тегов, параметров функций, переменных, значений полей и короткого кода. В Короткой ссылке рекомендуется использовать знак тильда: ~.
Синий курсив Для подсветки путей в продукте. Пути выглядят так же, как они оформлены в административном разделе системы. Создание опроса начинается со страницы Группы опросов (Сервисы > Опросы > Дополнительно > Группы опросов).
Синий шрифт Подсветка URL-адреса без создания собственно ссылки – псевдо УРЛ. Пример адреса страницы с контактами: https://mysite.ru/about/contacts/.

Нам жаль это слышать… Но мы постараемся быть лучше!

Мы благодарны Вам за помощь в улучшении документации.

Спасибо, мы рады что смогли помочь Вам. Ниже Вы можете оставить свой отзыв или пожелание :)
Мы стараемся сделать документацию понятнее и доступнее,
и Ваше мнение важно для нас
Курсы разработаны в компании «1С-Битрикс»