sbrl-github/Pepperminty-Wiki
sbrl-github/Pepperminty-Wiki
1
0
Fork 0
mirror of https://github.com/sbrl/Pepperminty-Wiki.git synced 2024-11-22 04:23:01 +00:00
Code Activity

Document register_save_preprocessor() in the api docs. Fixes #50.

Browse source
This commit is contained in:
Starbeamrainbowlabs 2016-03-12 18:46:55 +00:00
parent dbe9a97efa
commit 87d372c400
1 changed files with 9 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
Module_API_Docs.md
View file

@ -120,6 +120,15 @@ register_module([
The above adds an action called `action_name`, which, when requested, outputs the text `Hello, World!`. The above adds an action called `action_name`, which, when requested, outputs the text `Hello, World!`.
### `register_save_preprocessor($function)`
Registers a function to be called every time a page is edited. The function will be passed the following parameters:
1. A reference to the pageindex entry that is about to be saved.
2. The new text that is to replace the old text.
3. The old text that the new text is going to replace.
If you make the function that you pass here take the new text that is to be saved in as a reference, you may alter it before it is saved to disk.
### `page_renderer` ### `page_renderer`
You probably want your module to output a nice user-friendly page instead of a simple text-based one. Luckily, Pepperminty Wiki has a system to let you do that. You probably want your module to output a nice user-friendly page instead of a simple text-based one. Luckily, Pepperminty Wiki has a system to let you do that.