Add-On Upload Process

Uploading an Add-On

Uploading an add-on is a straightforward process. Log in to XNAT Marketplace (be sure to register if you have not already) and click the "Submit an Add-on" button just under the XNAT Marketplace logo. This will take you to a standard web form where you can enter details about your add-on. Please be as detailed as possible. In fact, it may be good to plan ahead to make sure you have everything you need by checking the "Things you'll need before uploading" section below.

When you submit the upload form, your add-on will go through a standard review process by XNAT Marketplace administrators. When they approve your add-on, it will automatically show up on the XNAT Marketplace for everyone to enjoy.

Things you'll need before uploading

  • A descriptive, informative title for your add-on that isn't already used in the Marketplace
  • A strategy for versioning your add-on. You'll have to be very specific with your version number when uploading. It is best to plan ahead.
  • Knowledge of whether you're uploading a Tool or a Plugin.
  • An idea of which categories you'd like your add-on listed under.
  • A good, easy to understand description of your add-on. The better you do here, the more likely someone will download and use your work.
  • A list of people who worked on the add-on. Give credit where credit is due.
  • A quick description of what environment your add-on has been used. For example, is this an experimental feature that has only been used on your development workstation, or is it a widely used add-on used in multi-center studies?
  • Screenshots if you got them. Save them as PNG or JPG files.
  • Documentation! This cannot be stressed enough. If you want people to use your add-on, you will have to provide adequate documentation as a PDF, DOC, XLS, TXT file or a URI to a publicly accessible website. At the minimum, make sure your documentation includes:
    • What your add-on does 
    • How your add-on works
    • Installation instructions
    • Uninstall instructions
    • How to find help
    • License restrictions
  • If you want a custom icon to appear for your add-on, make a 57x57 pixel PNG or JPG graphic.
  • Know what versions of XNAT your add-on requires.
  • Know what your add-on affects in the core XNAT code. This can include one or more of the following:
    • Velocity/HTML Templates
    • Database Schema
    • Java Classes
    • Javascript Functions
    • CSS Style Sheet
    • Project Dependencies
    • Spring Configuration Files
  • Finally, your add-on will have to be properly packaged per the documentation.