Callouts (Или “блоки выделения” / “сноски”) в Obsidian позволяют создавать визуально отличимые блоки текста для разных целей (заметки, предупреждения, вопросы и т.д.). Они основаны на синтаксисе блоков цитирования (>), но начинаются со специальной конструкции [!тип].
Основной синтаксис:
[!тип] Заголовок (опционально)
[!тип] Заголовок (опционально) Содержимое Callout. Каждая строка должна начинаться с "> " или быть правильно отступлена.
Если заголовок не указан, будет использоваться “тип” Callout (например, [!note] без заголовка отобразит “Note”).
Стандартные Типы Callouts
Note (или Abstract, Summary, Tldr)
Общая заметка, важная информация, резюме, “слишком длинно, не читал”. Иконка: Карандаш или Информационный значок.
Краткое содержание
[!note] Краткое содержание Этот Callout используется для общих заметок или выделения ключевой информации в тексте.
Tldr
[!tldr] Суть конспекта: ООП в Python базируется на классах и объектах, принципах инкапсуляции, наследования, полиморфизма и абстракции.
Info (или Todo)
Информационное сообщение, что-то к выполнению. Иконка: ‘i’ в круге или Галочка в круге.
Важная информация
[!info] Важная информация Убедитесь, что у вас установлен Python версии 3.6 или выше для работы с примерами кода.
Todo
[!todo] Добавить раздел про исключения в ООП.
Tip (или Hint, Important)
Совет, подсказка, что-то важное для запоминания. Иконка: Лампочка или Восклицательный знак в круге.
Полезный совет
[!tip] Полезный совет Используйте `@property` для создания "умных" атрибутов вместо явных геттеров и сеттеров.
Подсказка по синтаксису
[!hint] Подсказка по синтаксису Для создания приватных атрибутов используйте префикс `__` (два подчеркивания).
Success (или Check, Done)
Подтверждение успеха, что-то выполнено или верно. Иконка: Галочка.
Успешно
[!success] Успешно Раздел "Классы и Объекты" полностью изучен и понят!
Done
[!done] Все примеры кода протестированы и работают.
Question (или Help, Faq)
Вопрос, запрос помощи, часто задаваемые вопросы. Иконка: Знак вопроса.
Вопрос для самопроверки
[!question] Вопрос для самопроверки В чем заключается разница между методом класса и статическим методом?
Частые вопросы по ООП
[!faq] Частые вопросы по ООП Как решить проблему "ромба" при множественном наследовании?
Warning (или Caution, Attention)
Предупреждение, что-то, на что стоит обратить внимание. Иконка: Треугольник с восклицательным знаком.
Внимание!
[!warning] Внимание! Не злоупотребляйте множественным наследованием, это может усложнить поддержку кода.
Будьте осторожны
[!caution] Будьте осторожны Изменение атрибутов класса может повлиять на все его существующие и будущие экземпляры.
Error (или Danger, Fail, Failure, Missing)
Ошибка, что-то критическое, что-то не найдено или не сработало. Иконка: Знак “X” или Молния.
Ошибка при выполнении
[!error] Ошибка при выполнении При попытке создать экземпляр абстрактного класса произошла ошибка.
Fail
[!fail] Тест на полиморфизм завершился неудачей.
Bug (или Debug)
Ошибка или проблема в коде/системе, информация для отладки. Иконка: Жук или Знак отладки.
Обнаружен баг
[!bug] Обнаружен баг Метод `calculate_area` для класса `Square` возвращает неверное значение при отрицательных сторонах.
Лог отладки
[!debug] Лог отладки Переменная `self._price` имеет неожиданное значение после вызова сеттера.
Example
Пример кода, текста или концепции. Иконка: Список с маркерами или Документ.
Пример Инкапсуляции
[!example] Пример Инкапсуляции Использование `_protected_var` и `__private_var` демонстрирует соглашения Python.
Quote (или Cite)
Цитата. Иконка: Кавычки.
Бьёрн Страуструп
[!quote] Бьёрн Страуструп "Программирование — это искусство..."
Из книги "Чистый код"
[!cite] Из книги "Чистый код" "Хороший код рассказывает историю."
Дополнительные возможности Callouts
- Сворачивание: Добавьте
-после типа, чтобы сделать Callout свернутым по умолчанию (> [!info]+ Свернутая информация). Использование+делает его развернутым, но с возможностью свернуть.
Пример свернутого кода
[!info]- Пример свернутого кода code or text or smt
-
Пользовательские типы: Вы можете использовать любое имя в конструкции
[!любое_имя], а затем стилизовать его с помощью CSS-фрагмента.Мой особый блок
Этот блок имеет уникальный стиль, определенный в моем CSS-фрагменте (для вас он синий как классический note т.к. стиль не определен)
Использование Callouts помогает визуально организовать информацию и быстро находить нужные блоки в ваших заметках.
〰〰〰 𓆝 𓆟 𓆞 𓆝 𓆟 𓆝 𓆟 𓆞 〰〰〰