install_prereqs.rst 2.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950
  1. Tripal Prerequisites
  2. ====================
  3. .. note::
  4. Remember you must set the ``$DRUPAL_HOME`` environment variable if you want to cut-and-paste the commands below. See :doc:`../drupal_home`
  5. Tripal v3.x requires several Drupal modules. These include `Entity <https://www.drupal.org/project/entity>`_, `Views <https://www.drupal.org/project/views>`_, `CTools <https://www.drupal.org/project/ctools>`_, `Display Suite <https://www.drupal.org/project/ds>`_, `Field Group <https://www.drupal.org/project/field_group>`_, `Field Group Table <https://www.drupal.org/project/field_group_table>`_, `Field Formatter Class <https://www.drupal.org/project/field_formatter_class>`_ and `Field Formatter Settings <https://www.drupal.org/project/field_formatter_settings>`_ modules. Modules can be installed using the graphical Drupal website by clicking on the Modules link in the top adminstrative menu bar. Instructions for instaling Modules via the web-interface can be found here: https://www.drupal.org/documentation/install/modules-themes/modules-7. However, Drush can be quicker for module installation. The following instructions will show how to install a module using the Drush command-line tool.
  6. First, install the Entity module. We will download the current version using the drush command. On the command-line, execute the following:
  7. .. code-block:: bash
  8. cd $DRUPAL_HOME/sites/all/modules
  9. drush pm-download entity
  10. Typically for all module installation we should check the README for additional installation instructions. Next, enable the module using a drush command:
  11. .. code-block:: bash
  12. drush pm-enable entity
  13. For basic Tripal functionality you must also enable the Views and CTools modules. You can specify as many module as desired on one line:
  14. .. code-block:: bash
  15. drush pm-download views ctools
  16. drush pm-enable views views_ui ctools
  17. Finally, Tripal works best when it can provide default display layouts. To support default layouts you must also enable the remaining dependencies:
  18. .. code-block:: bash
  19. drush pm-download ds field_group field_group_table field_formatter_class field_formatter_settings
  20. drush pm-enable ds field_group field_group_table field_formatter_class field_formatter_settings
  21. Optionally, you can install the ckeditor module. This module provides a nice WYSIWYG editor that allows you to edit text on your site using a graphical editor. Otherwise, if you need images or formatting (e.g. underline, bold, headers) you would be required to write HTML. It is recommended that this module be installed to improve the user experience:
  22. .. code-block:: bash
  23. drush pm-download ckeditor
  24. drush pm-enable ckeditor
  25. Finally, we need an more recent version of JQuery that what comes with Drupal. We can get this by installing the JQuery update module.
  26. .. code-block:: bash
  27. drush pm-download jquery_update
  28. drush pm-enable jquery_update