tripal_pub_admin.tpl.php 4.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  1. <br /><h3>Tripal Publication Quick Links</h3>
  2. <ul>
  3. <li><?php print l('Search for Publications', 'find/publications') ?></li>
  4. <li><?php print l('Configuration', 'admin/tripal/tripal_pub/configuration') ?></li>
  5. <li><?php print l('Sync Publications', 'admin/tripal/tripal_pub/sync') ?></li>
  6. <li><?php print l('List of Importers', 'admin/tripal/tripal_pub/import_list') ?></li>
  7. <li><?php print l('Add a New Importer', 'admin/tripal/tripal_pub/import/new') ?></li>
  8. </ul>
  9. <h3>Module Description:</h3>
  10. <p>The Tripal Publication Module provides the functionality for adding, editing, deleting viewing and bulk
  11. importing of publications. This module additionally provides a search tool for finding publications that have
  12. been added to Chado database.
  13. </p>
  14. <h3>Setup Instructions:</h3>
  15. <ol>
  16. <li><p><b>Set Permissions</b>: The publication module supports the Drupal user permissions interface for
  17. controlling access to publication content and functions. These permissions include viewing,
  18. creating, editing or administering of
  19. publications. The default is that only the original site administrator has these
  20. permissions. You can <a href="<?php print url('admin/user/roles') ?>">add roles</a> for classifying users,
  21. <a href="<?php print url('admin/user/user') ?>">assign users to roles</a> and
  22. <a href="<?php print url('admin/user/permissions') ?>">assign permissions</a> for the publication content to
  23. those roles. For a simple setup, allow anonymous users access to view publication content and
  24. allow the site administrator all other permissions.</p></li>
  25. <li><p><b>Sync Publications</b>: If you already have publications in your Chado database, or you loaded them
  26. through a means other than Tripal, and you want those publications to appear on your site then you will need
  27. to "sync" them with Drupal. Use the <?php print l('sync publications', 'admin/tripal/tripal_pub/sync') ?>
  28. page to sync all publications.</p></li>
  29. <li><p><b>Configure the Search Behavior</b>: Before allowing site visitors to search for publications
  30. visit the <?php print l('configuration page', 'admin/tripal/tripal_pub/configuration') ?> to disable or enable
  31. fields for searching. Tripal uses its own ontology for storing publication information in Chado, and all
  32. child terms of the "Publication Details" are made available for searching. However, some of these
  33. may not be desired for searching and can be disabled.</p></li>
  34. <li><p><b>AGL Importer</b>: Initially, the Tripal publication module supports creating publication
  35. importers using PubMed and the USDA National Agricultural Library (AGL). The AGL database uses
  36. a Z39.50 protocol for querying and therefore Tripal requires the 'YAZ' library to connect. Before
  37. you can query AGL you must install the YAZ library and the PHP YAZ library. The following steps can
  38. be used on an Ubuntu 12.04 server to intall the necessary pre-requisites:
  39. <ol>
  40. <li>Install the YAZ libraries: sudo apt-get install yaz libyaz4-dev</li>
  41. <li>Install the PHP YAZ extension: sudo pecl install yaz</li>
  42. <li>Add the text 'extesion=yaz.so' to the appropriate php.ini file (e.g. /etc/php5/apache2filter/php.ini)</li>
  43. <li>Restart the webserver</li>
  44. </ol>
  45. </p></li>
  46. </ol>
  47. <h3>Features of this Module:</h3>
  48. <ul>
  49. <li><p><b>Add/Edit/Delete Publications</b>: Publications can be maually added <?php l('here', 'node/add/chado-pub') ?>.
  50. Once added, publications can be modified or deleted by clicking the Edit tab at the top of a publication page.</p></li>
  51. <li><p><b>Publication Search Tool</b>: A <?php print l('search tool','find/publications') ?> is provided for
  52. finding publications. Unlike most default search tools for Tripal, this tool does not rely on Drupal Views</p></li>
  53. <li><p><b>Bulk Import of Publications</b>: Site administrators can <?php print l('add a new publication importer', 'admin/tripal/tripal_pub/import/new') ?>
  54. which provides a set of search terms for querying a remote publication database (e.g. PubMed). Publications
  55. that matche the search terms can be imported when the publication import cron command is executed. The
  56. cron command can be executed using the Drush command: drush tpubs-import. This drush command can be added
  57. as a system-wide cron (in the same way the Tripal jobs cron is implemented) to be executed on a periodic basis.
  58. This will allow the site to import publications which have been newly added to remote databases and which
  59. are relative to the site. Site administrators can <?php print l('see the list of importers', 'admin/tripal/tripal_pub/import_list') ?>
  60. and edit, disable or delete the importers.</p></li>
  61. </ul>