3DSlicer中自己创建一个Extension项目（下篇）

将扩展的源代码上传到公开可用的存储库。建议以“Slicer”（使切片器扩展更易于识别）开头，后跟扩展名称（例如，“Sequences”扩展存储在“SlicerSequences”存储库中）。但是，这不是强制性要求。如果你有令人信服的理由不使用 Slicer 前缀，请在提出拉取请求时记下。在新的扩展提交清单中查看更多要求。

推荐使用 GitHub（由于用户社区庞大，免费公共项目托管）：加入 Github 并设置 Git。

如果开发包含 C++ loadable 或 CLI 模块的扩展（如果使用 Python 进行开发则不需要）：

生成目标以创建包文件。PACKAGE

通过使用扩展管理器安装创建的包文件来测试扩展。

完成扩展提交清单，然后将其提交到切片器扩展索引：

将扩展提交到扩展索引：

通过单击切片器扩展索引页面上的“Fork”按钮，在 GitHub 上创建 Fork ExtensionIndex 存储库

创建扩展说明（s4ext）文件

如果扩展已生成，则可以在生成文件夹中找到自动生成的扩展说明

如果未生成扩展，则使用文本编辑器手动创建扩展说明文件

将您的 .s4ext 文件添加到您的分叉存储库：可以使用 git 客户端或简单地单击“Upload files”按钮来完成

若要使扩展显示在最新的切片器预览版中：将文件上传到master分支中。

要使扩展出现在最新的切片器稳定版本中：将文件上传到与稳定版本对应的分支中，例如：4.10.

创建拉取请求：单击“Create pull request”按钮

按照拉取请求模板中的说明进行操作

3.应用程序设置

安装扩展后，目录将添加到特定于修订版的设置中：

包含扩展中捆绑的模块的文件夹将添加到 Modules/AdditionalPaths。这可确保找到与模块关联的库。

包含第三方动态库、Python 库等的文件夹将添加到 LibraryPaths、Paths、PYTHONPATH QT_PLUGIN_PATH。这可确保可以成功加载与模块关联的库。

4.扩展描述文件（.S4EXT）

扩展描述文件s4ext是一个带有扩展名的文本文件，允许指定与扩展相关的元数据。

描述文件由扩展的构建系统在扩展的构建树中根据扩展源代码的顶级文件中指定的元数据自动生成。由于描述是一个非常简单的文本文件，因此可以使用文本编辑器创建描述。如果扩展仅包含脚本化模块，则使用文本编辑器创建文件可能更简单，无需构建扩展即可开发这些模块。CMakeLists.txt

请注意，扩展管理器会忽略扩展描述文件的许多字段，而是使用 CMakeLists.txt中指定的信息。因此，在对扩展描述文件进行任何更改时，也必须在CMakeLists.txt文件中完成。

对于 superbuild 类型的扩展（构建自己的依赖项，例如在 C++ 中实现的外部库），将 build_subdirectory 初始化到 s4ext 中的内部构建位置至关重要。仪表板脚本并非在所有位置都使用CMakeLists.txt此变量的值。

语法

元数据是使用关键字后跟至少一个空格和关联的值来指定的。

不支持多行值。

空行将被忽略

以 a 开头的行被视为注释并被忽略。#

以下代码块演示了如何指定注释、元数据和关联值：

# This is a comment
metadataname This is the value associated with 'metadataname'

# This is an other comment
anothermetadata This is the value associated with 'anothermetadata'

支持的元数据字段

Name	Description	Required
scm	Source code management system. Must be `git`.	Y
scmurl	Read-only url used to checkout the extension source code.	Y
scmrevision	Revision allowing to checkout the expected source code.	Y
depends	List of extensions required to build this extension. Specify “NA” if there are no dependency. Extension names should be separated by a single space. For example: extensionA extensionB.	N
build_subdirectory	Name of the inner build directory in case of superbuild based extension. Default to `.`.	N
homepage	URL of the web page describing the extension.	Y
contributors	Extension contributor specified as `Firstname1 Lastname1 ([SubOrg1, ]Org1), Firstname2 Lastname2 ([SubOrg2, ]Org2)`.	N
category	Extension category.	Y
iconurl	URL to an icon (png file format and size of 128x128 pixels is recommended).	N
description	One line describing what is the purpose of the extension.	N
screenshoturls	Space separated list of urls to images.	N
enabled	Specify if the extension should be enabled after its installation. Valid values are `1` (default) = enabled; `0` = disabled.	N
status	Give people an idea what to expect from this code. This is currently not used.

注意：不支持 URL 中的参数（例如 &foo=bar）。如有必要，可以使用 URL缩短器服务。

5.扩展服务器

官方的切片器扩展服务器，“扩展目录”可在 https://extensions.slicer.org/ 上找到。若要获取扩展列表，请在 URL 中指定切片器修订版和平台，例如：https://extensions.slicer.org/catalog/All/30117/win。

扩展目录实现了一个 Web 应用程序（源代码），它连接到 Girder 服务器，通用型带有 Slicer Package Manager 插件（源代码）的存储服务器，该插件提供了方便的 REST API，用于访问切片器扩展包和元数据。

切片器中扩展管理器中的“管理扩展”选项卡使用此 REST API 获取有关更新的信息，并获取要安装或更新的包。

扩展服务器旨在使组织可以设置和维护自己的扩展服务器，例如分发自定义应用程序的扩展。可以在“应用程序设置”的“扩展”部分中设置扩展服务器地址。

直到 2021 年 8 月，一直使用基于 Midas 的服务器。https://slicer.kitware.com/midas3此服务器不再联机，因为无法执行所有可以确保其安全的软件更新。

扩展索引
ExtensionsIndex 是一个存储库，其中包含切片器扩展生成系统用于在扩展服务器上生成、测试、打包和上传扩展的扩展说明文件列表。*.s4ext

ExtensionsIndex 托管在 GitHub 上： https://github.com/Slicer/ExtensionsIndex

存储库的每个main分支都包含与切片器存储库中的同一分支相对应的扩展说明文件。例如，4.11 branch 包含切片器4.11分支的说明，branch 包含切片器分支的扩展说明。

扩展开发人员必须确保扩展索引的每个分支中的扩展说明与相应的切片器版本兼容。扩展开发人员通常在其存储库中创建相同的分支（main、4.11、4.13、...），并在扩展描述符文件中指定此分支名称。

6.扩展构建系统

扩展生成系统允许驱动切片器扩展的生成、测试、打包和上传。

使用扩展构建系统源代码，可以使用手动构建或仪表板驱动的自动构建来构建扩展。扩展描述文件必须简单地放在文件夹中，就像它们在扩展索引存储库中一样。

7.手动构建扩展列表

在本地生成扩展列表是测试扩展生成和获取自定义生成切片器应用程序的扩展包的便捷方法。

给定一个包含一个或多个扩展描述文件的目录，在扩展构建系统的帮助下，可以配置和构建关联的扩展，指定以下 CMake 选项：

CMake variable	Description
Slicer_DIR	Path to Slicer build tree. Required.
Slicer_EXTENSION_DESCRIPTION_DIR	Path to folder containing extension description files. Required.
CMAKE_BUILD_TYPE	Build type of the associated Slicer build directory
CTEST_MODEL	By default set to `Experimental`. Allow to choose on which CDash track results are submitted as well as setting the submission type associated with the uploaded extension.
Slicer_UPLOAD_EXTENSIONS	By default set to `OFF`. If enabled, extension builds will be submitted to Slicer dashboard and associated packages will be uploaded to extensions server.
SLICER_PACKAGE_MANAGER_URL	Slicer extensions server URL specifying where the extension should be uploaded. For example `https://slicer-packages.kitware.com`. source code. Note that this variable is expected to be set in place of `MIDAS_PACKAGE_URL`.
SLICER_PACKAGE_MANAGER_API_KEY	Token allowing to authenticate to the extensions server. Note that this variable is expected to be set in place of `MIDAS_PACKAGE_API_KEY` and `MIDAS_PACKAGE_EMAIL`.

以下示例中将使用以下文件夹：

Folder	Linux/macOS	Windows
Slicer source code tree (checked out from https://github.com/Slicer/Slicer.git)	`~/Slicer`	`C:\D\S`
Slicer build tree (built by following Slicer build instructions)	`~/Slicer-SuperBuild-Release`	`C:\D\SR`
List of extension description files (for example checked out from https://github.com/Slicer/ExtensionsIndex.git)	`~/ExtensionsIndex`	`C:\D\ExtensionsIndex`
Folder to store built extensions (new empty folder)	`~/ExtensionsIndex-Release`	`C:\D\ExtensionsIndexR`

8.生成、测试和打包

Linux 和 macOS：

cd ~/ExtensionsIndex-Release

cmake -DSlicer_DIR:PATH=~/Slicer-SuperBuild-Release/Slicer-build \
-DSlicer_EXTENSION_DESCRIPTION_DIR:PATH=~/ExtensionsIndex \
-DCMAKE_BUILD_TYPE:STRING=Release \
~/Slicer/Extensions/CMake

make
Windows：

cd /d C:\D\ExtensionsIndexR

"c:\Program Files\CMake\bin\cmake.exe" -DSlicer_DIR:PATH=C:/D/SR/Slicer-build ^
-DSlicer_EXTENSION_DESCRIPTION_DIR:PATH=C:/D/ExtensionsIndex ^
-DCMAKE_BUILD_TYPE:STRING=Release ^
C:/D/S/Extensions/CMake

"c:\Program Files\CMake\bin\cmake.exe" --build . --config Release

9.上传到扩展服务器

将配置/生成/测试结果提交到切片器仪表板Extensions-Experimental轨道，并将扩展上传到自定义扩展服务器。

Linux 和 macOS：

cd ~/ExtensionsIndex-Release
cmake -E env \
SLICER_PACKAGE_MANAGER_CLIENT_EXECUTABLE=/path/to/slicer_package_manager_client \
SLICER_PACKAGE_MANAGER_URL=https://slicer-packages.kitware.com \
SLICER_PACKAGE_MANAGER_API_KEY=a0b012c0123d012abc01234a012345a0 \
\
cmake -DSlicer_DIR:PATH=~/Slicer-SuperBuild-Release/Slicer-build \
-DSlicer_EXTENSION_DESCRIPTION_DIR:PATH=~/ExtensionsIndex \
-DCMAKE_BUILD_TYPE:STRING=Release \
-DCTEST_MODEL:STRING=Experimental \
-DSlicer_UPLOAD_EXTENSIONS:BOOL=ON \
~/Slicer/Extensions/CMake

make

Windows：

cd /d C:\D\ExtensionsIndexR
"c:\Program Files\CMake\bin\cmake.exe" -E env ^
SLICER_PACKAGE_MANAGER_CLIENT_EXECUTABLE=/path/to/slicer_package_manager_client ^
SLICER_PACKAGE_MANAGER_URL=https://slicer-packages.kitware.com ^
SLICER_PACKAGE_MANAGER_API_KEY=a0b012c0123d012abc01234a012345a0 ^
^
"c:\Program Files\CMake\bin\cmake.exe" -DSlicer_DIR:PATH=~/Slicer-SuperBuild-Release/Slicer-build ^
-DSlicer_EXTENSION_DESCRIPTION_DIR:PATH=C:/D/ExtensionsIndex ^
-DCMAKE_BUILD_TYPE:STRING=Release ^
-DCTEST_MODEL:STRING=Experimental ^
-DSlicer_UPLOAD_EXTENSIONS:BOOL=ON ^
C:/D/S/Extensions/CMake

make