Home Explore Help
Sign In
epsylon
/
Elgg-Lorea-Hydra
Watch 1
Star 0
Fork 0
Files Issues 0 Pull Requests 0
Branch: master
Branches Tags
Elgg-Lorea-H...
/
docs
/
plugins
/
profile.rst

profile.rst 2.1 KB
Permalink History Raw

1234567891011121314151617181920212223242526272829303132333435363738394041424344 
  1. Profile
    2. 

  2. =======
    3. 

  3. 

  4. .. figure:: images/profile.jpg
    5. 

  5.    :width: 180
    6. 

  6.    :align: right
    7. 

  7.    :alt: An Elgg profile
    8. 

  8.    
    9. 

  9.    An Elgg profile
    10. 

  10. 

  11. The profile plugin is bundled with both the full and core-only Elgg packages. The intention is that it can be disabled and replaced with another profile plugin if you wish.
    12. 

  12. It provides a number of pieces of functionality which many consider fundamental to the concept of a social networking site, and is unique within the plugins because the profile icon it defines is referenced as standard from all over the system.
    13. 

  13. 

  14. User details
    15. 

  15. ------------
    16. 

  16. 

  17. This provides information about a user, which is configurable from within the plugin's start.php file. You can change the available profile fields form the admin panel.
    18. 

  18. Each profile field has its own access restriction, so users can choose exactly who can see each individual element. Some of the fields contain tags (for example *skills*) limiting access to a field will also limit who can find you by that tag.
    19. 

  19. 

  20. User avatar
    21. 

  21. -----------
    22. 

  22. 

  23. .. figure:: images/user_hover_menu.jpg
    24. 

  24.    :width: 180
    25. 

  25.    :align: right
    26. 

  26.    :alt: The Elgg context menu
    27. 

  27.    
    28. 

  28.    The Elgg context menu
    29. 

  29. 

  30. The user avatar represents a user (or a group) throughout the site. By default, this includes a context-sensitive menu that allows you to perform actions on the user it belongs to wherever you see their avatar. For example, you can add them as a friend, send an internal message, and more. Each plugin can add to this context menu, so its full contents will vary depending on the functionality active in the current Elgg site.
    31. 

  31. 

  32. Notes for developers
    33. 

  33. --------------------
    34. 

  34. 

  35. Using a different profile icon
    36. 

  36.    To replace the profile icon, or provide more content, extend the ``icon/user/default`` view.
    37. 

  37. 

  38. Adding to the context menu
    39. 

  39.    The context menu can be expanded by registering a :ref:`plugin hook <design/events#plugin-hooks>` for 'register' 'menu:user_hover', the following sections have special meaning:
    40. 

  40. 

  41.    - **default** for non-active links (eg to read a blog)
    42. 

  42.    - **admin** for links accessible by administrators only
    43. 

  43. 

  44.    In each case, the user in question will be passed as ``$params['entity']``.
    45.