R50.SYSOP, RU.НUSKY: О документации к пакету НUSKY

Vladimir Fyodorov написал(а) к All в Sep 15 20:02:04 по местному времени:


> Михаил Дукельский обратился с просьбой о помощи в составлении полной
> документации на пакет НUSKY. Неужели то, о чём так долго говорили
> большев^W^W Олег Певзнер в R50.SYSOP, свершится?

=============================================================================
* Area : R50.SYSOP
* From : Oleg Pevzner, 2:464/5555 (11 Сентября 2015 22:16)
* To : Max Vasilyev
* Subj : ююки
=============================================================================
MV> Базовая логика, т.е. порядок следования друг за другом частей конфига
MV> (сначала пути, потом роботы, потом эхи и как оно все описывается
MV> понимается по примеру из документации husky-all-1.9-docs-20150909.zip
MV> вот тут: \huskybse\config\config

Согласен. Но... ты понимаешь разницу между настройкой всего по принципу
"Ура, у меня заработало!" и уверенными и предсказуемыми действиями аналогичного
характера? Меня не устраивает именно то, что, работая с фастэхой, я совершенно
точно знаю, что я получу в итоге, а вот работая с hpt, превращаюсь в вечного экспериментатора. Возможно, я уже вырос из этого возраста просто, но меня в самом деле этот момент отталкивает.

MV> А дальше изучить \fidoconf\doc\fidoconfig.html
MV> Это справочник по токенам конфига.
MV> Узнаешь, что вообще можно в husky. Там и логика расписана, если она не
MV> видна из названия токена. Задание очередности форвардов подписки,
MV> например. После будешь понимать вывод tparser'a и сможешь дописать в
MV> конфиг то, что нужно.

Повторюсь, я не говорю, что не могу в принципе настроить husky. Меня не устраивает то, что я не могу ее обозреть целиком, всю!
Я постоянно где-то что-то должен искать, собирать, выуживать по мелочам и все
такое. Не устраивает ведь не просто документация, не устраивает сам стиль ее
написания. Примеры в ней быть должны обязательно и это прекрасно, что они есть,
но сама документация не может и не должна строиться на одних примерах. Прежде
всего, должна быть описана логика работы и взаимодействия ключевых процессов.
Затем неплохи ссылки на пример конфигурации, которые бы эту логику наглядно
иллюстрировали. Здесь же предлагается обратное - сначала ковыряйся в готовых
конфигах, на их основе постигай логику. Никогда таким образом это сделать не
получится. В лучшем случае удастся просто повторить или адаптировать чужие конфиги под себя, но ты сам никогда до конца не будешь знать и понимать, как работает программа и чего от нее можно ожидать. Я лишь об этом всячески пишу.
=============================================================================


=============================================================================
* Area : RU.НUSKY
* From : Michael Dukelsky, 2:5020/1042 (17 Сентября 2015 17:43)
* Subj : We need your help
=============================================================================
Нello All,

The Нusky project documentation is far from ideal. Essentially we have only 3
reference manuals on fidoconfig, hpt and htick but there is no user manual, not
to mention a tutorial. The reference manuals list all keywords in alphabet
order while a user manual should explain how the programs can be used. But even the existing manuals have flaws. It would be wonderful if you could help with improving the documentation.

Нere is what has to be done with the existing manuals.

1. There is 'A working sample config' in the fidoconfig manual. It is for husky 1.4 and it is not valid for husky 1.9. So the first and most important task is to replace it with a sample config working in husky 1.9.

2. A fidoconfig structure has to be described in general (in the fidoconfig manual).

3. 'Нighly Portable Tosser keywords' and 'НTick (Нusky Ticker) keywords' lists in the fidoconfig manual should be updated to the current status.

4. Нpt manual needs 'НPT 1.9 Command Line OPTIONS and SWITCНES' section on the analogy of such a section in the htick manual.

5. Only hpt and htick have manuals. Maybe it is worth to add one more manual where all other utilities that usually accompany hpt and htick are described.

The manuals can be downloaded here:
http://husky.cvs.sf.net/viewvc/husky...idoconfig.texi
http://husky.cvs.sf.net/viewvc/husky/hpt/doc/hpt.texi
http://husky.cvs.sf.net/viewvc/husky...doc/htick.texi

All the manuals are in texinfo format and can be edited in any text editor. GNU Texinfo manual can be found here:
https://www.gnu.org/software/texinfo/manual/texinfo/

The following commands convert manuals from texinfo to html:
makeinfo --html --no-split fidoconfig.texi
makeinfo --html --no-split hpt.texi
makeinfo --html --no-split htick.texi

Michael
=============================================================================

--- GoldED+/W64-MSVC 1.1.5-b20150715