Задание окна для открытия ссылки при редактировании в режиме кода (для ознакомления)
|
---|
В коде каждый из пунктов этого списка задается с помощью атрибута target тега <a>. Атрибут target может принимать соответственно следующие значения:
|
Как отформатирован текст в курсе

Читать монотонный текст сложно. Форматирование - один из способов облегчить понимание смысла. Опишем правила форматирования, чтобы вам было легче ориентироваться.
Вкладки
Текст урока разбивается на тематические вкладки (табы). Сделано это с целью избавить читателя от прокрутки экрана или минимизировать её. Если вам неудобно пользоваться вкладками, то их
можно отключить
, тогда весь текст урока будет выводиться в виде единого массива.
Форматирование текста
Жирный шрифт используется для выделения важных в смысловом значении слов, терминов, фраз и предложений. То есть того, что особенно важно в контексте описываемого функционала: |
- Ключевое смысловое слово, фраза.
- Термины, названия элементов интерфейса: кнопки, вкладки, поля, горячие клавиши, формат или название файла.
- Название курса, глав курса, разделов и страниц сайтов. (Как правило, название глав или курсов даются ссылкой, но иногда это бывает излишним).
|
Курсив и подчёркивание используются для выделения: |
- Названия продуктов компании 1С-Битрикс, других программ и технологических платформ.
- Названия методов, классов, функций и событий, если нет их описания в API доке. (Если описание есть, то название метода или класса оформляется ссылкой на страницу документации.)
- Пространство имён в новом ядре D7.
- Ключевое слово, фраза, термин, если использование жирного шрифта нежелательно по каким-то причинам.
|
Серый фон
текста используется для выделения:
- путей в рамках файловой системы.
- атрибутов, тегов html, параметров функций, переменных, значения полей и настроек и листинга кода, который нет смысла помещать в стиль для листинга.
|
Синий курсив с > используется для подсветки путей в продукте. То есть пути выглядят так же, как они оформлены в административном отделе системы.
|
Синий шрифт используется для подсветки УРЛ без создания собственно ссылки - псевдо УРЛ.
|
Форматирование текста цветом используется в случаях, когда надо выделять информацию, относящуюся к разным сущностям в параллельных процессах.
|
Форматирование абзацев текста
Форматирование целых абзацев текста используется для выделения какой-либо информации с целью указать направленность этой информации.
Определения каких-либо сущностей, явлений, терминов и так далее выводятся в абзацах такого вида:
В Примечании размещается информация, поясняющая текст на странице, на которую стоит обратить внимание. Это могут быть примеры, расширенное объяснение, уточнение, ссылка на дополнительную информацию. Например:
Подробнее...
Предупреждения - это информация, имеющая критическое значение для работы того или иного функционала продукта. Например:
В особо важных случаях в этом виде форматирования может использоваться красный шрифт.
Всплывающие подсказки
Всплывающие подсказки обозначаются цветом шрифта и пунктирным подчёркиванием. Такие подсказки используются там, где:
- Нужно пояснить какой-то термин.
Пример: Как правило, все сайты имеют возможность авторизации из публичного раздела Публичный раздел - то, что видит посетитель сайта, но для контент-менеджера - это основное место работы . Подробнее... . - Дать наглядное представление о команде интерфейса.
Пример: При включённом режиме Правки откройте на редактирование элемент инфоблока, например, новость.
- Дать дополнительную, но не относящуюся напрямую к выполняемым работам, информацию.
Пример: Этот инструмент создаст ссылку с одним единственным слешом Слеш - косая черта, которая используется для разделения слов в адресе сайта после домена сайта Домен сайта - адрес по которому открывается самая главная страница. Например: yandex.ru . - Дать описание и ссылку на страницу компонента в пользовательской документации.
Пример: Простую фотогалерею в публичном разделе выводит комплексный компонент Фотогалерея 2.0 Комплексный компонент Фотогалерея 2.0 позволяет получить полнофункциональную фотогалерею, создавая физически только одну страницу.
Описание компонента «Фотогалерея 2.0 (комплексный компонент)» в пользовательской документации. .
Спойлеры, скрывающие текст
В спойлерах размещается информация, которая имеет вторичное значение, но может быть полезна "для общего развития". Для открытия спойлера надо просто кликнуть на "+" в спойлере:
Чтобы избежать лишней прокрутки экрана, в спойлерах может быть размещена большая по объёму информация.
и Ваше мнение важно для нас