You are here

README.txt in Views Fluid Grid 7.3

Same filename and directory in other branches
  1. 6 README.txt
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Views Fluid Grid
;; Original author: markus_petrux (http://drupal.org/user/39593)
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

CONTENTS OF THIS FILE
=====================
* OVERVIEW
* VIEWS INTEGRATION
* REQUIREMENTS
* INSTALLATION
* CUSTOMIZATION
  * TEMPLATES
  * STYLESHEETS
  * ADVANCED


OVERVIEW
========

This module provides the Fluid Grid style plugin for Views. This plugin displays
the view as a fluid grid using an HTML list element.

The plugin settings form provides options to define the width and height of the
elements in the grid. But it also provides advanced layout options implemented
in separate CSS classes that allow you to define item margins, alignment and a
couple of CSS3 properties (box-shadow and border-radius).


VIEWS INTEGRATION
=================

A fluid grid style plugin could be included in Views in the future. For further
information, please see the following issue in the Views queue:

http://drupal.org/node/377574


REQUIREMENTS
============

- Views 3.
  http://drupal.org/project/views


INSTALLATION
============

- Be sure to install all dependent modules.

- Copy all contents of this package to your modules directory preserving
  subdirectory structure.

- Go to Administer -> Site building -> Modules to install module.

- You can now start using the Fluid grid style plugin in your views.


CUSTOMIZATION - TEMPLATES
=========================

Please, see the "Theme: Information" option in Views UI. Information about
the template used by this style plugin is available under the "Style output"
entry.

The template shipped with the module is views-fluid-grid-plugin-style.tpl.php
located under the theme subdirectory of the package.


CUSTOMIZATION - STYLESHEETS
===========================

The following stylesheets are provided:

- views_fluid_grid.base.css

  It contains the base CSS classes to style the fluid grid.

- views_fluid_grid.size.css

  It contains additional CSS classes that are used to define the width and
  height of the items in the grid. These sizes are defined for each option
  in the settings form of the style plugin. If you need to add more sizes to
  the list, please see ADVANCED section below.

- views_fluid_grid.advanced.css

  If contains additional CSS classes to implement the advanced layout options
  available from the settings form of the style plugin. This file is loaded
  only if any of these advanced options are really used.


CUSTOMIZATION - ADVANCED
========================

You may want to use a different set of values for a few style plugin options.
To do so, you need to add the proper entries to your settings.php file.


// Custom options for Views Fluid Grid style plugin.
$conf['views_fluid_grid_plugin_style_widths'] = array(
  100,
  150,
  180,
  200,
  250,
  300,
  350,
  400,
  450,
  500,
);
$conf['views_fluid_grid_plugin_style_heights'] = array(
  100,
  150,
  200,
  250,
  300,
  350,
  400,
  450,
  500,
);
$conf['views_fluid_grid_plugin_style_margins'] = array(
  '0',
  '2px',
  '4px',
  '6px',
  '8px',
  '10px',
  '0.2em',
  '0.5em',
  '0.8em',
  '1em',
  '1.2em',
  '1.5em',
  '1.8em',
  '2em',
);
You can add more items to any of these variables to suit your needs. Then, you also need to provide the proper CSS classes. See the stylesheets shipped with this module to find out how these values match CSS classes. See examples for classes used for width and height in css/views_fluid_grid.size.css. Note that dots in $conf['views_fluid_grid_plugin_style_margins'] will be converted to dashes. See examples in css/views_fluid_grid.advanced.css. Examples:

/* This class is used for width 120. */
ul.views-fluid-grid-items-width-120 li.views-fluid-grid-item { width: 120px; }

/* This class is used for horizontal margin 0.6em. */
ul.views-fluid-grid-items-h-margin-0-6em li.views-fluid-grid-item { margin-left: 0.6em; margin-right: 0.6em; }

File

README.txt
View source
  1. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  2. ;; Views Fluid Grid
  3. ;; Original author: markus_petrux (http://drupal.org/user/39593)
  4. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  5. CONTENTS OF THIS FILE
  6. =====================
  7. * OVERVIEW
  8. * VIEWS INTEGRATION
  9. * REQUIREMENTS
  10. * INSTALLATION
  11. * CUSTOMIZATION
  12. * TEMPLATES
  13. * STYLESHEETS
  14. * ADVANCED
  15. OVERVIEW
  16. ========
  17. This module provides the Fluid Grid style plugin for Views. This plugin displays
  18. the view as a fluid grid using an HTML list element.
  19. The plugin settings form provides options to define the width and height of the
  20. elements in the grid. But it also provides advanced layout options implemented
  21. in separate CSS classes that allow you to define item margins, alignment and a
  22. couple of CSS3 properties (box-shadow and border-radius).
  23. VIEWS INTEGRATION
  24. =================
  25. A fluid grid style plugin could be included in Views in the future. For further
  26. information, please see the following issue in the Views queue:
  27. http://drupal.org/node/377574
  28. REQUIREMENTS
  29. ============
  30. - Views 3.
  31. http://drupal.org/project/views
  32. INSTALLATION
  33. ============
  34. - Be sure to install all dependent modules.
  35. - Copy all contents of this package to your modules directory preserving
  36. subdirectory structure.
  37. - Go to Administer -> Site building -> Modules to install module.
  38. - You can now start using the Fluid grid style plugin in your views.
  39. CUSTOMIZATION - TEMPLATES
  40. =========================
  41. Please, see the "Theme: Information" option in Views UI. Information about
  42. the template used by this style plugin is available under the "Style output"
  43. entry.
  44. The template shipped with the module is views-fluid-grid-plugin-style.tpl.php
  45. located under the theme subdirectory of the package.
  46. CUSTOMIZATION - STYLESHEETS
  47. ===========================
  48. The following stylesheets are provided:
  49. - views_fluid_grid.base.css
  50. It contains the base CSS classes to style the fluid grid.
  51. - views_fluid_grid.size.css
  52. It contains additional CSS classes that are used to define the width and
  53. height of the items in the grid. These sizes are defined for each option
  54. in the settings form of the style plugin. If you need to add more sizes to
  55. the list, please see ADVANCED section below.
  56. - views_fluid_grid.advanced.css
  57. If contains additional CSS classes to implement the advanced layout options
  58. available from the settings form of the style plugin. This file is loaded
  59. only if any of these advanced options are really used.
  60. CUSTOMIZATION - ADVANCED
  61. ========================
  62. You may want to use a different set of values for a few style plugin options.
  63. To do so, you need to add the proper entries to your settings.php file.
  64. @code
  65. // Custom options for Views Fluid Grid style plugin.
  66. $conf['views_fluid_grid_plugin_style_widths'] = array(100, 150, 180, 200, 250, 300, 350, 400, 450, 500);
  67. $conf['views_fluid_grid_plugin_style_heights'] = array(100, 150, 200, 250, 300, 350, 400, 450, 500);
  68. $conf['views_fluid_grid_plugin_style_margins'] = array('0', '2px', '4px', '6px', '8px', '10px', '0.2em', '0.5em', '0.8em', '1em', '1.2em', '1.5em', '1.8em', '2em');
  69. @endcode
  70. You can add more items to any of these variables to suit your needs. Then, you
  71. also need to provide the proper CSS classes. See the stylesheets shipped with
  72. this module to find out how these values match CSS classes. See examples for
  73. classes used for width and height in css/views_fluid_grid.size.css.
  74. Note that dots in $conf['views_fluid_grid_plugin_style_margins'] will be
  75. converted to dashes. See examples in css/views_fluid_grid.advanced.css.
  76. Examples:
  77. @code
  78. /* This class is used for width 120. */
  79. ul.views-fluid-grid-items-width-120 li.views-fluid-grid-item { width: 120px; }
  80. /* This class is used for horizontal margin 0.6em. */
  81. ul.views-fluid-grid-items-h-margin-0-6em li.views-fluid-grid-item { margin-left: 0.6em; margin-right: 0.6em; }
  82. @endcode