1 ! Copyright (C) 2008 Doug Coleman.
2 ! See http://factorcode.org/license.txt for BSD license.
3 USING: help.markup help.syntax kernel strings words vocabs ;
7 { $description "Set this symbol to hold your name so that the scaffold tools can generate the correct file header for copyright. Setting this variable in your .factor-boot-rc file is recommended." }
8 { $code "USING: namespaces tools.scaffold ;\n\"Stacky Guy\" developer-name set-global" } ;
13 { $description "Prints out scaffold help markup for a given word." } ;
16 { $values { "vocab" vocab } }
17 { $description "Takes an existing vocabulary and creates a help file with scaffolded help for each word. This word only works if no help file yet exists." } ;
19 HELP: scaffold-undocumented
22 { $description "Prints scaffolding documenation for undocumented words in a vocabuary except for automatically generated class predicates." } ;
24 { scaffold-help scaffold-undocumented } related-words
28 { "vocab-root" "a vocabulary root string" } { "string" string } }
29 { $description "Creates a directory in the given root for a new vocabulary and adds a main .factor file and an authors.txt file." } ;
32 { $description "Touches the .emacs file in your home directory and provides a clickable link to open it in an editor." } ;
34 HELP: scaffold-factor-boot-rc
35 { $description "Touches the .factor-boot-rc file in your home directory and provides a clickable link to open it in an editor." } ;
37 HELP: scaffold-factor-rc
38 { $description "Touches the .factor-rc file in your home directory and provides a clickable link to open it in an editor." } ;
42 { "path" "a pathname string" }
44 { $description "Touches the given path in your home directory and provides a clickable link to open it in an editor." } ;
47 { $description "Stores the vocabularies that are pulled into the documentation file from looking up the stack effect types." } ;
49 ARTICLE: "tools.scaffold" "Scaffold tool"
51 { $subsection developer-name }
52 "Generate new vocabs:"
53 { $subsection scaffold-vocab }
54 "Generate help scaffolding:"
55 { $subsection scaffold-help }
56 { $subsection scaffold-undocumented }
58 "Types that are unrecognized by the scaffold generator will be of type " { $link null } ". The developer should change these to strings that describe the stack effect names instead." $nl
59 "Scaffolding a configuration file:"
60 { $subsection scaffold-rc }
61 { $subsection scaffold-factor-boot-rc }
62 { $subsection scaffold-factor-rc }
63 { $subsection scaffold-emacs }
66 ABOUT: "tools.scaffold"