13 January 2016

Lesson 7 – Get help in 8th

Getting help with 8th

If you have looked into the 8th manual, you’ll be aware of the fact that there are a lot of words (functions) defined in 8th.

In order to find information quickly, there are a few helper words to accomplish that.

Extended SED (Stack Effect Diagram)

First we need to complete your understanding of SED’s.

Because SED’s are used to document the behaviour of words we need to extend it a little. We saw that:
The items before the dashes are the “input” items on the stack
The items behind the dashes are the “output” items on the stack

However, there are also words that take information directly from the REPL. In that case there is a special form of “input item” in angle brackets. Such item has to follow the word immediately.

The word help


help \ <name> --
Example: help apropos

The result is the documentation for the specific 8th word apropos.

NOTE: <name> must be a valid 8th word

The word apropos


apropos \ <text> -- 
Example: apropos  cls

The result of this is a list of documentation sets on all the words having the piece of text “cls” in their documentation.

NOTE: <text> is just a piece of text which is searched for in the documentation of all 8th words.

The word words/


words/ \ <filter> --

Example 1: words/ n:

   The result of this is a list starting with the number of words matching the filter (in this case we
   request all words in the n: namespace) followed by the individual matching words

Example 2: words/ cls

 






Here we see multiple results.

Showing the contents of the stack

Last but not least there is the .s word, which we saw earlier.

That word is definitively very important to know what is going on in your program.

More info about 8th

There is a central website for 8th here: http://8th-dev.com/

Video

Watch the complementary video here

No comments:

Post a Comment