vocab-element ( name -- element )

Vocabulary

fuel.help.private

Inputs

name

a string

Outputs

element

a sequence

Word description

Creates help markup for a vocab suitable for rendering with FUEL.

See also

article-element, word-element

Definition

USING: accessors arrays combinators fuel.help help.markup
help.topics help.vocabs kernel make sequences summary vocabs
vocabs.metadata ;

IN: fuel.help.private

: vocab-element ( name -- element )
    dup require \ article swap dup >vocab-link [
        {
            [
                name>> vocab-crumbs but-last \ $fuel-nav-crumbs
                prefix ,
            ]
            [ vocab-authors [ \ $authors prefix , ] when* ]
            [ vocab-tags [ \ $tags prefix , ] when* ]
            [
                summary
                [ { $heading "Summary" } swap 2array , ] when*
            ]
            [ drop \ $nl , ]
            [ vocab-help [ lookup-article content>> % ] when* ]
            [ name>> vocab-describe-words , ]
            [ name>> vocab-children-help % ]
        } cleave
    ] { } make 3array ;