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

Урок 3 из 135

Автор: Роберт Басыров

Сложность урока:

2 уровень - несложные понятия и действия, но не расслабляйтесь.

2 из 5

Дата изменения: 09.11.2024

Недоступно в лицензиях:

Текущую редакцию Вашего 1С-Битрикс можно просмотреть на странице Обновление платформы (Marketplace > Обновление платформы).

Ограничений нет

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

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

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

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

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

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

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

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

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

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

Ознакомьтесь с простым примером как работает продукт.
Предлагаем упрощенное, очеловеченное, объяснение работы инфоблоков и компонентов, предложенное нашим студентом и немного адаптированное нами, авторами: Проведем аналогии: База данных - это склад на котором хранятся различные овощи (различные виды информации); Инфоблоки - это тара или ящики, в которые насыпают овощи. Например, картошку насыпают в одни ящики, а яблоки - в другие; Модуль «Информационные блоки» - это цех по производству различной тары (ящиков) для хранения овощей на складе; Модуль, используемый для обработки информации из инфоблоков - это цех по переработке овощей. Например, из картофеля он умеет изготавливать разные продукты: чипсы, выпаривать крахмал или делать быстрорастворимое сухое пюре; Компонент - это руководитель и мастер цеха Компонент Иванович. Человек на самом деле очень опытный и ответственный, знающий свое дело как пять пальцев. У него хранятся ключи от овощехранилища и без его ведома никто на склад попасть не может; Контент-менеджер - это Контент Васильевич, собственник предприятия (продукта 1С-Битрикс), производящего различные продукты питания из овощей (информации). А теперь история одного рабочего дня на предприятии. Обращается как-то Контент Васильевич к Компоненту Ивановичу (Контент-менеджер настраивает параметры компонента на инфоблок) и говорит: Компонент Иванович, нужно нам картошку переработать со склада, ту что недавно подвезли и произвести из нее сухое картофельное пюре. Займись этим, будь другом, загрузи цех работой! Компонент Иванович, отвечает: Конечно, Контент Васильевич! Всё сделаем, можете не беспокоиться. Достает из кармана ключи и отправляется на склад. Открывает его, находит ящики (инфоблоки) наполненные картофелем (однородной информацией), оценивает качество и дает распоряжения работникам склада отнести необходимое кол-во ящиков в цех на переработку. Работники цеха - люди опытные, свое дело знающие, легко выполнят распоряжение о переработке картофеля, производстве пюре с определенными свойствами и расфасовке в упаковку заданного формата. Цех дружно принимается за дело и к обозначенному сроку выдаёт запрошенный продукт. Отблагодарив работников, Компонент Иванович докладывает Контенту Васильевичу о благополучном исполнении поручения и показывает результат (на экране Контент-менеджер видит результат обработанной информации из инфоблока). Заключение: заметьте, что в нашем жизненном примере на предприятии тоже всё устроено непросто: есть и цеха, и работники, и склад, где всё хранится в определенном порядке. Но собственник предприятия дал распоряжение ответственному и быстро получил результат. Так и Контент-менеджер загружает информацию и выбирает нужные параметры, а продукт Все его составляющие: инфоблоки, компоненты, модули и т.д. выполняет сложную работу и выдаёт результат.

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

Предлагаем упрощенное, очеловеченное, объяснение работы инфоблоков и компонентов, предложенное нашим студентом и немного адаптированное нами, авторами:

Проведем аналогии:

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

А теперь история одного рабочего дня на предприятии.

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

Компонент Иванович, отвечает: Конечно, Контент Васильевич! Всё сделаем, можете не беспокоиться. Достает из кармана ключи и отправляется на склад. Открывает его, находит ящики (инфоблоки) наполненные картофелем (однородной информацией), оценивает качество и дает распоряжения работникам склада отнести необходимое кол-во ящиков в цех на переработку.

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

Отблагодарив работников, Компонент Иванович докладывает Контенту Васильевичу о благополучном исполнении поручения и показывает результат (на экране Контент-менеджер видит результат обработанной информации из инфоблока).

Заключение: заметьте, что в нашем жизненном примере на предприятии тоже всё устроено непросто: есть и цеха, и работники, и склад, где всё хранится в определенном порядке. Но собственник предприятия дал распоряжение ответственному и быстро получил результат. Так и Контент-менеджер загружает информацию и выбирает нужные параметры, а продукт Все его составляющие: инфоблоки, компоненты, модули и т.д. выполняет сложную работу и выдаёт результат.

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

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

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

Определения каких-либо сущностей, явлений, терминов и так далее выводятся в абзацах такого вида:
Курс – организованная и логически завершенная последовательность страниц, содержащих информацию о некоторой предметной области.
В Примечании размещается информация, поясняющая текст на странице, на которую стоит обратить внимание. Это могут быть примеры, расширенное объяснение, уточнение, ссылка на дополнительную информацию. Например:
Примечание: подробное описание формы создания и редактирования теста представлено в документации по продукту.
Предупреждения – это информация, имеющая критическое значение для работы того или иного функционала продукта. Например:
Важно! Если курс был деактивирован, то результаты тестов и сертификаты по этому курсу будут недоступны пользователям. Если курс был удален, то результаты тестов и сертификаты этого курса будут также удалены.

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

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

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

Мы стараемся сделать документацию понятнее и доступнее,
и Ваше мнение важно для нас

Предыдущий урок

Наверх

Следующий урок

Курсы разработаны в компании «1С-Битрикс»