Поля отношений
Ключевые понятия
В разделе Edge fields (поля отношений) настройки позвляют назначить типам связей определённые роли. Впоследствии эти поля отношений применяют в в метаданных заметок.
Например, в проектной документации в заметках [[изделие]], [[узел]] и [[деталь]] описана поузловая сборка. Определены типы связей:
- компонент (composition);
- модуль (aggregation).
В метаданных заметок следует указать:
- поле с типом связи;
- наименование связующей заметки.
Пример заметки «изделие.md»:
aggregation: "[[узел]]"Пример заметки «узел.md»:
composition: "[[деталь]]"Плагин выстроит отношения в правильном порядке:
flowchart LR
Узел -->|модуль| Изделие
Деталь -->|компонент| Узел
Смысл полей отношений определяет пользователь. Пользователь может свободно вводить собственные названия полей и определять направления отношений между заметками.
В настройках плагина пользователь может определить имплицитные отношения, которые автоматически сформируют дополнительные связи. Например, задание функции календарные заметки (Date notes) может:
- соединить последовательно созданные заметки через связь «следующий — предыдущий» по дате;
- сгруппировать заметки по периоду: неделе, месяцу, кварталу или году.
Стиль стрелок Mermaid
Для каждого отношения в настройках плагина можно задать вид стрелок на схемах Mermaid.
По умолчанию определены следующие стрелки:
| Вид | Описание |
|---|---|
| default | Линия и стрелка по умолчанию для блока кода |
--> | Сплошная линия со стрелкой |
--- | Сплошная линия без стрелки |
| =⇒ | Толстая линия со стрелкой |
| === | Толстая линия без стрелки |
-.-> | Пунктивная линия со стрелкой |
-.- | Пунктивная линия без стрелки |
--o | Круг на конце |
--x | Крест на конце |
Если два ребра, соединяющих пару узлов имеют одинаковые пользовательские стрелки, плагин объединяет их в двунаправленную линию. Например, =⇒ и ⇐= будут изображены как ⇐=⇒ . Если же линии и стрелки различны, будут отображены две однонаправленные линии.
Скрыть поле в боковой панели
В настройках для каждого поля рядом с названием поля предусмотрена возможность «Скрывать в боковых панелях» (Hide in side views). Если включить, поле продолжит срабатывать, но больше не будет отображено в боковых панелях «Матрица» (Matrix) и «Дерево» (Tree).
Подобное поведение удобно для служебных полей, которые используют для навигации по графу, но не должны загромождать боковые панели. Если снять флажок, поле будет возвращено в представления.
Данная настройка влияет только на боковые панели «Матрица» и «Дерево». Поле по-прежнему будет представлено:
- в блоках кода с эксплицитным списком полей;
- в панелях «Путь» (Trail) и «Предыдущая, следующая страница» (Previous-Next).
Отношение с самим собой
В настройках можно задать имплицитное отношение заметки с собой (Self). Указанные поля автоматически получают отношение самозацикливания по указанному полю. И как источник, и как цель.