gloo 0.5.4 → 0.7.2

data/lib/gloo/help/core/it.txt

@@ -0,0 +1,23 @@
+IT
+
+  DESCRIPTION
+    'It' is a special virtual object.  'It' contains the value of
+    the last expression or command run.  Not all commands result in
+    a change to the value of it.
+
+  EXAMPLE
+    Get the value of an expression and store it somewhere for later use:
+
+      #
+      # Example of usage of 'it'.
+      #
+      it_example [can] :
+        result [int] :
+        on_load [script] :
+          show 3 + 4
+          put it into ^.result
+          show ^.result
+
+    Running this script will show 7 twice.  The first time will be the
+    result of the addition.  The second time will be showing the
+    result object.

data/lib/gloo/help/core/ops.txt

@@ -0,0 +1,16 @@
+OPERATORS
+
+  DESCRIPTION
+    These are the gloo operators:
+
+      +   addition
+      -   subtraction
+      *   multiplication
+      /   division
+
+  EXAMPLE
+    Here are some examples of expression usage:
+
+      > show 2 + 5
+      > put 12 / 3 into x
+      > show 23 * 3 - 6

data/lib/gloo/help/core/pathname.txt

@@ -0,0 +1,29 @@
+PATHNAME
+
+  DESCRIPTION
+    All gloo object data and scripts are stored in a heap of objects or
+    just "the heap".  The heap is hierarchical, with some objects having
+    children objects.  To reference an object, we use a "pathname".  The
+    pathname starts with the root level object then has a period, ".",
+    then the child object name, and so forth.  "a.b.c" refers to the "c"
+    object in the "b" container, which is in the "a" container.
+
+  ROOT
+    The word "root" is not needed when referring to objects.  In some
+    special cases, "root" can be used to point to the first level of
+    the object heap.  One such use would be with the "context" verb.
+
+  EXAMPLE
+    Here is an example of objects and a pathname reference to an
+    object within the hierarchy:
+
+      #
+      # Hierarchical containers.
+      #
+      a [can] :
+        b [can] :
+          c [string] : Hello World
+      on_load [script] : show a.b.c
+
+  SEE ALSO
+    context

data/lib/gloo/help/objs/basic/alias.txt

@@ -0,0 +1,36 @@
+ALIAS OBJECT TYPE
+  NAME: alias
+  SHORTCUT: ln
+
+  DESCRIPTION
+    A pointer to another object.
+    Normal path-name references will refere to the aliased object.
+    To refer to the alias itself, add an * at the end of the path-name.
+    This is neeed, for example, to set the value of the alias.
+    The value of the alias is merely the path-name of the
+    referenced object.
+
+  CHILDREN
+    None
+
+  MESSAGES
+    The alias will reflect the mesages of the object to which
+    it points.
+    The alias itself can receive the following message:
+    resolve - Check to see if the object referenced exists.
+          Sets it to true or false.
+
+  EXAMPLE
+
+    a [can] :
+      s [string] : a string
+      i [integer] : 13
+      ln [alias] : a.s
+      on_load [script] :
+        show a.ln
+        show a.ln*
+        put 'a.i' into a.ln*
+        put 7 into a.ln
+        show a.ln
+
+  SEE ALSO

data/lib/gloo/help/objs/basic/boolean.txt

@@ -0,0 +1,28 @@
+BOOLEAN OBJECT TYPE
+  NAME: boolean
+  SHORTCUT: bool
+
+  DESCRIPTION
+    A boolean value.
+    Value will be either true or false.
+
+  CHILDREN
+    None
+
+  MESSAGES
+    not - Set the boolean to the opposite of what it is now.
+    true - Set the boolean to true.
+    false - Set the boolean to false.
+
+  EXAMPLE
+
+    b [can] :
+      flag [boolean] : true
+      on_load [script] :
+        show b.flag
+        put false into b.flag
+        show b.flag
+        tell b.flag to not
+        show b.flag
+
+  SEE ALSO

data/lib/gloo/help/objs/basic/container.txt

@@ -0,0 +1,33 @@
+CONTAINER OBJECT TYPE
+  NAME: container
+  SHORTCUT: can
+
+  DESCRIPTION
+    A container of other objects.
+    A container is similar to a folder in a file system.
+    It can contain any number of objects including other containers.
+    The container structure provides direct access to any object
+    within it through the object.object.object path-name structure.
+
+  CHILDREN
+    None by default.  But any container can have any number of
+    objects added to it.
+
+  MESSAGES
+    count - Count the number of children objects in the container.
+            The result is put in <it>.
+    delete_children - Delete all children objects from the container.
+    show_key_value_tbl - Show a table with key (name) and values
+      for all children in the container.
+
+  EXAMPLE
+
+    can [can] :
+      data [can] :
+        1 : one
+        2 : two
+        3 : three
+    	on_load [script] :
+    		tell can.data to show_key_value_table
+
+  SEE ALSO

data/lib/gloo/help/objs/basic/decimal.txt

@@ -0,0 +1,28 @@
+DECIMAL OBJECT TYPE
+  NAME: decimal
+  SHORTCUT: num
+
+  DESCRIPTION
+    A decimal (numeric) value.
+
+  CHILDREN
+    None
+
+  MESSAGES
+    round - Round to the nearest whole value.
+      If an optional parameter is included, round to the
+      precision specified.
+
+  EXAMPLE
+
+    d [can] :
+      x [decimal] : 100
+      on_load [script] :
+        show d.x
+        put d.x / 3 into d.x
+        show d.x
+        tell d.x to round (1)
+        show d.x
+
+  SEE ALSO
+    integer

data/lib/gloo/help/objs/basic/integer.txt

@@ -0,0 +1,27 @@
+INTEGER OBJECT TYPE
+  NAME: integer
+  SHORTCUT: int
+
+  DESCRIPTION
+    An integer (numeric) value.
+
+  CHILDREN
+    None
+
+  MESSAGES
+    inc - Increment the integer value by 1.
+    dec - Decrement the integer value by 1.
+
+  EXAMPLE
+
+    i [can] :
+      x [integer] : 0
+      on_load [script] :
+        show i.x
+        tell i.x to inc
+        show i.x
+        put i.x * 10 into i.x
+        show i.x
+
+  SEE ALSO
+    decimal

data/lib/gloo/help/objs/basic/script.txt

@@ -0,0 +1,29 @@
+SCRIPT OBJECT TYPE
+  NAME: script
+  SHORTCUT: cmd
+
+  DESCRIPTION
+    An exectutable script.
+
+  CHILDREN
+    None
+
+  MESSAGES
+    run - Run the script.
+          The script can be run by telling the object or run.
+          It can all be executed with the run verb.
+
+  EXAMPLE
+
+    script [can] :
+    	on_load [script] :
+    		show "Showing multiple lines..."
+    		show script.msg1
+    		show script.msg2
+    		show script.msg3
+    		show "Done."
+    	msg1 [string] : one
+    	msg2 [string] : two
+    	msg3 [string] : three
+
+  SEE ALSO

data/lib/gloo/help/objs/basic/string.txt

@@ -0,0 +1,28 @@
+STRING OBJECT TYPE
+  NAME: string
+  SHORTCUT: str
+
+  DESCRIPTION
+    A string value.
+
+  CHILDREN
+    None
+
+  MESSAGES
+    up - Convert the string to uppercase.
+    down - Convert the string to lowercase.
+    size - Get the size of the string.
+
+  EXAMPLE
+
+    s [can] :
+      msg [string] : Hello World!
+      on_load [script] :
+        show s.msg
+        tell s.msg to up
+        show s.msg
+        tell s.msg to size
+        show it
+
+  SEE ALSO
+    text

data/lib/gloo/help/objs/basic/text.txt

@@ -0,0 +1,27 @@
+TEXT OBJECT TYPE
+  NAME: text
+  SHORTCUT: txt
+
+  DESCRIPTION
+    A longer, multi-line text string.
+    Use BEGIN and END to mark the text range.
+
+  CHILDREN
+    None
+
+  MESSAGES
+    edit - Edit the text field in the default editor.
+    page - Show the text, paginated.
+
+  EXAMPLE
+
+    t [container] :
+    	msg [txt] : BEGIN
+    		I will now write a poem
+    		of two lines or less
+    		END
+    	on_load [script] :
+    		show t.msg
+
+  SEE ALSO
+    string

data/lib/gloo/help/objs/basic/untyped.txt

@@ -0,0 +1,22 @@
+UNTYPED OBJECT TYPE
+  NAME: untyped
+  SHORTCUT: un
+
+  DESCRIPTION
+    An untyped object.
+    If no type is specified when an object is created it
+    will be of this type.
+
+  CHILDREN
+    None
+
+  MESSAGES
+    None
+
+  EXAMPLE
+
+    > create x
+    > put 1 into x
+    > put 'string' into x
+
+  SEE ALSO

data/lib/gloo/help/objs/cli/banner.txt

@@ -0,0 +1,49 @@
+BANNER OBJECT TYPE
+  NAME: banner
+  SHORTCUT: ban
+
+  DESCRIPTION
+    Banner text in large, colored font.
+
+  CHILDREN
+    text - string
+      The text for the banner.
+    style - string
+      The banner style.  See tty-font for options.
+    color - string
+      The color for the banner.  See pastel for options.
+
+  MESSAGES
+    show - Show the text banner.
+
+  EXAMPLE
+
+    ban [can] :
+      on_load [script] :
+        tell ban.one to show
+        tell ban.two to show
+        tell ban.three to show
+        tell ban.four to show
+        tell ban.five to show
+      one [banner] :
+        text [string] : Something New
+        style [string] : standard
+        color [string] : white on_green
+      two [banner] :
+        text [string] : Star Wars
+        style [string] : starwars
+        color [string] : red
+      three [banner] :
+        text [string] : Many_Dimensions
+        style [string] : 3d
+        color [string] : blue
+      four [banner] :
+        text [string] : As An Arrow
+        style [string] : straight
+        color [string] : yellow
+      five [banner] :
+        text [string] : Cranium
+        style [string] : block
+        color [string] : white on_yellow
+
+  SEE ALSO

data/lib/gloo/help/objs/cli/bar.txt

@@ -0,0 +1,34 @@
+BAR OBJECT TYPE
+  NAME: bar
+  SHORTCUT: bar
+
+  DESCRIPTION
+    CLI progress bar
+
+  CHILDREN
+    name - string
+      The name of the progress bar.
+    total - integer - 100
+      The total for the bar.
+
+  MESSAGES
+    start - Start the bar.
+    advance <amount> - Advance by the given amount.
+    stop - Complete the bar.
+
+  EXAMPLE
+
+    bar [can] :
+      on_load [script] :
+        tell bar.progress to start
+        tell bar.progress to advance
+        wait
+        tell bar.progress to advance (30)
+        wait
+        tell bar.progress to advance (40)
+        wait
+        tell bar.progress to stop
+      progress [bar] :
+        name [string] : going
+
+  SEE ALSO

data/lib/gloo/help/objs/cli/colorize.txt

@@ -0,0 +1,33 @@
+COLORIZE OBJECT TYPE
+  NAME: colorize
+  SHORTCUT: color
+
+  DESCRIPTION
+    The Colorize object can be used to write output in color.
+    The Colorize container can contain multiple strings, each
+    one can have a different color as specified by the names
+    of the children.
+
+  CHILDREN
+    <color> - string - no default value
+      The name of the child or children is the color.
+      The string's value is what will be written out.
+
+  MESSAGES
+    run - Output the string in the color specified.
+
+  EXAMPLE
+
+    color [can] :
+    	w [colorize] :
+    		white [string] : This is white!
+    	m [colorize] :
+    		red [string] : red -
+    		green [string] : green -
+    		blue [string] : blue
+    	on_load [script] :
+    		run color.w
+    		run color.m
+
+  SEE ALSO
+    pastel