basis/help/tips/tips-docs.factor

   1 USING: debugger editors help help.apropos help.markup
   2 help.syntax help.vocabs memory see stack-checker
   3 tools.destructors tools.time ;
   4 IN: help.tips
   5
   6 TIP: "To look at the most recent error, run " { $link :error } ". To look at the most recent error's callstack, run " { $link :c } "." ;
   7
   8 TIP: "Learn to use " { $link "dataflow-combinators" } "." ;
   9
  10 TIP: "Learn to use " { $link "editor" } " to be able to jump to the source code for word definitions from the listener." ;
  11
  12 TIP: "Check out " { $url "http://concatenative.org/wiki/view/Factor/FAQ" } " to get answers to frequently-asked questions." ;
  13
  14 TIP: "Drop by the " { $snippet "#concatenative" } " IRC channel on " { $snippet "irc.freenode.net" } " some time." ;
  15
  16 TIP: "You can write documentation for your own code using the " { $link "help" } "." ;
  17
  18 TIP: "You can write graphical applications using the " { $link "ui" } "." ;
  19
  20 TIP: "Power tools: " { $links see edit help about apropos time infer. } ;
  21
  22 TIP: "Tips of the day implement the " { $link "definition-protocol" } " and new tips of the day can be defined using the " { $link POSTPONE: TIP: } " parsing word." ;
  23
  24 TIP: "Try some simple demo applications, then look at the source code in " { $snippet "extra/" } ": " { $snippet "\"demos\" run" } ;
  25
  26 TIP: "To save time on reloading big libraries such as the " { $vocab-link "furnace" } " web framework, save the image after loading them using the " { $link save } " word." ;
  27
  28 TIP: "Use the " { $link leaks. } " combinator to track down resource leaks." ;
  29
  30 HELP: TIP:
  31 { $syntax "TIP: content ;" }
  32 { $values { "content" "a markup element" } }
  33 { $description "Defines a new tip of the day." } ;
  34
  35 ARTICLE: "all-tips-of-the-day" "All tips of the day"
  36 { $tips-of-the-day } ;
  37
  38 ARTICLE: "tips-of-the-day" "Tips of the day"
  39 "The " { $vocab-link "help.tips" } " vocabulary provides a facility for displaying tips of the day in the " { $link "ui-listener" } ". Tips are defined with a parsing word:"
  40 { $subsections POSTPONE: TIP: }
  41 "All tips defined so far:"
  42 { $subsections "all-tips-of-the-day" } ;
  43
  44 ABOUT: "tips-of-the-day"