You are here

README.txt in Insert View 5

Same filename and directory in other branches
  1. 8 README.txt
  2. 6.2 README.txt
  3. 6 README.txt
  4. 7.2 README.txt
  5. 2.0.x README.txt
OVERVIEW
--------
The Views module allows administrators to create dynamic lists of content for
display in pages or blocks. It is possible to insert those lists into existing
node bodies and blocks, but such inclusion requires that PHP filtering be turned
on. The Insert View module allows any user to insert view listings using tag
syntax, without the need for PHP execution permissions. The Insert View tag
syntax for embedding a view is relatively simple:

[view:<name of view>] is replaced by the content listing corresponding to the
named view.

[view:<name of view>=<number>] limits the listing to a particular <number> of
entries.

[view:<name of view>=<number>=<comma-delimited-list>] limits the listing to a
particular <number> of entries, and passes a comma delimited list of arguments to the view.

Here's an example you could use with the default view named "tracker" which
takes a user ID as an argument:

[view:tracker=5=1]

In short this tag says, "Insert the view named tracker, limit the number of
results to 5, and supply the argument/user ID 1."

Sometimes you want to pass an argument without placing a limit on the number
of results. You can do that by leaving the <number> position empty, like so:

[view:<name of view>==<comma-delimited-list>]

You can use a pager with your view by using the following syntax (note:
you must set a limit which will serve as the number of nodes per page):

[view_pager:<name of view>=<number>].

INSTALLATION
------------
Extract and save the Insert View folder in your site's modules folder and enable it at
admin/build/modules. Obviously, it requires the Views module to do its magic.

Once Insert View is installed, visit the the input formats page at /admin/settings/filters
and click the "configure" link for the input format(s) for which you wish to enable the
Insert View Filter.  Then simply check the checkbox for the filter.

IMPORTANT PERFORMANCE NOTE: To dispaly views correctly, Insert View turns off caching for
the input formats for which it is enabled. That means every node using this input format
will not be cacheable. This can impact site performance. In these cases, it is recommended
to create a special input format for use when inserting views.

UPGRADING FROM A PREVIOUS VERSION?
----------------------------------
In previous versions of Insert View (including the 2008-Jan-11 development snapshot
and earlier) it was was not required to enable the Insert View filter for input formats
(by visiting the /admin/settings/filters pages) because Insert View was a pseudo filter
and used hook_nodeapi() rather than the filter system.

Insert View now runs as a classic Drupal filter module, and that means it now works
in blocks.  If you upgrade your site and find Insert View tags aren't working, please
visit /admin/settings/filters and enable the Insert View Filter for each input format
necessary.

File

README.txt
View source
  1. OVERVIEW
  2. --------
  3. The Views module allows administrators to create dynamic lists of content for
  4. display in pages or blocks. It is possible to insert those lists into existing
  5. node bodies and blocks, but such inclusion requires that PHP filtering be turned
  6. on. The Insert View module allows any user to insert view listings using tag
  7. syntax, without the need for PHP execution permissions. The Insert View tag
  8. syntax for embedding a view is relatively simple:
  9. [view:] is replaced by the content listing corresponding to the
  10. named view.
  11. [view:=] limits the listing to a particular of
  12. entries.
  13. [view:==] limits the listing to a
  14. particular of entries, and passes a comma delimited list of arguments to the view.
  15. Here's an example you could use with the default view named "tracker" which
  16. takes a user ID as an argument:
  17. [view:tracker=5=1]
  18. In short this tag says, "Insert the view named tracker, limit the number of
  19. results to 5, and supply the argument/user ID 1."
  20. Sometimes you want to pass an argument without placing a limit on the number
  21. of results. You can do that by leaving the position empty, like so:
  22. [view:==]
  23. You can use a pager with your view by using the following syntax (note:
  24. you must set a limit which will serve as the number of nodes per page):
  25. [view_pager:=].
  26. INSTALLATION
  27. ------------
  28. Extract and save the Insert View folder in your site's modules folder and enable it at
  29. admin/build/modules. Obviously, it requires the Views module to do its magic.
  30. Once Insert View is installed, visit the the input formats page at /admin/settings/filters
  31. and click the "configure" link for the input format(s) for which you wish to enable the
  32. Insert View Filter. Then simply check the checkbox for the filter.
  33. IMPORTANT PERFORMANCE NOTE: To dispaly views correctly, Insert View turns off caching for
  34. the input formats for which it is enabled. That means every node using this input format
  35. will not be cacheable. This can impact site performance. In these cases, it is recommended
  36. to create a special input format for use when inserting views.
  37. UPGRADING FROM A PREVIOUS VERSION?
  38. ----------------------------------
  39. In previous versions of Insert View (including the 2008-Jan-11 development snapshot
  40. and earlier) it was was not required to enable the Insert View filter for input formats
  41. (by visiting the /admin/settings/filters pages) because Insert View was a pseudo filter
  42. and used hook_nodeapi() rather than the filter system.
  43. Insert View now runs as a classic Drupal filter module, and that means it now works
  44. in blocks. If you upgrade your site and find Insert View tags aren't working, please
  45. visit /admin/settings/filters and enable the Insert View Filter for each input format
  46. necessary.