KolibriOS Documentation
-
А почему вопрос ?Все сложное - просто!
Потому что, обычно, и юзер и программист ищут в документации ответы на вопросы: как настроить систему, как ползоватся той или иной программой, какая функция возвращает нужное значение, как работает планировщик задач и т.п.G@K wrote:А почему вопрос ?
ушёл...
Very good. Только вот хотелось бы какое-то выделение кода в тексте, в идеале подсветкой синтаксиса, как в fasmw.
Вот новый выпуск. Так как времени у мну почти нет, изменения совсем небольшие - переделана заглавная страница, теперь документация называется "Pterox' DocPack" (надеюсь Willow не будет против - название приглянулось ), почти на каждой странице раздела "KolibriOS API" появилась ссылка для открытия содержания этого самого раздела, чтобы не нажимать двести раз кнопку [<-] (назад), также добавлен мануал по ФАСМу.
З.Ы. Этот выпуск сделан больше для того, чтобы показать - дело не заглохло, и хоть малыми шагами, но движется навстречу прогрессу
http://ftp.kolibrios.org/users/Nasarus/ ... 7.0+/R3.7z
Спасибо В следующем выпуске постараюсь сделать подсветку и многое что еще другое.Very good. Только вот хотелось бы какое-то выделение кода в тексте, в идеале подсветкой синтаксиса, как в fasmw.
З.Ы. Этот выпуск сделан больше для того, чтобы показать - дело не заглохло, и хоть малыми шагами, но движется навстречу прогрессу
http://ftp.kolibrios.org/users/Nasarus/ ... 7.0+/R3.7z
ушёл...
Уже лучше, но в разделе "Установка" почему-то находится описание API функции. А в целом документация мне нравиться.
Исправим-с))Rock_maniak_forever wrote:Уже лучше, но в разделе "Установка" почему-то находится описание API функции. А в целом документация мне нравиться.
ушёл...
1) файл hot_keys.htm битый (забит нулями)
2) почему бы "Предыдущие выпуски" не разбить по версиям?
3) если перейти к документу в папке api, не работает ссылка внизу страницы ("История выпусков"). нужно изменить относительный путь.
2) почему бы "Предыдущие выпуски" не разбить по версиям?
3) если перейти к документу в папке api, не работает ссылка внизу страницы ("История выпусков"). нужно изменить относительный путь.
Сегодня поправлю и выложуAlbom wrote:1) файл hot_keys.htm битый (забит нулями)
3) если перейти к документу в папке api, не работает ссылка внизу страницы ("История выпусков"). нужно изменить относительный путь.
http://ftp.kolibrios.org/users/Nasarus/ ... 7.0+/R2.7z - предыдущая версия, старые может как-нибудь потом выложу.Albom wrote:
ушёл...
Извиняюсь, неправильно понял2) почему бы "Предыдущие выпуски" не разбить по версиям?
ушёл...
I. Информация для пользователя KolibriOS
"Этот выпуск" - не совсем понятно, о системе или о справке идет речь. Может, "Информация об этой версии системы", или еще как-то?
Лицензия - "Лицензионное соглашение"? Почему бы сразу не открывать GNU GPL, вместо того, чтобы заставлять пользователя потом нажимать два раза на кнопку назад?
TCP/IP стек - в информации для пользователя идет раньше, чем горячие клавиши. Однако содержит в себе информацию, важную скорее для разработчика. Лучше может разделить на две части? Одна - как настроить сеть (примено так и назвать), а другая - как разрабатывать приложения с доступом к стеку.
Другие приложения - не сразу и поймешь, какие-такие другие.
Предыдущие выпуски - скорее я бы включил все это в раздел "для любознательных"
Зато добавил бы страничку, описывающую основные возможности системы, требования к ПК и названия программ - какие для чего нужны.
II. Для программиста
Документация по API. mike.dld на wiki предложил использовать таблицы для наглядного описания системных функций. Почему бы не поступить именно так? Таблицы можно делать и в псевдографике (я даже программы видел для автоматического конвертирования html-таблиц)
FASM manual есть и на русском (правда, совсем не свежий)
Использование различных компиляторов в КолибриОС. Зачем в русской версии документации и русская, и английская статья?
III. Насчет онлайн-версии и поддержании в актуальном состоянии
Чем не нравится wiki, почему бы не синхронизировать все это?
Аккуратно подправить там главную страницу (давно пора изменить ссылки по разделам).
И время от времени новые и обновленные страницы из wiki добавлять в htm-версию
IV. О навигации
Копирайт на страницы добавлен везде с историей версий. А ссылочек "Назад, на главную, вперед" - очень жаль, что нет.
"Этот выпуск" - не совсем понятно, о системе или о справке идет речь. Может, "Информация об этой версии системы", или еще как-то?
Лицензия - "Лицензионное соглашение"? Почему бы сразу не открывать GNU GPL, вместо того, чтобы заставлять пользователя потом нажимать два раза на кнопку назад?
TCP/IP стек - в информации для пользователя идет раньше, чем горячие клавиши. Однако содержит в себе информацию, важную скорее для разработчика. Лучше может разделить на две части? Одна - как настроить сеть (примено так и назвать), а другая - как разрабатывать приложения с доступом к стеку.
Другие приложения - не сразу и поймешь, какие-такие другие.
Предыдущие выпуски - скорее я бы включил все это в раздел "для любознательных"
Зато добавил бы страничку, описывающую основные возможности системы, требования к ПК и названия программ - какие для чего нужны.
II. Для программиста
Документация по API. mike.dld на wiki предложил использовать таблицы для наглядного описания системных функций. Почему бы не поступить именно так? Таблицы можно делать и в псевдографике (я даже программы видел для автоматического конвертирования html-таблиц)
FASM manual есть и на русском (правда, совсем не свежий)
Использование различных компиляторов в КолибриОС. Зачем в русской версии документации и русская, и английская статья?
III. Насчет онлайн-версии и поддержании в актуальном состоянии
Чем не нравится wiki, почему бы не синхронизировать все это?
Аккуратно подправить там главную страницу (давно пора изменить ссылки по разделам).
И время от времени новые и обновленные страницы из wiki добавлять в htm-версию
IV. О навигации
Копирайт на страницы добавлен везде с историей версий. А ссылочек "Назад, на главную, вперед" - очень жаль, что нет.
Исправил ошибки, о которых мне сообщили (и не только ). Обновил документацию по FASM'у до версии 1.68 (раньше было 1.62).
Вот выпуск R4:
R4.7z - 407 447 байт
P.S.: Большое спасибо всем авторам и тестерам!
Вот выпуск R4:
R4.7z - 407 447 байт
К сожалению, HTMLv не поддерживает ссылки формата "../index.htm", поэтому есть два варианта развития событий: либо держать все страницы в одной папке, либо ждать когда Leency сделает поддержку в своем браузере .Albom wrote:3) если перейти к документу в папке api, не работает ссылка внизу страницы ("История выпусков"). нужно изменить относительный путь.
Та же ситуация - либо идти через *опу и прописывать цвет в HTML-страницах, либо делать подсветку программно с помощью HTMLv +/- TynipadAsper wrote:Very good. Только вот хотелось бы какое-то выделение кода в тексте, в идеале подсветкой синтаксиса, как в fasmw.
P.S.: Большое спасибо всем авторам и тестерам!
Sorcerer
Спасибо за совет. В версии R6 все сделаю как надо =)
Спасибо за совет. В версии R6 все сделаю как надо =)
ушёл...
Я за копирайтом не гонюсь, просто лень было переделывать комментарийSorcerer wrote:IV. О навигации
Копирайт на страницы добавлен везде с историей версий. А ссылочек "Назад, на главную, вперед" - очень жаль, что нет.
ушёл...
ушёл...
Новый, 5-ый релиз документации. Главные плюсы: 1)в разделе "KolibriOS API" все ссылки теперь рабочие; 2) история версий разбита по номерам (спасибо Albom'у за совет). Остальные изменения читайте в спойлере ниже:
2. Переделаны страницы DocPack.htm (index.htm, соответсвенно)
3. История версий разбита на страницы (v0.7.7.0.htm, v.0.5.2.0 и т.д.)
4. Частично синхронизированы с wiki описания некоторых API-функций
5. Благодаря изменениям все ссылки в разделе "API" теперь работают.
6. Для удобства навигации содержимое папки API вернулось в папку Pages. По этой же причине там теперь лежит папка Data
7. Для удобства навигации в папке Pages теперь лежит копия файла DockPack.htm (index.htm)
8. Создан файл files.ini - группированый список файлов. Пока в нем только страницы описания API
Это скриншот:
Ссылка:
Pterox' DocPack R5.7z - 409 416 байт
Spoiler:
1. Переделаны статьи "Лицензионное соглашение", "История версий Колибри OS"; licence.htm удален за ненадобностью2. Переделаны страницы DocPack.htm (index.htm, соответсвенно)
3. История версий разбита на страницы (v0.7.7.0.htm, v.0.5.2.0 и т.д.)
4. Частично синхронизированы с wiki описания некоторых API-функций
5. Благодаря изменениям все ссылки в разделе "API" теперь работают.
6. Для удобства навигации содержимое папки API вернулось в папку Pages. По этой же причине там теперь лежит папка Data
7. Для удобства навигации в папке Pages теперь лежит копия файла DockPack.htm (index.htm)
8. Создан файл files.ini - группированый список файлов. Пока в нем только страницы описания API
Spoiler:
Pterox' DocPack R5.7z - 409 416 байт
ушёл...
Who is online
Users browsing this forum: No registered users and 1 guest