HELP{

Vocabulary

help.syntax

Syntax

HELP{ help-markup }

Word description

Generates help markup using syntax that does not require literal strings. Has some known problems with syntax words, which need to be quoted inside the HELP{ } definition.

Examples

HELP{ I am a doc string. This is a second paragraph. { $snippet "code snippet" } }

generates

{ "I am a doc string." $nl "This is a second paragraph." { $snippet "code snippet" } }

Definition

USING: arrays combinators help.syntax.private kernel parser
sequences ;

IN: help.syntax

SYNTAX: HELP{
    scan-object dup \ } eq?
    [ drop { } ] [
        {
            { [ dup help-text? ] [ \ } parse-help-text ] }
            { [ dup help-code? ] [ parse-help-code ] }
            { [ dup help-values? ] [ parse-help-values ] }
            { [ dup help-examples? ] [ parse-help-examples ] }
            [ \ } parse-until >array ]
        } cond swap prefix
    ] if suffix! ;