是时候重新考虑Delphi帮助文件系统了吗?

时间:2020-12-29 02:05:04

The majority of components available for Delphi do not have HTML Help files for Delphi 2009. Many components including some very popular commercial components only have HLP and CHM help files.

Delphi可用的大多数组件都没有Delphi 2009的HTML帮助文件。许多组件(包括一些非常流行的商业组件)只有HLP和CHM帮助文件。

Many of the third-party components are no longer being actively developed but are used by many developers. As a result there is no IDE help for these components.

许多第三方组件不再被积极开发,但被许多开发人员使用。因此,这些组件没有IDE帮助。

There were very few complaints about the old CHM help files but today there are a large number of complaints about the help file system. Maybe it is time for Codegear to rethink the type of help file system used.

关于旧的CHM帮助文件的投诉很少,但今天有大量关于帮助文件系统的投诉。也许现在是Codegear重新考虑使用的帮助文件系统类型的时候了。

One of the complaints that I have about it is even when you install components that provide HTML help files the Contents Tab becomes corrupted where by previously installed component contents are removed.

我对其提出的一个抱怨是,即使您安装了提供HTML帮助文件的组件,“内容”选项卡也会因先前安装的组件内容被删除而损坏。

Are there possible alternatives for Codegear to consider?

Codegear是否有可能考虑采用其他替代方案?

4 个解决方案

#1


I have the same feeling. The old help system helps me more quickly to find an answer.

我有同样的感觉。旧的帮助系统可以帮助我更快地找到答案。

#2


One idea is to maybe to model it after the Delphi Wiki at: http://delphi.wikia.com/wiki/Delphi_Wiki

一个想法是可能在Delphi Wiki之后对其进行建模:http://delphi.wikia.com/wiki/Delphi_Wiki

The wiki actually isn't set up that bad, especially with the VCL link in the left frame.

wiki实际上并没有那么糟糕,尤其是左框架中的VCL链接。

It's fairly pleasant to look at, has a decent search, includes issues, examples, cross references, and what I like the most: user comments and tips.

看起来相当愉快,有一个不错的搜索,包括问题,示例,交叉引用,以及我最喜欢的:用户评论和提示。

Actually regarding the user comments and tips, the thing I like most about the PHP documentation at www.php.net/docs.php (which I think is the best programming documentation I've seen) is the user comments and tips.

实际上关于用户评论和提示,我最喜欢www.php.net/docs.php上的PHP文档(我认为这是我见过的最好的编程文档)是用户评论和提示。

If they can integrate the great layout that you'll find at Delphi Basics into it, and allow 3rd party components to add their help files into it, then they'll have a complete reference. (But the 3rd parties will obviously have to restructure their help files to the new format - whatever it ends up as).

如果他们可以将您在Delphi Basics中找到的优秀布局集成到其中,并允许第三方组件将其帮助文件添加到其中,那么他们将获得完整的参考。 (但第三方显然必须将他们的帮助文件重新构建为新格式 - 无论结果如何)。

The wiki also has sections for Tutorials, Tips and Tricks, References and Popular Articles. And I think it could also become the all-encompassing code-repository we all would like.

维基还有教程,技巧和窍门,参考文献和热门文章的部分。而且我认为它也可以成为我们都想要的无所不包的代码库。

An option to download the help wiki should be allowed so it can be accessed offline.

应允许下载帮助Wiki的选项,以便可以脱机访问。

And they'll have to figure out how to get the F1 key to work to properly search the wiki/help file, whether online or offline, and give the most relevant results.

他们必须弄清楚如何让F1键正常搜索wiki / help文件,无论是在线还是离线,并提供最相关的结果。

The trouble with the Wiki now is that it is not complete, and the full set of Delphi help files need to be incorporated into it.

现在Wiki的问题在于它不完整,需要将完整的Delphi帮助文件集合到其中。

This might be a pipedream, but something like this would be my ideal.

这可能是一个白日梦,但这样的事情将是我的理想。

#3


This is a pet hate of mine. The Delphi Help has just got worse, although with a recent slight improvement. I honestly believe that this is one of the things holding back its adoption.

这是我的宠物仇恨。德尔福帮助变得更糟,尽管最近略有改善。老实说,我认为这是阻碍其采用的事情之一。

#4


Micosoft introduced Help3 for VS2010, so maybe we will see it in Delphi too:

Micosoft为VS2010引入了Help3,所以也许我们也会在Delphi中看到它:

here is a blog post which answers the question "Why A New Help System?"

这是一篇博客文章,回答了“为什么是一个新的帮助系统?”的问题。

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

It quotes an internal paper, which led to the new "Help3" project in early 2008:

它引用了一篇内部论文,在2008年初引发了新的“Help3”项目:

"The paper described the following issues with the help experience in Visual Studio:

“该论文描述了Visual Studio中的帮助体验中的以下问题:

  1. Not being able to find the information you need is a common problem. F1 Help and Search do not work as well as they should.
  2. 无法找到您需要的信息是一个常见问题。 F1帮助和搜索功能不尽如人意。

  3. The performance of the help system – primarily start-up, topic-load, local search results – is one of the biggest problems.
  4. 帮助系统的性能 - 主要是启动,主题加载,本地搜索结果 - 是最大的问题之一。

  5. The offline MSDN library install is fragile due to the complexities of the help system.
  6. 由于帮助系统的复杂性,脱机MSDN库安装很脆弱。

  7. The proprietary nature of our help format offers little incentive for partners to develop authoring tools and cannot be easily adopted by developers in their own products.
  8. 我们的帮助格式的专有性质为合作伙伴提供了开发创作工具的激励,并且开发人员无法在自己的产品中轻松采用。

  9. On the content production side, the help platform saddles us with outdated tools and processes.
  10. 在内容制作方面,帮助平台为我们提供了过时的工具和流程。

  11. Finally, and most importantly, no single team at Microsoft owns solving these problems."
  12. 最后,最重要的是,微软没有一个团队能够解决这些问题。“

#1


I have the same feeling. The old help system helps me more quickly to find an answer.

我有同样的感觉。旧的帮助系统可以帮助我更快地找到答案。

#2


One idea is to maybe to model it after the Delphi Wiki at: http://delphi.wikia.com/wiki/Delphi_Wiki

一个想法是可能在Delphi Wiki之后对其进行建模:http://delphi.wikia.com/wiki/Delphi_Wiki

The wiki actually isn't set up that bad, especially with the VCL link in the left frame.

wiki实际上并没有那么糟糕,尤其是左框架中的VCL链接。

It's fairly pleasant to look at, has a decent search, includes issues, examples, cross references, and what I like the most: user comments and tips.

看起来相当愉快,有一个不错的搜索,包括问题,示例,交叉引用,以及我最喜欢的:用户评论和提示。

Actually regarding the user comments and tips, the thing I like most about the PHP documentation at www.php.net/docs.php (which I think is the best programming documentation I've seen) is the user comments and tips.

实际上关于用户评论和提示,我最喜欢www.php.net/docs.php上的PHP文档(我认为这是我见过的最好的编程文档)是用户评论和提示。

If they can integrate the great layout that you'll find at Delphi Basics into it, and allow 3rd party components to add their help files into it, then they'll have a complete reference. (But the 3rd parties will obviously have to restructure their help files to the new format - whatever it ends up as).

如果他们可以将您在Delphi Basics中找到的优秀布局集成到其中,并允许第三方组件将其帮助文件添加到其中,那么他们将获得完整的参考。 (但第三方显然必须将他们的帮助文件重新构建为新格式 - 无论结果如何)。

The wiki also has sections for Tutorials, Tips and Tricks, References and Popular Articles. And I think it could also become the all-encompassing code-repository we all would like.

维基还有教程,技巧和窍门,参考文献和热门文章的部分。而且我认为它也可以成为我们都想要的无所不包的代码库。

An option to download the help wiki should be allowed so it can be accessed offline.

应允许下载帮助Wiki的选项,以便可以脱机访问。

And they'll have to figure out how to get the F1 key to work to properly search the wiki/help file, whether online or offline, and give the most relevant results.

他们必须弄清楚如何让F1键正常搜索wiki / help文件,无论是在线还是离线,并提供最相关的结果。

The trouble with the Wiki now is that it is not complete, and the full set of Delphi help files need to be incorporated into it.

现在Wiki的问题在于它不完整,需要将完整的Delphi帮助文件集合到其中。

This might be a pipedream, but something like this would be my ideal.

这可能是一个白日梦,但这样的事情将是我的理想。

#3


This is a pet hate of mine. The Delphi Help has just got worse, although with a recent slight improvement. I honestly believe that this is one of the things holding back its adoption.

这是我的宠物仇恨。德尔福帮助变得更糟,尽管最近略有改善。老实说,我认为这是阻碍其采用的事情之一。

#4


Micosoft introduced Help3 for VS2010, so maybe we will see it in Delphi too:

Micosoft为VS2010引入了Help3,所以也许我们也会在Delphi中看到它:

here is a blog post which answers the question "Why A New Help System?"

这是一篇博客文章,回答了“为什么是一个新的帮助系统?”的问题。

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

It quotes an internal paper, which led to the new "Help3" project in early 2008:

它引用了一篇内部论文,在2008年初引发了新的“Help3”项目:

"The paper described the following issues with the help experience in Visual Studio:

“该论文描述了Visual Studio中的帮助体验中的以下问题:

  1. Not being able to find the information you need is a common problem. F1 Help and Search do not work as well as they should.
  2. 无法找到您需要的信息是一个常见问题。 F1帮助和搜索功能不尽如人意。

  3. The performance of the help system – primarily start-up, topic-load, local search results – is one of the biggest problems.
  4. 帮助系统的性能 - 主要是启动,主题加载,本地搜索结果 - 是最大的问题之一。

  5. The offline MSDN library install is fragile due to the complexities of the help system.
  6. 由于帮助系统的复杂性,脱机MSDN库安装很脆弱。

  7. The proprietary nature of our help format offers little incentive for partners to develop authoring tools and cannot be easily adopted by developers in their own products.
  8. 我们的帮助格式的专有性质为合作伙伴提供了开发创作工具的激励,并且开发人员无法在自己的产品中轻松采用。

  9. On the content production side, the help platform saddles us with outdated tools and processes.
  10. 在内容制作方面,帮助平台为我们提供了过时的工具和流程。

  11. Finally, and most importantly, no single team at Microsoft owns solving these problems."
  12. 最后,最重要的是,微软没有一个团队能够解决这些问题。“