Время переосмыслить файловую систему справки Delphi? - PullRequest
9 голосов
/ 21 апреля 2009

Большинство компонентов, доступных для Delphi, не имеют файлов справки HTML для Delphi 2009. Многие компоненты, включая некоторые очень популярные коммерческие компоненты, имеют только файлы справки HLP и CHM.

Многие сторонние компоненты больше не разрабатываются, а используются многими разработчиками. В результате для этих компонентов нет справки IDE.

Было очень мало жалоб на старые файлы справки CHM, но сегодня есть большое количество жалоб на файловую систему помощи. Возможно, пришло время Codegear переосмыслить тип используемой файловой системы справки.

Одна из претензий, которые у меня возникают по этому поводу, заключается в том, что даже при установке компонентов, предоставляющих файлы справки HTML, вкладка «Содержимое» повреждается при удалении ранее установленного содержимого компонента.

Существуют ли возможные альтернативы для Codegear?

Ответы [ 4 ]

4 голосов
/ 26 апреля 2009

Одна из идей состоит в том, чтобы смоделировать ее после Delphi Wiki по адресу: http://delphi.wikia.com/wiki/Delphi_Wiki

На самом деле вики настроена не так уж и плохо, особенно со ссылкой на VCL в левом фрейме.

На него довольно приятно смотреть, неплохой поиск, включает в себя проблемы, примеры, перекрестные ссылки и что мне нравится больше всего: комментарии пользователей и советы.

На самом деле, что касается комментариев и советов пользователей, что мне больше всего нравится в документации PHP на www.php.net / docs.php (которую, я думаю, - лучшая документация по программированию, которую я ' Видел ) это комментарии пользователей и советы.

Если они смогут интегрировать в него великолепный макет, который вы найдете по адресу Delphi Basics , и позволить сторонним компонентам добавлять в него свои файлы справки, то у них будет полная справка. (Но третьим сторонам, очевидно, придется реструктурировать свои файлы справки в новый формат - каким бы он ни был).

В вики также есть разделы с учебными пособиями, советами и рекомендациями, ссылками и популярными статьями. И я думаю, что он также может стать всеобъемлющим хранилищем кода, который нам всем нужен.

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

И они должны будут выяснить, как заставить работать клавишу F1, чтобы правильно искать файл вики / справки, будь то онлайн или офлайн, и давать наиболее релевантные результаты.

Проблема с вики в настоящее время заключается в том, что она не полная, и в нее должен быть включен полный набор файлов справки Delphi.

Это может быть напыщенная мечта, но что-то вроде этого было бы моим идеалом.

4 голосов
/ 24 апреля 2009

У меня такое же чувство. Старая справочная система помогает мне быстрее найти ответ.

2 голосов
/ 27 апреля 2009

Это моя любимая ненависть. Помощь Delphi только ухудшилась, хотя с недавним небольшим улучшением. Я искренне верю, что это одна из вещей, сдерживающая его принятие.

0 голосов
/ 05 марта 2011

Micosoft представила Help3 для VS2010, поэтому, возможно, мы увидим ее и в Delphi:

вот сообщение в блоге, которое отвечает на вопрос «Зачем нужна новая справочная система?»

http://thirdblogfromthesun.com/2010/10/the-story-of-help-in-visual-studio-2010/

Он цитирует внутреннюю статью, которая привела к новому проекту "Help3" в начало 2008 года:

"В документе описаны следующие вопросы с помощью опыта в Visual Studio:

  1. Неспособность найти нужную информацию - обычное дело. проблема. F1 Помощь и Поиск не работать так, как они должны.
  2. Производительность справочной системы - в первую очередь запуск, загрузка тем, Результаты локального поиска - один из самые большие проблемы.
  3. Автономная установка библиотеки MSDN хрупка из-за сложности справочная система.
  4. Запатентованный характер нашего справочного формата дает мало стимулов для партнеры по разработке инструментов авторинга и не может быть легко принят разработчики в своих продуктах.
  5. Что касается производства контента, то платформа помощи обременяет нас устаревшие инструменты и процессы.
  6. Наконец, и самое главное, ни одна команда Microsoft не имеет решения эти проблемы. "
...