tripal_cv_help.tpl.php 3.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445
  1. <h3>Module Description:</h3>
  2. <p>The Tripal CV (Controlled Vocabularies) Module provides
  3. functionality for managing controlled vocabularies and the terms they are
  4. comprised of. The flexibility and extendibility of the chado schema depends
  5. on controlled vocabularies. For example, by using a controlled vocabulary for
  6. feature types the chado schema can describe features of any type, even those
  7. we have not concieved of yet.</p>
  8. <h3>Setup Instructions:</h3>
  9. <p>After installation of the controlled vocabulary module, the following tasks should be performed:</p>
  10. <ol>
  11. <li><p><b>Set Permissions</b>: By default only the site administrator account has access to create, edit, delete
  12. or administer vocabularies and terms. Navigate to the <?php print l('permissions page', 'admin/user/permissions')?> and set the
  13. permissions under the 'tripal_cv' section as appropriate for your site. For a simple setup, allow anonymous
  14. users access to view content and create a special role for creating, editing and other administrative tasks.</p></li>
  15. <li><p><b>Loading of Ontologies/Controlled Vocabularies</b>: You can access this loader at <?php
  16. print l('Admin->Tripal Management->Tripal CV->Load Ontology With OBO File', 'admin/tripal/loaders/chado_vocabs/obo_loader')
  17. ?>. This loader allows you to choose from a list of common ontologies or
  18. enter the URL or location to an OBO file. Even the list of common
  19. ontologies is using a URL ensuring you get the most up to date ontology.</p>
  20. <p>NOTE: in some cases, community developed ontologies for your
  21. data may not yet be developed. In this case, it is suggested that you begin
  22. developement of an ontology using one of the online tools. You might find
  23. that many researchers are trying to deal with the same data and are willing
  24. to help you in this endevor. </p></li>
  25. </ol>
  26. <h3>Features of this Module:</h3>
  27. <p>Aside from the data loading described above, the Tripal Controlled Vocabulary (CV) module also provides the following functionality:</p>
  28. <ul>
  29. <li><p><b>Create/Update/Delete A Controlled Vocaulbulary</b>: to create your own controlled vocabulary go to
  30. <?php l('the page for adding a vocbulary', 'admin/tripal/tripal_cv/cv/add') ?> and
  31. fill out the form provided. To Update/Delete a controlled vocabulary go to
  32. <?php print l('the page for editing a vocuabulary', 'admin/tripal/tripal_cv/cv/edit') ?>,
  33. select the existing vocabulary you want to modify and then
  34. edit it as desired. This only modifies the vocabulary itself. See the next section for adding, removing, editing
  35. the terms of a vocabulary.</p></li>
  36. <li><p><b>Create a Controlled Vocaulbulary Term</b>: Use
  37. <?php print l('the page for adding a new CV term', 'admin/tripal/tripal_cv/cvterm/add') ?>,
  38. select the controlled vocabulary you want to add terms to and then fill
  39. out the form.</p></li>
  40. </ul>