You are here

README.txt in Coffee 7

Same filename and directory in other branches
  1. 8 README.txt
  2. 6 README.txt
  3. 7.2 README.txt
-- SUMMARY --

The Coffee module helps you to navigate through the Drupal admin faster,
inspired by Alfred and Spotlight (OS X).

For a full description of the module, visit the project page:
  http://drupal.org/sandbox/michaelmol/1356930

To submit bug reports and feature suggestions, or to track changes:
  http://drupal.org/project/issues/1356930


-- REQUIREMENTS --

None.


-- INSTALLATION --

* Install as usual, see http://drupal.org/node/70501 for further information.


-- CONFIGURATION --

* Configure user permissions in admin/people/permissions

  - access coffee

    Users in Roles with the "access coffee" permission can make use of the
    Coffee module. 


-- USAGE --

Toggle Coffee using the keyboard shortcut alt + D
(alt + shift + D in Opera, alt + ctrl + D in Windows Internet Explorer).

Type the first few characters of the task that you want to perform. Coffee
will try to find the right result in as less characters as possible.
For example, if you want to go the the Appearance admin page, type ap and
just hit enter.

If your search query returns multiple results, you can use the arrow up/down
keys to choose the one you were looking for.

This will work for all Drupal admin pages.

If the Devel module is installed it will also look for items that Devel 
generates. For example; type 'clear' to get devel/cache/clear as result. 


-- COFFEE COMMANDS --

Coffee provides some default commands that you can use.

:add
Rapidly add content of a specific content type.

:help
View the Coffee module help page.


-- COFFEE HOOKS --

You can define your own commands in your module with hook_coffee_command(),
see coffee.api.php for further documentation.


-- CONTRIBUTORS --

Maintainer
- Michael Mol 'michaelmol' <http://drupal.org/user/919186>

JavaScript/CSS/Less
- Maarten Verbaarschot 'maartenverbaarschot' <http://drupal.org/user/1305466>

File

README.txt
View source
  1. -- SUMMARY --
  2. The Coffee module helps you to navigate through the Drupal admin faster,
  3. inspired by Alfred and Spotlight (OS X).
  4. For a full description of the module, visit the project page:
  5. http://drupal.org/sandbox/michaelmol/1356930
  6. To submit bug reports and feature suggestions, or to track changes:
  7. http://drupal.org/project/issues/1356930
  8. -- REQUIREMENTS --
  9. None.
  10. -- INSTALLATION --
  11. * Install as usual, see http://drupal.org/node/70501 for further information.
  12. -- CONFIGURATION --
  13. * Configure user permissions in admin/people/permissions
  14. - access coffee
  15. Users in Roles with the "access coffee" permission can make use of the
  16. Coffee module.
  17. -- USAGE --
  18. Toggle Coffee using the keyboard shortcut alt + D
  19. (alt + shift + D in Opera, alt + ctrl + D in Windows Internet Explorer).
  20. Type the first few characters of the task that you want to perform. Coffee
  21. will try to find the right result in as less characters as possible.
  22. For example, if you want to go the the Appearance admin page, type ap and
  23. just hit enter.
  24. If your search query returns multiple results, you can use the arrow up/down
  25. keys to choose the one you were looking for.
  26. This will work for all Drupal admin pages.
  27. If the Devel module is installed it will also look for items that Devel
  28. generates. For example; type 'clear' to get devel/cache/clear as result.
  29. -- COFFEE COMMANDS --
  30. Coffee provides some default commands that you can use.
  31. :add
  32. Rapidly add content of a specific content type.
  33. :help
  34. View the Coffee module help page.
  35. -- COFFEE HOOKS --
  36. You can define your own commands in your module with hook_coffee_command(),
  37. see coffee.api.php for further documentation.
  38. -- CONTRIBUTORS --
  39. Maintainer
  40. - Michael Mol 'michaelmol'
  41. JavaScript/CSS/Less
  42. - Maarten Verbaarschot 'maartenverbaarschot'