Main Content

本页的翻译已过时。点击此处可查看最新英文版本。

创建和共享工具箱

您可以对 MATLAB® 文件进行打包,以创建可与其他人共享的工具箱。这些文件可以包含 MATLAB 代码、数据、App、示例和文档。当您创建工具箱时,MATLAB 会生成一个安装文件 (.mltbx),您或其他人可利用该文件来安装工具箱。

创建工具箱

如要创建工具箱安装文件:

  1. 主页选项卡的环境部分中,从附加功能菜单中选择 工具箱打包

  2. 在“打包为工具箱”对话框中,点击 按钮并选择您的工具箱文件夹。比较好的做法是从您工具箱文件夹的上一级文件夹创建工具箱文件包。.mltbx 工具箱文件包含了工具箱文件和文件夹路径设置的有关信息。默认情况下,您创建工具箱时所包含的位于您的路径上的文件夹和文件,将在最终用户安装工具箱后出现在他们的路径上。

  3. 在对话框中,添加有关您的工具箱的以下信息。

    工具箱信息字段说明
    工具箱名称

    输入工具箱名称(如有必要)。默认情况下,工具箱名称为工具箱文件夹的名称。工具箱名称即 .mltbx 的文件名。

    版本

    按照 Major.Minor.Bug.Build 的格式输入工具箱版本号。BugBuild 为可选项。

    作者姓名、电子邮件和公司

    输入工具箱作者的联系信息。要保存联系信息,请点击设置为默认联系人

    工具箱图像

    要选择表示您的工具箱的图像,请点击选择工具箱图像

    摘要和说明

    输入工具箱的摘要和说明。比较好的做法是编写简洁的摘要文本,并在说明文本中添加详细信息。

  4. 要确保 MATLAB 检测到期望的组件,请审核工具箱内容。选择工具箱文件夹后,将会显示“打包为工具箱”对话框的以下各部分。

    “打包为工具箱”对话框中的部分说明
    工具箱文件和文件夹

    您的工具箱中所包含文件夹和文件的列表。仅列出位于工具箱文件夹顶层的文件和文件夹。您无法在“工具箱打包”对话框中浏览所有文件夹。

    默认情况下,如果您的工具箱在同一个文件夹中包含同名的 P 代码文件和 MATLAB 代码文件 (.m),则 MATLAB 会从工具箱中排除 .m 文件。要同时包含 .p.m 文件,请清除排除具有匹配的 P 文件的 MATLAB 脚本或函数文件选项。

    要从工具箱中排除其他文件或文件夹,请点击排除文件和文件夹,然后在显示的文本文件中对其进行注册。比较好的做法是排除与您的工具箱相关的任何源代码管理文件。

    要求

    附加功能 - 工具箱所需的附加功能列表。安装工具箱时,系统会下载并安装选定的附加功能。MATLAB 用它认为工具箱需要的附加功能自动填充此列表,默认将选择所有附加功能。您可以选择忽略不想与工具箱一起安装的附加功能。

    如果 MATLAB 在列表中找不到附加功能的安装信息,您必须输入下载 URL。下载 URL 是 MATLAB 可以下载和安装附加功能的位置。安装工具箱时,MATLAB 使用指定的 URL 安装附加功能。

    外部文件 - 您的工具箱所需的、位于工具箱文件夹外部的文件列表。MATLAB 用它认为工具箱需要的文件自动填充此列表,默认将选择所有文件。您可以选择忽略工具箱中不需要的任何文件。

    安装操作

    MATLAB 路径 - 在用户安装工具箱时添加到其 MATLAB 路径中的文件夹列表。默认情况下,该列表包括您在创建工具箱时路径上的所有工具箱文件夹。您可以不将文件夹添加到用户的路径,只需在列表中清除它们即可。要管理安装工具箱时的路径,请点击管理当前 MATLAB 路径。要将列表重置为默认列表,请点击重置为当前的 MATLAB 路径

    Java 类路径 - 在用户安装工具箱时添加到其 Java® 类路径中的 Java 文件列表。安装工具箱时,JAR 文件会在 MATLAB 会话期间添加到动态路径中。当工具箱用户重新启动 MATLAB 时,JAR 文件将添加到静态路径中。

    安装其他软件 - 在用户安装工具箱时安装到用户系统上的其他软件的 ZIP 文件列表。

    指定以下字段:

    • 显示名称 - 在用户安装工具箱时向他们显示的名称。

    • 许可证 URL - 在用户安装工具箱时向他们显示的其他软件许可协议的 URL。在安装过程中,系统会提示用户阅读并接受许可协议。您必须为许可协议指定有效的 URL。

    • 下载 URL - 包含其他软件的 ZIP 文件的 URL。要为不同的平台指定不同的下载 URL,请从下载 URL 左侧的下拉菜单中选择平台名称。然后,点击添加平台,为其他平台添加下载 URL。

    当用户安装工具箱时,MATLAB 会将所有其他软件安装在 addons\Toolboxes\AdditionalSoftware 文件夹中,其中 addons 是附加功能的默认安装文件夹。有关附加功能默认安装文件夹位置的详细信息,请参阅获取和管理附加功能

    如果您的工具箱包含引用指定附加软件的安装文件夹的代码,需确保这些引用可移植到其他计算机。请将引用替换为对生成的函数 toolboxname\getInstallationLocation.mlx 的调用,其中 toolboxname 是工具箱的名称。例如,如果要创建名为 mytoolbox 的工具箱,并且要引用名为 mysoftware 的附加软件的安装位置,请将以下代码

    mysoftwarelocation = 'C:\InstalledSoftware\mysoftware\'
    替换为以下代码:
    mysoftwarelocation = mytoolbox.getInstallationLocation('mysoftware')
    要在打包工具箱之前在计算机上启用工具箱测试,请在安装其他软件部分点击底部的 toolboxname\getInstallationLocation.mlx 链接,然后输入每个附加软件在您计算机上的安装位置。

    工具箱可移植性

    当用户安装工具箱时,MATLAB 使用工具箱可移植性部分中的信息。如果由于用户使用的平台或 MATLAB 版本不受支持而导致兼容性检查失败,MATLAB 会显示警告。但是,用户仍可以安装工具箱。

    平台兼容性 - 支持工具箱的平台的列表。考虑您的工具箱是否具有针对特定平台的第三方软件或硬件要求。MATLAB Online™ 不能与硬件交互,包括用于图像采集和仪器控制的设备。

    版本兼容性 - 支持工具箱的 MATLAB 版本的列表。

    产品 - 您的工具箱所需的 MathWorks® 产品的列表。手动创建此列表。

    示例、App 和文档

    示例 - 已发布的与工具箱关联的 MATLAB 示例。要包含 .m.mlx 文件作为示例,请点击添加示例按钮,选择您的代码文件,然后点击发布 HTML。MATLAB 将代码发布为 HTML 并将输出文件放入 html 文件夹中。

    您也可以在 MATLAB 中手动将代码文件发布为 HTML,然后将代码文件和 HTML 文件包含在工具箱文件夹中。

    • 对于实时脚本 (.mlx) 示例,请将其导出为 HTML。在实时编辑器选项卡上,选择保存 > 导出为 HTML,然后将其保存在名为 html 的文件夹中。

    • 对于脚本 (.m) 示例,请使用 publish 函数将其发布为 HTML。当您发布示例时请勿指定输出文件夹。为了“打包为工具箱”工具能识别示例,输出文件夹必须是默认文件夹 (html)。

    如要为您的示例创建不同的类别,请将示例放置在工具箱文件夹内不同的各个子文件夹中。当您将工具箱文件夹添加到“打包为工具箱”对话框中时,MATLAB 会创建一个 demos.xml 文件来描述您的示例,并用示例子文件夹的名称作为示例类别名称。您也可以创建您自己的 demos.xml 文件。demos.xml 文件允许接收者通过位于帮助浏览器主页面底部的补充软件链接来访问您的示例。有关详细信息,请参阅显示自定义示例

    App - 已发布的与工具箱关联的 MATLAB 可安装 App。“打包为工具箱”工具可识别 App(.mlapp 文件)和 App 安装程序文件(.mlappinstall 文件),并将它们包含在您的工具箱中。

    • 要指定哪些 App(.mlapp 文件)将随工具箱安装并在用户的 MATLAB App 库中注册,请选择这些 App。

    • 工具箱文件夹中的所有 .mlappinstall 文件都将安装并在用户的 MATLAB App 库中注册。

    入门指南 - 工具箱快速入门指南。为了“打包为工具箱”工具能识别入门指南,请将该指南保存为实时脚本并命名为 GettingStarted.mlx,置于工具箱文件夹的 doc 子文件夹中。

    您也可以通过“打包为工具箱”对话框来生成并编辑 GettingStarted.mlx

    工具箱的用户可以在附加功能管理器中通过工具箱的“选项”菜单来查看入门指南。有关详细信息,请参阅获取和管理附加功能

    帮助浏览器集成 - 与工具箱关联的自定义文档。为了“打包为工具箱”工具能识别自定义文档,请包含一个 info.xml 文件来识别您的文档文件。如果您在打包工具箱之前使用 builddocsearchdb 函数编译文档数据库,则可以将生成的 helpsearch 子文件夹纳入工具箱。info.xml 文件和 helpsearch 文件夹允许接收者通过位于帮助浏览器主页面底部的补充软件链接来访问您的文档。有关详细信息,请参阅显示自定义文档

    您也可以通过“打包为工具箱”对话框生成 info.xmlhelptoc.xml 模板文件。要通过帮助浏览器访问您的文档,请完成文档模板并将 info.xml 包含在 MATLAB 路径中。

  5. 将您的工具箱打包。

    • 要保存您的工具箱,请点击位于“打包为工具箱”对话框顶部的打包。对您的工具箱进行打包会在您的当前 MATLAB 文件夹中生成一个 .mltbx 文件。

    • 要保存您的工具箱并将其在 MATLAB Central File Exchange 中共享,请从“打包为工具箱”对话框顶部的打包菜单中选择打包和共享。此选项会在您的当前 MATLAB 文件夹中生成 .mltbx 文件,并打开一个网页以将工具箱提交给 File Exchange。MATLAB 会将工具箱的相关信息填充到 File Exchange 提交表单中。检查并提交该表单以在 File Exchange 中共享您的工具箱。

    当您创建工具箱时,MATLAB 会生成一个包含工具箱有关信息的 .prj 文件,并频繁保存该文件。比较好的做法是保存此关联的 .prj 文件,以便您能在未来迅速创建工具箱的修订版本。

共享工具箱

如要与其他人共享您的工具箱,则可以为他们提供 .mltbx 文件。您在打包工具箱时添加的所有文件都包含在 .mltbx 文件中。当最终用户安装您的工具箱时,他们无需担心 MATLAB 路径或其他安装详细信息。.mltbx 文件会为最终用户管理这些详细信息。

如需了解安装、卸载和查看工具箱信息的相关信息,请参阅获取和管理附加功能

您可以与其他人共享您的工具箱,方法是将 .mltbx 文件添加到电子邮件消息的附件,或使用您通常用来共享文件的任何其他方法,例如上传到 MATLAB Central File Exchange。如果您将工具箱上传到 File Exchange,则您的用户可以从 MATLAB 中下载该工具箱。有关详细信息,请参阅获取和管理附加功能

您也可以在打包工具箱时将其上传到 File Exchange。从“打包为工具箱”对话框顶部的打包菜单中选择打包和共享

注意

虽然 .mltbx 文件可以包含您指定的任何文件,但 MATLAB Central File Exchange 对提交的文件设置了其他限制。如果您的工具箱包含了以下任意内容,则无法提交到 File Exchange:

  • MEX 文件。

  • 其他二进制可执行文件,例如 DLL 或 ActiveX® 控件。(数据和图像文件通常可以接受。)

另请参阅

| | | | |

相关主题