Fix metadata provider docs. Add link from Summary

ADIS-SA · Mar 9, 2018 · 3c425dd · 3c425dd
1 parent f4196d5
commit 3c425dd
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 2 deletions.
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
@@ -21,6 +21,7 @@ This wiki is intended to be used as a reference for the concepts and APIs in Cor
   - [Rendering Loop](concepts/rendering-loop.md)
   - [Libraries](concepts/libraries.md)
   - [Rendering Pipeline](concepts/rendering-pipeline.md)
+  - [Metadata Providers](concepts/metadata-providers.md)
 - Advanced
   - [Image Cache](advanced/image-cache.md)
   - [Enabled Element Layers](advanced/enabled-element-layers.md)

diff --git a/docs/concepts/metadata-providers.md b/docs/concepts/metadata-providers.md
@@ -37,8 +37,18 @@ function metaDataProvider(type, imageId)
     }
   }
 }
-````
 
+// Register this provider with CornerstoneJS
+cornerstone.metaData.addProvider(metaDataProvider);
 
+// Retrieve this metaData
+var imagePlaneModule = cornerstone.metaData.get('imagePlaneModule', 'ct://1');
+````
 
-In web-based imaging applications it is beneficial for performance to only request images when they are required. T
+## Basics
+  * Cornerstone allows for the registration of multiple Metadata Providers.
+  * Each provider can provide whichever information the developer desires.
+  * When a request is made for metadata for an image, Cornerstone will iterate through the known providers until it retrieves a defined set of metadata for the specified metadata type.
+  * Providers can be added to Cornerstone with an optional priority value in order to influence the order in which they are called.
+  * When DICOM images are loaded by [Cornerstone WADO Image Loader](https://github.com/cornerstonejs/cornerstoneWADOImageLoader), their metadata will be parsed and added to a metadata provider automatically.
+  * Within [Cornerstone Tools](https://github.com/cornerstonejs/cornerstoneTools), specific metadata types are used to provide metadata for tools.