article-title ( topic -- string )
Factor handbook » Developer tools » Help system » Help system implementation

Prev:	article-name ( topic -- string )
Next:	article-content ( topic -- content )

Vocabulary
help.topics

Inputs

topic

an article name or a word

Outputs

string

a string

Word description
Outputs the title of a specific help article.

Definition

IN: help.topics

GENERIC: article-title ( topic -- string )

Methods

USING: accessors help.apropos help.topics sequences ;

M: apropos-search article-title
    text>> "Search results for \"" "\"" surround ;


USING: accessors help.topics ;

M: article article-title title>> ;


USING: help.topics kernel ;

M: f article-title drop \ f article-title ;


USING: accessors help.topics ;

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


USING: accessors help.apropos help.topics kernel make
math.parser sequences ;

M: more-completions article-title
    [
        "All " %
        [ seq>> length # " " % ] [ category>> category>name % ]
        [ " results for \"" % search>> % "\"" % ] tri
    ] "" make ;


USING: help.topics kernel ;

M: object article-title lookup-article article-title ;


USING: accessors help.topics help.vocabs sequences ;

M: vocab-author article-title
    name>> "Vocabularies by " prepend ;


USING: help.topics sequences vocabs ;

M: vocab-spec article-title vocab-name " vocabulary" append ;


USING: accessors help.topics help.vocabs sequences ;

M: vocab-tag article-title
    name>> "Vocabularies tagged \"" "\"" surround ;


USING: accessors effects help.topics kernel prettyprint
sequences words words.symbol ;

M: word article-title
    dup [ parsing-word? ] [ symbol? ] bi or
    [ name>> ] [
        [ unparse ] [
            stack-effect
            [ effect>string " " prepend ] [ "" ] if*
        ] bi append
    ] if ;