-
Notifications
You must be signed in to change notification settings - Fork 0
/
help.html
248 lines (248 loc) · 18.4 KB
/
help.html
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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
<!DOCTYPE html>
<html lang="en">
<head>
<script type="text/javascript" src="//code.jquery.com/jquery-1.11.0.min.js"></script>
<script type="text/javascript" src="//cdnjs.cloudflare.com/ajax/libs/jquery-cookie/1.3.1/jquery.cookie.min.js"></script>
<script type="text/javascript" src="//cdnjs.cloudflare.com/ajax/libs/underscore.js/1.5.1/underscore-min.js"></script>
<script type="text/javascript" src="//cdnjs.cloudflare.com/ajax/libs/backbone.js/1.0.0/backbone-min.js"></script>
<script type="text/javascript" src="//cdn.worldsecuresystems.com/bcapi/bcapi-0.1.0.min.js"></script>
<script src="https://ajax.cdnjs.com/ajax/libs/json2/20110223/json2.js"></script>
<script src="/_System/Apps/digifuel-review/assets/scripts/help-1.0.0.min.js"></script>
<script src="/_System/Apps/digifuel-review/assets/scripts/review-1.0.6.min.js"></script>
<link rel="stylesheet" href="/_System/Apps/digifuel-review/assets/css/review-1.0.6.min.css">
<link rel="stylesheet" type="text/css" href="/_System/Apps/digifuel-review/public/reviews.css"/>
</head>
<body id="help-pg">
<div id="v3main" class="v3panel">
<ul id="hybridSubmenu">
<li><a id="tab-reviews" href="/_System/Apps/digifuel-review/index.html">Reviews</a> </li>
<li><a id="tab-edit" href="/_System/Apps/digifuel-review/edit.html">Edit Review</a> </li>
<li class="app-help"><a id="tab-help" href="/_System/Apps/digifuel-review/help.html"><span class="bcicon bcicon-help-solid"></span><span class="help-item-text">Help</span></a> </li>
</ul>
</div>
<div id="container-body" class="app-help">
<form method="post" id="hybridForm" class="clear">
<h2 class="hybridFormHeader"> <span class="hybridFormTitlewrap">Review v1.0.6</span> </h2>
<div>
<p>Review is a customer submitted reviews App that allows you to easily insert a customer review functionality into your websites pages, products and web apps.</p>
</div>
</form>
<form method="post" id="hybridForm" class="clear">
<h2 class="hybridFormHeader hybridFormExpand"> <span class="hybridFormTitlewrap">Create a Review</span> </h2>
<div>
<ol>
<li>Open the BC CMS then navigate to the Customer Reviews App in the left menu and click the icon.</li>
<li>Click + Add a Review App to create a customer submitted review.</li>
<li>Enter the name you want the customer review to be called.</li>
<li>Choose your customer reviews permission. IMPORTANT to enable the Allow Anonymous Reviews feature read the Review Permission section for details.</li>
<li>Use the form builder to add, remove and rearrange the features you want in your review.</li>
<li>Click "Create Review" to create your review.</li>
<li>Insert the customer review into your website using Liquid tags. Refer to ‘Inserting a Review’ below.</li>
<li><span class="glyphicon glyphicon-eye-close"></span> and <span class="glyphicon glyphicon-eye-open"></span> signify an items visibility to users (Click to toggle items visibility).</li>
</ol>
</div>
</form>
<form method="post" id="hybridForm" class="clear">
<h2 class="hybridFormHeader hybridFormExpand"> <span class="hybridFormTitlewrap">Insert a Review</span> </h2>
<div>
<ol>
<li>First you will need to make sure the Customer Reviews jQuery is referenced on the page or page template you are adding the customer review too. <br />
Apply the following JQuery script ref immediately before the closing body tag on any page you wish to add a customer review.
<pre><code><script type="text/javascript" src="/_System/Apps/digifuel-review/public/reviews.js"></script></code></pre>
<br />
JQuery is a required to use the Customer Review App and you will need to be using v1.7 or later. For instructions on installing JQuery in BC refer to <a href="https://forums.adobe.com/docs/DOC-2964">Using jQuery with BC - A good approach.</a> If you are upgrading your sites jquery refer to this page for feature that may have been deprecated. <a href="https://api.jquery.com/category/deprecated">Jquery Deprecated code</a></li>
<li>Copy and paste each snippet of Liquid code from the ‘Inserting Review’ section of your Customer Review into the HTML where you wish it to be situated on the page.<br />
<div> <strong>Star Rating Bar: </strong>Contains the rating star icons, average rating value out of 5 & reviews submitted value.</div>
<div class="starBar stars">
<div class="form-rating selected">1</div>
<div class="form-rating selected">2</div>
<div class="form-rating selected">3</div>
<div class="form-rating">4</div>
<div class="form-rating">5</div>
</div>
<div class="starBar"> <span class="average"> 3</span> out of <span class="best">5</span> based on <span data-sum="14" class="votes">4</span> reviews.</div>
<div class="clear"> <strong>Review List View: </strong>Gives you a list of the reviews made by customers with their comments and ratings.
<div class="review-item">
<div class="review">
<div class="starRatings">Rating: 3
<div class="rating star3"></div>
<div class="rating noStar3"></div>
</div>
<div class="item"><span>Comment </span>The customer submitted review goes in here.</div>
<div class="item"><span>Email </span>[email protected]</div>
<div class="item"><span>Name </span>Daniel Telfer</div>
<div class="item"><span>Location </span>New Zealand</div>
<div class="altRatings"><span>Product Quality </span>Rating: 4
<div class="rating star4"></div>
<div class="rating noStar4"></div>
</div>
<div class="altRatings"><span>Product Value </span>Rating: 4
<div class="rating star4"></div>
<div class="rating noStar4"></div>
</div>
</div>
<div class="review-meta"><span class="custName">Mr Daniel Telfer</span> - 10-Aug-2014</div>
</div>
</div>
<div class="clear"> <strong>Review Form: </strong>Contains the editable form that customers will use to add their reviews.
<div id="reviewForm">
<div class="item review-rating">
<div class="form-rating selected">1</div>
<div class="form-rating selected">2</div>
<div class="form-rating selected">3</div>
<div class="form-rating">4</div>
<div class="form-rating">5</div>
<div id="yourrating">3 Stars</div>
<div class="rating-select">
<input type="text" maxlength="4000" name="CAT_Custom_1000" id="CAT_Custom_1000" class="cat_textbox ratingSelect" data-role="none">
</div>
</div>
<div class="item">
<label for="ItemDescription">Title</label>
<input type="text" maxlength="4000" name="CAT_Custom_1022" id="CAT_Custom_1022" class="cat_textbox" data-role="none">
</div>
<div class="item">
<label for="ItemDescription">Your Review</label>
<textarea name="ItemDescription" id="ItemDescription" cols="10" rows="4" class="cat_listbox"></textarea>
</div>
<div class="item">
<label for="CAT_Custom_1030">Email Address</label>
<input type="text" maxlength="4000" name="CAT_Custom_1030" id="CAT_Custom_1030" class="cat_textbox" data-role="none">
</div>
<div class="item title">
<label for="CAT_Custom_1042">Title</label>
<select name="CAT_Custom_1042" id="CAT_Custom_1042" class="cat_dropdown">
<option value=" ">-- Please select --</option>
<option value="Dr">Dr</option>
<option value="Miss">Miss</option>
<option value="Mr">Mr</option>
<option value="Mrs">Mrs</option>
<option value="Ms">Ms</option>
</select>
</div>
<div class="item">
<label for="CAT_Custom_1040">Name</label>
<input type="text" maxlength="4000" name="CAT_Custom_1040" id="CAT_Custom_1040" class="cat_textbox customerName" data-role="none">
</div>
<div class="item">
<label for="CAT_Custom_1050">Location</label>
<input type="text" maxlength="4000" name="CAT_Custom_1050" id="CAT_Custom_1050" class="cat_textbox" data-role="none">
</div>
<div class="item checkbox">
<label for="CAT_Custom_1060">Recommend this Product</label>
<input type="checkbox" name="CAT_Custom_1060" id="CAT_Custom_1060" value="1" data-role="none">
</div>
<div class="item item-rating">
<label for="CAT_Custom_1070">Product Quality</label>
<div class="form-rating alt selected">1</div>
<div class="form-rating alt selected">2</div>
<div class="form-rating alt selected">3</div>
<div class="form-rating alt">4</div>
<div class="form-rating alt">5</div>
<div class="rating-select">
<input type="text" maxlength="4000" name="CAT_Custom_1070" id="CAT_Custom_1070" class="cat_textbox ratingSelect" data-role="none">
</div>
</div>
<div class="item item-rating">
<label for="CAT_Custom_1080">Product Value</label>
<div class="form-rating alt selected">1</div>
<div class="form-rating alt selected">2</div>
<div class="form-rating alt selected">3</div>
<div class="form-rating alt">4</div>
<div class="form-rating alt">5</div>
<div class="rating-select">
<input type="text" maxlength="4000" name="CAT_Custom_1080" id="CAT_Custom_1080" class="cat_textbox ratingSelect" data-role="none">
</div>
</div>
<input class="cat_button" type="submit" value="Submit" id="catcustomcontentbutton" data-role="none">
</div>
</div>
</li>
<li>Style the Customer Review layout using the CSS located here "/_System/Apps/digifuel-review/public/reviews.css".</li>
<li>Turn on Liquid in the BC Admin under Site Setting / Beta Features. Check the Module Named Parameters & Liquid Markup check boxes.</li>
</ol>
</div>
</form>
<form method="post" id="hybridForm" class="clear">
<h2 class="hybridFormHeader hybridFormExpand"> <span class="hybridFormTitlewrap">Edit a Review</span> </h2>
<div>
<ol>
<li>Open the BC CMS then navigate to the Customer Review App and click.</li>
<li>Select the review from the menu you wish to edit.</li>
<li>Edit, add, remove and rearrange the review</li>
<li>Click Save.</li>
</ol>
</div>
</form>
<form method="post" id="hybridForm" class="clear">
<h2 class="hybridFormHeader hybridFormExpand"> <span class="hybridFormTitlewrap">Review Permissions</span> </h2>
<div>
<ol>
<li>Requires Approval - If enabled each review submitted will need to be enabled before it can be viewed on the site. <br /><strong>Enable Review</strong> - Open the Reviews tab in the Customer Reviews Admin app select a review with where the "View" link is red. "View" links in red signify disbaled reviews. Click the "View" link to open the review and check the enable checkbox. <br /><strong>Disable Review</strong> - to disable a review open the review in the admin app with the "View" link and uncheck the enable checkbox.</li>
<li>Allow Anonymous Reviews - If enabled this allows user that are not logged into to add reviews to the site. <br /><strong>Activate Anonymous Reviews</strong> - Navigate to the CRM Search feature in the BC admin and search "Anonymous". The full user name you are looking for is "Anonymous Reviews" open this user and click the edit button. In the Password field enter this password "<strong>dvjoKb9BCHA1</strong>" without the quotes and click save. This feature is now enabled for this site.</li>
</ol>
</div>
</form>
<form method="post" id="hybridForm" class="clear">
<h2 class="hybridFormHeader hybridFormExpand"> <span class="hybridFormTitlewrap">Rich Snippets - Structured Data</span> </h2>
<div>
<ul>
<li>Customer Reviews app uses <a href="http://schema.org/">schema.org</a> structured data to support better search engine visibility.</li>
<li>By default Customer Reviews uses the aggregated review schema embedded inside a products schema. If you have a different schema you wish to use then the Customer Review Schema can be found and edited in this directory on your site "/_System/Apps/digifuel-review/public/reviews-schema.tpl" more on schema's can be found here at <a href="http://schema.org/">schema.org</a> or <a href="https://developers.google.com/structured-data">Google's Strutured Data</a>. Test your structured data with <a href="https://developers.google.com/structured-data/testing-tool/">Google's Strutured Data Testing Tool</a>.</li>
<li>Customer Reviews default structured data - Product name, description & image / Aggregated Reviews ratingCount & ratingValue.</li>
</ul>
</div>
</form>
<form method="post" id="hybridForm" class="clear">
<h2 class="hybridFormHeader hybridFormExpand"> <span class="hybridFormTitlewrap">Requirements/Limitations</span> </h2>
<div>
<p><strong>Requirements: </strong>This app requires that JQuery is installed and ‘Page Referrer’ is not disabled in the web browser.</p>
<p><strong>Limitations: </strong>Some features of this app are limited by BC Open Admin API’s either by being currently available or limited. As these API’s are made available updates will add features and rectify some of the current limitation.</p>
<ul>
<li>Reviews cannot be renamed</li>
<li>The "Requries Aprroval" setting cannot be altered once an app is created. </li>
<li>Page referrer must be turned on in the browser</li>
</ul>
</div>
</form>
<form method="post" id="hybridForm" class="clear">
<h2 class="hybridFormHeader hybridFormExpand"> <span class="hybridFormTitlewrap">Troubleshooting</span> </h2>
<div>
<div class="Q expand"><a>I have updated the app from the BC appstore and the app is no longer working.</a></div>
<div class="A">
<p>If you have updated the app to a version 1.0.6 or greater then you will need to first go to each review app and update by clicking save in the edit review tab then replacing the liquid on any page the app is installed with the new liquid tags. You will also need to replace the reviews.js the review app is referencing on any page review is installed or on the template or content holder it was placed to <pre><code><script type="text/javascript" src="/_System/Apps/digifuel-review/public/reviews.js"></script></code></pre>.</p>
</div>
<div class="Q expand"> <a>My customers reviews are not showing in the reviews tab. </a></div>
<div class="A">
<p>Usually this would mean that jQuery and or review.js is not installed correctly on the page the customer review is inserted on. Refer to the section above ‘Inserting a Review’ to make sure all the elements required are on the page.</p>
</div>
<div class="Q expand"><a>I cannot rename a review.</a></div>
<div class="A">
<p>Unfortunately you cannot rename the review app in this version. This feature will hopefully be added in a future version as BC Open Admin adds more API’s.</p>
</div>
<div class="Q expand"><a>I get an error telling me that ‘Page referrer is blocked’. </a></div>
<div class="A">
<p>This error occurs when the browser you are using has the Page Referrer blocked. To fix this try using another browser or search how to re enable ‘Page Referrer’ in the browser you are using. This requirement will hopefully be lifted as BC Open Admin adds more features. </p>
</div>
<div class="Q expand"><a>I have tried everything and the Review App is just not working. </a></div>
<div class="A">
<p>If you have tried everything and the Customer Reviews app is just not working then contact [email protected] for assistance.</p>
</div>
</div>
</form>
<form method="post" id="hybridForm" class="clear">
<h2 class="hybridFormHeader hybridFormExpand"> <span class="hybridFormTitlewrap">Uninstall App</span> </h2>
<div>
<p><strong>NOTE: </strong>UNINSTALL will delete all the Customer Reviews app settings. However it will not delete the webapps that contain the database of reviews and their information.</p>
<p>
<button id = "uninstall-app" class="btn btn-danger" onclick="uninstallApp()">Uninstall</button>
</p>
<p><strong>WARNING: </strong>DELETE will delete all the Customer Reviews app settings and all the webapps that contain the database of reviews and their information. This process cannot be undone.</p>
<p>
<button id = "delete-app" class="btn btn-danger" onclick="deleteApp()">Delete</button>
</p>
</div>
</form>
</div>
</body>
</html>