Websites
/
lektor-website
mirror of https://github.com/lektor/lektor-website.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Link to plugin events from plugin dev guide

This commit is contained in:
Armin Ronacher 2015-12-26 21:41:30 +01:00
parent 59a4ab50b9
commit c97c98935d
1 changed files with 12 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
content/docs/plugins/dev/contents.lr
View File

@ -122,8 +122,8 @@ hello-world: Hello World
Plugins in Lektor are based on the concept of hooking events. There are many Plugins in Lektor are based on the concept of hooking events. There are many
events that can be hooked but we will only cover a very basic one here, events that can be hooked but we will only cover a very basic one here,
the `process_template_context` event. To respond to it, we need to implement the `setup-env` event. To respond to it, we need to implement
a function named `on_process_template_context`: a function named `on_setup_env`:
```python ```python
import random import random
@ -141,18 +141,25 @@ class HelloWorldPlugin(Plugin):
name = 'Hello World' name = 'Hello World'
description = 'This is a demo plugin for testing purposes.' description = 'This is a demo plugin for testing purposes.'
def on_process_template_context(self, context, **extra): def on_setup_env(self, **extra):
context['get_random_message'] = get_random_message self.env.jinja_env.globals.update(
get_random_message=get_random_message
)
``` ```
This will inject a function with the name `get_random_message` into our This will inject a function with the name `get_random_message` into our
template context whenever a template is rendered. This means that we template globals when the environment is initialized. This means that we
can access this function from templates then: can access this function from templates then:
```html+jinja ```html+jinja
<p>Message of the page: {{ get_random_message() }} <p>Message of the page: {{ get_random_message() }}
``` ```
There are many events that can be hooked and they can be found in the
[Event Documentation :ref](../../api/plugins/events/). All events need
to be subscribed with an extra `**extra` argument to catch down additional
arguments that might be supplied in the future.
## What Plugins Can Do ## What Plugins Can Do
To understand what you can do with plugins have a look at the To understand what you can do with plugins have a look at the