You are here

Home » API reference » Coffee 7.2

README.txt in Coffee 7.2

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

The Coffee module helps you to navigate through the Drupal admin faster,
inspired by Alfred and Spotlight (OS X). By default the management menu is
included in the results. Go to the config page to select an other of multiple
menus. 

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

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


-- REQUIREMENTS --

Menu module (core).


-- 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.

* Configure which menus are included in the coffee results here:
  - admin/config/user-interface/coffee


-- 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. 

-- UPGRADE PATH -- 

If you had Coffee 1.x installed, make sure to run update.php as it will install
a cache table for the prefetching the Coffee results. 

If you have implemented the hook hook_coffee_command() make sure to rewrite it 
to the newly hook_coffee_commands(), see coffee.api.php for an example. 

-- COFFEE COMMANDS --

Coffee provides default commands that you can use.

:add
Rapidly add a node of a specific content type.

-- COFFEE HOOKS --

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


-- CONTRIBUTORS --

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

Co-maintainer
- Alli Price 'heylookalive' <http://drupal.org/user/431193>

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

File

README.txt
View source 
  1. 

  2. -- SUMMARY --

  3. 

  4. The Coffee module helps you to navigate through the Drupal admin faster,

  5. inspired by Alfred and Spotlight (OS X). By default the management menu is

  6. included in the results. Go to the config page to select an other of multiple

  7. menus. 

  8. 

  9. For a full description of the module, visit the project page:

  10.   http://drupal.org/project/coffee

  11. 

  12. To submit bug reports and feature suggestions, or to track changes:

  13.   http://drupal.org/project/issues/1356930

  14. 

  15. 

  16. -- REQUIREMENTS --

  17. 

  18. Menu module (core).

  19. 

  20. 

  21. -- INSTALLATION --

  22. 

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

  24. 

  25. 

  26. -- CONFIGURATION --

  27. 

  28. * Configure user permissions in admin/people/permissions

  29. 

  30.   - access coffee

  31. 

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

  33.     Coffee module.

  34. 

  35. * Configure which menus are included in the coffee results here:

  36.   - admin/config/user-interface/coffee

  37. 

  38. 

  39. -- USAGE --

  40. 

  41. Toggle Coffee using the keyboard shortcut alt + D

  42. (alt + shift + D in Opera, alt + ctrl + D in Windows Internet Explorer).

  43. 

  44. Type the first few characters of the task that you want to perform. Coffee

  45. will try to find the right result in as less characters as possible.

  46. For example, if you want to go the the Appearance admin page, type ap and

  47. just hit enter.

  48. 

  49. If your search query returns multiple results, you can use the arrow up/down

  50. keys to choose the one you were looking for.

  51. 

  52. This will work for all Drupal admin pages.

  53. 

  54. If the Devel module is installed it will also look for items that Devel 

  55. generates. For example; type 'clear' to get devel/cache/clear as result. 

  56. 

  57. -- UPGRADE PATH -- 

  58. 

  59. If you had Coffee 1.x installed, make sure to run update.php as it will install

  60. a cache table for the prefetching the Coffee results. 

  61. 

  62. If you have implemented the hook hook_coffee_command() make sure to rewrite it 

  63. to the newly hook_coffee_commands(), see coffee.api.php for an example. 

  64. 

  65. -- COFFEE COMMANDS --

  66. 

  67. Coffee provides default commands that you can use.

  68. 

  69. :add

  70. Rapidly add a node of a specific content type.

  71. 

  72. -- COFFEE HOOKS --

  73. 

  74. You can define your own commands in your module with hook_coffee_commands(),

  75. see coffee.api.php for further documentation.

  76. 

  77. 

  78. -- CONTRIBUTORS --

  79. 

  80. Maintainer

  81. - Michael Mol 'michaelmol' 

  82. 

  83. Co-maintainer

  84. - Alli Price 'heylookalive' 

  85. 

  86. JavaScript/CSS/Less

  87. - Maarten Verbaarschot 'maartenverbaarschot'