tripal_cv_help.tpl.php 3.2 KB

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