tripal_project_admin.tpl.php 7.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293
  1. <h3>Tripal Project Administrative Tools Quick Links:</h3>
  2. <ul>
  3. <li><a href="<?php print url("admin/tripal/tripal_project/configuration") ?>">Project Configuration</a></li>
  4. </ul>
  5. <h3>Module Description:</h3>
  6. <p>The Tripal Project module provides support for visualization of "project" pages, editing and updating.</p>
  7. <h3>Setup Instructions:</h3>
  8. <ol>
  9. <li><p><b>Set Permissions</b>: The project module supports the Drupal user permissions interface for
  10. controlling access to project content and functions. These permissions include viewing,
  11. creating, editing or administering of
  12. project content. The default is that only the original site administrator has these
  13. permissions. You can <a href="<?php print url('admin/user/roles') ?>">add roles</a> for classifying users,
  14. <a href="<?php print url('admin/user/user') ?>">assign users to roles</a> and
  15. <a href="<?php print url('admin/user/permissions') ?>">assign permissions</a> for the project content to
  16. those roles. For a simple setup, allow anonymous users access to view organism content and
  17. allow the site administrator all other permissions.</p></li>
  18. <li><p><b>Sync any Existing Projects</b>: Near the top of the ' . l('Project Configuration page', 'admin/tripal/tripal_project/configuration') ?> there is
  19. a Sync Projects section which provides list of projects currently in chado which can be sync\'d.
  20. Simply select the projects you would like to create Drupal/Tripal pages for and click Sync Projects.</p></li>
  21. </ol>
  22. <h3>Features of this Module:</h3>
  23. <ul>
  24. <li><b>Add/Edit/Delete Projects</b>: Projects with no associated features can be created ' . l('here', 'node/add/chado-project') ?> but it is
  25. recommended to create the project using the feature loader. For example, when you load FASTA files using the Tripal loader you are
  26. given the option of specifying a project for all created features. Existing Projects (regardless of the method used to create them) can be
  27. edited or deleted by clicking the Edit tab at the top of the Project Page.</li>
  28. <li><p><b>Integration with Drupal Views</b>: <a href="http://drupal.org/project/views">Drupal Views</a> is
  29. a powerful tool that allows the site administrator to create lists or basic searching forms of Chado content.
  30. It provides a graphical interface within Drupal to allow the site admin to directly query the Chado database
  31. and create custom lists without PHP programming or customization of Tripal source code. Views can also
  32. be created to filter content that has not yet been synced with Druapl in order to protect access to non
  33. published data (only works if Chado was installed using Tripal). You can see a list of available pre-existing
  34. Views <a href="<?php print url('admin/build/views/') ?>">here</a>, as well as create your own. </p></li>
  35. <li><b>Basic Listing</b>: This module provides a basic <a href="<?php print url('projects') ?>">project display
  36. tool</a> for finding or listing projects in Chado. It does not require indexing for Drupal searching but relies
  37. on Drupal Views. <a href="http://drupal.org/project/views">Drupal Views</a> must be installed.</li>
  38. </ul>
  39. <h3>Page Customizations</h3>
  40. <p>There are several ways to customize the look-and-feel for the way Chado data is presented through Tripal.
  41. Below is a description of several methods. These methods may be used in conjunction with one another to
  42. provide fine-grained control.
  43. <ul>
  44. <li><p><b>Integration with Drupal Panels</b>: <a href="http://drupal.org/project/views">Drupal Panels</a>
  45. allows for customization of a page layout if you don\'t want to do PHP/Javascript/CSS programming. Tripal comes with pre-set layouts for project pages. However,
  46. Panels become useful if you prefer a layout that is different from the pre-set layouts. Chado content
  47. is provided to Panels in the form of Drupal "blocks" which you can then place anywhere on a page using the
  48. Panel\'s GUI.</p></li>
  49. <li><p><b>Drupal\'s Content Construction Kit (CCK)</b>: the
  50. <a href="http://drupal.org/project/cck">Content Construction Kit (CCK) </a> is a powerful way to add non-Chado content
  51. to any page without need to edit template files or knowing PHP. You must first download and install CCK.
  52. With CCK, the site administartor can create a new field to appear on the page. For example, currently,
  53. the Chado publication module is not yet supported by Tripal. Therefore, the site administrator can add a text
  54. field to the project pages. This content is not stored in Chado, but will appear on the project page. A field
  55. added by CCK will also appear in the form when editing a project to allow users to manually enter the appropriate
  56. text. If the default pre-set layout and themeing for Tripal is used, it is better to create the CCK element,
  57. indicate that it is not to be shown (using the CCK interface), then manually add the new content type
  58. where desired by editing the templates (as described below). If using Panels, the CCK field can be added to the
  59. location desired using the Panels interface.</p></li>
  60. <li><p><b>Drupal Node Templates</b>: The Tripal packages comes with a "theme_tripal" directory that contains the
  61. themeing for Chado content. The project module has a template file for project "nodes" (Tripal project pages). This file
  62. is named "node-chado_project.tpl.php", and provides javascript, HTML and PHP code for display of the project
  63. pages. You can edit this file to control which types of information (or which project "blocks") are displayed for projects. Be sure to
  64. copy these template to your primary theme directory for editing. Do not edit them in the "theme_tripal" directory as
  65. future Tripal updates may overwrite your customizations. See the <a href="http://tripal.info">Tripal website </a>
  66. for instructions on how to access variables and other Chado content within the template file.</p></li>
  67. <li><p><b>Project "Block" Templates</b>: In the "theme_tripal" directory is a subdirectory named "tripal_project".
  68. Inside this directory is a set of templates that control distinct types of information for projects. For example,
  69. there is a "base" template for displaying of data directly from the Chado project table. These templates are used both by Drupal blocks
  70. for use in Drupal Panels (as described above) or for use in the default pre-set layout that the node template
  71. provides (also desribed above). You can customize this template as you desire. Be sure to copy the
  72. template to your primary theme directory for editing. Do not edit them in the "theme_tripal" directory as
  73. future Tripal updates may overwrite your customizations. See the <a href="http://tripal.info">Tripal website </a>
  74. for instructions on how to access variables and other Chado content within the template files.</p></li>
  75. </li>
  76. <li><p><b>Adding Links to the "Resources" Sidebar</b>: If you use the pre-set default Tripal layout for theming, you
  77. will see a "Resources" sidebar on each page. The links that appear on the sidebar are automatically generated
  78. using Javascript for all of the project "Blocks" that appear on the page. If you want to add additional links
  79. (e.g. a link to a views table showing all features of the current project) and you want that link to appear in the
  80. "Resources" sidebar, simply edit the Drupal Node Template (as described above) and add the link to the
  81. section at the bottom of the template file where the resources section is found.</p></li>
  82. </ul>
  83. </p>