tools: more about/etc fixes
parent
1faeab2df7
commit
6570c082a9
|
@ -95,7 +95,7 @@ $nl
|
||||||
postpone\ HELP:
|
postpone\ HELP:
|
||||||
}
|
}
|
||||||
"A parsing word defines the main help article for a vocabulary:"
|
"A parsing word defines the main help article for a vocabulary:"
|
||||||
{ $subsections postpone\ about: }
|
{ $subsections \ ABOUT: }
|
||||||
"The " { $emphasis "content" } " in both cases is a " { $emphasis "markup element" } ", a recursive structure taking one of the following forms:"
|
"The " { $emphasis "content" } " in both cases is a " { $emphasis "markup element" } ", a recursive structure taking one of the following forms:"
|
||||||
{ $list
|
{ $list
|
||||||
{ "a string," }
|
{ "a string," }
|
||||||
|
@ -512,11 +512,11 @@ HELP: \ ARTICLE:
|
||||||
}
|
}
|
||||||
} ;
|
} ;
|
||||||
|
|
||||||
HELP: \ about:
|
HELP: \ ABOUT:
|
||||||
{ $syntax "about: article" }
|
{ $syntax "ABOUT: article" }
|
||||||
{ $values { "article" "a help article" } }
|
{ $values { "article" "a help article" } }
|
||||||
{ $description "Defines the main documentation article for the current vocabulary." } ;
|
{ $description "Defines the main documentation article for the current vocabulary." } ;
|
||||||
|
|
||||||
HELP: vocab-help
|
HELP: vocab-help
|
||||||
{ $values { "vocab-spec" "a vocabulary specifier" } { "help" "a help article" } }
|
{ $values { "vocab-spec" "a vocabulary specifier" } { "help" "a help article" } }
|
||||||
{ $description "Outputs the main help article for a vocabulary. The main help article can be set with " { $link postpone\ about: } "." } ;
|
{ $description "Outputs the main help article for a vocabulary. The main help article can be set with " { $link \ ABOUT: } "." } ;
|
||||||
|
|
|
@ -20,5 +20,5 @@ SYNTAX: \ ARTICLE:
|
||||||
over add-article >link
|
over add-article >link
|
||||||
] dip remember-definition ;
|
] dip remember-definition ;
|
||||||
|
|
||||||
SYNTAX: \ about:
|
SYNTAX: \ ABOUT:
|
||||||
current-vocab scan-object >>help changed-definition ;
|
current-vocab scan-object >>help changed-definition ;
|
||||||
|
|
|
@ -21,7 +21,7 @@ HELP: words.
|
||||||
HELP: about
|
HELP: about
|
||||||
{ $values { "vocab" "a vocabulary specifier" } }
|
{ $values { "vocab" "a vocabulary specifier" } }
|
||||||
{ $description
|
{ $description
|
||||||
"Displays the main help article for the vocabulary. The main help article is set with the " { $link postpone\ about: } " parsing word."
|
"Displays the main help article for the vocabulary. The main help article is set with the " { $link \ ABOUT: } " parsing word."
|
||||||
} ;
|
} ;
|
||||||
|
|
||||||
ARTICLE: "browsing-help" "Browsing documentation"
|
ARTICLE: "browsing-help" "Browsing documentation"
|
||||||
|
|
|
@ -81,7 +81,7 @@ PRIVATE<
|
||||||
[
|
[
|
||||||
scaffold-copyright
|
scaffold-copyright
|
||||||
"USING: ;" print
|
"USING: ;" print
|
||||||
"in: " write print
|
"IN: " write print
|
||||||
] with-string-writer ;
|
] with-string-writer ;
|
||||||
|
|
||||||
: set-scaffold-main-file ( vocab path -- )
|
: set-scaffold-main-file ( vocab path -- )
|
||||||
|
@ -217,14 +217,14 @@ M: object add-using ( object -- )
|
||||||
: docs-file-string ( vocab -- str2 )
|
: docs-file-string ( vocab -- str2 )
|
||||||
[
|
[
|
||||||
{
|
{
|
||||||
[ "in: " write print nl ]
|
[ "IN: " write print nl ]
|
||||||
[ interesting-words. ]
|
[ interesting-words. ]
|
||||||
[
|
[
|
||||||
[ "ARTICLE: " write unparse dup write bl print ]
|
[ "ARTICLE: " write unparse dup write bl print ]
|
||||||
[ "{ $vocab-link " write pprint " }" print ] bi
|
[ "{ $vocab-link " write pprint " }" print ] bi
|
||||||
";" print nl
|
";" print nl
|
||||||
]
|
]
|
||||||
[ "about: " write unparse print ]
|
[ "ABOUT: " write unparse print ]
|
||||||
} cleave
|
} cleave
|
||||||
] with-string-writer ;
|
] with-string-writer ;
|
||||||
|
|
||||||
|
@ -302,7 +302,7 @@ PRIVATE<
|
||||||
[
|
[
|
||||||
scaffold-copyright
|
scaffold-copyright
|
||||||
"USING: tools.test " write dup write " ;" print
|
"USING: tools.test " write dup write " ;" print
|
||||||
"in: " write write ".tests" print
|
"IN: " write write ".tests" print
|
||||||
] with-string-writer ;
|
] with-string-writer ;
|
||||||
|
|
||||||
: set-scaffold-tests-file ( vocab path -- )
|
: set-scaffold-tests-file ( vocab path -- )
|
||||||
|
|
Loading…
Reference in New Issue