[devel] Fw: want to unify documentation

[devel] Fw: want to unify documentation

[Alexander Bokovoy]

Может быть кого-нибудь заинтересует? Алексей -- разработчик dictd.

----- Forwarded message from Aleksey Cheusov <cheusov@scnsoft.com> -----

Date: Wed, 18 Dec 2002 21:08:12 +0000 (UTC)
From: Aleksey Cheusov <cheusov@scnsoft.com>
Subject: want to unify documentation
Newsgroups: fido7.ru.linux
Organization: Science Soft


У меня не вопрос.

Я хочу услышать мнение народа по поводу
приведения документации для программистов
в более-менее единую форму.

Имеются ввиду справочники по функциям, классам,
типам и так далее для языков программирования 
и всяким приблудам.

Лично мне надоедает вспоминать, где же это я видел
"в манах ли", в "инфо", во всяких howto, rfc, perldoc
opengroup.org и так далее.

С помощью DICT клиента для emacs dictionary.el
(AFAIK других нет) можно легко всё ето дело привести к одному
виду и настроить на major/minor mode
и получить доступ к любым справочникам
непосредственно там, где программа собственно создаётся
не ползая тормозиллой по всяким opengroup.org и другим.

Вот пример:

(defvar perl-help-history)

(defun lookup-perl-func ()
  (interactive)
  (dictionary-search
    (read-string
	  "word: "
	  (current-word)
	  'perl-help-history)
    "perl_ref"
  )
)
(defun my-perl-mode-hook ()
  (c-set-style "user")
  (local-set-key [f1] 'lookup-perl-func) 
)
(add-hook 'perl-mode-hook      'my-perl-mode-hook)

Вопрос 1: что народ думает по этому поводу.
Вопрос 2: готов ли кто-нибудь из присутствующих
          сконвертировать, например, справочник по stl
          в dict формат или что-то другое, ему нужное.
          Если да, то из этого дела может
          получиться yet another package ;) для любимого
          дистрибутива. Тоже самое касается надстройки
          над dictionary.el.

На вопросах реализации DICT сервера я не останавливаюсь,
потому как это детали.

На мой взгляд, идею полезная и довольно банальна, но,
почему-то, никем не реализована.

Меня интересует ваше мнение.

-- 
Best regards, Aleksey Cheusov.

----- End forwarded message -----

-- 
/ Alexander Bokovoy
---
Remember the good old days, when CPU was singular?

Re: [devel] Fw: want to unify documentation

[Alex Ott]

Привет всем

идея интересная. я правда больше привык использовать info в качестве большого справочника. Для dict я думаю будут раздражать тормоза, иногда он долго ищет

Re: [devel] Fw: want to unify documentation

[Alexander Bokovoy]

On Thu, Dec 19, 2002 at 11:54:55AM +0300, Alex Ott wrote:
> Привет всем
> 
> идея интересная. я правда больше привык использовать info в качестве
> большого справочника. Для dict я думаю будут раздражать тормоза, иногда
> он долго ищет
Это зависит от используемого плагина. Дело в том, что в новом dictd
добавлена поддержка плагинов. Это позволяет абстрагироваться от формата, в
котором данные записаны и возложить их обработку на сам плагин. То есть,
для клиента все будет выглядеть словарем dict, а на самом деле будет идти
поиск по info, man и так далее. Это немножко не то, что предлагал Алексей,
но мне кажется такой подход более разумным -- не потребуется синхронизация
оригиналов и сконвертированных вариантов в формате dict.

-- 
/ Alexander Bokovoy
---
Of course you have a purpose -- to find a purpose.