Elgg Documentation Version 1.9 Various déc. 07, 2020 Table des matières 1 Getting Started 3 1.1 Features..................................................3 1.2 Bundled plugins.............................................4 1.3 License..................................................9 1.4 Installation................................................ 10 1.5 Developer Overview........................................... 18 2 Administrator Guides 21 2.1 Getting Started.............................................. 21 2.2 Upgrading Elgg............................................. 22 2.3 Plugins.................................................. 24 2.4 Performance............................................... 27 2.5 Cron................................................... 31 2.6 Backup and Restore........................................... 32 2.7 Getting Help............................................... 45 3 Developer Guides 49 3.1 Don’t Modify Core............................................ 49 3.2 Plugins.................................................. 50 3.3 Plugin coding guidelines......................................... 62 3.4 Accessibility Guidelines......................................... 64 3.5 Helper functions............................................. 65 3.6 Forms + Actions............................................. 67 3.7 Database................................................. 73 3.8 Internationalization............................................ 79 3.9 Menus.................................................. 80 3.10 Notifications............................................... 84 3.11 River................................................... 88 3.12 Page handler............................................... 90 3.13 Routing.................................................. 90 3.14 Page ownership.............................................. 90 3.15 Gatekeeper................................................ 91 3.16 Widgets.................................................. 92 3.17 Views................................................... 96 3.18 Context.................................................. 103 3.19 Themes.................................................. 104 3.20 JavaScript................................................. 106 i 3.21 Plugin settings.............................................. 112 3.22 Permissions Check............................................ 114 3.23 Authentication.............................................. 116 3.24 Walled Garden.............................................. 117 3.25 Web services............................................... 117 3.26 Upgrading Plugins............................................ 122 3.27 List of events in core........................................... 132 3.28 List of plugin hooks in core....................................... 134 4 Plugin Tutorials 141 4.1 Hello world................................................ 141 4.2 Customizing the Home Page....................................... 143 4.3 Building a Blog Plugin.......................................... 144 4.4 Integrating a Rich Text Editor...................................... 149 4.5 Basic Widget............................................... 151 5 Design Docs 155 5.1 Actions.................................................. 155 5.2 Database................................................. 156 5.3 Events and Plugin Hooks......................................... 170 5.4 Internationalization............................................ 174 5.5 AMD................................................... 174 5.6 Security.................................................. 175 5.7 Loggable................................................. 178 6 Contributor Guides 179 6.1 Translations............................................... 179 6.2 Reporting Issues............................................. 179 6.3 Writing Code............................................... 180 6.4 Writing Documentation......................................... 190 6.5 Internationalizing documentation.................................... 193 6.6 Becoming a Financial Supporter..................................... 193 6.7 Release Process Workflow........................................ 194 7 Appendix 197 7.1 FAQs and Other Troubleshooting.................................... 197 7.2 Roadmap................................................. 226 7.3 Release Policy.............................................. 227 7.4 Support policy.............................................. 228 7.5 History.................................................. 228 ii Elgg Documentation, Version 1.9 Elgg( pronunciation) est un environnement de développement intégrant des fonctionnalités sociales. Ce frame- work est idéal pour construire des applications dans lesquelles les utilisateurs s’identifient et partagent des informa- tions. Elgg a été utilisé pour construire tous types d’applications sociales: — réseau sociaux ouverts (similaires à Facebook) — thématiques (comme la communauté Elgg) — intranets privés / RSE — rencontres — éducatifs — blog d’entreprise Is existe également un site de démonstration qui permet de tester une installation Elgg standard Ceci constitue la documentation officielle du projet Elgg. Table des matières 1 Elgg Documentation, Version 1.9 2 Table des matières CHAPITRE 1 Getting Started Discover if Elgg is right for your community. 1.1 Features Demo : http://demo.elgg.org/ Showcases : https://community.elgg.org/showcase 1.1.1 For developers — Permissive license — Theme framework — Internationalization — Templating engine — Widgets framework — Plugin APIs — Social graph — Web services API — jQuery-based JS framework — Session management — Custom URL routing 3 Elgg Documentation, Version 1.9 1.1.2 For admins — User profiles and avatars — Fine-grained access control lists — Friends and friends lists (ala G+ circles) — Responsive, mobile-friendly design — RSS support — Activity stream — Plugins for common content types like blogs, bookmarks, files, microblogging, private messages, documents, message boards, discussion — User authentication and administration If you need more functionality than what Elgg offers out-of-the-box there are a couple of options : — Add more by installing plugins - for example, blogs, forums, social bookmarks — Develop your own features via plugins — Hire someone to do the above for you 1.2 Bundled plugins Elgg comes with a set of plugins. These provide the basic functionality for your social network. 1.2.1 Blog A weblog, or blog, is arguably one of the fundamental DNA pieces of most types of social networking site. The simplest form of personal publishing, it allows for text-based notes to be published in reverse-chronological order. Commenting is also an important part of blogging, turning an individual act of publishing into a conversation. Elgg’s blog expands this model by providing per-entry access controls and cross-blog tagging. You can control exactly who can see each individual entry, as well as find other entries that people have written on similar topics. You can also see entries written by your friends (that you have access to). Voir aussi : Blogging on Wikipedia 1.2.2 Dashboard The dashboard is bundled with both the full and core-only Elgg packages. This is a users portal to activity that is important to them both from within the site and from external sources. Using Elgg’s powerful widget API, it is possible to build widgets that pull out relevant content from within an Elgg powered site as well as grab information from third party sources such as Twitter or Flickr (providing those widgets exist). A users dashboard is not the same as their profile, whereas the profile is for consumption by others, the dashboard is a space for users to use for their own needs. Fig. 1 – An typical Elgg dash- board 4 Chapitre 1. Getting Started Elgg Documentation, Version 1.9 1.2.3 Diagnostics For the technically savvy user, system diagnostics enables you to quickly evaluate the server environment, Elgg code, and plugins of an Elgg install. System diag- nostics is a core plugin that comes turned on by default with Elgg. To download the diagnostics file, follow the steps below. The file is a dump of all sorts of useful information. To use : — Log in as Administrator — Go to Administration -> Administer -> Utilities ->System diagnostics — Click “Download” System diagnostics dump file contents : — List of all Elgg files along with a hash for each file — List of all the plugins — PHP superglobals — PHP settings — Apache settings — Elgg CONFIG values — language strings — site settings — database settings — plugin hooks — actions — views — page handlers — much more 1.2.4 File repository The file repository allows users to upload any kind of file. As with everything in an Elgg system, you can filter uploaded files by tag and restrict access so that they’re only visible by the people you want them to be. Each file may also have comments attached to it. There are a number of different uses for this functionality Photo gallery When a user uploads photographs or other pictures, they are automatically col- lated into an Elgg photo gallery that can be browsed through. Users can also see Fig. 2 – A file in an Elgg file repo- pictures that their friends have uploaded, or see pictures attached to a group. Cli- sitory cking into an individual file shows a larger version of the photo. 1.2. Bundled plugins 5 Elgg Documentation, Version 1.9 Podcasting An Elgg file repository RSS feed automatically doubles as an RSS feed, so you can subscribe to new