Board.KolibriOS.org

Official KolibriOS board
It is currently Tue Jun 02, 2020 10:12 pm

All times are UTC+03:00




Post new topic  Reply to topic  [ 10 posts ] 
Author Message
PostPosted: Thu Jun 16, 2011 6:07 am 
Offline
User avatar

Joined: Tue Aug 25, 2009 4:45 pm
Posts: 797
Есть ли единый формат документации, или какие-то наработки и идеи по этому поводу?

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

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

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


Top
   
PostPosted: Thu Jun 16, 2011 7:39 am 
KolibriOS Documentation


Top
   
PostPosted: Thu Jun 16, 2011 12:36 pm 
Offline
Mentor
User avatar

Joined: Mon Oct 19, 2009 10:58 am
Posts: 488
В качестве идеи кто-то на форуме предлагал markdown. Мне кажется, он мог бы быть прекрасным форматом документации для колибри, т.к. в исходном виде он читается в колибри стандарными программами, а будучи преобразованным в html может служить в качестве онлайн документации.

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


Top
   
PostPosted: Thu Jun 16, 2011 4:35 pm 
Offline

Joined: Mon Sep 24, 2007 11:11 am
Posts: 2814
Предлагал я.Маркдаун - это и есть вики-разметка, по сути. Через пару недель займусь им.


Top
   
PostPosted: Thu Jun 16, 2011 6:02 pm 
Offline
User avatar

Joined: Tue Aug 25, 2009 4:45 pm
Posts: 797
Sourcerer: посмотри в сторону reStructured Text.
Да, с ним проще будет настроить автогенерацию вики-статей прямо из документации


Top
   
PostPosted: Thu Jun 16, 2011 11:34 pm 
Offline
User avatar

Joined: Tue May 08, 2007 12:44 am
Posts: 348
Разрешите чуток попиариться.

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

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

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

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

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

_________________
Разработчик языка программирования Кантор и Delphi для KolibriOS


Top
   
PostPosted: Fri Jun 17, 2011 10:16 pm 
Offline
User avatar

Joined: Mon Apr 16, 2007 6:38 pm
Posts: 1222
"Главная мысль проекта: Wacko -- лучший Word." - напоминает "OS/2 лучше dos, чем dos", или что-то в этом роде, а потом закопалось.

_________________
И мы уже давно не пешки,
Мы пули, мы орлы, и решки!
Война ютит бинарный код,
Умри, или иди вперед!


Top
   
PostPosted: Thu May 24, 2012 8:10 pm 
Offline
User avatar

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


Top
   
PostPosted: Thu May 24, 2012 8:20 pm 
Offline

Joined: Mon Sep 24, 2007 11:11 am
Posts: 2814
Это, конечно, супер, но нужно две вещи. AWeb и FreshLib.


Top
   
PostPosted: Fri May 25, 2012 10:11 am 
Offline

Joined: Fri Feb 18, 2011 3:13 pm
Posts: 201
markdown все еще не сделан, но будет. А будет ли "стандартный markdown" все еще неясно. Есть некоторые вещи, которые мне не нравятся в стандарте, например разметка кода.

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


Top
   
Display posts from previous:  Sort by  
Post new topic  Reply to topic  [ 10 posts ] 

All times are UTC+03:00


Who is online

Users browsing this forum: No registered users and 1 guest


You cannot post new topics in this forum
You cannot reply to topics in this forum
You cannot edit your posts in this forum
You cannot delete your posts in this forum
You cannot post attachments in this forum

Search for:
Jump to:  
Powered by phpBB® Forum Software © phpBB Limited