Stripping CVS keywords
[project/insert_view.git] / README.txt
1 SECURITY WARNING
2 ----------------
3 This filter is powerful, therefore it should be granted to trusted users only.
4 If you allow this filter to untrusted users, then you have to make sure that
5 EVERY VIEW EVERY DISPLAY (default display also!) has correct views access
6 settings.
7
8 OVERVIEW
9 --------
10 Insert view filter allows to embed views using tags. The tag syntax is
11 relatively simple: [view:name=display=args]. The parameters are: view name, view
12 display id, view arguments. For example [view:tracker=page=1] says, embed a view
13 named "tracker", use the "page" display, and supply the argument "1". The
14 display and args parameters can be omitted. If the display is left empty, the
15 view's default display is used. Multiple arguments are separated with slash. The
16 args format is the same as used in the URL (or view preview screen).
17
18 Valid examples:
19 [view:my_view]
20 [view:my_view=my_display]
21 [view:my_view=my_display=arg1/arg2/arg3]
22 [view:my_view==arg1/arg2/arg3]
23
24 HOW TO FIND A DISPLAY ID
25 ------------------------
26 On the edit page for the view in question, you'll find a list of displays at the
27 left side of the control area. "Defaults" will be at the top of that list. Hover
28 your mouse pointer over the name of the display you want to use. A URL will
29 appear in the status bar of your browser.  This is usually at the bottom of the
30 window, in the chrome. Everything after #views-tab- is the display ID. For
31 example in http://localhost/admin/build/views/edit/tracker?destination=node%2F51#views-tab-page
32 the display ID would be "page".
33
34 INSTALLATION
35 ------------
36 Extract and save the insert_view folder in your site's modules folder and enable
37 it at admin/build/modules. Obviously, it requires the Views module to do its
38 magic.
39
40 Once Insert view is installed, visit the the input formats page at
41 /admin/settings/filters and click the "configure" link for the input format(s)
42 for which you wish to enable the Insert view filter. Then simply check the
43 checkbox for the filter.
44
45 PERFORMANCE
46 -----------
47 To display views correctly, Insert view turns off caching for the input formats
48 for which it is enabled. That means every node using this input format will not
49 be cacheable. This can impact site performance. In these cases, it is
50 recommended to create a special input format for use when inserting views.