plugins.rst 4.7 KB

  1. Plugins
  2. #######
  3. Plugins can modify the behavior of and add new features to Elgg.
  4. .. contents:: Contents
  5. :depth: 2
  6. :local:
  7. Where to get plugins
  8. ====================
  9. Plugins can be obtained from:
  10. * `The Elgg Community`_
  11. * `Github`_
  12. * Third-party sites (typically for a price)
  13. If no existing plugins meet your needs, you can `hire a developer`_ or :doc:`create your own </guides/index>`.
  14. .. _The Elgg Community:
  15. .. _Github:
  16. .. _hire a developer:
  17. The Elgg Community
  18. ==================
  19. Finding Plugins
  20. ---------------
  21. Sort based on most popular
  22. ^^^^^^^^^^^^^^^^^^^^^^^^^^
  23. On the community plugin page, you can sort by date uploaded (Filter: Newest) or number of downloads (Filter: Most downloads). Sorting by the number of downloads is a good idea if you are new to Elgg and want to see which plugins are frequently used by other administrators. These will often (but not always) be higher quality plugins that provide significant capabilities.
  24. Use the plugin tag search
  25. ^^^^^^^^^^^^^^^^^^^^^^^^^
  26. Next to the filtering control on the plugin page is a search box. It enables you to search by tags. Plugins authors choose the tags.
  27. Look for particular plugin authors
  28. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  29. The quality of plugins varies substantially. If you find a plugin that works well on your site, you can check what else that plugin author has developed by clicking on their name when viewing a plugin.
  30. Evaluating Plugins
  31. ------------------
  32. Look at the comments and ratings
  33. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  34. Before downloading and using a plugin, it is always a good idea to read through the comments that others have left. If you see people complaining that the plugin does not work or makes their site unstable, you probably want to stay away from that plugin. The caveat to that is that sometimes users ignore installation instructions or incorrectly install a plugin and then leave negative feedback. Further, some plugin authors have chosen to not allow comments.
  35. Install on a test site
  36. ^^^^^^^^^^^^^^^^^^^^^^
  37. If you are trying out a plugin for the first time, it is a bad idea to install it on your production site. You should maintain a separate test site for evaluating plugins. It is a good idea to slowly roll out new plugins to your production site even after they pass your evaluation on your test site. This enables you to isolate problems introduced by a new plugin.
  38. Types of plugins
  39. ================
  40. Themes
  41. ------
  42. Themes are plugins that modify the look-and-feel of your site. They generally
  43. include stylesheets, client-side scripts and views that alter the default
  44. presentation and behavior of Elgg.
  45. Language Packs
  46. --------------
  47. Language packs are plugins that provide support for other languages.
  48. Language packs can extend and include translations for language strings
  49. found in the core, core plugins and/or third-party plugins.
  50. Some of the language packs are already included in the core, and can be found in
  51. ``languages`` directory off Elgg's root directory. Individual plugins tend to
  52. include their translations under the ``languages`` directory within the plugin's
  53. root.
  54. This structure makes it easy to create new language packs that supercede existing
  55. language strings or add support for new languages.
  56. Installation
  57. ============
  58. All plugins reside in the ``mod`` directory of your Elgg installation.
  59. To install a new plugin:
  60. * extract (unzip) contents of the plugin distribution package
  61. * copy/FTP the extracted folder into the ``mod`` directory of your Elgg
  62. installation, making sure that ``manifest.xml`` and ``start.php`` are
  63. directly under the plugin directory (e.g. if you were to install a plugin called
  64. ``my_elgg_plugin``, plugin's manifest would need to be found at
  65. ``mod/my_elgg_plugin/manifest.xml``)
  66. * activate the plugin from your admin panel
  67. To activate a plugin:
  68. * Log in to your Elgg site with your administrator account
  69. * Go to Administration -> Configure -> Plugins
  70. * Find your plugin in the list of installed plugins and click on the
  71. 'enable' button.
  72. .. _admin/plugins#plugin-order:
  73. Plugin order
  74. ============
  75. Plugins are loaded according to the order they are listed on the Plugins page. The initial ordering after an install is more or less random. As more plugins are added by an administrator, they are placed at the bottom of the list.
  76. Some general rules for ordering plugins:
  77. - A theme plugin should be last or at least near the bottom
  78. - A plugin that modifies the behavior of another plugin should be lower in the plugin list
  79. Pre-1.8 notes
  80. =============
  81. In Elgg 1.7 and below, the interface for managing installed plugins is located at
  82. Administration -> Tool Administration.