factor/library/help/help.factor

58 lines
1.2 KiB
Factor

! Copyright (C) 2005, 2006 Slava Pestov.
! See http://factorcode.org/license.txt for BSD license.
IN: help
USING: arrays hashtables io kernel namespaces strings ;
! Markup
GENERIC: print-element
! Help articles
SYMBOL: articles
TUPLE: article title content ;
: article ( name -- article ) articles get hash ;
: add-article ( name title element -- )
<article> swap articles get set-hash ;
M: string article-title article article-title ;
M: string article-content article article-content ;
! Special case: f help
M: f article-title drop \ f article-title ;
M: f article-content drop \ f article-content ;
! Glossary of terms
SYMBOL: terms
TUPLE: term entry ;
M: term article-title term-entry ;
M: term article-content
term-entry terms get hash
[ "No such glossary entry" ] unless* ;
: add-term ( term element -- ) swap terms get set-hash ;
SYMBOL: last-block
: (help) ( topic -- )
default-style [
last-block on article-content print-element
] with-nesting* terpri ;
DEFER: $heading
: help ( topic -- )
default-style [ dup article-title $heading ] with-style
(help) ;
: glossary ( name -- ) <term> help ;
: handbook ( -- ) "handbook" help ;
: tutorial ( -- ) "tutorial" help ;