You are here

README.txt in Header image 7

Same filename and directory in other branches
  1. 5 README.txt
  2. 6 README.txt
This module allows you to display an image in a block where the selection
of the image is based on conditions per image.

Each image, included in a node, can be shown based on node id, path,
taxonomy, book or PHP code. Headerimage has an arbitrary content type to work
with.

Multiple images (nodes) can be displayed in one block, with each image
having its own conditions. Using a weight per node the order of selection
can be controlled.


-- INSTALLATION --

* Copy header image module to your modules directory and enable it on the
  admin modules page.

* Set access rights for admin and view on the access control page.

* If required create a content type to put your image in.
  Set content type(s) and conditions types on the header image settings page
  Structure > Header image > Settings

* Create one or more blocks for header image at the add block page.
  Structure > Header image > Add block

* Using the selected content type, upload one image into the node using an image
  field.
  Image header is designed to work with a node containing only one image.
  However with custom theming you can display any node content and any
  part of the node content. By default the node content without the
  title, taxonomy or links is shown in teaser view.

* Enter the display conditions to the node.
  Different type of conditions are available: node id, URL, taxonomy, etc.
  Select the conditions types you will use (site wide) on the header image
  settings page: Site configuration > Header image > Settings

  The header image node will be displayed when one of it's display conditions
  are met (evaluated to TRUE). Empty or not selected conditions are evaluated
  false.

  For testing purpose it may be convenient to show a block on all pages.
  See Troubleshooting below.

* Change the weight of the display condition to influence the order in which
  display conditions are evaluated from one node to another. For example,
  a header image node with weight 0 is evaluated before a header image with
  weight 1.

* Assign the block to the region of your choice in the Blocks administration
  page.
  Site building > Blocks


-- TROUBLESHOOTING --

* Use the condition weight to control the order in which the conditions are
  evaluated. The node with the smallest weight number will be evaluated
  first.
  Tip: To use one image as default give it a high weight (10) and a
  condition always evaluating to true.
  For example: path: '*' or PHP: <?php return true; ?>

* If the block is (partly) not visible, check the Display settings of your
  content type. Header image uses the teaser view or full view depending
  on the Teaser setting.
  Administer > Content management > Content types > MyHeaderImageContentType > Display fields


-- THEMING --

* By default the block will show the content of the node, without the
  title, taxonomy or links. The node is shown in teaser view or full view
  depending on the Teaser setting.


-- AUTHOR --

Erik Stielstra
For contact: http://drupal.org/user/73854

File

README.txt
View source
  1. This module allows you to display an image in a block where the selection
  2. of the image is based on conditions per image.
  3. Each image, included in a node, can be shown based on node id, path,
  4. taxonomy, book or PHP code. Headerimage has an arbitrary content type to work
  5. with.
  6. Multiple images (nodes) can be displayed in one block, with each image
  7. having its own conditions. Using a weight per node the order of selection
  8. can be controlled.
  9. -- INSTALLATION --
  10. * Copy header image module to your modules directory and enable it on the
  11. admin modules page.
  12. * Set access rights for admin and view on the access control page.
  13. * If required create a content type to put your image in.
  14. Set content type(s) and conditions types on the header image settings page
  15. Structure > Header image > Settings
  16. * Create one or more blocks for header image at the add block page.
  17. Structure > Header image > Add block
  18. * Using the selected content type, upload one image into the node using an image
  19. field.
  20. Image header is designed to work with a node containing only one image.
  21. However with custom theming you can display any node content and any
  22. part of the node content. By default the node content without the
  23. title, taxonomy or links is shown in teaser view.
  24. * Enter the display conditions to the node.
  25. Different type of conditions are available: node id, URL, taxonomy, etc.
  26. Select the conditions types you will use (site wide) on the header image
  27. settings page: Site configuration > Header image > Settings
  28. The header image node will be displayed when one of it's display conditions
  29. are met (evaluated to TRUE). Empty or not selected conditions are evaluated
  30. false.
  31. For testing purpose it may be convenient to show a block on all pages.
  32. See Troubleshooting below.
  33. * Change the weight of the display condition to influence the order in which
  34. display conditions are evaluated from one node to another. For example,
  35. a header image node with weight 0 is evaluated before a header image with
  36. weight 1.
  37. * Assign the block to the region of your choice in the Blocks administration
  38. page.
  39. Site building > Blocks
  40. -- TROUBLESHOOTING --
  41. * Use the condition weight to control the order in which the conditions are
  42. evaluated. The node with the smallest weight number will be evaluated
  43. first.
  44. Tip: To use one image as default give it a high weight (10) and a
  45. condition always evaluating to true.
  46. For example: path: '*' or PHP:
  47. * If the block is (partly) not visible, check the Display settings of your
  48. content type. Header image uses the teaser view or full view depending
  49. on the Teaser setting.
  50. Administer > Content management > Content types > MyHeaderImageContentType > Display fields
  51. -- THEMING --
  52. * By default the block will show the content of the node, without the
  53. title, taxonomy or links. The node is shown in teaser view or full view
  54. depending on the Teaser setting.
  55. -- AUTHOR --
  56. Erik Stielstra
  57. For contact: http://drupal.org/user/73854