]> gitweb.factorcode.org Git - factor.git/commitdiff
help.markup: new pages for undocumented elements
authorrazetime <raghuallthetime@hotmail.com>
Tue, 20 Dec 2022 13:31:03 +0000 (19:01 +0530)
committerrazetime <raghuallthetime@hotmail.com>
Tue, 20 Dec 2022 13:31:40 +0000 (19:01 +0530)
basis/help/help-docs.factor

index 28c29727c5d82928d6cfa13b770b4f5a119de02c..125f587a1f75de9d6ef5f8d360b89bfca13e41a8 100644 (file)
@@ -345,6 +345,90 @@ HELP: $link
     { $markup-example { $link + } }
 } ;
 
+HELP: $breadcrumbs
+{ $values { "topics" "topics to feature in the breadcrumb" } }
+{ $description "Displays a list of help articles or words. Used to indicate a sequence of links that lead to the current page." }
+; 
+
+HELP: $class-description
+{ $values { "element" "a markup element" } }
+{ $description "Prints a \"Class Description\" heading, and displays its content." }
+;
+
+HELP: $complex-shuffle
+{ $values { "element" "a markup element" } }
+{ $description "Used to indicate that a shuffle word is in the " { $link "shuffle-words-complex" } "category." }
+;
+
+HELP: $content
+{ $values { "element" "a markup element" } }
+{ $description "Prints the content of a help article. The link to the article is given as a string or a word." }
+;
+
+HELP: $deprecated
+{ $values { "element" "a markup element" } }
+{ $description "Prints a notice indicating that the current page describes a deprecated word." }
+;
+
+HELP: $emphasis
+{ $values { "element" "a markup element" } }
+{ $description "Prints " { $emphasis "emphasized" } "text. This is also known as italicized text." }
+;
+
+HELP: $inputs
+{ $values { "element" "a markup element" } }
+{ $description "Prints an \"Inputs\" heading, and displays the inputs for a word. Use " { $link $values } 
+  " instead, which displays both inputs and outputs if applicable." }
+;
+
+HELP: $io-error
+{ $values { "element" "a markup element" } }
+{ $description "Indicates an error class for input/output." }
+;
+
+HELP: $long-link
+{ $values { "element" "a markup element" } }
+{ $description "Prints a link to a word or article, along with its stack effect, if available." }
+;
+
+HELP: $low-level-note
+{ $values { "children" "a list of markup elements" } }
+{ $description "Prints a disclaimer, indicating that the current page describes a low level word." }
+;
+
+HELP: $methods
+{ $values { "element" "a markup element" } }
+{ $description "Prints the methods for a word. This word is only used internally." }
+;
+
+HELP: $or
+{ $values { "element" "a markup element of shape " { $snippet "{ class1 class2 }" } } }
+{ $description
+    "Produces the text β€œa " { $emphasis "class1" } " or " { $emphasis "class2" } 
+    "” or β€œan " { $emphasis "class1" } " or " { $emphasis "class2" } "”, depending on the first letter of either class name."
+}
+;
+
+HELP: $outputs
+{ $values { "element" "a markup element" } }
+{ $description "Prints an \"Outputs\" heading, and displays the outputs for a word. Use " { $link $values } 
+  " instead, which displays both inputs and outputs if applicable." }
+;
+
+HELP: $parsing-note
+{ $values { "children" "a list of markup elements" } }
+{ $description "Prints a disclaimer, indicating that the current page describes a word made to be used for parsing." }
+;
+
+HELP: $pretty-link
+{ $values { "element" "an article name or word" } }
+{ $description "Prints the link to an article or word, along with its definition icon." }
+;
+HELP: $vocab-link
+{ $values { "element" "a string" } }
+{ $description "Prints a link to a vocabulary article." }
+;
+
 HELP: textual-list
 { $values { "seq" sequence } { "quot" { $quotation ( elt -- ) } } }
 { $description "Applies the quotation to each element of the sequence, printing a comma between each pair of elements." }