help.topics vocabulary - Factor Documentation (original) (raw)

help.topics vocabulary
Factor handbook » Vocabulary index

Summary
Help topic management

Metadata

Words

Tuple classes

Class	Superclass	Slots
article	tuple	title content loc
link	tuple	name
no-article	tuple	name

Predicate classes

Class	Superclass
word-link	link

Mixin classes

topic

Generic words

Word	Stack effect
>link	( obj -- obj )
article-content	( topic -- content )
article-name	( topic -- string )
article-parent	( topic -- parent/f )
article-title	( topic -- string )
set-article-parent	( parent topic -- )
valid-article?	( topic -- ? )

Symbol words

article-xref
articles

Ordinary words

Word	Stack effect
	( title content -- article )
lookup-article	( name -- article )
no-article	( name -- * )

Class predicate words

Word	Stack effect
article?	( object -- ? )
link?	( object -- ? )
no-article?	( object -- ? )
topic?	( object -- ? )
word-link?	( object -- ? )

Files

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

Metadata files

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