You are here

Home » API reference » Coffee 8

README.txt in Coffee 8

Same filename and directory in other branches
  1. 6 README.txt
  2. 7.2 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.

To open the first result in a new window, press command + enter on a mac or
ctrl + enter on a pc.

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 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' <https://www.drupal.org/u/michaelmol>

Co-maintainer
- Marco 'willzyx' <https://www.drupal.org/u/willzyx>
- Alli Price 'heylookalive' <https://www.drupal.org/u/heylookalive>
- Oliver Köhler 'Nebel54' <https://www.drupal.org/u/nebel54>

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. To open the first result in a new window, press command + enter on a mac or

  50. ctrl + enter on a pc.

  51. 

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

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

  54. 

  55. This will work for all Drupal admin pages.

  56. 

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

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

  59. 

  60. 

  61. -- COFFEE COMMANDS --

  62. 

  63. Coffee provides default commands that you can use.

  64. 

  65. :add

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

  67. 

  68. -- COFFEE HOOKS --

  69. 

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

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

  72. 

  73. 

  74. -- CONTRIBUTORS --

  75. 

  76. Maintainer

  77. - Michael Mol 'michaelmol' 

  78. 

  79. Co-maintainer

  80. - Marco 'willzyx' 

  81. - Alli Price 'heylookalive' 

  82. - Oliver Köhler 'Nebel54'