Просмотров: 296090
Дата последнего изменения: 26.05.2023
Сложность урока:
2 уровень - несложные понятия и действия, но не расслабляйтесь.
3
4
5
Недоступно в лицензиях:
Ограничений нет
Читать монотонный текст сложно. Форматирование - один из способов облегчить понимание смысла. Опишем правила форматирования, чтобы вам было легче ориентироваться.
Вкладки
Текст урока разбивается на тематические вкладки (табы). Сделано это с целью избавить читателя от прокрутки экрана или минимизировать её. Если вам неудобно пользоваться вкладками, то их
можно отключить
, тогда весь текст урока будет выводиться в виде единого массива.
Внимание! При использовании вкладок поиск в браузере ищет только по открытой вкладке, а не по всему уроку.
Форматирование текста
|
Жирный шрифт используется для выделения важных в смысловом значении слов, терминов, фраз и предложений. То есть того, что особенно важно в контексте описываемого функционала: |
- Ключевое смысловое слово, фраза.
- Термины, названия элементов интерфейса: кнопки, вкладки, поля, горячие клавиши, формат или название файла.
- Название курса, глав курса, разделов и страниц сайтов. (Как правило, название глав или курсов даются ссылкой, но иногда это бывает излишним).
| Примеры использования жирного шрифта
|
| Пример названия курса или главы | Изучение курса позволяет освоить основные методы администрирования системы, а также пополнить знания по темам, изученным в курсе Контент-менеджер. |
| Пример названий элементов интерфейса: | При этом у компонента Список новостей нужно настроить входные параметры так, чтобы он мог формировать ссылки на страницу детальной новости (с кодом новости). Для этого нужно в группе параметров Шаблоны ссылок в поле URL страницы детального просмотра задать путь к этой странице, а также название параметра, в котором будет передаваться код новости для показа. |
| Пример ключевой фразы, слова | При регистрации сервера обязательно укажите Домен для NTLM авторизации. Он должен полностью (включая регистр) совпадать с названием домена. |
|
| и |
Курсив и подчёркивание используются для выделения: |
- Названия продуктов компании 1С-Битрикс, других программ и технологических платформ.
- Названия методов, классов, функций и событий, если нет их описания в API доке. (Если описание есть, то название метода или класса оформляется ссылкой на страницу документации.)
- Пространство имён в новом ядре D7.
- Ключевое слово, фраза, термин, если использование жирного шрифта нежелательно по каким-то причинам.
| Примеры использования курсива
|
| Пример названия метода: | Усовершенствованные методы буферизации в шаблоне позволяют более не использовать CBitrixComponentTemplate::EndViewTarget() ввиду того, что конец шаблона вызывает завершение буферизации автоматически. (Если страница метода в документации есть, то будет так: Перед подключением компонента ко всем значениям параметров применяется функция
htmlspecialcharsEx
Функция переводит текст в HTML-безопасный вид, заменяя специальные символы их визуальным HTML представлением.
Подробнее...
)
|
| Пример названий продуктов и платформ: | Чтобы научиться эффективно работать в Bitrix Framework, нужно не сравнивать то, что вы знаете по другим системам, а стараться понять, как то или иное реализуется в этой системе. В плане обучения «сравнительный» подход не работает. Просто отвлекитесь от старых знаний и изучите новую систему, используя только знания PHP и сайтостроения, а не сравнивая идеологии и технологии. |
| Пример пространства имён в D7: | При необходимости модуль может организовывать подпространства внутри своего пространства имен. Например, Bitrix\Main\IO, Bitrix\Forum\SomeName\SomeNameTwo. |
|
Серый фон текста используется для выделения:
- путей в рамках файловой системы.
- атрибутов, тегов html, параметров функций, переменных, значения полей и настроек и листинга кода, который нет смысла помещать в стиль для листинга.
| Примеры использования серого фона
|
| Пример выделения путей в рамках файловой системы: | Результаты кеширования сохраняются в виде файлов в каталоге /bitrix/cache/. |
| Пример выделения атрибутов, тегов и так далее: | Если в компоненте написать код:
$arParams = & $arSomeArray;
то переменная $arParams будет отвязана от члена класса компонента и привязана к массиву $arSomeArray. |
|
Синий курсив с > используется для подсветки путей в продукте. То есть пути выглядят так же, как они оформлены в административном отделе системы.
| Примеры использования синего курсива
|
| Пример оформления путей в административном отделе системы: | Файлы кеша можно удалить в административной части на закладке Очистка файлов кеша страницы Настройки > Настройки продукта > Автокеширование. |
|
Синий шрифт используется для подсветки УРЛ без создания собственно ссылки - псевдо УРЛ.
| Примеры использования синего шрифта
|
| Пример псевдо УРЛ: | При помощи access_token приложение совершает запросы к REST-сервису до его истечения.
https://имя_портала.bitrix24.ru/rest/user.current?auth=код_авторизации |
|
Форматирование текста цветом используется в случаях, когда надо выделять информацию, относящуюся к разным сущностям в параллельных процессах.
| Примеры использования цветного шрифта
|
| Цветной шрифт: | - Настроить инфоблок на контроллере:
........
- На подключенном сайте надо создать инфоблок с таким же значением внешнего кода, как и на контроллере. Кроме привязки к сайту, названия и внешнего кода необходимо настроить и права доступа к инфоблоку.
......
|
|
Форматирование абзацев текста
Форматирование целых абзацев текста используется для выделения какой-либо информации с целью указать направленность этой информации.
Определения каких-либо сущностей, явлений, терминов и так далее выводятся в абзацах такого вида:
Статическая информация – это информация, которая редко изменяется с течением времени. Например, рекламные тексты, история компании, контактная информация и т.п. Статическая информация создается, редактируется, дополняется и удаляется пользователями, обладающими правом на редактирование страниц сайта. Такое редактирование производится, как правило, в визуальном редакторе непосредственно в тексте самой страницы.
В Примечании размещается информация, поясняющая текст на странице, на которую стоит обратить внимание. Это могут быть примеры, расширенное объяснение, уточнение, ссылка на дополнительную информацию. Например:
Примечание. В ядре D7 настройки кеширования производятся в
специальном файле
Настройки выполняются в файле /bitrix/.settings.php.
Подробнее...
Предупреждения - это информация, имеющая критическое значение для работы того или иного функционала продукта. Например:
Важно! Если курс был деактивирован, то результаты тестов и сертификаты по этому курсу будут недоступны пользователям. Если курс был удален, то результаты тестов и сертификаты этого курса будут также удалены.
В особо важных случаях в этом виде форматирования может использоваться красный шрифт.
Всплывающие подсказки
Всплывающие подсказки обозначаются цветом шрифта и пунктирным подчёркиванием. Такие подсказки используются там, где:
- Нужно пояснить какой-то термин.
Пример: Как правило, все сайты имеют возможность авторизации из
публичного раздела
Публичный раздел - то, что видит посетитель сайта, но для контент-менеджера - это основное место работы . Подробнее...
.
- Дать наглядное представление о команде интерфейса.
Пример: При включённом режиме Правки откройте на
редактирование элемент инфоблока
, например, новость.
- Дать дополнительную, но не относящуюся напрямую к выполняемым работам, информацию.
Пример: Этот инструмент создаст ссылку с одним единственным
слешом
Слеш - косая черта, которая используется для разделения слов в адресе сайта
после
домена сайта
Домен сайта - адрес по которому открывается самая главная страница. Например: yandex.ru
.
- Дать описание и ссылку на страницу компонента в пользовательской документации.
Пример: Простую фотогалерею в публичном разделе выводит комплексный компонент
Фотогалерея 2.0
Комплексный компонент Фотогалерея 2.0 позволяет получить полнофункциональную фотогалерею,
создавая физически только одну страницу.
Описание компонента «Фотогалерея 2.0 (комплексный компонент)» в пользовательской документации.
.
Внимание! Всплывающие подсказки не работают в файлах формата CHM и Epub. Интернет на мобильных устройствах на сегодняшний день - не проблема, используйте эти файлы документации только в крайнем случае.
Спойлеры, скрывающие текст
В спойлерах размещается информация, которая имеет вторичное значение, но может быть полезна "для общего развития". Для открытия спойлера надо просто кликнуть на "+" в спойлере:
|
Задание окна для открытия ссылки при редактировании в режиме кода (для ознакомления)
|
|---|
| В коде каждый из пунктов этого списка задается с помощью атрибута target тега <a>. Атрибут target может принимать соответственно следующие значения:
- _blank;
- _parent;
- _self;
- _top.
|
Чтобы избежать лишней прокрутки экрана, в спойлерах может быть размещена большая по объёму информация.
Видеоролики
Видеоролики обычно располагаются в начале соответствующего урока. Также вы можете следить за новыми роликами:
