link
Factor handbook » Developer tools » Help system » Help system implementation

Prev:	articles
Next:	>link ( obj -- obj )

Vocabulary
help.topics

Class description
Class of help article presentations. Instances can be passed to write-object to output a clickable hyperlink. Also, instances of this class are valid definition specifiers; see Definitions.

Definition

IN: help.topics

TUPLE: link name ;

Methods

USING: help.topics ;

M: link >link ;


USING: help.home help.topics ;

M: link add-recent-where recent-articles ;


USING: accessors help.topics ;

M: link article-content name>> article-content ;


USING: accessors help.topics ;

M: link article-parent name>> article-parent ;


USING: accessors help.topics ;

M: link article-title name>> article-title ;


USING: definitions help.syntax help.topics kernel ;

M: link definer drop \ ARTICLE: \ ; ;


USING: definitions help.topics ;

M: link definition article-content ;


USING: accessors definitions help help.topics ;

M: link forget* name>> remove-article ;


USING: accessors help.topics ;

M: link set-article-parent name>> set-article-parent ;


USING: accessors definitions help.topics ;

M: link set-where name>> lookup-article loc<< ;


USING: accessors help.topics kernel make prettyprint summary
words ;

M: link summary
    [
        "Link: " % name>> dup word?
        [ summary ] [ unparse-short ] if %
    ] "" make ;


USING: accessors help.topics kernel prettyprint.custom see ;

M: link synopsis*
    dup definer. dup name>> pprint* article-title pprint* ;


USING: accessors help.html help.topics kernel ;

M: link topic>filename*
    name>> dup [ "article" ] [ topic>filename* ] if ;


USING: help.crossref help.markup help.topics kernel sequences
tools.crossref vocabs ;

M: link uses
    [
        { $subsection $subsections $link $see-also }
        article-links [ >link ] map
    ] [ { $vocab-link } article-links [ >vocab-link ] map ] bi
    append ;


USING: accessors help.topics ;

M: link valid-article? name>> valid-article? ;


USING: accessors definitions help.topics ;

M: link where name>> lookup-article loc>> ;