vedeu 0.8.1 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 60d8aaa6126ec4e15edc18e5b0c7be8a932e500c
-  data.tar.gz: 71f61ddeb4937aa1992866756386748430a64172
+  metadata.gz: e72a4e701c2e16801c6f4b3116cf8ba40a54bfd2
+  data.tar.gz: e09f9047d8aa9b5c8ac2bcda49bbf6cacded29b5
 SHA512:
-  metadata.gz: 00cf06475482f5dc6f3ef13c20725f7d67017446c2023a160f460cbf1f3558eb353a49e98db310a721eb7051b25c53baf6053f9de79870b437c87029e5f08806
-  data.tar.gz: 2504ea7c128679347dc7e207ff48edfc601c4870bd2e81fe0e1ccbd301d7219bfc747c9925808e096facad2ed157c65724f5f1d83de482dea2e7b573cd8d46bc
+  metadata.gz: 1e5438cae3e71924368025179a9556252eb2e255cfd1fd3cd470ebecb8f41ab95991d1279fe160cecae30ae841acb2db7497c6954207d2485c340127d1f993db
+  data.tar.gz: f3fb017c495bdb18c6a6eb327a04b69776e181f81b1a27535dd4cdc985b6971c8ff80df58a7697ef40f853e276fc4054632299defb7c3b8ed5032ec60feb04bf

data/docs/api.md

@@ -129,110 +129,6 @@ See {file:docs/events.md}
   - items
   - name
 
-
-# API Methods
-
-### Vedeu.add_command
-
-@todo Add more documentation.
-
-### Vedeu.add_keypress
-
-@todo Add more documentation.
-
-### Vedeu.all_commands
-
-Returns an array of all commands received by Vedeu.
-
-@todo Add more documentation.
-
-### Vedeu.all_keypresses
-
-Returns an array of all keypresses received by Vedeu.
-
-@todo Add more documentation.
-
-### Vedeu.background_colours
-
-Repository method. Access registered background colours.
-
-    Vedeu.background_colours # => [Vedeu::Colours::Backgrounds]
-
-    Vedeu.background_colours.all # => [Hash<String => String>]
-
-
-### Vedeu.bind
-
-@todo Add more documentation.
-
-### Vedeu.bind_alias
-
-@todo Add more documentation.
-
-### Vedeu.border
-
-See {Vedeu::DSL::Border::ClassMethods.border}
-
-### Vedeu.borders
-
-Repository method. Access registered borders.
-
-    Vedeu.borders # [Vedeu::Borders::Repository]
-
-    Vedeu.borders.all # [Array<Vedeu::Borders::Border>]
-
-### Vedeu.bound?
-
-@todo Add more documentation.
-
-### Vedeu.buffer_update
-
-@todo Add more documentation.
-
-### Vedeu.buffer_write
-
-@todo Add more documentation.
-
-### Vedeu.buffers
-
-Repository method. Access registered borders.
-
-    Vedeu.buffers # [Vedeu::Buffers::Repository]
-
-    Vedeu.buffers.all # [Array<Vedeu::Buffers::Buffer>]
-
-### Vedeu.clear
-
-@todo Add more documentation.
-
-### Vedeu.clear_by_group
-
-@todo Add more documentation.
-
-### Vedeu.clear_by_name
-
-@todo Add more documentation.
-
-### Vedeu.clear_content_by_name
-
-@todo Add more documentation.
-
-### Vedeu.clock_time
-
-@todo Add more documentation.
-
-### Vedeu.configuration
-
-@todo Add more documentation.
-
-### Vedeu.configure
-
-@todo Add more documentation.
-
-### Vedeu.cursor
-
-@todo Add more documentation.
-
 ### Vedeu.cursors
 
 Repository method. Access registered cursors.
@@ -241,34 +137,6 @@ Repository method. Access registered cursors.
 
     Vedeu.cursors.all # [Array<Vedeu::Cursors::Cursor>]
 
-### Vedeu.debug
-
-@todo Add more documentation.
-
-### Vedeu.direct_write
-
-@todo Add more documentation.
-
-### Vedeu.documents
-
-@todo Add more documentation.
-
-### Vedeu.drb_restart
-
-@todo Add more documentation.
-
-### Vedeu.drb_start
-
-@todo Add more documentation.
-
-### Vedeu.drb_status
-
-@todo Add more documentation.
-
-### Vedeu.drb_stop
-
-@todo Add more documentation.
-
 ### Vedeu.events
 
 Repository method. Access registered events.
@@ -277,34 +145,6 @@ Repository method. Access registered events.
 
     Vedeu.events.all # [Array<Vedeu::Events::Collection>]
 
-### Vedeu.exit
-
-@todo Add more documentation.
-
-### Vedeu.focus
-
-@todo Add more documentation.
-
-### Vedeu.focus?
-
-@todo Add more documentation.
-
-### Vedeu.focus_by_name
-
-@todo Add more documentation.
-
-### Vedeu.focus_next
-
-@todo Add more documentation.
-
-### Vedeu.focus_previous
-
-@todo Add more documentation.
-
-### Vedeu.focussed?
-
-@todo Add more documentation.
-
 ### Vedeu.foreground_colours
 
 Show all the registered foreground colours.
@@ -321,17 +161,6 @@ Repository method. Access registered interface/view geometry.
 
     Vedeu.geometries.all # [Array<Vedeu::Geometries::Geometry>]
 
-### Vedeu.geometry
-
-@todo Add more documentation.
-
-### Vedeu.goto
-
-@todo Add more documentation.
-
-### Vedeu.group
-
-@todo Add more documentation.
 
 ### Vedeu.groups
 
@@ -341,26 +170,6 @@ Repository method. Access registered groups.
 
     Vedeu.groups.all # [Array<Vedeu::Groups::Group>]
 
-### Vedeu.height
-
-@todo Add more documentation.
-
-### Vedeu.hide_cursor
-
-See {file:docs/cursors.md#vedeuhide_cursor__}
-
-### Vedeu.hide_group
-
-@todo Add more documentation.
-
-### Vedeu.hide_interface
-
-@todo Add more documentation.
-
-### Vedeu.interface
-
-@todo Add more documentation.
-
 ### Vedeu.interfaces
 
 Repository method. Access registered interfaces.
@@ -369,10 +178,6 @@ Repository method. Access registered interfaces.
 
     Vedeu.interfaces.all # [Array<Vedeu::Interfaces::Interface>]
 
-### Vedeu.keymap
-
-@todo Add more documentation.
-
 ### Vedeu.keymaps
 
 Repository method. Access registered keymaps.
@@ -381,46 +186,6 @@ Repository method. Access registered keymaps.
 
     Vedeu.keymaps.all # [Array<Vedeu::Input::Keymap>]
 
-### Vedeu.keypress
-
-@todo Add more documentation.
-
-### Vedeu.keys
-
-@todo Add more documentation.
-
-### Vedeu.last_command
-
-Returns the last command entered into Vedeu.
-
-@todo Add more documentation.
-
-### Vedeu.last_keypress
-
-Returns the last keypress entered into Vedeu.
-
-@todo Add more documentation.
-
-### Vedeu.log
-
-@todo Add more documentation.
-
-### Vedeu.log_stderr
-
-@todo Add more documentation.
-
-### Vedeu.log_stdout
-
-@todo Add more documentation.
-
-### Vedeu.log_timestamp
-
-@todo Add more documentation.
-
-### Vedeu.menu
-
-@todo Add more documentation.
-
 ### Vedeu.menus
 
 Repository method. Access registered menus.
@@ -429,62 +194,6 @@ Repository method. Access registered menus.
 
     Vedeu.menus.all # [Array<Vedeu::Menus::Menu>]
 
-### Vedeu.profile
-
-@todo Add more documentation.
-
-### Vedeu.read
-
-This allows the direct reading from the terminal, unencumbered by the
-framework.
-
-    Vedeu.read("some input here") # => programmatic cooked mode
-                                  #    (default)
-
-    Vedeu.read("\e[24;2~", mode: :raw) # => programmatic raw mode
-                                       #    (provides :shift_f12 in
-                                       #    this example)
-
-    Vedeu.read(nil, mode: :raw) # => for a single keypress
-
-    Vedeu.read(nil, mode: :cooked) # => (default mode) for a 'line at
-                                   #    a time' (pressing 'return'
-                                   #    ends the line)
-
-The way that these are used will depend on the mode your terminal is currently set to. Vedeu by default sets this to `:raw` (single character, hidden cursor). `Vedeu.read` by default expects the terminal to be in `:cooked` mode unless you provide the `mode: :raw` option.
-
-- In `:cooked` mode (default), it will trigger a `:_command_` event
-  with the input provided, meaning you should bind to :command to
-  receive the input.
-- In `:raw` mode, it will trigger a `:_keypress_` event with the input
-  provided, meaning you should bind to `:key` to receive the input.
-
-You can also access the input given using the API methods:
-
-    Vedeu.all_commands
-    Vedeu.all_keypresses
-    Vedeu.last_command
-    Vedeu.last_keypress
-
-### Vedeu.ready!
-
-@todo Add more documentation.
-
-### Vedeu.ready?
-
-@todo Add more documentation.
-
-### Vedeu.refresh
-
-@todo Add more documentation.
-
-### Vedeu.render
-
-@todo Add more documentation.
-
-### Vedeu.render_output
-
-@todo Add more documentation.
 
 ### Vedeu.renderers
 
@@ -492,69 +201,3 @@ Repository method. Access registered renderers.
 
     Vedeu.renderers # [Vedeu::Renderers]
 
-### Vedeu.renders
-
-@todo Add more documentation.
-
-### Vedeu.renders
-
-@todo Add more documentation.
-
-### Vedeu.resize
-
-@todo Add more documentation.
-
-### Vedeu.show_cursor
-
-See {file:docs/cursors.md#vedeushow_cursor__}
-
-### Vedeu.show_group
-
-@todo Add more documentation.
-
-### Vedeu.show_interface
-
-@todo Add more documentation.
-
-### Vedeu.timer
-
-@todo Add more documentation.
-
-### Vedeu.toggle_cursor
-
-See {file:docs/cursors.md#vedeutoggle_cursor__}
-
-### Vedeu.toggle_group
-
-@todo Add more documentation.
-
-### Vedeu.toggle_interface
-
-@todo Add more documentation.
-
-### Vedeu.trigger
-
-@todo Add more documentation.
-
-### Vedeu.unbind
-
-@todo Add more documentation.
-
-### Vedeu.view
-
-@todo Add more documentation.
-
-### Vedeu.views
-
-@todo Add more documentation.
-
-### Vedeu.width
-
-@todo Add more documentation.
-
-### Vedeu.write
-
-This allows the direct writing to the terminal, unencumbered by the
-framework.
-
-@todo Add more documentation.

data/docs/configuration.md

@@ -14,7 +14,7 @@ If you need to access the value of Vedeu's configuration for whatever
 reason, simply ask for it:
 
     # => The current value of 'base_path'
-    Vedeu.configuration.base_path
+    Vedeu.config.base_path
 
 ## Configuration Options
 

data/docs/dsl/by_method/add_command.md

@@ -0,0 +1,5 @@
+Add a command (a collection of characters/keypresses from a
+Vedeu::Editor::Document) to the store. Used by Vedeu internally to
+store commands entered.
+
+    Vedeu.add_command(:some_command)

data/docs/dsl/by_method/add_keypress.md

@@ -0,0 +1,4 @@
+Add a keypress to the store. Used by Vedeu internally to store a
+keypress entered.
+
+    Vedeu.add_keypress(:escape)

data/docs/dsl/by_method/all_commands.md

@@ -0,0 +1,3 @@
+Returns an array of all commands received by Vedeu.
+
+    Vedeu.all_commands