tripal_organism_help.tpl.php 2.5 KB

123456789101112131415161718192021222324252627282930313233343536373839
  1. <h3>Module Description:</h3>
  2. <p>The Tripal Organism module allows you to add, edit and/or delete chado organisms.
  3. Furthermore, it also provides listing of organisms and details page for each organism.
  4. Basically, the chado organism module is designed to hold information about a given species.
  5. For more information on the chado organism module see the
  6. <a href="http://gmod.org/wiki/Chado_Organism_Module">GMOD wiki page</a></p>
  7. <h3>Setup Instructions:</h3>
  8. <p>After installation of the organism module. The following tasks should be performed.</p>
  9. <ul>
  10. <li><p><b>Set Permissions</b>: By default only the site administrator account has access to create, edit, delete
  11. or administer features. Navigate to the <?php print l('permissions page', 'admin/user/permissions')?> and set the
  12. permissions under the 'tripal_organism' section as appropriate for your site. For a simple setup, allow anonymous
  13. users access to view content and create a special role for creating, editing and other administrative tasks.</p></li>
  14. <li><p><b>Create an Organism</b>: Organism pages can be created in two ways:</p>
  15. <ol>
  16. <li><p><b>Sync Organisms</b>: If your organism has been pre-loaded into Chado then you need to sync the organism.
  17. This process is what creates the pages for viewing online. Not all organisms need be synced, only those
  18. that you want shown on the site. Use the the
  19. <a href="<?php print url('admin/tripal/tripal_organism/configuration') ?>">Organism Configuration page</a>
  20. to sync organisms. </p></li>
  21. <li><p><b>Manually Add An Organism</b>: If your organism is not already present in the Chado database
  22. you can create an organism using the <a href="<?php print url('node/add/chado-organism') ?>">Create Organism page</a>.
  23. Once saved, the organism will be present in Chado and also "synced".</p>
  24. </ol>
  25. </li>
  26. </ul>
  27. <h3>Features of this Module:</h3>
  28. <p>Aside from organism page setup (as described in the Setup section above),
  29. The Tripal organism module also provides the following functionality</p>
  30. <ul>
  31. <li><p><b>Simple Search Tool</b>: A <?php print l('simple search tool','chado/organisms') ?> is provided for
  32. finding organisms. This tool relies on Drupal Views. <a href="http://drupal.org/project/views">Drupal Views</a>
  33. which must be installed to see the search tool. Look for it in the navigation menu under the item
  34. "Search Data". </p></li>
  35. </ul>