Paul: Proposed guidelines for articles on callbacks.

2011-01-17T17:09:56Z

Proposed guidelines for articles on callbacks.

New page

Suggested guidelines to document callbacks:

* Have an article for each callback, with a minimal example.

* Let a page's title be the name of the callback it describes, so it is automatically linked to this page, meant as a general introduction. If the page title differs, change the link here from <pre>[[callback_name]]</pre> to <pre>[[page_title|callback_name]]</pre>

* Link all pages on callbacks to this general introduction, which should gather general information about callbacks (e.g. no need to reexplain <tt>callback.register()</tt> on each page).

* Make code low-level, which means: no format-specific tricks, and nothing but <tt>callback.register()</tt> (we can redirect to the general introduction for discussion about the limitations of <tt>callback.register()</tt>). Basically, this means avoiding things like <tt>\documentclass{article}</tt> or even plain TeX's <tt>\bye</tt>. The code should be pure Lua and pure TeX (probably we can allow allocation macros like \newif and \newbox, though, since they are common to all formats), so the reader can simply paste it and process it as s/he prefers.

* Commented code is better than pure code, although pure code is better than no code.

Talk:Callbacks - Revision history

Paul: Proposed guidelines for articles on callbacks.