PlanCake

Добро пожаловать в PlanCake

PlanCake позволяет удобно читать файлы Markdown и оставлять заметки прямо там, где они нужны. Он показывает файл таким, каким его и задумано читать: настоящие заголовки, списки, таблицы и блоки кода вместо решёток и звёздочек. PlanCake создан для длинных планов реализации, которые пишут ИИ-ассистенты для программирования — нередко от 800 строк и больше, — но он работает с любым файлом Markdown.

Чтение — это только половина проверки. Вторая половина — сказать, что вы думаете: «этот шаг неправильный», «сначала сделай вот это». В PlanCake вы щёлкаете по абзацу, элементу списка, заголовку, строке таблицы или блоку кода, который хотите прокомментировать, либо нажимаете Enter на нём, и вводите свою заметку. PlanCake записывает её прямо в файл Markdown, сразу после этого блока, между парой маркеров. Вам никогда не нужно считать строки или вычислять, куда вставить заметку, — PlanCake знает, из каких строк файла взят каждый блок. Тот, кто откроет файл следующим, будь то коллега или ИИ-ассистент вроде Claude, найдёт ваши заметки именно там, где им положено быть.

Несколько вещей стоит знать заранее. PlanCake — это не текстовый редактор: кроме ваших заметок и флажков в списках задач, он никогда не изменяет текст документа. Сохранять нечего — каждая заметка попадает в файл в момент, когда вы её подтверждаете. PlanCake работает в Windows 10 и 11 (64-разрядных), и всё в нём одинаково хорошо работает мышью, только с клавиатуры и с программой экранного доступа.

Быстрый старт

1. Откройте план: запустите PlanCake из меню «Пуск» и перетащите файл Markdown на его окно, либо нажмите Ctrl+O и выберите файл. Из командной строки то же самое делает команда plancake plan.md.
2. Прочитайте его. Заголовки, списки, таблицы и код отображаются отформатированными; прокручивайте колесом мыши либо клавишами со стрелками и перелистывания страниц.
3. Дойдя до того, что хотите прокомментировать, щёлкните по этому месту. С клавиатуры нажимайте Alt+Shift+Стрелка вниз или Alt+Shift+Стрелка вверх, чтобы переходить от блока к блоку, пока нужный не будет выделен рамкой, затем нажмите Enter. Откроется диалог «Добавить заметку» с курсором в поле заметки.
4. Введите заметку и нажмите Enter либо щёлкните ОК. Заметка появится сразу после блока, а строка состояния сообщит «Заметка добавлена». Она уже в файле.
5. Продолжайте читать и добавлять заметки. Закончив, закройте окно — сохранять нечего.

Установка PlanCake

PlanCake существует в двух видах: установщик, который всё настроит за вас, и портативная версия, которая запускается из любой папки, включая USB-накопитель. После запуска оба варианта работают одинаково; различие только в том, где PlanCake хранит свои настройки. Загрузите любой из них с сайта PlanCake.

С помощью установщика

Запустите установщик и следуйте его шагам. Помимо самого PlanCake, он позаботится о том, что нужно PlanCake для работы: он установит .NET 10 Desktop Runtime и среду выполнения Microsoft Edge WebView2, если их ещё нет на вашем компьютере. Он также добавит PlanCake в переменную PATH, поэтому команда plancake будет работать в любом новом окне PowerShell или командной строки.

Ваши настройки хранятся в %APPDATA%\Oire\PlanCake.

Установщик добавляет PlanCake в меню «Пуск» вместе с ярлыком этого руководства на языке, который вы выбрали для установщика.

PlanCake не подписан сертификатом подписи кода. Поэтому при первом запуске установщика или файла plancake.exe из портативного zip-архива фильтр Windows SmartScreen может показать сообщение «Система Windows защитила ваш компьютер» и неизвестного издателя. Чтобы продолжить, выберите Подробнее, а затем Выполнить в любом случае.

Портативная версия

Распакуйте zip-архив в любую папку и запустите оттуда plancake.exe. В архив входит пустая папка userdata рядом с plancake.exe; пока эта папка на месте, PlanCake хранит настройки в ней и ничего не записывает в ваш профиль пользователя. Удалите или переименуйте папку userdata, и PlanCake снова начнёт использовать %APPDATA%\Oire\PlanCake.

Портативная версия ничего не устанавливает, поэтому на компьютере уже должны быть .NET 10 Desktop Runtime и среда выполнения Microsoft Edge WebView2. В Windows 11 WebView2 уже есть; если её нет, PlanCake сообщит об этом при запуске и предложит открыть страницу загрузки.

Чтобы пользоваться командой plancake с портативной версией, либо указывайте полный путь к ней, либо самостоятельно добавьте её папку в PATH.

Удаление PlanCake

Удалите PlanCake в разделе «Приложения» параметров Windows или командой «Деинсталлировать PlanCake» в меню «Пуск». Программа удаления убирает PlanCake из PATH и спрашивает, удалить ли также ваши настройки и журналы; ваши файлы Markdown и заметки в них она никогда не затрагивает. Портативная версия ничего не устанавливает: чтобы удалить её, удалите её папку.

Если вы работаете в обычной учётной записи Windows, а удаление разрешает администратор, вводя свой пароль, программа удаления работает от имени этого администратора и ищет его настройки, а не ваши, поэтому о них не спрашивает. Тогда ваши настройки и журналы остаются в %APPDATA%\Oire\PlanCake и %LOCALAPPDATA%\Oire\PlanCake; если они вам больше не нужны, удалите эти папки сами.

Более короткая команда: pk

Если вы целыми днями открываете планы из командной строки, можно дать PlanCake двухбуквенное имя. Сам PlanCake этого не делает — это одна строка в вашем собственном профиле оболочки.

• В PowerShell добавьте эту строку в свой профиль (файл, путь к которому хранится в $PROFILE):

  Set-Alias pk plancake

• В bash добавьте эту строку в .bashrc:

  alias pk=plancake

После этого pk plan.md открывает план, и любая команда из раздела Работа из командной строки работает с pk вместо plancake.

Главное окно

В верхней части окна находится строка меню, слева — документ, справа — список заметок, а в самом низу — строка состояния. Заголовок окна показывает имя открытого файла, например plan.md - PlanCake.

Чтобы дать документу или списку заметок больше места, перетащите границу между ними. С клавиатуры выберите Расширить список заметок или Сузить список заметок в меню «Вид»: каждая команда сдвигает границу на десятую часть общей ширины, до круглого значения — например, с 32 процентов список станет шириной 40 процентов или 30 процентов. Строка состояния сообщит новую долю, например «Список заметок 40%». Ни одна из сторон не может сжаться до исчезновения: список остаётся не менее примерно 150 пикселей шириной, а документ — примерно 200. У этого предела граница останавливается, и строка состояния повторяет текущую долю. Обе команды недоступны, пока список заметок скрыт.

PlanCake запоминает размер и положение окна, было ли оно развёрнуто, ширину списка заметок и масштаб: следующее окно открывается так же, на экране, который по-прежнему подключён. Самое первое окно подстраивается под экран, на котором открывается.

Документ

Это ваш файл Markdown в отформатированном виде. Когда PlanCake открывает файл, он начинается с самого начала. Ваши заметки тоже показываются внутри документа, каждая сразу после блока, к которому она относится, и визуально отделена от текста плана, чтобы вы сразу видели, что написано вами.

Список заметок

Список заметок собирает в одном месте все заметки файла, в порядке их появления. В нём три столбца:

Заметка

Первое предложение заметки в одну строку, без разметки Markdown. Столбец занимает всю ширину, которую оставляют два других. Наведите указатель мыши на строку, чтобы увидеть заметку целиком.

Строки

Где заметка находится в файле: 12 для однострочной заметки, 12-14 для более длинной.

Блок

Первое предложение блока, за которым следует заметка, чтобы вы понимали, о чём она, не переходя к ней. В обоих столбцах очень длинное предложение по возможности сокращается на запятой, двоеточии или тире.

Чтобы перейти к заметке в документе, нажмите Enter на её строке или дважды щёлкните по ней; фокус переместится на заметку. Чтобы удалить заметку, выделите её и нажмите Delete; после этого выделение переходит на ближайшую оставшуюся заметку, так что вы никогда не теряете место в списке. Щёлкните по строке правой кнопкой мыши либо нажмите клавишу Клавиша приложений или Shift+F10, чтобы открыть меню с командами «Изменить заметку» и «Удалить заметку».

Если хотите отдать документу всё окно, выберите Список заметок в меню «Вид». Список скроется, а повторный выбор снова его покажет; строка состояния сообщит «Список заметок скрыт» или «Список заметок показан». PlanCake запоминает выбор: это тот же переключатель, что и Показывать список заметок в настройках, поэтому новые окна открываются так же, а другие открытые окна следуют ему, как только вы в них переключитесь.

Переключение между документом и списком

Щёлкните там, где хотите работать, или нажмите F6, чтобы переключиться между документом и списком заметок. Если в списке нет заметок, строка состояния сообщит «Заметок нет».

Tab тоже работает: нажатие Tab после последней ссылки или флажка в документе переводит в список заметок, и Shift+Tab с первого элемента списка делает то же самое. Из списка Tab и Shift+Tab возвращают в документ.

Когда список заметок скрыт, и F6, и Tab оставляют фокус в документе. F6 перемещает фокус — он не показывает скрытый список снова. Для этого используйте Вид, Список заметок.

Сообщения в строке состояния

Ничто в PlanCake не происходит бесшумно. Каждое изменение — добавленная заметка, отмеченная задача, перезагруженный файл, завершённая загрузка — подтверждается коротким сообщением в строке состояния внизу окна, например «Заметка добавлена» или «Файл перезагружен». Сообщение остаётся там, пока его не заменит следующее.

Вопросы, которые задаёт PlanCake

Когда PlanCake задаёт вопрос с ответом «да» или «нет» — удалить эту заметку? отметить эту задачу? перезагрузить этот файл? — нажатие Escape отвечает Нет, и то же самое делает закрытие вопроса его кнопкой закрытия. Вы всегда можете отступить, ничего не выбрав.

В остальных диалогах — Добавить заметку, Настройки, Открыть по ссылке — Escape равносилен кнопке «Отмена»: он закрывает диалог и отменяет введённое. В диалогах «Сочетания клавиш» и «О программе PlanCake» Escape просто закрывает их.

Работа с программой экранного доступа

PlanCake был создан с учётом программ экранного доступа, и, если вы ею пользуетесь, стоит знать несколько подробностей:

• Документ — это веб-страница, поэтому вы читаете его обычными клавишами навигации своей программы экранного доступа — по заголовкам, спискам, таблицам и так далее. Чтобы прокомментировать блок, перейдите к нему и нажмите Enter; вы остаётесь в своём режиме чтения, на том же месте. После сохранения вы попадаете на новую заметку.
• Каждое сообщение строки состояния озвучивается независимо от того, где находится фокус, поэтому вы слышите «Заметка добавлена», «Заметок больше нет» или «Файл перезагружен», даже не ища строку состояния. Если вы пропустили сообщение, команда вашей программы экранного доступа для чтения строки состояния или повтора последнего сообщения озвучит его снова.
• Каждая заметка в документе — это область с названием «Заметка пользователя», чтобы вы могли отличить её от собственного текста плана.
• Настройка «Язык документа» сообщает вашей программе экранного доступа, каким голосом читать план, независимо от языка интерфейса: план на английском языке читается английским голосом, даже если Windows и PlanCake работают на русском.
• Когда файл перезагружается после изменения извне, страница обновляется на месте, поэтому позиция чтения остаётся прежней.
• Ctrl+A намеренно не выделяет весь документ: выделение текста оставлено на усмотрение команд вашей программы экранного доступа.

Открытие файла

Планы попадают к вам разными путями: файл на диске, путь, который кто-то вставил в чат, ссылка на GitHub. PlanCake умеет открывать их все напрямую, не требуя ничего предварительно сохранять. Каким бы способом вы ни открыли файл, он всегда начинается с самого начала.

Когда ни один файл не открыт, окно перечисляет способы открыть файл и их клавиши. Большой файл может открываться не сразу: если это занимает больше полсекунды или файл больше 1 МБ, PlanCake показывает диалог «Открытие файла» с индикатором выполнения. Нажмите Escape или кнопку Отмена, чтобы прервать открытие; открытый до этого файл останется как был.

Из командной строки

Введите plancake, а после — файл:

plancake docs\plans\001-plan.md

Откроется окно с этим файлом. Введите просто plancake, чтобы получить пустое окно. Можно также перетащить файл Markdown на plancake.exe или на ярлык к нему.

Из диалога открытия или перетаскиванием

Перетащите файл Markdown из Проводника и отпустите его на окне PlanCake. Либо нажмите Ctrl+O, либо выберите Открыть в меню «Файл»: стандартный диалог открытия Windows покажет файлы Markdown (.md и .markdown); переключите тип файлов на Все файлы, чтобы увидеть всё.

Из буфера обмена

Нажмите Ctrl+V в окне PlanCake или выберите Открыть из буфера обмена в меню «Файл». PlanCake смотрит, что вы скопировали:

• Файл, скопированный в Проводнике: PlanCake откроет его. Если вы скопировали несколько файлов, откроется первый из них, являющийся файлом Markdown.
• Путь, скопированный как текст, с кавычками или без них (команда Проводника Копировать как путь добавляет их): PlanCake откроет этот файл.
• Веб-ссылка, начинающаяся с http:// или https://: PlanCake загрузит файл и откроет его, как описано в следующем разделе.

Если в буфере обмена что-то другое, строка состояния сообщит «В буфере обмена нет файла Markdown или ссылки.»

По ссылке из интернета

Допустим, коллега прислал вам ссылку на план на GitHub. Нажмите Ctrl+L или выберите Открыть по ссылке в меню «Файл». Поле «Ссылка» уже заполнено, если в буфере обмена есть ссылка; иначе вставьте её или введите вручную. Нажмите Enter или щёлкните ОК, чтобы загрузить; нажмите Escape или щёлкните Отмена, чтобы отказаться.

Строка состояния покажет «Загрузка из github.com...», а по завершении загрузки — куда сохранён файл; после этого план откроется. Загрузки попадают в вашу папку «Загрузки» под собственным именем файла и всегда как файл Markdown: к ссылке на файл другого типа добавляется .md, так что tool.bat сохраняется как tool.bat.md и никогда не запустится. Как и браузер, PlanCake помечает файл как загруженный из интернета; если файл с таким именем там уже есть, PlanCake добавит номер, например plan (2).md, как это делает браузер. Поскольку загруженный файл — это обычный файл на вашем диске, ваши заметки сохраняются в нём так же, как в любом другом.

Несколько вещей о ссылках:

• Можно вставить обычную ссылку на страницу файла на GitHub; PlanCake сам получит необработанный Markdown, что за ней стоит.
• Ссылка на обычную веб-страницу, а не на файл Markdown, отклоняется: «Эта ссылка ведёт на веб-страницу, а не на файл Markdown.»
• Загрузка останавливается через 30 секунд, а файлы больше 10 МБ не загружаются.

Одно окно на файл

Каждый файл получает собственное окно, и один файл никогда не открыт в двух окнах одновременно. Если вы открываете файл, который уже открыт в другом окне PlanCake — из командной строки, из буфера обмена, откуда угодно, — PlanCake выводит то окно на передний план вместо того, чтобы открывать второе. Так два окна никогда не смогут записать в один и тот же файл противоречащие друг другу заметки.

Чтение документа

Перемещение по документу

Прокручивайте колесом мыши или полосой прокрутки, либо используйте клавиши со стрелками, Page Up, Page Down, Home и End. Tab перемещает от ссылки к ссылке и от флажка к флажку. Выделяйте текст мышью и копируйте его клавишами Ctrl+C, как в любой другой программе; завершение выделения никогда не открывает диалог заметки.

Чтобы поработать с определённым блоком с клавиатуры — абзацем, заголовком, элементом списка, строкой таблицы, блоком кода или заметкой — нажмите Alt+Shift+Стрелка вниз для следующего блока и Alt+Shift+Стрелка вверх для предыдущего, либо выберите Следующий блок и Предыдущий блок в меню «Заметки». Блок получит рамку и прокрутится в область видимости. Нажмите Enter, чтобы добавить к нему заметку (или изменить её, если это уже заметка), либо клавишу Клавиша приложений для его меню. В начале или в конце документа строка состояния сообщит «Блоков больше нет».

Переход начинается от блока или заметки, с которыми вы работали или к которым переходили последними. Если такого ещё не было, Alt+Shift+Стрелка вниз переходит к первому видимому блоку, а Alt+Shift+Стрелка вверх — к последнему. В списке заметок эти же клавиши переходят к блоку в документе и оставляют фокус там.

Переход по ссылкам и назад

Щёлкните по ссылке или нажмите на ней Enter, и PlanCake сделает то, что уместно для того, куда она ведёт:

• Веб-ссылка открывается в вашем браузере по умолчанию.
• Ссылка на другой файл Markdown рядом с этим открывает его в PlanCake, в том же окне.
• Ссылка на папку открывает её в Проводнике, а ссылка на текстовый файл, PDF или изображение открывает его программой, которую Windows использует для него. Любой другой файл (программа, сценарий, например .bat, .js или .py, или файл любого другого типа, открытие которого может что-то запустить) по ссылке никогда не открывается, что бы ни говорил её текст: вместо этого PlanCake спрашивает, показать ли файл в Проводнике. По ссылке на файл в сетевой папке другого компьютера PlanCake не переходит.
• Ссылка на заголовок в том же документе переводит к этому заголовку.
• Если ссылка ведёт на несуществующий файл, строка состояния сообщает об этом и показывает путь.

PlanCake запоминает файлы, которые вы открывали в окне, и то, на каком месте вы были в каждом из них, — как история браузера. Нажмите Alt+Стрелка влево или Backspace, либо выберите Назад в меню «Вид», чтобы вернуться к предыдущему файлу, точно на то место, где вы его оставили. Alt+Стрелка вправо или Вперёд снова переходит вперёд. На концах истории строка состояния сообщает «Предыдущего файла нет» или «Следующего файла нет». Если файл из истории с тех пор был удалён, PlanCake сообщает об этом и пропускает его.

Открытие файла любым другим способом — клавишами Ctrl+O, перетаскиванием, из буфера обмена, по ссылке — тоже добавляет его в историю, так что Назад всегда возвращает вас к тому, что вы читали раньше.

Масштабирование

Чтобы увеличить текст, нажмите Ctrl+Плюс; чтобы уменьшить — Ctrl+Минус. Клавиши на цифровой клавиатуре тоже работают, как и команды «Увеличить масштаб» и «Уменьшить масштаб» в меню «Вид». Каждый шаг меняет размер на 10 процентов, в пределах от 50 до 300 процентов, и строка состояния показывает новый размер, например «Масштаб 120%». Нажмите Ctrl+0, чтобы вернуться к 100 процентам. Следующее открытое окно начнёт с того же масштаба.

Язык документа

PlanCake различает два языка: язык своих меню и диалогов и язык, на котором написан документ. Переключение интерфейса на французский не делает английский план французским. Язык документа важен, когда план читается вслух (см. Работа с программой экранного доступа), и помогает PlanCake распознавать старые кодировки файлов (см. Файлы не в UTF-8).

Новые документы используют Язык документа из настроек — английский, пока вы его не измените. Чтобы задать другой язык для одного конкретного файла, выберите Язык документа в меню «Вид» и укажите его. Это применяется только к открытому файлу; следующий открытый файл снова использует язык из настроек.

Заметки

Добавление заметки

1. Щёлкните по абзацу, заголовку, элементу списка, строке таблицы или блоку кода, который хотите прокомментировать. Блок под указателем мыши подсвечивается, так что видно, к какому блоку щелчок добавит заметку. С клавиатуры перейдите к нему клавишами Alt+Shift+Стрелка вниз или Alt+Shift+Стрелка вверх (см. Перемещение по документу) и нажмите Enter. Откроется диалог «Добавить заметку». Он показывает начало блока под надписью Заметка к, чтобы вы могли убедиться, что выбрали нужный, и помещает курсор в поле «Заметка».
2. Введите заметку. Чтобы начать в ней новую строку, нажмите Ctrl+Enter.
3. Нажмите Enter или щёлкните ОК, чтобы сохранить; нажмите Escape или щёлкните Отмена, чтобы отказаться. ОК недоступна, пока поле пусто, и нажатие Enter тогда лишь сообщает «Сначала введите заметку.»

PlanCake сразу же записывает заметку в файл, прямо после блока. Документ обновляется, строка состояния сообщает «Заметка добавлена», и новая заметка оказывается там, где вы сейчас находитесь. Она также появляется в списке заметок.

Достаточно одного щелчка; двойной щелчок не делает ничего сверх одиночного. Выделение текста мышью не открывает диалог, так что вы по-прежнему можете выделять и копировать текст как обычно.

Если вам удобнее, чтобы Enter создавал новую строку, а Ctrl+Enter сохранял, измените Enter в диалоге заметки в настройках. Если вы хотите, чтобы щелчок или Enter на блоке открывали меню, а не диалог — например, потому что вы часто щёлкаете, чтобы просто встать на блок, а заметки при этом добавляются случайно, — измените Enter или щелчок по блоку. Обе настройки описаны в разделе Настройки заметок.

Заметку можно добавить и через контекстное меню: щёлкните по блоку правой кнопкой мыши либо нажмите на нём клавишу Клавиша приложений или Shift+F10 и выберите Добавить заметку.

Изменение заметки

Щёлкните по заметке в документе либо перейдите к ней клавишами F9 или Alt+Shift+Стрелка вниз и нажмите Enter. Откроется тот же диалог, но с заголовком «Изменить заметку» и заполненный текстом заметки. Измените его и сохраните; строка состояния сообщит «Заметка изменена».

Открыть заметку для изменения можно также из списка заметок, через контекстное меню или командой «Изменить заметку» в меню «Заметки».

Удаление заметок

Чтобы удалить одну заметку, выделите её в списке заметок и нажмите Delete. Либо щёлкните по заметке правой кнопкой мыши — в документе или в списке — или нажмите на ней клавишу Клавиша приложений или Shift+F10 и выберите Удалить заметку. PlanCake спросит «Удалить эту заметку?» и покажет её текст; щёлкните Да или нажмите Enter. Строка состояния сообщит «Заметка удалена». Если вы не хотите, чтобы вас спрашивали каждый раз, отключите Спрашивать перед удалением заметки в настройках.

Чтобы удалить сразу все заметки из файла — скажем, после того как автор плана разобрался со всеми ими, — выберите Удалить все заметки в меню «Правка». PlanCake всегда спрашивает заранее, называя число заметок, независимо от настройки.

Переход от заметки к заметке

Нажмите F9 для следующей заметки и Shift+F9 для предыдущей, либо используйте Следующая заметка и Предыдущая заметка в меню «Заметки». В документе это переводит вас к заметке; в списке заметок — перемещает выделение. После последней заметки или перед первой строка состояния сообщит «Заметок больше нет».

Отмена изменения

Нажмите Ctrl+Z, чтобы отменить действие, и Ctrl+Y, чтобы повторить его, либо используйте Отменить и Повторить в меню «Правка». Это охватывает всё, что записывает PlanCake: добавление, изменение и удаление заметок, удаление всех заметок, а также отметку и снятие отметки с задач. Строка состояния сообщает, что было отменено или повторено, например «Добавление заметки отменено» или «Отметка задачи повторена», а «Нечего отменять» — когда отменять больше нечего.

Отмена работает только пока файл всё ещё содержит то, что PlanCake записал последним. Если с тех пор файл изменило что-то другое, PlanCake не отменяет поверх этого изменения; он сообщает: «Файл изменился, поэтому больше нечего отменять или повторять.»

Форматирование внутри заметки

В заметке можно использовать разметку Markdown: выделение, встроенный код, ссылки, списки и даже блок кода. В документе заметка показывается отформатированной, а файл хранит ровно то, что вы напечатали.

Два исключения сохраняют структуру плана нетронутой. Заголовок, набранный в заметке, показывается как полужирный текст, а не как настоящий заголовок, поэтому ваши заметки никогда не смешиваются с собственными заголовками плана. А теги HTML, которые вы наберёте, показываются как обычный текст.

Заметка не может содержать собственный закрывающий маркер, по умолчанию [/usernote], потому что это преждевременно завершило бы её. Если вы используете единственный маркер без закрывающего (см. Настройки заметок), заметка не может содержать и этот маркер, поскольку он начал бы вторую заметку. Если вы наберёте один из них, PlanCake оставит диалог открытым и объяснит почему.

Как заметка выглядит в файле

Заметки — это обычный текст в вашем файле Markdown, заключённый в пару маркеров. Заметка к абзацу выглядит так:

Back up the database before you run the migration.
[usernote]Also back up the uploads folder.[/usernote]

Тот, кто откроет файл в текстовом редакторе, и любой инструмент, который его читает, увидит ваши заметки. Вы даже можете написать заметку вручную в том же виде, и PlanCake покажет её как свою собственную. Чтобы использовать другие маркеры, см. Настройки заметок.

Маркеры внутри кода не считаются заметками: между обратными апострофами, как в `[usernote]`, или в блоке кода. Не считаются заметками и маркеры в HTML: внутри HTML-комментария, <!-- … -->, или в блоке <pre>, <script>, <style> или <textarea>, от открывающего тега до закрывающего. Если Открывающий маркер сам начинается с <!--, маркеры внутри комментариев по-прежнему считаются заметками. План или руководство, где маркеры показаны как пример, сохраняет их как есть, и ни окно, ни команды их не трогают. Сам PlanCake никогда не пишет заметку внутри кода: заметка к блоку кода записывается в строку после него.

Копирование текста блока

Чтобы скопировать абзац, элемент списка или другой блок без разметки Markdown, щёлкните по нему правой кнопкой мыши либо нажмите на нём клавишу Клавиша приложений или Shift+F10 и выберите Копировать текст блока. Строка состояния сообщит «Текст блока скопирован».

Отметка выполненных задач

Многие планы содержат списки задач — такие строки в файле, как - [ ] Write the tests. PlanCake показывает их как настоящие флажки, чтобы вы могли отмечать шаги по ходу дела, не открывая редактор.

1. Щёлкните по флажку либо нажмите на нём Пробел или Enter.
2. PlanCake спросит «Отметить эту задачу как выполненную? Файл на диске будет изменён.» (или «Отметить эту задачу как невыполненную? Файл на диске будет изменён.» для уже отмеченной задачи) и покажет задачу. Щёлкните Да или нажмите Enter. Если вы ответите Нет, флажок останется точно таким же, как был.
3. PlanCake запишет [x] или [ ] в этой строке файла. Фокус останется на флажке, а строка состояния сообщит «Задача отмечена» или «Отметка с задачи снята».

Если вы часто отмечаете задачи и вопрос вам не нужен, отключите Спрашивать, прежде чем отметить задачу или снять с неё отметку в настройках. Ctrl+Z отменяет отметку так же, как любое другое изменение.

Задача с подзадачами, часть из которых выполнена, а часть нет, показывается частично отмеченной. Это только отображение: в Markdown нет третьего состояния, поэтому для неё ничего не записывается. Отметка такой задачи помечает выполненной только её саму — строки её подзадач никогда не затрагиваются.

Когда файл изменяется вне PlanCake

План на проверке редко остаётся неподвижным: его обновляет ИИ-ассистент, правит коллега, система контроля версий приносит новую редакцию. PlanCake замечает, когда открытый файл меняется на диске, и сразу перезагружает его. Строка состояния сообщает «Файл перезагружен», а вы остаётесь там, где читали, — страница обновляется на месте, а не возвращается к началу.

Если вы предпочитаете решать сами, установите При изменении файла на диске в значение Спрашивать, перезагружать ли его в настройках. Тогда PlanCake будет спрашивать, перезагружать ли файл. Если вы ответите Нет, он сообщит, что клавиша F5 перезагрузит файл, когда вы будете готовы.

Если файл удалён, переименован или перемещён, PlanCake сообщит об этом, и команды работы с заметками будут недоступны, пока файл не вернётся. Когда он снова появится на прежнем месте, PlanCake сообщит, что он вернулся, и перезагрузит его.

PlanCake никогда не перезаписывает изменение, которого не видел. Предположим, файл изменился, пока вы печатали заметку. Когда вы сохраните её, PlanCake откажется записывать, покажет файл в его нынешнем виде и сообщит «Файл изменился. Попробуйте ещё раз.» Ничего не теряется ни с той, ни с другой стороны: добавьте заметку заново, и она попадёт в текущую версию файла.

Файлы не в UTF-8

Почти все файлы Markdown сегодня хранятся в UTF-8. Более старые файлы, особенно на таких языках, как русский или иврит, иногда сохранены в устаревшей кодировке Windows. PlanCake открывает и правильно показывает их, но по умолчанию не записывает в них: файл открывается только для чтения, и PlanCake сообщает об этом, называя кодировку, например «Этот файл не в UTF-8, поэтому он открыт только для чтения в кодировке Windows-1251. Добавлять к нему заметки нельзя. Чтобы преобразовать его в UTF-8, включите в настройках преобразование файлов, записанных не в UTF-8.»

Чтобы добавлять заметки в такие файлы, включите Преобразовывать в UTF-8 при открытии в дополнительных настройках. После этого PlanCake преобразует каждый такой файл в UTF-8 в момент открытия и сообщает об этом, например «Файл преобразован из Windows-1251 в UTF-8.» Меняется только кодировка; текст и переносы строк остаются прежними.

Иногда PlanCake не может точно определить, в какой кодировке сохранён файл. Такой файл всегда остаётся только для чтения, что бы ни говорила настройка: «Не удалось распознать кодировку этого файла, поэтому он открыт только для чтения и никогда не изменяется. Добавлять к нему заметки нельзя.» Это твёрдое правило. Запись файла, прочитанного неверно, уничтожила бы символы, которые PlanCake не смог разобрать, а PlanCake никогда так не поступает.

Настройка «Язык документа» — одна из подсказок, которые PlanCake использует для распознавания устаревшей кодировки, так что установка в ней языка, на котором написаны ваши старые файлы, помогает.

Настройки

Нажмите Ctrl+Запятая или выберите Настройки в меню «Файл». Настройки расположены на трёх вкладках: Общие, Заметки и Дополнительно; щёлкните по вкладке или переключайтесь между ними клавишами Ctrl+Tab и Ctrl+Shift+Tab. Щёлкните ОК, чтобы применить изменения — они вступят в силу сразу, без перезапуска PlanCake, — или Отмена (Escape), чтобы отменить их.

Общие

Язык интерфейса

Язык меню, диалогов и сообщений: English (английский), Русский, Українська (украинский), Français (французский), עברית (иврит) или Deutsch (немецкий). Язык системы, значение по умолчанию, следует за языком Windows и использует английский, если Windows работает на языке, которого нет у PlanCake. На иврите всё окно располагается справа налево. Переключить его можно и командой «Язык интерфейса» в меню «Вид». Эта настройка не меняет язык документа.

Язык документа

Язык, на котором PlanCake предполагает написанным вновь открытый документ. По умолчанию: английский. Он никогда не следует за языком интерфейса или Windows. См. Язык документа.

При изменении файла на диске

Перезагружать его (по умолчанию) перезагружает файл, как только что-то другое его изменит. Спрашивать, перезагружать ли его сначала спрашивает вас. См. Когда файл изменяется вне PlanCake.

Спрашивать перед удалением заметки

Включено по умолчанию. Отключите, чтобы удалять отдельные заметки без вопроса. Удалить все заметки спрашивает всегда.

Спрашивать, прежде чем отметить задачу или снять с неё отметку

Включено по умолчанию. Отключите, чтобы отмечать задачи одним щелчком или нажатием клавиши.

Показывать список заметок

Включено по умолчанию. Отключите, чтобы скрыть список заметок в этом окне и во всех остальных. Это тот же переключатель, что и Список заметок в меню «Вид»: изменив один, вы меняете и другой.

Проверять обновления при запуске

Включено по умолчанию. PlanCake проверяет один раз при запуске и молчит, если нет новой версии.

Проверять обновления в фоне

Как часто PlanCake проверяет снова, пока продолжает работать: Раз в день, Раз в 3 дня, Раз в неделю (по умолчанию), Раз в месяц или Никогда. Никогда отключает только эти повторные проверки, но не проверку при запуске.

Заметки

Открывающий маркер

Текст, с которого заметка начинается в файле. По умолчанию: [usernote]. Он не может быть пустым, не может начинаться или заканчиваться пробелом либо двойной кавычкой и не может содержать разрыв строки.

Закрывающий маркер (оставьте пустым, чтобы использовать один маркер, который действует до конца строки)

Текст, которым заметка заканчивается. По умолчанию: [/usernote]. К нему применяются те же правила, и он должен отличаться от открывающего маркера. Если оставить его пустым, заметка идёт от открывающего маркера до конца строки; тогда заметки всегда занимают одну строку, а любые разрывы строк, которые вы наберёте в заметке, становятся пробелами. Если маркеры нарушают одно из этих правил, строка под ними объясняет почему, начиная со слова «Ошибка:», а программа экранного доступа зачитывает её, как только вы сделаете паузу в наборе.

Enter или щелчок по блоку

Добавляет заметку (по умолчанию) открывает диалог «Добавить заметку». Открывает контекстное меню вместо этого показывает меню блока, где вы выбираете Добавить заметку или Копировать текст блока; выберите это, если замечаете, что добавляете заметки случайно. Щелчок или Enter на уже существующей заметке всегда открывает её для изменения, а щелчок правой кнопкой мыши, клавиша Клавиша приложений и Shift+F10 всегда открывают меню.

Enter в диалоге заметки (Ctrl+Enter — наоборот)

Сохраняет заметку — значение по умолчанию. Начинает новую строку подходит для длинных заметок из нескольких абзацев. Что бы вы ни выбрали, Ctrl+Enter делает противоположное.

Дополнительно

Преобразовывать в UTF-8 при открытии

По умолчанию отключено, поэтому файлы в устаревших кодировках открываются только для чтения и никогда не изменяются. Включите, чтобы PlanCake при открытии преобразовывал файл не в UTF-8 в UTF-8 без маркера порядка байт (BOM), позволяя добавлять заметки. При преобразовании файл на диске перезаписывается. Файл, кодировку которого PlanCake не может распознать, никогда не преобразуется. См. Файлы не в UTF-8.

Работа из командной строки

PlanCake умеет работать и без окна. Четыре команды читают заметки в файле, проверяют, остались ли они, удаляют их все или экспортируют файл в HTML. Они созданы для скриптов и для ИИ-ассистентов: Claude использует их, чтобы прочитать ваши заметки к плану и убедиться, что каждая из них учтена.

Каждая команда следует одному и тому же образцу:

plancake <command> <file> [options]

Введите plancake --help для списка команд или plancake list --help для параметров конкретной команды. Вывод — в UTF-8 без маркера порядка байт. Ошибки идут в поток ошибок, с кодом выхода 1. Ошибкой считается и опечатка в имени команды, например plancake chek («Неизвестная команда: chek. Возможно, вы имели в виду check?»): окно с несуществующим файлом в этом случае не открывается.

Команды list, check и export никогда не изменяют ваш файл Markdown. Только clear делает это.

Вывод списка заметок

plancake list plan.md

Эта команда выводит по одной строке на заметку: строки заметки, строки блока, за которым она следует, начало этого блока и саму заметку. Строки нумеруются с 1, как в текстовом редакторе. Разрывы строк внутри заметки показываются как косая черта.

43-43 after 41-42 "Back up the database before you run the migration.": Also back up the uploads folder.

Заметка перед первым блоком файла не следует ни за каким блоком, и её строка говорит об этом:

1-1 at the start: Read the whole plan before you start.

Этот формат предназначен для скриптов, поэтому его неизменные слова и пунктуация — «after», «at the start», дефис, кавычки — остаются английскими независимо от языка интерфейса.

Добавьте --json для формата JSON: список объектов с полями noteStartLine, noteEndLine, blockStartLine, blockEndLine, blockKind, blockExcerpt и text. Строки нумеруются с 1. Поле blockKind принимает значения paragraph, heading, listItem, code, tableRow или start — для заметки перед первым блоком; у такой заметки blockStartLine и blockEndLine равны null, а blockExcerpt пуст. Добавьте -o (или --output) и имя файла, чтобы записать результат в файл вместо экрана:

plancake list plan.md --json -o notes.json

Экспорт заметок в меню «Файл» сохраняет из окна тот же JSON.

Проверка того, остались ли заметки

plancake check plan.md

Эта команда выводит число заметок, например 2 заметки, и завершается с кодом выхода 0, если их нет, 3, если они есть, и 1, если файл не удалось прочитать. Скрипт может различить три случая: готово, заметки ещё остались, что-то сломалось.

Удаление всех заметок

plancake clear plan.md

Эта команда удаляет из файла все заметки и выводит, сколько их удалено, например Удалены 2 заметки. Для файла в устаревшей кодировке команда clear следует настройке преобразования: если преобразование отключено или кодировку не удаётся распознать, она отказывается изменять файл, в котором есть заметки, и объясняет почему. Добавьте --convert, чтобы в этот раз преобразовать такой файл в UTF-8 независимо от настройки; файл, кодировку которого не удаётся распознать, по-прежнему никогда не изменяется.

plancake clear old-plan.md --convert

Экспорт в HTML

plancake export plan.md -o plan.html

Эта команда записывает автономную веб-страницу документа с чётко выделенными заметками, чтобы поделиться ею с тем, кто не пользуется PlanCake. Страница содержит собственные стили и не содержит скриптов. Параметр -o обязателен. Язык страницы — это Язык документа из настроек; чтобы использовать другой, добавьте --lang и код языка, например --lang fr. Заголовок страницы — это первый заголовок документа либо имя файла, если заголовков нет. Изображения, которые являются файлами на вашем компьютере, например ![Схема](diagram.png) рядом с планом, встраиваются в страницу, поэтому она показывает их, где бы её ни открыли; изображение больше 10 МБ или в сетевой папке другого компьютера не встраивается. Изображения из интернета остаются ссылками.

Другие маркеры для одного запуска

По умолчанию команды используют маркеры из настроек. Чтобы задействовать другие для одного запуска, добавьте:

--open-marker <text>

Маркер, с которого начинается заметка.

--close-marker <text>

Маркер, которым заметка заканчивается.

--single-token

У заметок нет закрывающего маркера, и они заканчиваются вместе со строкой. Это нельзя сочетать с --close-marker.

plancake check plan.md --open-marker "!NOTE!" --single-token

PowerShell и cmd не ждут

PlanCake — это оконная программа для Windows, а интерактивные PowerShell или командная строка не ждут завершения таких программ. Когда вы вводите команду в приглашении, оно может вернуться раньше, чем появится вывод; вывод тогда покажется ниже него. Он полон — просто запаздывает.

Вывод, перенаправленный по конвейеру или перехваченный, всегда полон, потому что оболочка его дожидается. Так обстоит дело в bash, когда вы перенаправляете его в другую команду, и в собственных вызовах инструментов Claude.

В скриптах PowerShell есть одна ловушка: присвоение вывода переменной — это не перенаправление по конвейеру. $notes = plancake list plan.md не ждёт завершения и оставляет $LASTEXITCODE пустым. Вместо этого перенаправьте команду по конвейеру либо запустите её через cmd:

$notes = plancake list plan.md | Out-String
plancake check plan.md | Out-Host
$LASTEXITCODE

cmd /c "plancake check plan.md"

Проверка плана вместе с Claude

Вот как всё это сочетается, когда Claude пишет план и просит вас его проверить. Вы открываете план командой pk plan.md, читаете его и оставляете заметки везде, где не согласны или хотите изменений. Когда вы говорите Claude, что закончили, он выполняет plancake list plan.md --json, чтобы прочитать ваши заметки вместе с теми блоками, к которым они относятся, дорабатывает план и удаляет заметки, которые учёл. Команда plancake check plan.md подтверждает, что ничего не осталось.

Если вы используете плагины Debussy для Claude Code, их этап проверки плана человеком читает заметки, помеченные маркерами из настройки noteMarkers в Debussy, где пара маркеров записывается как open...close. Маркеры PlanCake по умолчанию, [usernote] и [/usernote], подходят под это соглашение как есть. О том, как это настроить, см. документацию Debussy; её исходный код на GitHub.

Справочник по клавиатуре и мыши

Эти сочетания клавиш фиксированы, их нельзя изменить. Все их можно посмотреть и в самом PlanCake: выберите Сочетания клавиш в меню «Справка».

В любом месте окна

В документе

В списке заметок

В диалоге заметки

Если вы установите Enter в диалоге заметки на Начинает новую строку, Enter и Ctrl+Enter поменяются местами.

Справочник по меню

Щёлкните по названию меню, нажмите Alt или F10, чтобы попасть в строку меню, либо откройте меню напрямую: Alt+Ф для меню Файл, Alt+П для меню Правка, Alt+В для меню Вид, Alt+З для меню Заметки, Alt+С для меню Справка. Команды, которые сейчас неприменимы — Отменить, когда нечего отменять, Следующая заметка в файле без заметок, — недоступны.

Файл

Правка

Вид

Заметки

Справка

Контекстные меню

Откройте контекстное меню щелчком правой кнопкой мыши либо клавишей Клавиша приложений или Shift+F10.

Обновление PlanCake

PlanCake проверяет наличие новых версий при запуске, а затем раз в неделю, и молчит, если не находит новой. Когда появляется новая версия, окно описывает её и предлагает установить; можно также пропустить эту версию или получить напоминание позже. Частоту проверок или их отключение можно изменить в Общих настройках.

Если у вас открыто несколько планов, автоматические проверки выполняет только одно окно, так что одно и то же обновление не предлагается вам несколько раз.

Чтобы проверить прямо сейчас, выберите Проверить наличие обновлений в меню «Справка». PlanCake сообщит результат, например «У вас последняя версия PlanCake.»

Ваши данные и конфиденциальность

Ваши заметки хранятся в ваших файлах

У PlanCake нет ни базы данных, ни скрытых файлов для ваших заметок: каждая заметка — это обычный текст внутри файла Markdown, которому она принадлежит. Что бы ни резервировало ваши файлы — система контроля версий, облачная синхронизация, копия на USB-накопителе, — оно резервирует вместе с ними и ваши заметки. Чтобы поделиться с кем-то своими заметками, отдайте файл.

Настройки и журналы

Ваши настройки хранятся в одном текстовом файле, PlanCake.cfg:

• С установщиком: %APPDATA%\Oire\PlanCake\PlanCake.cfg
• Портативная версия: userdata\PlanCake.cfg, рядом с plancake.exe

Чтобы перенести настройки на другой компьютер, скопируйте этот файл в такое же место там. В той же папке находится папка logs, которая записывает, что делал PlanCake, и помогает при сообщении о проблеме. Рабочие файлы просмотра документа хранятся в %LOCALAPPDATA%\Oire\PlanCake, если PlanCake установлен, и в той же папке userdata в портативной версии. Удаление этих папок сбрасывает PlanCake к настройкам по умолчанию и никогда не затрагивает ваши файлы Markdown и заметки в них.

Что передаётся по сети

PlanCake обращается к интернету только для двух вещей: загрузки файла, когда вы открываете его по ссылке, и проверки обновлений. Он никуда не отправляет данные об использовании.

Устранение неполадок