OutWiker 4.0.0.970 beta 6. Начал обновлять документацию
Выложил следующую бета-версию OutWiker под номером 4.0.0.970. Вообще-то я думал, она станет последней бета-версией перед релизом, но даже несмотря на то, что выход этой версии немного задержался, я не успел сделать все, что планировал, поэтому релиз отложим еще как минимум на одну бету. Самое крупное изменение в этот раз связано с тем, что я начал обновлять справку по программе и погряз в этом деле.
Сначала я собирался только обновить скриншоты окон программы в справке и описать новые параметры, которые появились в диалоге настроек, но когда я начал просматривать остальные разделы справки, пришла идея оформить их более наглядно, используя текстовые стили, появившиеся в викиразметке уже после тех времен, когда я писал эту справку. Теперь в новой версии документации, например, горячие клавиши в тексте выделены одним цветом, пункты меню — другим, а имена файлов и пути — третьим. Заодно я решил проставить перекрестные ссылки между страницами справки, где это уместно, а в конце почти каждого раздела документации добавить раздел «См. также» со ссылками на страницы, близкие по смыслу. Поскольку справка сделана в виде дерева заметок в формате OutWiker, то это заодно может служить хорошей демонстрацией возможностей приложения. Пример обновленной страницы документации можете увидеть на следующей картинке.
Как оказалось, это только начало. Я слишком увлекся и практически переписал текст почти всех разделов, до которых успел добраться.
К тому же, справка к OutWiker прилагается на двух языках — русском и английском. Параллельно с изменением русской версии нужно было исправлять и английскую, сохраняя оформление в формате викинотации. В этом деле мне сильно помог ИИ (я использовал Gemini). Во-первых, я не доверяю своему знанию английского языка и сам бы я перевел с кучей ошибок. Во-вторых, ИИ отлично справляется с переводом с учетом используемой викинотации на странице, если его об этом предупредить. И, в-третьих, я попросил ИИ параллельно обращать внимание на стиль текста, указав, что это документация и нужно использовать соответствующие термины. Когда я начал читать то, что перевел ИИ, оказалось, что он действительно использует более подходящие термины для некоторых элементов интерфейса. Иногда я с ним обсуждал в диалоге, какие слова в какой ситуации лучше использовать, но оказалось, что во многих местах элементы интерфейса (пункты меню и названия настроек) лучше переименовать. В основном это касалось англоязычных терминов, но и для русской локализации я замечал некоторые шероховатости, которые исправлял.
Исправление английских надписей тянет за собой много последующей работы. Англоязычные строки прописаны в коде, они используются как идентификаторы, для которых потом создаются локализации. С английской локализацией все просто — в 99% случаев строки перевода совпадают со строкой-идентификатором, русскую локализацию надо обновлять более осмысленно. Кроме того, в последнее время на сайте crowdin.com пользователь Link-Mario оперативно обновляет немецкую локализацию, за что ему огромное спасибо. В последний месяц работы по переводу ему прибавилось. Зато теперь немецкая локализация покрывает 100% строк, как в основной части программы, так и в плагинах.
После обновления надписей в интерфейсе во многих случаях надо обновить скриншоты окон. Это дело тоже достаточно муторное, потому что для сохранения единого стиля всех картинок я это делаю из-под Windows 11, которую запускаю в виде виртуальной машины из-под своего домашнего Линукса. На данный момент мы с ИИ переписали еще не всю документацию (осталось чуть меньше 20 страниц), поэтому и изменения в названиях элементов интерфейса еще будут происходить.
В очередной раз я убеждаюсь, что написание документации — это полезный этап работы, даже если эту самую документацию никто читать не будет. В процессе описания того, как программа должна работать, находишь незамеченные ранее проблемы и появляются идеи, что можно еще улучшить. Пока оформлял страницу справки про ссылки, заметил, что википарсер не очень аккуратно обрабатывал ссылки с якорями, куда надо перейти внутри страницы. Поправил эту ошибку и еще несколько не критичных багов. И уже в процессе написания этого поста заметил неприятный баг, связанный с отображением дерева заметок, открытого в режиме только для чтения. Этим багом займусь уже в следующей бета-версии.
Помимо обновления в справке я переделал отрисовку облака меток. Теперь метки при наведении на них курсора мыши выглядят более аккуратно и сглажено, сама отрисовка стала быстрее и, если где-то было заметно моргание при прокрутке облака меток, то теперь этого моргания быть не должно.
Еще поправил сборку технической документации, которая расположена по адресу outwiker.readthedocs.io, долгое время сборка этой документации была сломана. Но я ее так давно не обновлял, что она уж сильно устарела, и ее надо полностью переписывать. Возможно, ей займусь уже после релиза.
Кажется, на этом все. Последнюю бета-версию OutWiker, как обычно, можно скачать на этой странице.
Подписывайтесь на OutWiker в социальных сетях (пока еще можно):
PS. Вы можете подписаться на новости сайта через RSS, Группу Вконтакте или Канал в Telegram.






Leave a comment