example_ng_manifest.yaml

name: space-race
display_name: Space Race
visibility: public
categories: ["Annotation", "Segmentation", "Acquisition"]
contributions:
  commands:
    # NOTE: no longer needing `name` prepended - we do this for the developer
    - command: get_reader
      # contribution type is declared with command, as are the attributes of the contribution
      # can be done using a discriminating union
      type: reader
      python_name: space_race._reader:napari_get_reader
      title: Open data with Space Race
      accepts_directories: false
      filename_patterns: ['*.npy']
    - command: write_multiple
      type: writer
      python_name: space_race._writer:write_multiple
      title: Save multi-layer data with Space Race
      layer_types: ['image*','labels*']
      filename_extensions: []
    - command: write_single_image
      type: writer
      python_name: space_race._writer:write_single_image
      title: Save image data with Space Race
      layer_types: ['image']
      filename_extensions: ['.npy']
    - command: make_sample_data
      # sample URI contributions don't need a command, so they'd be listed in a separate spot
      type: sample
      python_name: space_race._sample_data:make_sample_data
      title: Load sample data from Space Race
      display_name: Space Race
      key: space_race
    - command: make_container_widget
      type: widget
      python_name: space_race:ImageThreshold
      title: Make threshold Container widget
      display_name: Container Threshold
      # menu contributions would be associated with the command itself
      # napari contributable menus are referred to just by the menu title (not the full menu path)
      menus:
        - menu: 'segment/thresholds'
          group: 'thresholds'
          order: 1
        # plugins can put submenus in their own submenu
        - menu: 'space-race/segmentation'
    - command: make_magic_widget
      type: widget
      python_name: space_race:threshold_magic_widget
      title: Make threshold magic widget
      display_name: Magic Threshold
      menus: 
        - menu: 'space-race/segmentation'
    - command: make_function_widget
      type: widget
      python_name: space_race:not_threshold_segment
      title: Make different segmentation widget
      autogenerate: true
      display_name: Not Threshold Segmentation
      menus:
        - menu: 'segment'
    - command: make_qwidget
      type: widget
      python_name: space_race:ExampleQWidget
      title: Make example QWidget
      display_name: Example QWidget

  # submenus are declared explicitly, together with their labels
  # they can either start with an existing contributable napari menu, or 
  # the plugin's own name.
  # this determines the root of the submenu
  submenus:
    - id: 'space-race/segmentation'
      label: Threshold Segmentation
    - id: 'segment/thresholds'
      label: Thresholds
  
  # this would become a dedicated contribution and we'd change the name to disambiguate
  # from sample contributions that need a command
  sample_uri:
    - key: kiribati
      display_name: Tabueran Kiribati
      uri: https://en.wikipedia.org/wiki/Napari#/media/File:Tabuaeran_Kiribati.jpg
  
  # contributions that don't rely on commands would continue being listed here
  themes:
  - id: monokai
    label: Monokai
    type: dark
    syntax_style: monokai
    colors:
      canvas: black
      console: black
      background: '#272822'
      foreground: '#75715e'
      primary: '#cfcfc2'
      secondary: '#f8f8f2'
      highlight: '#e6db74'
      text: '#a1ef34'
      icon: '#a1ef34'
      warning: '#f92672'
      current: '#66d9ef'

# Note: the internal schema representation is how we generate all the docs and references
# so it's not that trivial to just change the user bit and keep the internal stuff the same...