Difference between revisions of "Step-By-Step Instruction"

From Metadata-Registry
Jump to: navigation, search
Line 1: Line 1:
 
===Step-by-Step Instructions for Using the NSDL Registry===
 
===Step-by-Step Instructions for Using the NSDL Registry===
  
====Step-By-Step Instruction====
+
====STEP 1. User Registration====
  
* '''STEP 1.''' Go to the production [http://metadataregistry.org Registry] (or to the [http://beta.metadataregistry.org Sandbox] if you want to try things out first)
+
* Go to the production [http://metadataregistry.org Registry] (or to the [http://beta.metadataregistry.org Sandbox] if you want to try things out first)
  
  
Line 9: Line 9:
  
  
* '''STEP 2.''' Click on “sign in/register” in the top right hand corner and register yourself as a user. If you just want to browse the Registry, you don't need to register, but user registration and login is essential for managing vocabularies.
+
* Click on “sign in/register” in the top right hand corner and register yourself as a user. If you just want to browse the Registry, you don't need to register, but user registration and login is essential for managing vocabularies.
  
  
Line 15: Line 15:
  
  
* '''STEP 3.''' As a User, you may now register an organization or a person as a Resource Owner or maintenance agency. When you register an owner, you automatically become an administrator for that owner/maintenance agency within the Registry. Soon you will be able to add other registered users as maintainers for the vocabularies you register (for now, if you need to add another maintainer, contact the [mailto:jphipps@madcreek.com Registry Admin]).
+
====STEP 2. Register an Owner or Maintenance Agency====
 +
 
 +
* As a User, you may now register an organization or a person as a Resource Owner or maintenance agency. When you register an owner, you automatically become an administrator for that owner/maintenance agency within the Registry. Soon you will be able to add other registered users as maintainers for the vocabularies you register (for now, if you need to add another maintainer, contact the [mailto:jphipps@madcreek.com Registry Admin]).
  
 
* All registered vocabularies must have an owner, but registered owners may have any number of vocabularies.  Not every vocabulary owned by a particular agency or individual will be managed by the same maintainers.  
 
* All registered vocabularies must have an owner, but registered owners may have any number of vocabularies.  Not every vocabulary owned by a particular agency or individual will be managed by the same maintainers.  
Line 25: Line 27:
 
* Required information for owners or maintenance agencies allows essential contact to be maintained between the individual or organization and the NSDL Registry. Contact information is used to provide notifications of activity and to provide assistance in the event of problems.  
 
* Required information for owners or maintenance agencies allows essential contact to be maintained between the individual or organization and the NSDL Registry. Contact information is used to provide notifications of activity and to provide assistance in the event of problems.  
  
* '''Step 4.''' After you've registered an owner/maintenance agency, you will be shown your accepted data. On the right side menu, you will see a list of current vocabularies and owners, and links on the bottom of the list that allow you to register a new owner or a new vocabulary. If you click the vocabulary link, you will be presented with a form to fill out for your vocabulary.
+
====Step 3. Register a Top-Level Vocabulary====
 +
 
 +
* After you've registered an owner/maintenance agency, you will be shown your accepted data. On the right side menu, you will see a list of current vocabularies and owners, and links on the bottom of the list that allow you to register a new owner or a new vocabulary. If you click the vocabulary link, you will be presented with a form to fill out for your vocabulary.
  
  
Line 42: Line 46:
 
** URI: If you click in the URI he application will ask you if you wish to associate the domain name and token to create the base URI for the vocabulary. You should say "yes."
 
** URI: If you click in the URI he application will ask you if you wish to associate the domain name and token to create the base URI for the vocabulary. You should say "yes."
  
* Step 5. Once your vocabulary is registered, you may add concepts by clicking on the concepts tab at the top, and clicking on the “create” button to invoke the concepts form. After the first concept is registered, you can use “save and add” to save the current concept and allow you to register the next in one step. We suggest that you register all your concepts FIRST, before adding any properties to the concepts (why we suggest this will become more obvious when you begin to create relationships between concepts).
+
====Step 4. Add Terms to your Vocabulary====
 +
 
 +
* Once your vocabulary is registered, you may add concepts/terms by clicking on the concepts tab at the top tab. You will be presented with a header with the name of your vocabulary, and an "Add Concept" button. After the first concept is registered, you can use “save and add” to save the current concept and invoke an empty form to register the next in the same step. We suggest that you register all your concepts FIRST, before adding any properties to the concepts (why we suggest this will become more obvious when you begin to create relationships between concepts).
 +
 
 +
 
 +
[[Image:Add_concept_form.png]]
 +
 
 +
 
 +
* Note that when the form is presented, the URI will default to the Domain name/token you chose for the vocabulary, and a unique number.  If you prefer a different number or text string, you can substitute it for that defaulted number before saving the entry. Once the page is saved, the URI cannot be chanced, but instead must be deleted and the concept re-entered.
 +
 
 +
====Step 5. Add Properties to your Terms====
  
* Step 6. Once your concepts are registered, you can go through and add additional properties. When you add “broader,” “narrower,” or “related” properties to a concept, The Registry will automatically maintain these relationships in the related concepts.
+
* Once your concepts are registered, you can go through and add additional properties. When you add “broader,” “narrower,” or “related” properties to a concept, The Registry will automatically maintain these relationships in the related concepts.

Revision as of 15:08, 15 November 2006

Step-by-Step Instructions for Using the NSDL Registry

STEP 1. User Registration

  • Go to the production Registry (or to the Sandbox if you want to try things out first)


Registry front page.png


  • Click on “sign in/register” in the top right hand corner and register yourself as a user. If you just want to browse the Registry, you don't need to register, but user registration and login is essential for managing vocabularies.


New login screen.png


STEP 2. Register an Owner or Maintenance Agency

  • As a User, you may now register an organization or a person as a Resource Owner or maintenance agency. When you register an owner, you automatically become an administrator for that owner/maintenance agency within the Registry. Soon you will be able to add other registered users as maintainers for the vocabularies you register (for now, if you need to add another maintainer, contact the Registry Admin).
  • All registered vocabularies must have an owner, but registered owners may have any number of vocabularies. Not every vocabulary owned by a particular agency or individual will be managed by the same maintainers.


New owner page.png


  • Required information for owners or maintenance agencies allows essential contact to be maintained between the individual or organization and the NSDL Registry. Contact information is used to provide notifications of activity and to provide assistance in the event of problems.

Step 3. Register a Top-Level Vocabulary

  • After you've registered an owner/maintenance agency, you will be shown your accepted data. On the right side menu, you will see a list of current vocabularies and owners, and links on the bottom of the list that allow you to register a new owner or a new vocabulary. If you click the vocabulary link, you will be presented with a form to fill out for your vocabulary.


New vocabulary page.png


  • If you are a maintainer or administrator for more than one owner, you will be given a pull down list to select on behalf of which owner you are registering the vocabulary. It is critical that you select the correct owner at this stage, because all other relationships cascade from this action.
  • Specific data instructions:
    • Name (required): Use the full name by which the vocabulary is commonly known.
    • URL: If the vocabulary is available on a website, key in the full address here, including the "http://" portion.
    • Note: Any relevant human-readable text may be added here. Remember that this not will be publicly available to those browsing the Registry.
    • Community: If the vocabulary was developed for use by a specific community, it may be noted here.
    • Base Domain: The form will default to the Registry domain: http://metadataregistry.org/uri/ but you may override the default if you wish to use a domain associated with the vocabulary owner.
    • Token: The token distinguishing the specific vocabulary (ensuring unambiguous URIs) should be related to the vocabulary name, but in shortened form.
    • URI: If you click in the URI he application will ask you if you wish to associate the domain name and token to create the base URI for the vocabulary. You should say "yes."

Step 4. Add Terms to your Vocabulary

  • Once your vocabulary is registered, you may add concepts/terms by clicking on the concepts tab at the top tab. You will be presented with a header with the name of your vocabulary, and an "Add Concept" button. After the first concept is registered, you can use “save and add” to save the current concept and invoke an empty form to register the next in the same step. We suggest that you register all your concepts FIRST, before adding any properties to the concepts (why we suggest this will become more obvious when you begin to create relationships between concepts).


Add concept form.png


  • Note that when the form is presented, the URI will default to the Domain name/token you chose for the vocabulary, and a unique number. If you prefer a different number or text string, you can substitute it for that defaulted number before saving the entry. Once the page is saved, the URI cannot be chanced, but instead must be deleted and the concept re-entered.

Step 5. Add Properties to your Terms

  • Once your concepts are registered, you can go through and add additional properties. When you add “broader,” “narrower,” or “related” properties to a concept, The Registry will automatically maintain these relationships in the related concepts.