Editors' Notes markup renderer
A server to render Editors' Notes markup, with support for formatting citations from Zotero or CSL data.
Installing this package will create a binary called
Run it with
editorsnotes_renderer [--host=127.0.0.1] [--port=7194]
The server exposes a single root endpoint. It must be POSTed to with a JSON
object containing a
data key with text that will be parsed as Editors' Notes
One GET parameter is understood by the server, the
flag. If set, the response will be a JSON object containing
note keys containing arrays of the objects which would be
transcluded in a rendered note.
If this flag is not set, the response will be an HTML string representing the markup data rendered, with respect to the following POST parameters:
url_root(string): The root of all links to items (i.e. /projects/emma/)
note(arr): An array of Notes as represented in the Editors' Notes API. Notes'
titleattributes will be used to generate inline labels.
topic(arr): An array of Topics as represented in the Editors' Notes API. Topics'
preferred_nameattributes will be used to generate inline labels.
document(arr): An array of Documents as represented in the Editors' Notes API. Documents'
descriptionwill be used to generate inline labels or citations, in that order of preference.
citation_style(string): CSL style for formatted document citations. Default is
document items will determine the text that will be
transcluded into the rendered markup HTML. If a transcluded item has no matching
representation, the rendered HTML will include the message
([item type] not found).