126 lines
4.1 KiB
Factor
126 lines
4.1 KiB
Factor
! Copyright (C) 2009 Jose Antonio Ortega Ruiz.
|
|
! See http://factorcode.org/license.txt for BSD license.
|
|
USING: accessors arrays assocs combinators
|
|
combinators.short-circuit fry help help.crossref help.markup
|
|
help.markup.private help.topics help.vocabs io io.streams.string
|
|
kernel listener make namespaces parser prettyprint see sequences
|
|
summary vocabs vocabs.hierarchy vocabs.metadata vocabs.parser
|
|
words ;
|
|
IN: fuel.help
|
|
|
|
<PRIVATE
|
|
|
|
: fuel-find-word ( name -- word/f )
|
|
{ [ search ] [ '[ name>> _ = ] all-words swap find nip ] } 1|| ;
|
|
|
|
: fuel-value-str ( word -- str )
|
|
[ pprint-short ] with-string-writer ; inline
|
|
|
|
: fuel-definition-str ( word -- str )
|
|
[ see ] with-string-writer ; inline
|
|
|
|
: fuel-methods-str ( word -- str )
|
|
methods [ f ] [
|
|
[ [ see nl ] each ] with-string-writer
|
|
] if-empty ; inline
|
|
|
|
: fuel-related-words ( word -- seq )
|
|
dup "related" word-prop remove ; inline
|
|
|
|
: fuel-parent-topics ( word -- seq )
|
|
help-path [ dup article-title swap 2array ] map ; inline
|
|
|
|
SYMBOLS: $doc-path $next-link $prev-link ;
|
|
|
|
: next/prev-link ( link link-symbol -- 3arr )
|
|
swap [ name>> ] [ [ link-long-text ] with-string-writer ] bi 3array ;
|
|
|
|
: (fuel-word-element) ( word -- element )
|
|
\ article swap dup article-title swap
|
|
[
|
|
{
|
|
[ \ $vocabulary swap vocabulary>> 2array , ]
|
|
[
|
|
>link
|
|
[ prev-article [ \ $prev-link next/prev-link , ] when* ]
|
|
[ next-article [ \ $next-link next/prev-link , ] when* ] bi
|
|
]
|
|
[ fuel-parent-topics [ \ $doc-path prefix , ] unless-empty ]
|
|
[ word-help % ]
|
|
[ fuel-related-words [ \ $related swap 2array , ] unless-empty ]
|
|
[ get-global [ \ $value swap fuel-value-str 2array , ] when* ]
|
|
[ \ $definition swap fuel-definition-str 2array , ]
|
|
[ fuel-methods-str [ \ $methods swap 2array , ] when* ]
|
|
} cleave
|
|
] { } make 3array ;
|
|
|
|
: fuel-vocab-help-row ( vocab -- element )
|
|
[ vocab-name ] [ summary ] bi 2array ;
|
|
|
|
: fuel-vocab-help-root-heading ( root -- element )
|
|
[ "Children from " prepend ] [ "Other children" ] if* \ $heading swap 2array ;
|
|
|
|
SYMBOL: vocab-list
|
|
SYMBOL: describe-words
|
|
|
|
: fuel-vocab-help-table ( vocabs -- element )
|
|
[ fuel-vocab-help-row ] map vocab-list prefix ;
|
|
|
|
: fuel-vocab-list ( assoc -- seq )
|
|
[
|
|
[ drop f ] [
|
|
[ fuel-vocab-help-root-heading ]
|
|
[ fuel-vocab-help-table ] bi*
|
|
[ 2array ] [ drop f ] if*
|
|
] if-empty
|
|
] { } assoc>map sift ;
|
|
|
|
: fuel-vocab-children-help ( name -- element )
|
|
disk-vocabs-for-prefix fuel-vocab-list ; inline
|
|
|
|
: fuel-vocab-describe-words ( name -- element )
|
|
[ words. ] with-string-writer \ describe-words swap 2array ; inline
|
|
|
|
: (fuel-vocab-element) ( name -- element )
|
|
dup require \ article swap dup >vocab-link
|
|
[
|
|
{
|
|
[ 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>> fuel-vocab-describe-words , ]
|
|
[ name>> fuel-vocab-children-help % ]
|
|
} cleave
|
|
] { } make 3array ;
|
|
|
|
PRIVATE>
|
|
|
|
: (fuel-word-help) ( name -- elem/f )
|
|
fuel-find-word [
|
|
[ auto-use? on (fuel-word-element) ] with-scope
|
|
] [ f ] if* ;
|
|
|
|
: (fuel-word-synopsis) ( name -- str/f )
|
|
fuel-find-word [ synopsis ] [ f ] if* ;
|
|
|
|
: (fuel-word-def) ( name -- str )
|
|
fuel-find-word [ [ def>> pprint ] with-string-writer ] [ f ] if* ; inline
|
|
|
|
: (fuel-vocab-summary) ( name -- str ) >vocab-link summary ; inline
|
|
|
|
: (fuel-vocab-help) ( name -- str )
|
|
dup empty? [ fuel-vocab-children-help ] [ (fuel-vocab-element) ] if ;
|
|
|
|
: (fuel-get-vocabs/author) ( author -- element )
|
|
[ "Vocabularies by " prepend \ $heading swap 2array ]
|
|
[ authored fuel-vocab-list ] bi 2array ;
|
|
|
|
: (fuel-get-vocabs/tag) ( tag -- element )
|
|
[ "Vocabularies tagged " prepend \ $heading swap 2array ]
|
|
[ tagged fuel-vocab-list ] bi 2array ;
|
|
|
|
: format-index ( seq -- seq )
|
|
[ [ >link name>> ] [ article-title ] bi 2array \ $subsection prefix ] map ;
|