Help system implementation - Factor Documentation (original) (raw)
Help topic protocol:
article-name ( topic -- string ) article-title ( topic -- string ) article-content ( topic -- content ) article-parent ( topic -- parent/f ) set-article-parent ( parent topic -- )
Boilerplate word help can be automatically generated (for example, slot accessor help):
word-help* ( word -- content )
lookup-article ( name -- article )
Utilities for traversing markup element trees:
elements ( elt-type element -- seq )
collect-elements ( element seq -- elements )
Links and article instances implement the definition protocol; refer to Definitions.