Home A - Z
Menu

An Otter Wiki

Commit 37b166

2026-08-30 20:08:01 Ralph Thesen: Link the plugins page from the home page
home.md ..
@@ 17,7 17,7 @@
- (experimental) Embeddings: [AttachmentList](/Examples/AttachmentList), [DataTable](/Examples/DataTable), [Figure](/Examples/Figure), [ImageFrame](/Examples/ImageFrame), [Include](/Examples/Include), [InfoBox](/Examples/InfoBox), [PageIndex](/Examples/PageIndex) and [Video](/Examples/Video%20Attachment).
- Customizable Sidebar: Create a menu and/or display a page index
- (experimental) Repository management: Git Web Server, automatic pushes & pulls to/from a remote
- - (experimental) Plugin support
+ - (experimental) [Plugin support](/Plugins): extend the wiki through hooks
- A very cute Otter as logo (drawn and released by [Christy Presler](https://christypresler.com/) under CC BY 3.0)
### Try It Out
plugins.md ..
@@ 11,6 11,22 @@
> plugin and cannot find a matching hook, please open an
> [issue](https://github.com/redimp/otterwiki/issues).
+ ## Example plugins
+
+ Same example plugins live in
+ [docs/plugin_examples](https://github.com/redimp/otterwiki/tree/main/docs/plugin_examples)
+ in the source repository. Each is a self-contained package you can copy as a
+ starting point, and they come with a `docker-compose.yaml` for trying them out
+ and a test suite.
+
+ - [noemojis](https://github.com/redimp/otterwiki/tree/main/docs/plugin_examples/plugin_noemojis) removes all emojis from pages.
+ - [htmlinjection](https://github.com/redimp/otterwiki/tree/main/docs/plugin_examples/plugin_htmlinjection) demonstrates the HTML injection and per-element rendering hooks.
+ - [referencingpages](https://github.com/redimp/otterwiki/tree/main/docs/plugin_examples/plugin_referencingpages) shows which pages reference the current page via WikiLinks.
+ - [sidebarpageindex](https://github.com/redimp/otterwiki/tree/main/docs/plugin_examples/plugin_sidebarpageindex) demonstrates the sidebar page index filter and sort hooks.
+ - [authorsignature](https://github.com/redimp/otterwiki/tree/main/docs/plugin_examples/plugin_authorsignature) adds a footer with the original author and last editor.
+ - [redlinks](https://github.com/redimp/otterwiki/tree/main/docs/plugin_examples/plugin_redlinks) marks WikiLinks to non-existent pages in red, like MediaWiki's redlinks.
+
+
## What a plugin is
A plugin is a normal, pip-installable Python package that registers one or more
@@ 160,18 176,3 @@
- `sidebar_page_index_filter_entries(entries, mode)` filters the sidebar page index entries in place.
- `sidebar_page_index_sort_entries(entries, mode)` sorts the sidebar page index entries in place.
-
- ## Example plugins
-
- Six worked examples live in
- [docs/plugin_examples](https://github.com/redimp/otterwiki/tree/main/docs/plugin_examples)
- in the source repository. Each is a self-contained package you can copy as a
- starting point, and they come with a `docker-compose.yaml` for trying them out
- and a test suite.
-
- - [noemojis](https://github.com/redimp/otterwiki/tree/main/docs/plugin_examples/plugin_noemojis) removes all emojis from pages.
- - [htmlinjection](https://github.com/redimp/otterwiki/tree/main/docs/plugin_examples/plugin_htmlinjection) demonstrates the HTML injection and per-element rendering hooks.
- - [referencingpages](https://github.com/redimp/otterwiki/tree/main/docs/plugin_examples/plugin_referencingpages) shows which pages reference the current page via WikiLinks.
- - [sidebarpageindex](https://github.com/redimp/otterwiki/tree/main/docs/plugin_examples/plugin_sidebarpageindex) demonstrates the sidebar page index filter and sort hooks.
- - [authorsignature](https://github.com/redimp/otterwiki/tree/main/docs/plugin_examples/plugin_authorsignature) adds a footer with the original author and last editor.
- - [redlinks](https://github.com/redimp/otterwiki/tree/main/docs/plugin_examples/plugin_redlinks) marks WikiLinks to non-existent pages in red, like MediaWiki's redlinks.
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9