ПРЕДЫДУЩАЯ ПУБЛИКАЦИЯ
Введение
В первой публикации мы упомянули важность простого текста для Zettelkasten, о чем мы и попытаемся поговорить в дальнейшем. Для того чтобы работать с информацией, необходима более удобная визуализация и представление информации в электронном источнике, чем просто простой текст. Поэтому в IT индустрии стали придумывать некоторые специальные символы, применение которых совместно с простым текстом приведет к оформленному специальным образом документу, тому документу, который мы так привыкли видеть на экранах и прежде всего в интернете. Эти специальные символы, форматирующие простой текст, называют тегами. Одним из представителей такого формата является HTMLс новаторской идеей отделить от текста команды оформления – CSS.
Проблема формата #HTML, заключается в том, что тэгов форматирования стало слишком много, что делает невозможным обычному человеку набирать текст в данном формате.
Тогда и появилась идея, создать формат с максимально упрощенной разметкой, которую любой человек мог быстро запомнить и применить – MARKDOWN текст, или просто MD текст.
MD– это открытый формат, основанный на обычных текстовых файлах, и поэтому в будущем должен быть доступен для чтения любым компьютером, который может работать с текстовыми файлами. Вы можете свободно редактировать заметки в других программах, даже если они открыты в OBSIDIAN. OBSIDIAN основывается и работает на MD формате, но при этом добавляет в него небольшие свои добавления, которые не портят концепцию упрощенной разметки. По большей части, если все, что вы используете, может быть преобразовано в MARKDOWN, оно будет довольно хорошо работать в OBSIDIAN. В MARKDOWN OBSIDIAN Вы также можете использовать CSS, при этом предлагается достаточно много уже готовых шаблонов стилей оформления.
MARKDOWN OBSIDIAN
Публикация - это не теоретический справочник (в OBSIDIAN он также и на русском языке), поэтому мы кратко обозначим некоторые основные моменты.
В OBSIDIAN документ можно просматривать либо в режиме редактирования, либо в режиме предварительного просмотра. В режиме редактирования вы увидите базовую визуализацию #MARKDOWN, но некоторые вещи, такие как подсветка синтаксиса кода и встроенные файлы, будут отображаться только в режиме предварительного просмотра.
На практике для работы достаточно режима редактирования.
OBSIDIAN автоматически сохраняет вашу заметку через две секунды после того, как вы перестанете печатать или закроете панель. Вы также можете выполнить сохранение вручную в любое время, набрав: Ctrl/Cmd-S.
Если вы хотите скопировать текст только без форматирования, пожалуйста, используйте для этого Ctrl-Shift-V.
Форматирование
В OBSIDIAN возможны 6 уровней заголовков:
Заголовок любой заметки создается всегда на уровне 1.
Выделение текста:
Достаточно легко создать списки, указать тире, либо цифру с точкой, а затем пробел и список готов, табуляция позволяет выравнивать текст по горизонтальным уровням.
Ссылки
В OBSIDIAN используются внутренние и внешние ссылки. По внешним ссылкам подробно можно посмотреть в документации, обратим внимание: при копировании в OBSIDIAN ссылки из интернета, например, используя Ctrl-V, она автоматически преобразуется во внешнюю ссылку в формате MD.
Создание внутренних ссылок
Для создания внутренней ссылки на заметку просто наберите [[ - OBSIDIAN сам добавит завершающие ]]. Вам будет предложен список заметок, на которые вы можете ссылаться. Используйте клавиши со стрелками вверх и вниз для перемещения по списку и Enter для вставки ссылки на выделенную заметку.
В итоге Вы получите в режиме редактирования:
В режиме просмотра:
Если вы укажите наименование не существующего заголовка заметки, OBSIDIAN все равно создаст ссылку на такую заметку. При щелчке мышкой на такой ссылке заметка будет автоматически создана в базе знаний и Вам останется только применить к ней шаблон и обозначить теги типа и состояния.
Для того чтобы в области предварительного просмотра в ссылке отображался текст, отличный от заголовка заметки, на которую она ссылается, используйте вертикальную черту |. Например, [[Имя ссылки|Отображаемое имя ссылки]], в нашей заметке: [[00 javadoc | javadoc]] (пробелы с вертикальной чертой - допустимы), поэтому по итогу получаем наименование ссылки не «00 javadoc» а просто «javadoc»:
Аналогично вид внутренней ссылки в нашей заметке на документ (в строке «book title:»):
[[имя файла.pdf| ISBN-10: 1-292-22187-9]]
Для отображения в заметке скана изображения (предварительно файл изображения должен быть помещен в каталог базы знаний, где хранятся файлы изображений, документов), достаточно ввести:
![[имя файла.png]]
В OBSIDIAN возможны внутренние ссылки на заголовки, на абзацы текста как внутри заметки, так и в других заметках. Это отдельная особенность OBSIDIAN, расширяющая MARKDOWN, и поэтому может не поддерживаться другими программами.
Таблицы
Вы можете создавать таблицы просто из текста. Шапка таблицы (первая строка) отделяется от остальных строк дефисами -. Столбцы разделяются вертикальной чертой |:
Блоки
КОД
Под кодом подразумевается программный код, но данная возможность полезна и для простого выделения, в том числе информации, содержащей специфические символы (это полезно там, где есть риски пересечения с MD форматом). В OBSIDIAN есть возможность подсвечивать код программирования большого количества языков, список поддерживаемых языков можно найти здесь.
Для этого достаточно ввести код в следующую структуру: между тремя последовательными обратными кавычками с указанием кода языка программирования (```js), в данном случае это JavaScript и закрывающими данный блок тремя последовательными обратными кавычками:
Важно: весь код, где бы он не был указан в заметке, рассматривается OBSIDIAN как обычный текст, а это значит, что, помещая заметку с кодом в базу знаний, методами анализа (рассмотренными в публикации 3) можно получить всю необходимую информацию по данному коду из базы знаний.
МАТЕМАТИЧЕСКИЕ ФОРМУЛЫ
Для отображения формулы в отдельном блоке, необходимо заключить ее в двойные $$:
ДИАГРАММЫ
OBSIDIAN использует библиотеку Mermaid для отображения диаграмм и схем. У Mermaid есть удобный «живой редактор» (подход аналогичен используемому для кода):
ВСТРОЕННЫЙ ЗАПРОС
В публикации 3 мы упоминали о возможности использования системы поиска и отбора внутри заметки, сейчас мы можем показать это. Подход аналогичен как при отображении кода – используем всю ту же последовательность обратных кавычек, только вместо наименования языка разработки указывается кодовое слово «query». Теперь внутри данного блока мы сможем использовать все возможности системы поиска и отбора OBSIDIAN. Я добавил в нашу заметку «Comments» запрос по тегу состояния notstarted (об этом мы поговорим в следующей публикации, данный тег означает в моем Zettelkasten пустую заметку, и это значит, что этот запрос покажет в базе знаний все пустые заметки):
Результат в заметке «Comments»:
СЛЕДУЮЩАЯ ПУБЛИКАЦИЯ
