View File | Revision Log | Show Annotations | Download File | View Changeset
/hippo/hippo-cms7/plugins/content-tagging/trunk/README
Revision: 47606
Committed: Tue Dec 16 14:56:56 2014 UTC (6 years, 1 month ago) by adouma
File size: 4148 byte(s)
Log Message:
HIPPLUG-970: cleanup and new maven configuration of standard Hippo Plugin Content Tagging

File Contents

# Content
1 ===================================================
2 Hippo Plugin Content Tagging
3 ===================================================
4
5 About
6 ==========
7 The content tagging plugin contains multiple plug-ins to work with tags.
8 It contains:
9 - A tagcloud for browsing your documents based on tags
10 - A plug-in for adding tags to documents
11 - A plug-in based system for suggesting tags (TagSuggestor)
12 - A plug-in for suggesting tags for the current document
13
14 You can use the plug-in for adding tags and the tagcloud seperate and without the others.
15 The plug-in for suggesting tags of the current document has a dependy on the TagSuggestor.
16
17
18 How to use
19 ==========
20 - Add an dependency to your quickstart/war/pom.xml by adding the following
21 to your <dependecies> section:
22
23 <!-- tagging addon -->
24 <dependency>
25 <groupId>org.hippo.cms7</groupId>
26 <artifactId>hippo-plugin-content-tagging</artifactId>
27 <version>4.09.00-SNAPSHOT</version>
28 <type>jar</type>
29 </dependency>
30
31 Next start your application (quickstart/war).
32
33 === Activating the tagcloud ===
34 - Use the console to navigate to "/hippo:configuration/hippo:frontend/cms/cms-browser/browserPlugin"
35 - Now add "extension.tagcloud" to the wicket.extensions property
36 - Also add a new property "extension.tagcloud" with value "service.browse.tagcloud" (String)
37 - Be sure to save your changes and you are done.
38
39 === Content ===
40 The content type you what to tag should have the mixin hippostd:taggable. You do not have to
41 define a property hippostd:tags in the prototype as the plugin will try to create it by itself,
42 but it won't do harm either.
43
44 By default it will try to add the template plug-ins to the default content article. You can copy the
45 nodes to the same location of other content types to enable tagging there.
46
47 Example:
48 [defaultcontent:taggablenews] > hippostd:taggable, hippo:document, hippostd:publishable, hippostd:publishableSummary
49 - defaultcontent:title (string)
50 - defaultcontent:date (date)
51 - defaultcontent:introduction (string)
52 + defaultcontent:body (hippostd:html)
53 + defaultcontent:internallink (hippo:facetselect)
54
55 Background
56 ==========
57 === Tags (Input) plug-in ===
58 This is a simple Wicket plug-in that sets a value on a document.
59
60 === Tags suggestion plug-in ===
61 This is a simple Wicket plug-in that draw's the results of the TagSuggestor in a sorted tagcloud.
62 Hence it shares some code with the TagCloud plug-in.
63
64 === TagSuggestor ===
65 The main purpose of the TagSuggestor is to act as a central point of communication. All outside
66 resources interface with the TagSuggestor. The TagSuggestor than relay's the request to all the
67 TagProviders. All the TagProviders return to the TagSuggestor who in turn returns to the calling
68 resource. The result is that off all TagProviders combined.
69
70 TagProviders all extend from the AbstractTagsProvider and thus implement the ITagsProvider interface.
71 Every TagProvider receives the document from the TagSuggestor for inspection and can do it's own magic
72 to search for tags. All TagProviders must return their suggestion in a TagCollection.
73
74 === Tagcloud ===
75 The tagcloud plug-in consists of:
76 - TagCloudPlugin class. This is the plug-in and the Wicket component that draws the tagcloud
77 - A DocumentListingPlugin and DocumentsProvider. These are necessary to lookup the the handle's
78 from the documents returned by the Facetsearch.
79
80
81 TODO
82 ==========
83 - expand configuration options. At the moment you can configure the score given to the individual
84 tags, but you could also add configuration options for the collection as a whole. The code for
85 that is already there. Just need to add the property in the console and read it in the constructor.
86 Also the names under with the suggestor and the providers register could be made configurable in
87 the console. This would make it easy to use multiple suggestors simultaneously with different
88 configurations.
89 - make the TagCloud pageable so it will be possible to reach less popular tags
90 - make adding tag (input & suggesting) plug-ins to content available in GUI (template editor)
91
92
93 Bugs
94 ==========
95 Please report all bugs to JIRA https://issues.onehippo.com/browse/HIPPLUG
96

Properties

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