-
Notifications
You must be signed in to change notification settings - Fork 0
Plugin API Hooks
This is a draft list of all current hooks into the API. MarkTraceur created this page mostly for his own reference, but hopefully it can be useful to others.
These hooks are called during or in order to set up the formatting process.
All of these methods are called with two arguments:
- name - the name of the hook being called
- context - an object with some relevant information about the context of the call
Called from: src/static/js/domline.js
Things in context:
- domline - The current DOM line being processed
- cls - The class of the current block element (useful for styling)
This hook is called for elements in the DOM that have the "lineMarkerAttribute" set. You can add elements into this category with the aceRegisterBlockElements hook above.
The return value of this hook should have the following structure:
{ preHtml: String, postHtml: String, processedMarker: Boolean }
The preHtml and postHtml values will be added to the HTML display of the element, and if processedMarker is true, the engine won't try to process it any more.
Called from: src/static/js/domline.js
Things in context:
- domline - the current DOM line being processed
- cls - The class of the current element (useful for styling)
This hook is called for any line being processed by the formatting engine, unless the aceDomLineProcessLineAttributes hook from above returned true, in which case this hook is skipped.
The return value of this hook should have the following structure:
{ extraOpenTags: String, extraCloseTags: String, cls: String }
extraOpenTags and extraCloseTags will be added before and after the element in question, and cls will be the new class of the element going forward.
Called from: src/static/js/domline.js
Things in context:
- node - the DOM node that just got written to the page
This hook is for right after a node has been fully formatted and written to the page.
Called from: src/static/js/linestylefilter.js
Things in context:
- linestylefilter - the JavaScript object that's currently processing the ace attributes
- key - the current attribute being processed
- value - the value of the attribute being processed
This hook is called during the attribute processing procedure, and should be used to translate key, value pairs into valid HTML classes that can be inserted into the DOM.
The return value for this function should be a list of classes, which will then be parsed into a valid class string.
Called from: src/static/js/linestylefilter.js
Things in context:
- linestylefilter - the JavaScript object that's currently processing the ace attributes
- browser - an object indicating which browser is accessing the page
This hook is called to apply custom regular expression filters to a set of styles. The one example available is the ep_linkify plugin, which adds internal links. They use it to find the telltale [[ ]] syntax that signifies internal links, and finding that syntax, they add in the internalHref attribute to be later used by the aceCreateDomLine hook (documented above).
Called from: src/static/js/ace.js
Things in context: None
This hook is provided to allow custom CSS files to be loaded. The return value should be an array of paths relative to the plugins directory.
Called from: src/static/js/ace.js
Things in context:
- iframeHTML - the HTML of the editor iframe up to this point, in array format
This hook is called during the creation of the editor HTML. The array should have lines of HTML added to it, giving the plugin author a chance to add in meta, script, link, and other tags that go into the <head> element of the editor HTML document.
Called from: src/static/js/ace2_inner.js
Things in context:
- callstack - a bunch of information about the current action
- editorInfo - information about the user who is making the change
- rep - information about where the change is being made
- documentAttributeManager - information about attributes in the document (this is a mystery to me)
This hook is made available to edit the edit events that might occur when changes are made. Currently you can change the editor information, some of the meanings of the edit, and so on. You can also make internal changes (internal to your plugin) that use the information provided by the edit event.
Called from: src/static/js/ace2_inner.js
Things in context: None
The return value of this hook will add elements into the "lineMarkerAttribute" category, making the aceDomLineProcessLineAttributes hook (documented below) call for those elements.
Called from: src/static/js/ace2_inner.js
Things in context:
- editorInfo - information about the user who will be making changes through the interface, and a way to insert functions into the main ace object (see ep_headings)
- rep - information about where the user's cursor is
- documentAttributeManager - some kind of magic
This hook is for inserting further information into the ace engine, for later use in formatting hooks.
These hooks are for other parts of the software on the client side, that is, when the editor is being used.
Called from: src/static/js/contentcollector.js
Things in context:
- cc - the contentcollector object
- state - the current state of the change being made
- tname - the tag name of this node currently being processed
- style - the style applied to the node (probably CSS)
- cls - the HTML class string of the node
This hook is called before the content of a node is collected by the usual methods. The cc object can be used to do a bunch of things that modify the content of the pad. See, for example, the heading1 plugin for etherpad original.
Called from: src/static/js/contentcollector.js
Things in context:
- cc - the contentcollector object
- state - the current state of the change being made
- tname - the tag name of this node currently being processed
- style - the style applied to the node (probably CSS)
- cls - the HTML class string of the node
This hook is called after the content of a node is collected by the usual methods. The cc object can be used to do a bunch of things that modify the content of the pad. See, for example, the heading1 plugin for etherpad original.