Board.KolibriOS.org

Есть ли единый формат документации, или какие-то наработки и идеи по этому поводу?

По поводу текста - отдельно.

Также интересны мнения по поводу поддержки диаграмм.

А то - вижу DocPack. И думается, как бы реализовать в нем поддержку reStructured Text, например, и диаграмм.

В качестве идеи кто-то на форуме предлагал markdown. Мне кажется, он мог бы быть прекрасным форматом документации для колибри, т.к. в исходном виде он читается в колибри стандарными программами, а будучи преобразованным в html может служить в качестве онлайн документации.

Правда, тут на нём никто не пишет, и неясно, как он будет взаимодействовать с вики.

Предлагал я.Маркдаун - это и есть вики-разметка, по сути. Через пару недель займусь им.

Sourcerer: посмотри в сторону reStructured Text.
Да, с ним проще будет настроить автогенерацию вики-статей прямо из документации

Разрешите чуток попиариться.

Мы на пару с Proger_XP пилим такую штуку, как Wacko -- творчески переосмысленную вики-разметку WackoWiki, которую теперь можно использовать на форуме, в блоге и естественно, в документации.

Как и любая другая вики-разметка, Wacko пригодна для ввода руками, и кроме того, писалась русскими для русских учитывает, что у пишущего может быть более одной раскладки -- наиболее употребительные теги вводятся без переключения: **жирный**, //курсив//, ==Заголовок== и т. п.

Всё началось с попытки использовать WackoWiki для работы над большой документацией. Выяснилось, что её парсер плохо обрабатывает вложенные теги, а через веб-интерфейс сложно вносить согласованные изменения в документы. Поэтому было решено написать парсер с нуля, а для ведения документации использовать его в связке с SVN, что и было сделано. Теперь работа над документацией ведётся привычными средствами: вводится и редактируется в любимом блокноте, сравнивается через diff, версии хранятся в SVN.

Мы отделяем понятие разметки от её реализации. В планах давно значится разработка оффлайнового Wacko-процессора -- компилятора вики-разметки, вроде dcc32 или gcc. К сожалению, руки пока не дошли. Если кто-то возьмётся за реализацию для Колибри, с удовольствием готовы консультировать.

Главная мысль проекта: Wacko -- лучший Word.

"Главная мысль проекта: Wacko -- лучший Word." - напоминает "OS/2 лучше dos, чем dos", или что-то в этом роде, а потом закопалось.

John Found сделал микро CMS на асемблере, которая использует формат шаблонов - markdown, так что желающие могут найти исходники здесь http://chiselapp.com/user/johnfound/rep ... gAsm/index и приспособить их для форматирования документации в Колибри.

Это, конечно, супер, но нужно две вещи. AWeb и FreshLib.

markdown все еще не сделан, но будет. А будет ли "стандартный markdown" все еще неясно. Есть некоторые вещи, которые мне не нравятся в стандарте, например разметка кода.

Можно посмотреть здесь: тестовая инсталяция