diff --git a/doc/Events.md b/doc/Events.md new file mode 100644 index 000000000..c0cfe60c3 --- /dev/null +++ b/doc/Events.md @@ -0,0 +1,10 @@ +Builtin Events +============== + +Reader Events +------------- + +* UpdatePos: emitted by typesetting related modules to notify other modules to +recalculate the view based on the new typesetting. + +* PosUpdate: emitted by readerrolling module to signal a change in pos. diff --git a/doc/config.ld b/doc/config.ld index 9fa5fd846..c78c36fa1 100644 --- a/doc/config.ld +++ b/doc/config.ld @@ -5,7 +5,7 @@ title = 'KOReader Documentation' dir = 'html' style = '!fixed' use_markdown_titles = true -topics = {'../README.md', './Hacking.md'} +topics = {'../README.md', './Hacking.md', './Events.md'} package = '' format = 'markdown' sort_modules = true