Page 4 of 4

Re: Документация и справочная система

Posted: Fri Jan 25, 2019 5:48 pm
by IgorA
Alex2003 wrote:SF KOS ещё не переведён полностью: уж очень много текста...
Я думал что имелся ввиду перевод с русского на английский
Alex2003 wrote:Я его загоняю в веб страницу
А почему через Word? Он же кучу лишнего форматирования в файл сохраняет.
Например файл 143,2 кб (в htm) тогда как размер текста в нем 18,5 кб (при сохранении в txt). Т.е. 87% файла это Word-овский мусор!

Re: Документация и справочная система

Posted: Fri Jan 25, 2019 7:45 pm
by bad_Dr3dd0x
А в чём тогда предлагаешь делать доки?

Re: Документация и справочная система

Posted: Fri Jan 25, 2019 11:33 pm
by IgorA
Наверное самый лучший вариант это править вручную, но он же и самый долгий. Вот пример этого файла, где я в Notepad-е по быстрому сделал автозамены для заголовков:
sysfuncr.7z (32.84 KiB)
Downloaded 350 times
Размер получившегося файла 186 Кб, в то время как исходный 220 Кб. Уменьшение получилось за счет того, что были убраны символы форматирования такие как ===== и ----- , которых было очень много. По идее весь файл с тегами должен быть примерно такого же размера как и исходный файл.
В крайнем случае использовать программу ВебЛомастер для уменьшения размера файла, но она может вместе с удалением лишних тегов изменить и форматирование файла.

Re: Документация и справочная система

Posted: Sat Jan 26, 2019 1:17 am
by dunkaist
You want the same info as in *.txt files but with a nicer markup, right? Doing it manually is time consuming, error prone and will require more synchronization work in the future. My opinion is that there could be two similar approaches:
  1. Convert text docs into, say, AsciiDoc or ReStructuredText and use corresponding tools to generate html/pdf;
  2. Keep text docs in current format and write a small script to parse and convert them into html/tex.
Btw, the latter one is a good programming exercise for beginners.

Re: Документация и справочная система

Posted: Sat Jan 26, 2019 9:06 am
by bad_Dr3dd0x
dunkaist, thanks for the good advice!
IgorA, тебе тоже спасибо!

Re: Документация и справочная система

Posted: Sat Apr 27, 2019 3:13 pm
by Leency
Alex2003 wrote:Держите переведённый!
Перевод был сделан в Word из-за чего HTML файлы не открываются черзе WebView в Колибри и имеют большой размер.

Дал Alex2003 инструкции как создавать корректные HTML файлы в plain-текстовом редакторе с подсветкой синтаксиса.

Re: Документация и справочная система

Posted: Sat Apr 27, 2019 3:32 pm
by bad_Dr3dd0x
Уже исправляю!

Re: Документация и справочная система

Posted: Sun Oct 18, 2020 1:50 am
by dunkaist
Here is (quite outdated) sysfuncs.txt converted to markdown.

I don't know how to easily convert this to a file with table of contents, I didn't try. But it should be much easier than with current plain text format.

Re: Документация и справочная система

Posted: Mon Oct 19, 2020 4:53 pm
by lev
dunkaist wrote:I don't know how to easily convert this to a file with table of contents, I didn't try. But it should be much easier than with current plain text format.
You can try pandoc.

Ошибка в документации

Posted: Sun Jul 04, 2021 2:30 pm
by zorggish
Файл (root)/kernel/trunk/docs/sysfuncr.txt

Функция 48, подфункция 5

* (left,top) - координаты левого верхнего угла,
(right,bottom) - координаты правого нижнего.
Таким образом, размер рабочей области по оси x определяется
формулой right-left+1, по оси y - формулой bottom-right+1.

Вместо bottom-right должно быть bottom-top

Re: Ошибка в документации

Posted: Sun Jul 04, 2021 3:01 pm
by Leency
Fixed #8994

@moderators please move this topic into http://board.kolibrios.org/viewtopic.ph ... 83&p=75113
dunkaist: done