tripal_chado_views_help.tpl.php 3.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041
  1. <h3>Views Integration Description:</h3>
  2. <p>Tripal Views provides an interface for integrating <a href="http://drupal.org/project/views">Drupal Views</a>
  3. with Chado tables, custom tables and materialized views. This allows site administrators to create custom pages
  4. and forms for tables in the Chado schema (if Chado was installed by Tripal). All tables in Chado are integrated
  5. automatically with Drupal Views but custom tables and materialized views are not. After creating a new materialized
  6. view or custom table you can follow the links above to integrate the table with Drupal Views. The interface allows
  7. you to specify which fields the table can be joined with other tables and also specify field, sort and filter
  8. handlers for views. Different handlers provide different functionality.
  9. </p>
  10. <br>
  11. <h3>Setup Instructions:</h3>
  12. <p>After installation of the Tripal core module. The following tasks should be performed</p>
  13. <ol>
  14. <li><b>Set Permissions</b>: To allow access to site administrators for this module, simply
  15. <?php print l('assign permissions', 'admin/user/permissions') ?> to the appropriate user roles for the
  16. permission type "manage tripal_views_integration". </li>
  17. </ol>
  18. <br>
  19. <h3>Usage Instructions:</h3>
  20. <p>To use Tripal Views integration follow these steps:</p>
  21. <ol>
  22. <li><b>Identify or create a materialized view or custom table:</b> Using the <?php print l('Tripal materialized View interface', "admin/tripal/mviews") ?>
  23. identify the view you would like to integrate or create a new one. Or, using the <?php print l('Tripal custom table interface', 'admin/tripal/custom_tables')?></li>
  24. <li><b>Integration a new table</b>: Navigate to the <?php print l('new integration page', "admin/tripal/views/integration/new") ?>
  25. to integrate the new table. Provide a user friendly name
  26. and description to help you remember the purpose for integrating the view. Next, select the table you want to integrate
  27. from the provided select box. If your table has fields that can join with other Chado tables, you may
  28. provide those relationships in the provided form. Finally, if your fields require a special handlers, you
  29. may select them from the drop downs provided</li>
  30. <li><b>Alter an existing integration</b>: If a table is already integrated you can alter its integration configuration by navigating
  31. to the <?php print l('list of integrated tables', 'admin/tripal/views/integration/list')?>, select the table from the list and alter it accordingly.
  32. You can create new integration configurations for tables that are already integrated by lowering the priority setting. The configuration setting
  33. with the lowest priority will be selected.</li>
  34. <li><b>Create custom pages/block/search form</b>: After saving conifguration settings from either step above, you can navigate to the
  35. Drupal Views interface where you can create a custom page, block or search form.</li>
  36. <li><b>Review your integrated views</b>: A page providing a
  37. <?php print l('list of all integrated views', "admin/tripal/views/integration/list") ?> is provided. You may
  38. view this page to see all integrated views, but also to remove any unwanted integrations.</li>
  39. </ol>