From e60f8de676a5d0830778bcda61e83650fc5fa7f0 Mon Sep 17 00:00:00 2001 From: Marcel Klehr Date: Sun, 23 Dec 2012 22:48:28 +0100 Subject: [PATCH] Expand plugin system docs with l10n info --- doc/plugins.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/doc/plugins.md b/doc/plugins.md index 3717c111..afa01316 100644 --- a/doc/plugins.md +++ b/doc/plugins.md @@ -11,12 +11,13 @@ A basic plugin usually has the following folder structure: ep_/ | static/ | templates/ + | locales/ + ep.json + package.json ``` -If your plugin includes client-side hooks, put them in `static/js/`. If you're adding in CSS or image files, you should put those files in `static/css/ `and `static/image/`, respectively, and templates go into `templates/`. +If your plugin includes client-side hooks, put them in `static/js/`. If you're adding in CSS or image files, you should put those files in `static/css/ `and `static/image/`, respectively, and templates go into `templates/`. Translations go into `locales/` -A Standard directory structure like this makes it easier to navigate through your code. That said, do note, that this is not actually *required* to make your plugin run. +A Standard directory structure like this makes it easier to navigate through your code. That said, do note, that this is not actually *required* to make your plugin run. If you want to make use of our i18n system, you need to put your translations into `locales/`, though, in order to have them intergated. (See "Localization" for more info on how to localize your plugin) ## Plugin definition Your plugin definition goes into `ep.json`. In this file you register your hooks, indicate the parts of your plugin and the order of execution. (A documentation of all available events to hook into can be found in chapter [hooks](#all_hooks).)