关于 File Exchange
通过 File Exchange,您可以找到或共享自定义的应用程序、类、代码示例、驱动程序、函数、Simulink 模型、脚本和视频。通过 File Exchange,您可以:
- 提交文件
- 链接到 GitHub 仓库
- 共享包含您的 MATLAB 代码的网站
- 了解许可证信息
- 提供说明帮助他人引用您的劳动成果
- 使用内容类型、搜索框和搜索指令来查找文件
- 通过添加标签为提交内容添加注释,以便将来根据您的使用情况进行查找、评价和讨论
- 通过社区成员对您提交文件的使用、标记和评价来获得社区认可
- 赢得徽章
- 建立您的声誉
- 提出问题和获取反馈
您对 File Exchange 的使用受 MATLAB Central 使用条款的约束。
提交文件
您可以提交最大 250 MB 的文件。要提交文件,请登录到您的社区资料。如果您没有个人资料,您需要创建个人资料。在您的帐户页上点击“发布”,以从计算机上传文件或链接到 GitHub 仓库。
连接 GitHub 仓库
File Exchange 和 GitHub 之间的连接可以让贡献者在单一环境中开发软件项目,而不必将文件上传到两个位置。贡献者可获得 GitHub 带来的协作开发的所有好处,而社区成员可访问您项目的最新版本 - 无论他们是从 File Exchange 还是从 GitHub 开始。下载连接到 GitHub 的文件的社区成员需自己负责验证这些文件的内容和许可。
当连接到 GitHub 仓库时,File Exchange 将仓库内容存储在 MathWorks 服务器上,以使内容在 File Exchange 和附加功能资源管理器中可用。存储在 MathWorks 服务器上的文件为只读并会自动更新以反映 GitHub 中的变化。存储仓库内容使 MathWorks 能够提供方便的功能,例如显示 MATLAB 代码的预览。
要将您的仓库连接到 GitHub,请选择以下选项之一:
- GitHub 发行版 - 使用 GitHub 发行版是推荐的连接方式。当您的仓库准备好发行时,使用 GitHub 发行版来打包您的代码。如果使用 GitHub 发行版,则当您在 GitHub 中创建新发行版时,您的 File Exchange 提交内容会自动更新
当您创建 GitHub 发行版时:
- - 如果您将代码打包为工具箱,请将您的工具箱(.mltbx 文件)附加到发行版。之后,File Exchange 会以下载形式提供该工具箱。如果未将 .mltbx 文件附加到发行版,File Exchange 将使用 zip 文件提供发行版内容。
- - 遵循以下关于标注版本的提示:
- - 以 major.minor.patch.extension(patch 和 extension 是可选的)格式输入版本。
- - 版本号段必须少于六位数。
- - 无法识别字母数字标签(例如 2-beta)。
- - 将 mltbx 文件附加到发行版时,将包中的版本号设置为与 GitHub 发行版相同的版本号。
- - 有关 GitHub 发行版的详细信息,请参阅 GitHub 文档。
- 默认分支 - 如使用这种方法,File Exchange 会用仓库的默认分支(通常为 main 或 master)来显示文件预览并提供下载包。您提交到默认分支的更改在 24 小时内可用。根据您的开发过程,使默认分支在 File Exchange 中可用可能导致您的用户获得不稳定的代码。我们推荐使用 GitHub 发行版来稳定地发行代码。
- 如果您使用 Git LFS,请将您的代码打包为工具箱,并将 mltbx 文件附加到您仓库的 GitHub 发行版中。File Exchange 中的默认分支连接不支持 Git LFS。
使文件易于查找和使用
- 确保您的标题和描述清晰、简洁且有意义。
- 审阅您的提交,以确保可读性和拼写正确。
- 使用有助于目标搜索的标签;请参阅创建标签。
- 添加图像时,确保图像使用与代码相同的文件名且与代码位于同一目录中。
- 感谢您参考的或对您的提交内容有启发的文件。您的致谢会显示在您的文件页,以及被感谢的文件的页面上。
许可证信息
许可明确地说明了您作为 File Exchange 上可用代码的作者和用户所拥有的权利。许可详细说明了如何用代码,并回答了有关代码修改、分发和商业使用的权利的常见问题。
直接发布到 File Exchange 的所有代码均且只支持 BSD 许可证。您使用上传文件直接提交到 File Exchange 的社区内容都会自动加上 BSD 许可证条款。您使用连接到 GitHub 或链接到外部网站发布的社区内容可以使用其他许可证类型。MathWorks 员工提交的某些内容,包括硬件支持包,可能受限于 MathWorks 有限许可证。获得许可的 File Exchange 提交内容具有查看许可证链接。有关 File Exchange 上许可的详细信息,请参阅 File Exchange 许可常见问题解答。
提供说明帮助他人引用您的劳动成果
引用说明有助于社区成员在自己的研究或派生工作中引用您的工作。例如,您可能希望其他人引用您的 File Exchange 详细信息页、您撰写的一篇研究文章、您所属的组或一些项目的组合。
创建新 File Exchange 条目时会添加默认引用说明,您可以删除该说明。此外,您还可以:
- 使用自定义文本指定引用说明
- 生成一个数字对象标识符 (DOI)。您必须在其他地方生成此标识符。有关详细信息,请访问 DOI.org
- 创建多个引用说明
浏览内容类型
File Exchange 会根据与您的提交内容相关联的信息为文件分配内容类型。
对内容分配此类型 | 当文件具有此扩展名时 | 且提交内容符合以下条件 |
---|---|---|
App |
.mlappinstall |
- |
驱动程序 |
.mdd |
- |
示例 |
.m |
/html 子目录下存在与 MATLAB .m 文件同名的 .html 文件 |
函数 |
.m |
函数 调用 |
Simulink 模型 |
.mdl |
- |
视频 |
.avi、.mp4、.wmv、.mpg、.mov、.swf、.mpeg |
- |
提示:如果您是提交者并且您提交内容中的文件已显示,但显示的不是预览图像,而是内容为" Preview image not found " 的消息,请在同一目录中添加与您的代码具有相同文件名的图像,File Exchange 将随您的文件显示该图像。示例:如果您有名为“foo.mdl”的文件,添加名为 foo.gif 的截图会向用户显示您 Simulink 模型的截图,而不是这条消息。
许可证信息
许可明确地说明了您作为 File Exchange 上可用代码的作者和用户所拥有的权利。许可详细说明如何使用该文件,并回答了有关修改、分发和商业使用权利的常见问题。
直接发布到 File Exchange 的所有代码均且只支持 BSD 许可证。您使用上传文件直接提交到 File Exchange 的社区内容都会自动加上 BSD 许可证条款。您使用连接到 GitHub 或链接到外部网站发布的社区内容可以使用其他许可证类型。MathWorks 员工提交的某些内容,包括硬件支持包,可能受限于 MathWorks 有限许可证。获得许可的 File Exchange 提交内容具有查看许可证链接。有关 File Exchange 上许可的详细信息,请参阅 File Exchange 许可常见问题解答。
赢得徽章
您可以通过参与 File Exchange 来赢得徽章。您赢得的所有徽章都会显示在您的社区资料页上。
您可以赢得的徽章示例如下:
- 首次提交
- 首次评价
- 编辑精选
- 个人最佳下载
- ... 还有更多
请访问 社区徽章 页,查看您可以赢得的徽章类型。
当您…… | 赢得的额外积分 |
---|---|
提交内容被“每周精选”博客选中 |
+50 个积分 |
提交内容为您赢得一枚年度徽章 |
+50 个积分 |
提交内容荣获 5 星评级 |
+5 个积分 |
提交内容荣获 4 星评级 |
+4 个积分 |
提交内容下载了 10 次 |
如果提交内容在过去 3 个月内未更新,则 +1 个积分 如果提交内容是在过去 3 个月内有更新,则 +2 个积分 |
查看 排行榜 ,看看谁的声誉最高!
提出问题和获取反馈
如果您有与 File Exchange 相关的问题或意见,请使用此 反馈论坛。类别请选择 MATLAB Central。与特定 File Exchange 提交内容相关的功能问题和意见可以通过该提交中的留言或讨论来解决。
有关 MATLAB 和 Simulink 问题请使用 MATLAB Answers 获得社区专家的回答。如果您在许可或者其他 MathWorks 产品或服务方面需要更多帮助,请 联系支持部门。