steve
/
factor
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

print out doc links after listing words

db4
Doug Coleman 2008-09-04 02:03:04 -05:00
parent 27b97b0172
commit 1f431b305f
1 changed files with 14 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
basis/tools/scaffold/scaffold.factor
View File

@ -146,16 +146,14 @@ ERROR: no-vocab vocab ;
: help-header. ( word -- ) : help-header. ( word -- )
"HELP: " write name>> print ; "HELP: " write name>> print ;
PRIVATE>
: help. ( word -- ) : (help.) ( word -- )
[ help-header. ] [ $values. ] [ $description. ] tri ; [ help-header. ] [ $values. ] [ $description. ] tri ;
<PRIVATE
: help-file-string ( str1 -- str2 ) : help-file-string ( str1 -- str2 )
[ [
[ "IN: " write print nl ] [ "IN: " write print nl ]
[ words natural-sort [ help. nl ] each ] [ words natural-sort [ (help.) nl ] each ]
[ "ARTICLE: " write unparse dup write bl print ";" print nl ] [ "ARTICLE: " write unparse dup write bl print ";" print nl ]
[ "ABOUT: " write unparse print ] quad [ "ABOUT: " write unparse print ] quad
] with-string-writer ; ] with-string-writer ;
@ -189,6 +187,15 @@ PRIVATE>
dup find-vocab-root [ no-vocab ] unless ; dup find-vocab-root [ no-vocab ] unless ;
PRIVATE> PRIVATE>
: link-vocab ( vocab -- )
check-vocab
"Edit documentation: " write
[ find-vocab-root ] keep
[ append-path ] keep "-docs.factor" append append-path
<pathname> . ;
: help. ( word -- )
[ (help.) ] [ nl vocabulary>> link-vocab ] bi ;
: scaffold-help ( vocab-root string -- ) : scaffold-help ( vocab-root string -- )
[ [
@ -199,9 +206,10 @@ PRIVATE>
] with-scaffold ; ] with-scaffold ;
: scaffold-undocumented ( string -- ) : scaffold-undocumented ( string -- )
words dup words
[ [ "help" word-prop ] [ predicate? ] bi or not ] filter [ [ "help" word-prop ] [ predicate? ] bi or not ] filter
natural-sort [ help. nl ] each ; natural-sort [ (help.) nl ] each
link-vocab ;
: scaffold-vocab ( vocab-root string -- ) : scaffold-vocab ( vocab-root string -- )
prepare-scaffold prepare-scaffold