tools: more about/etc fixes

locals-and-roots
Doug Coleman 2016-06-22 10:08:57 -07:00
parent 1faeab2df7
commit 6570c082a9
4 changed files with 10 additions and 10 deletions

View File

@ -95,7 +95,7 @@ $nl
postpone\ HELP:
}
"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:"
{ $list
{ "a string," }
@ -512,11 +512,11 @@ HELP: \ ARTICLE:
}
} ;
HELP: \ about:
{ $syntax "about: article" }
HELP: \ ABOUT:
{ $syntax "ABOUT: article" }
{ $values { "article" "a help article" } }
{ $description "Defines the main documentation article for the current vocabulary." } ;
HELP: vocab-help
{ $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: } "." } ;

View File

@ -20,5 +20,5 @@ SYNTAX: \ ARTICLE:
over add-article >link
] dip remember-definition ;
SYNTAX: \ about:
SYNTAX: \ ABOUT:
current-vocab scan-object >>help changed-definition ;

View File

@ -21,7 +21,7 @@ HELP: words.
HELP: about
{ $values { "vocab" "a vocabulary specifier" } }
{ $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"

View File

@ -81,7 +81,7 @@ PRIVATE<
[
scaffold-copyright
"USING: ;" print
"in: " write print
"IN: " write print
] with-string-writer ;
: set-scaffold-main-file ( vocab path -- )
@ -217,14 +217,14 @@ M: object add-using ( object -- )
: docs-file-string ( vocab -- str2 )
[
{
[ "in: " write print nl ]
[ "IN: " write print nl ]
[ interesting-words. ]
[
[ "ARTICLE: " write unparse dup write bl print ]
[ "{ $vocab-link " write pprint " }" print ] bi
";" print nl
]
[ "about: " write unparse print ]
[ "ABOUT: " write unparse print ]
} cleave
] with-string-writer ;
@ -302,7 +302,7 @@ PRIVATE<
[
scaffold-copyright
"USING: tools.test " write dup write " ;" print
"in: " write write ".tests" print
"IN: " write write ".tests" print
] with-string-writer ;
: set-scaffold-tests-file ( vocab path -- )