View File | Revision Log | Show Annotations | Download File | View Changeset
/hippo/attic/forge/dropdown-plugin/tags/dropdown-plugin-1.03.00/src/site/xdoc/configuration.xml
Revision: 58756
Committed: Thu Mar 2 13:00:33 2017 UTC (3 years, 2 months ago) by jhoffman
Content type: text/xml
File size: 4103 byte(s)
Log Message:
Moved project from forge.onehippo.org/svn/ without history

File Contents

# Content
1 <?xml version="1.0"?>
2 <!--
3 Licensed to the Apache Software Foundation (ASF) under one or more
4 contributor license agreements. See the NOTICE file distributed with
5 this work for additional information regarding copyright ownership.
6 The ASF licenses this file to You under the Apache License, Version 2.0
7 (the "License"); you may not use this file except in compliance with
8 the License. You may obtain a copy of the License at
9
10 http://www.apache.org/licenses/LICENSE-2.0
11
12 Unless required by applicable law or agreed to in writing, software
13 distributed under the License is distributed on an "AS IS" BASIS,
14 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 See the License for the specific language governing permissions and
16 limitations under the License.
17 -->
18 <document>
19 <properties>
20 <title>Getting Started</title>
21 <subtitle>Getting up and running quickly</subtitle>
22 </properties>
23 <body>
24 <section name="Configuration">
25 <p>
26 With this generic plugin, we can easily customize the property editing user experiences
27 by providing a property editor plugin based on each document type.
28 </p>
29 </section>
30 <section name="StaticDropdown configuration">
31 <p>
32 After you install this plugin, if you edit a document type in the CMS,
33 then you can now add 'StringChoice' type into the document type.
34 Add a 'StringChoice' type to the document type and save the changes.
35 </p>
36 <p>
37 Now, in the cms console, navigate the document type template node.
38 For example, if your document type is 'gettingstarted:textpage',
39 then you need to navigate to /hippo:namespaces/gettingstarted/textpage/editor:templates/_default_.
40 Under it there must be a child node defining your StringChoice, having a child node, 'cluster.options'.
41 Navigate to 'cluster.options' child node of the node, and add a property, named 'selectable.options'
42 with a comma-delimited string.
43 </p>
44 <p>
45 For example, I have the StringChoice type node at "/hippo:namespaces/gettingstarted/textpage/editor:templates/_default_/names",
46 and it has a "cluster.options" child node.
47 So, I add a property, "selectable.options" in the "cluster.options" child node with value, "Ard, Arthur".
48 </p>
49 <p>
50 Save all changes, and try the document type editing in CMS and update all contents.
51 </p>
52 </section>
53 <section name="DynamicDropdown configuration">
54 <p>
55 Somewhere in the repository content, a document of type 'dropdown:valuelist' should be set up
56 containing your wanted key/label pairs.
57 </p>
58 <p>
59 In the document namespace, nodetype section, the hipposysedit:type property of your field
60 should be set to DynamicDropdown.
61 </p>
62 <p>
63 In the document namespace, editor section, the 'cluster.options' node of your field
64 should contain a String property 'source' that points to the value list applicable.
65 It should be a absolulte path starting with '/' or a UUID of the valuelists handle.
66 </p>
67 </section>
68 <section name="DynamicMultiSelect configuration">
69 <p>
70 Somewhere in the repository content, a document of type 'dropdown:valuelist' should be set up
71 containing your wanted key/label pairs.
72 </p>
73 <p>
74 In the document namespace, editor section, your field should have:
75 </p>
76 <ul>
77 <li>property 'plugin.class' should be 'org.onehippo.forge.cms.frontend.plugin.DynamicMultiSelectPlugin'</li>
78 <li>property 'valuelist.provider' should be 'service.valuelist.default' (if you're using the default)</li>
79 <li>the 'valuelist.options' node of your field should contain a String property 'source' that points
80 to the value list applicable.</li>
81 </ul>
82 <p>There is also an optional property 'selectlist.maxrows' defining the maximum number of rows in your
83 multiselect (defaulting to 8).
84 </p>
85 </section>
86 </body>
87 </document>

Properties

Name Value
svn:eol-style native
svn:keywords Id