tripal_featuremap_help.tpl.php 2.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  1. <h3>Module Description:</h3>
  2. <p>The Tripal Map module is an interface for the Chado Map module which groups
  3. features (sequences) into
  4. maps (typically genetic maps).
  5. This module provides support for visualization of "map" pages, editing and
  6. updating.
  7. </p>
  8. <h3>Setup Instructions:</h3>
  9. <ol>
  10. <li><p><b>Set Permissions</b>: By default only the site administrator
  11. account has access to create, edit, delete
  12. or administer maps. Navigate to
  13. the <?php print l('permissions page', 'admin/user/permissions') ?>
  14. and set the
  15. permissions under the 'tripal_featuremap' section as appropriate for
  16. your site. For a simple setup, allow anonymous
  17. users access to view content and create a special role for creating,
  18. editing and other administrative tasks.</p></li>
  19. <li><p><b>Create a Map</b>: An map (called a feature map in Chado) can
  20. be <?php print l('created', 'node/add/chado-featuremap') ?>
  21. manually in the same way any other data type. There is no loader for
  22. loading large files of map information including
  23. features that may be associated with these maps (e.g. genetic
  24. markers). The Tripal bulk loader is the only way
  25. to load this type of data.</p></li>
  26. <li><p><b>Sync any Existing Maps</b>: Before Maps can be viewed on the
  27. website, they must first
  28. be <?php print l('created manually', 'node/add/chado-featuremap') ?>
  29. or if they already exist in the Chado database they must be synced.
  30. Near the top of
  31. the <?php print l('Map Configuration page', 'admin/tripal/tripal_featuremap/configuration') ?>
  32. there is
  33. a Sync Maps section which provides list of maps currently in chado
  34. which can be sync\'d.
  35. Simply select the maps you would like to create Drupal/Tripal pages
  36. for and click Sync Maps. Once synced,
  37. pages will appear on the site for maps.</p></li>
  38. </ol>
  39. <h3>Features of this Module:</h3>
  40. <ul>
  41. <li><p><b>Edit or Delete Maps</b>: Maps can be manually edited or deleted by
  42. navigating to the map page and clicking the "Edit" button.</p></li>
  43. <li><p><b>Simple Search Tool</b>:
  44. A <?php print l('simple search tool', 'chado/featuremaps') ?> is
  45. provided for
  46. finding maps. This tool relies on Drupal Views. <a
  47. href="http://drupal.org/project/views">Drupal Views</a>
  48. which must be installed to see the search tool. Look for it in the
  49. navigation menu under the item
  50. "Search Data". </p></li>
  51. </ul>