ARTICLE:
Factor handbook » Developer tools » Help system » Writing documentation

Next:

HELP:

Vocabulary
help.syntax

Syntax

ARTICLE: topic title content... ;

Inputs
None

Outputs
None

Word description
Defines a help article. String topic names are reserved for core documentation. Contributed modules should name articles by arrays, where the first element of an array identifies the module; for example, { "httpd" "intro" }.

Examples

USING: help help.syntax ; ARTICLE: "example" "An example article" "Hello world." ; "example" help

Definition

USING: compiler.units help help.syntax.private help.topics
kernel parser ;

IN: help.syntax

SYNTAX: ARTICLE:
    location [
        scan-object scan-object \ ; parse-help-text <article>
        over add-article >link
    ] dip remember-definition ;