help vocabulary
Factor handbook » Vocabulary index

Documentation
Help system

Metadata

Authors:

Slava Pestov

Words

Generic words

Word	Stack effect
word-help*	( word -- content )

Symbol words

help-hook

Ordinary words

Word	Stack effect
$about	( element -- )
$index	( element -- )
$predicate	( element -- )
$title	( topic -- )
($index)	( articles -- )
($navigation-link)	( content element label -- )
($navigation-links)	( topic -- )
($navigation-path)	( topic -- )
($navigation-table)	( element -- )
($title)	( topic -- )
(:help)	( error -- )
:help	( -- )
:help-debugger	( -- )
add-article	( article name -- )
all-articles	( -- seq )
all-errors	( -- seq )
effect-help	( effect -- content )
error?	( word -- ? )
help	( topic -- )
orphan-articles	( -- seq )
print-topic	( topic -- )
remove-article	( name -- )
remove-word-help	( word -- )
set-word-help	( content word -- )
sort-articles	( seq -- newseq )
word-help	( word -- content )
xref-help	( -- )

Files

resource:basis/help/help.factor
resource:basis/help/help-docs.factor
resource:basis/help/help-tests.factor

Metadata files

resource:basis/help/authors.txt
resource:basis/help/summary.txt

Children from resource:basis

Vocabulary	Summary
help.apropos
help.cookbook
help.crossref	Help article cross-referencing
help.definitions	Help article definition protocol implementation
help.handbook	Factor developer's handbook
help.home
help.html	Converting help to HTML
help.lint	Help lint tool
help.markup	Help markup language
help.search	Search within help articles
help.stylesheet	Default help stylesheet
help.syntax	Parsing words for defining help articles
help.tips
help.topics	Help topic management
help.tour	A tour of factor's most prominent features
help.tutorial
help.vocabs	Browsing vocabularies

Children from resource:extra

Vocabulary	Summary
help.lint	Help lint tool
help.pdf