The I-GUIDE Catalog is part of the I-GUIDE Platform and provides search, discovery, and dynamic interaction with resources created by or used by I-GUIDE researchers.
Display resource owner-defined access and usage examples that may contain code. Examples will be provided for the user to choose from for common content types (e.g., launching notebooks)
Code can be copied and pasted into a terminal/notebook/etc., and formatting is preserved
Syntax highlighting
Code language is displayed
Contains a description and potentially instructions
Graphical representation of “haspart” and “ispartof” relationships that allows users to navigate parent/child relationships.
One simple way to do this may be to encourage use of a readme.md file that is part of the resource content.
From the functional specifications:
Display resource owner-defined access and usage examples that may contain code. Examples will be provided for the user to choose from for common content types (e.g., launching notebooks)
One simple way to do this may be to encourage use of a readme.md file that is part of the resource content.