Handbook
Glossary
Help system implementation
Factor handbook
»
Developer tools
»
Help system
Prev:
Tips of the day
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 )
word-help*
( word -- content )
Help article implementation:
lookup-article
( name -- article )
articles
Links:
link
>link
( obj -- obj )
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
.