summaryrefslogtreecommitdiffstats
path: root/README.txt
blob: 33b00099a47585d9323a6ee86e0948c6019a428f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
I. Installation
--------------------------------------
Install and enable the following modules, preferably using Drush:
* Context (7.x-3.0-beta2 and up) http://drupal.org/project/context
* Context UI (included as a sub-module in Context)
* Context Field (7.x-1.0-beta1 and up) http://drupal.org/project/context_field

* Boxes (7.x-1.0-beta5 and up) http://drupal.org/project/boxes
* Views (7.x-3.0-rc1 and up) http://drupal.org/project/views
* Ctools (7.x-1.0-rc1 and up) http://drupal.org/project/ctools
* Entity Autocomplete (7.x-1.0-beta1 and up) http://drupal.org/project/entity_autocomplete

* Views Boxes (7.x-1.0-beta4 and up) http://drupal.org/project/views_boxes
* Views Arguments Extras (7.x-1.0-beta1 and up) http://drupal.org/project/views_arguments_extras


II. Using Context Field
--------------------------------------
In this tutorial, we're going to enhance the basic page content type with
Context Field so that each new page will have its own automatically
created context.

* Go to /admin/structure/types and click 'manage fields' on Basic page.

* Add a new field of the Context type, and set the options dropdown to 
  Auto Create, then save.

* On the follow-up page, click 'Save field settings'.

* You'll then see a number of ways to configure how this specific field
  behaves. The Default Context is the one that ships with the module, 
  and we will set the use to 'Clone default context on Entity Creation', 
  meaning we'll a new copy of that one for each page we create.
  Alternatively, we can pick 'Always use Default Context' to essentially
  reference one specific context for all page nodes. Once you've decided
  on this, save your settings.

* Create and save a test page node.

* You'll notice the 'Configure layout' link when you view the node.
  If not, make sure that your role has the 'Use Context Field Editor'
  permission. Click on that link.

* You are now in context editing mode, with the editor widget to the
  right of your screen. You can now use the dropdown to filter on the
  category of block-type items that you can then drag and drop into
  the region of your choice. If you've used Context UI before, this
  should be familiar to you. For testing purposes, Select User in
  the dropdown then drag and drop "Who's Online" into the Featured
  region. The block will then render its contents.

* Any changes made to the currently selected context (viewable in
  the Context Field editor) will need to get saved by clicking 'Done'
  and then 'Save changes'. Should your current page have multiple
  contexts, you can edit a specific one by clicking the corresponding
  'Edit' button next to it in the editor.

* You can minimize the Context Editor by clicking its grey title bar,
  and you can get out of the context editing mode by clicking the 'X'.


III. Using Views Boxes with Context Field
--------------------------------------
Now let's make this interesting and use the Context Editor with
some Views Boxes.

III.A. Basic use:
--------------------------------------
* Enter a couple of article nodes (just set the titles for now).

* Make sure you have Views UI enabled and then create a new view
  (called list_articles) with a block display that returns the titles
  of your published articles.

* Go back to your test page and reclick 'Configure Layout'.

* Select Boxes in the editor's dropdown, and then drag and drop
  'Add custom view box' into a region.

* You'll be prompted to set the box's description (which is used
  for admin UI purposes) and its title (which is actually rendered
  and shown to end users). Set the title to <none> and the description
  to 'Views Box - Articles' and then click Continue.

* The 'View' dropdown shown then allows you to pick the block display
  you want this box instance to use. For now, we just have list_articles
  which doesn't have any exposed or contextual filters, so we can go
  ahead and save our settings.

* You'll now see your list of articles.

III.B. Exposed and contextual filters:
--------------------------------------
Views Boxes ships with some filters that are particularly useful for 
allowing extra levels of control over your view while still storing
the configuration data in the box itself. We're going to cover the ability
to curate this list_articles so that we can manually sort the article nodes
through the box. For this, we're going to install the Views Arguments Extras
module as it provides some filters that we'll need.

* Go edit the list_articles view.

* Add a contextual filter and select 'Content: Nid'. Before you save it,
  scroll down and open up the 'More' options.

* The administrative title can be used for two purposes: displaying what it
  is that we'll be selecting (Article nodes) to the admin when using the box,
  and to limit the autocomplete fields we'll have to specific entities and
  bundles. By default the autocomplete field will display all nodes, but if
  we want to restrict it to articles, we'd enter: 
  Article nodes [node] {bundles:article} here

* Check the 'Allow multiple values' option and save your changes.

* Add a sort criteria and select 'Arguments: Multi-item Argument Order'.
  This insures that we're actually sorting using the nodes we'll be selecting
  through the contextual filter in the box. Make sure that this sort criteria
  comes before the existing 'Content: Post date' and it's set to
  'sort descending'. Save your changes to the view and go back to your page
  node with the list_articles view block.

* Edit the box by clicking the gear icon that appears when you hover over it
  and then selecting 'Edit Box'. Notice that you don't necessarily need to be
  in Context Editor mode to edit existing boxes.

* You'll notice that you now get 'Article Nodes' under settings for the box,
  which allows you to pick article nodes using the autocomplete fields and to
  order them as you'd like. Once you're done with this, save the changes and
  you'll get your manually reordered list.

* You can reuse the same box instance or another page if you want to keep the
  same ordered list, but you can also create a new custom view box that reuses
  the same view display but with a different selection of nodes. This allows
  for a pretty powerful way to make views configurable through the box interface
  while still keeping the benefits of reusing the same displays (templates
  for examples). Other filters can be exposed too and used through the box
  interface, and having a view box filter on a specific taxonomy term can be
  achieved in a similar manner.

Documentation written by tirdadc - http://drupal.org/user/383630