创建帮助文件。

JohnM · 发表于 2022-7-6 12:23:46

我在这里看到了很多程序和一些关于分发的问题，但从来没有一个关于帮助文件的主题。所以我想我会开始一个，也许可以帮助一些人，甚至学到一些东西。
我创建了很多程序，也销售了一些，所以我必须提供我的程序的帮助文件。
编写帮助文件可能是一件痛苦的事，但有时却是一件必要的坏事。
在大型项目中，我使用帮助软件制作。hlp或。chm文件，但该软件有一个学习曲线。它有它的位置，但我想讨论中小型项目的帮助。

AutoCAD有一个名为“Browser”的命令，您可以键入url，它将启动默认web浏览器并导航到url。这已经成为我的一个很酷的工具。

首先，我总是在“C:\program files”目录中为程序创建一个文件夹，这样出于编码目的，我总是知道程序文件夹的路径。我将工作文件存储在驱动器上的另一个文件夹中。C:\程序文件位置供用户使用。
当我创建一个对话框时，我在表单上放置了一个或多个帮助按钮，稍后我将在浏览器url中放置帮助文件。
在我的工作文件夹中，我创建了另一个名为“帮助”的文件夹，这样我就可以把东西分开，在这个文件夹中，我创建了一个名为“对话框”的文件夹。对话框文件夹将保存我制作的对话框图像。
在AutoCAD中，我显示我的第一个对话框并使用CTRL+ALT，然后点击打印屏幕按钮，这将仅捕获活动对话框并将其放在剪贴板上。
然后我打开windows绘画程序并粘贴。然后我将其保存到我创建的对话框文件夹中。对每个对话框重复此过程。
然后打开Microsoft word并将其另存为htm文件，命名为“帮助”。
开始键入帮助信息，使用“插入”>“图片”>“来自文件”选项并插入对话框图像。继续此过程，在需要的地方插入所有对话框。
完成后，将htm文件复制到c:\program files位置。
现在分配帮助按钮
（命令“browser”“C:/program files//”）
注意：我对C:/C程序文件中的C有问题。这必须是大写字母。
现在，当用户单击“帮助”按钮时，他们的浏览器将启动，文件将显示在浏览器中。

如果有多个对话框，可以将浏览器打开到浏览器中的特定行。
制作htm文件时，制作一个shorcuts或topics列表。喜欢
对话框1
对话框2
对话框3
如何使用该程序。

现在转到每个对话框图像或文字，单击它，然后转到“插入”>“书签”，并为该图像或文字指定一个图书标记。
然后返回列表，右键单击快捷方式或主题词，如对话框1和选择超链接。然后在对话框中选择“放置在此文档中”，然后可以在对话框中选择书签。
现在，当用户打开帮助文件时，他们可以快速导航到快捷方式或主题
您甚至可以使用此过程在整个文档中创建（返回顶部）超链接，以便用户可以快速返回到文件的开头。

现在，您可以使用程序窗体上的按钮打开帮助文件，然后单击快捷方式或主题超链接，跳到第二个对话框图像。
在web浏览器地址栏中，复制文本，并将该url用于第二个对话框上的“帮助”按钮。等等
现在，当您的程序用户显示一个不同的对话框与帮助按钮，它会打开网络浏览器，并跳到这一点。

这就是我提出的，所以任何建议或评论都会有所帮助

Freerefill · 发表于 2022-7-6 12:30:30

哦，哇。。这比我做的要先进得多。。

... 我只是把它写在一个文本文件中，然后拼凑出一个函数来逐行打印>>

这真的很棒。如果我写了一个足够好的程序，我会认真考虑写一个很棒的帮助文件，像这样谢谢你的输入！

flowerrobot · 发表于 2022-7-6 12:36:23

哇，谢谢你。

我以为我用的是pdf，带书签的东西要做，但我觉得我喜欢你的方法

干杯花

fuccaro · 发表于 2022-7-6 12:42:51

我过去经常使用微软的HTML help workshop。它是免费的，我在大约1个小时内学会了使用基础知识。

AQucsaiJr · 发表于 2022-7-6 12:53:08

这正是我用来为我创建的下拉菜单创建帮助文件的过程。很酷的一点是，让网络上的所有用户都能轻松访问它。我使用了两个不同的HTML编辑器，使文件看起来非常专业。

很好的打字和解释约翰。我几乎把它搁置到了T上，但是我需要我网络中的所有用户都能访问我的，所以我有几个额外的步骤。

JohnM · 发表于 2022-7-6 12:58:39

在大型项目中，我使用了heplmatic pro（40美元）。它做得很好，但我认为它是典型的帮助文件软件。我相信那里也有一些免费的东西，但通常它们是相似的。
我很高兴看到还有其他人花时间编写帮助文件。它让你的软件看起来更专业。虽然他们是一个痛苦的，几乎没有人读他们。我有客户打电话问我问题，我告诉他们ifo在帮助文件中，但他们说打电话给我窃听更快。
PDF的想法很酷。我有acrobat标准，所以我可以创建自己的PDF文件，几乎每个人都有acrobat reader。我只是更精通文字，但我会调查一下的。
还有人使用过setfunhelp命令吗？
它允许用户在程序运行时点击F1以打开帮助文件。
大多数AutoCAD用户不知道，当您键入任何命令（如“line”）然后单击F1时，它将显示AutoCAD帮助文件并显示line命令帮助

fuccaro · 发表于 2022-7-6 13:02:06

... 并且可以完成AutoCAD的本机帮助文件。好的，你可以添加自己的页面。在AutoCAD中工作时，可以按F1键访问公司标准

JohnM · 发表于 2022-7-6 13:06:12

我刚刚遇到了一个使用浏览器命令的问题。如果Internet explorer是默认浏览器，browser命令效果很好，但当firefox或mozilla是默认浏览器时会出现问题。
解决方案是使用startapp函数并调用Internet explorer，问题就解决了
（startapp“C:/program files/internet explorer/iexplore.exe”“My Help Path.htm”）

Raggi_Thor · 发表于 2022-7-6 13:16:11

如果使用（findfile）查找htm文件会怎么样？

然后，您必须添加文件夹以支持文件搜索路径，但稍后也可以更轻松地将该文件夹移动到C:\Programfiler\中，因为它在挪威windows（Vista之前）中被称为C:\Programfiler\。

JohnM · 发表于 2022-7-6 13:17:54

你说得很对。我总是忘记考虑其他语言。
我在安装包中使用INNO安装程序，它将安装路径写入注册表。我将使用（vl registry read reg key[val name]）来检索安装路径，并将路径的其余部分strcat在一起。我只是陷入了过去的困境，谢谢你提出来。

[编程交流] 创建帮助文件。

发表回复

精选推荐