forked from imeji-community/imeji_sass
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathhelp.html
346 lines (315 loc) · 16.7 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
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
<p>
<h2 class="imj_sectionHeadline">Start with imeji</h2>
<a href="#Register">Register</a><br/>
<a href="#change_password">Change my password</a><br/>
<a href="#forgot_password">Forgot my password</a><br/>
</p>
<p>
<h2 class="imj_sectionHeadline">Manage my collection</h2>
<a href="#Create_Collection">Create</a><br/>
<a href="#Edit_Collection_Metadata">Edit informations</a><br/>
<a href="#Share_Collection">Share</a><br/>
<a href="#Release_Collection">Release</a><br/>
<a href="#Delete__Discard_Collection">Delete / Discard</a><br/>
<a href="#Assign_DOI_to_Collection">Assign a DOI</a><br/>
<a href="#Cite_Collection">Cite</a><br/>
</p>
<p>
<h2 class="imj_sectionHeadline">Manage my items</h2>
<a href="#upload">Upload files</a><br/>
<a href="#edit_item">Describe (<a href="#edit_item_single">One item</a> - <a href="#edit_item_selected">Many items</a> - <a href="#edit_item_all">All collection's items</a>)</a><br/>
<a href="#edit_license">Add license</a><br/>
<a href="#delete_item">Delete / Discard</a><br/>
<a href="#move_item">Move to another collection</a><br/>
</p>
<p>
<h2 class="imj_sectionHeadline">Search</h2>
<a href="#simple_search">Simple search</a><br/>
<a href="#advanced_search">Advanced search</a><br/>
</p>
<p>
<h2 class="imj_sectionHeadline">Contact us</h2>
For further support, please contact the
<span style="font-style: italic;"><a href="mailto:XXX_SUPPORT_EMAIL_XXX">support team</a></span>.
</p>
<hr style="width: 100%; height: 1px;">
<h3 class="imj_sectionHeadline" style="padding:0"><a name="Register"></a>Register</h3>
<ol style="padding:0 0 0.5em 2%">
<li>1. Go to <a href="./register" target="_blank">the registration page</a></li>
<li>2. Fill the form with at least, your email, you family name and your organization and click on <i>Register now</i></li>
<li>3. Open you e-mail client and click on the confirmation link</li>
<li>4. On the confirmation page, enter the password as sent in the confirmation e-mail</li>
</ol>
<br/>
<h3 class="imj_sectionHeadline" style="padding:0"><a name="change_password"></a>Change my password</h3>
<span style="text-decoration: underline">Note</span>: You first need to log in.
<ol style="padding:0 0 0.5em 2%">
<li>1. Go to your <i>user page</i> by clicking on your user name on the top of the page</li>
<li>2. Enter your new password in both <i>New password</i> and <i>Repeat password</i></li>
<li>3. Click on <i>Change password</i></li>
</ol>
<br/>
<h3 class="imj_sectionHeadline" style="padding:0"><a name="forgot_password"></a>Forgot my password</h3>
Please contact the <span style="font-style: italic;"><a href="mailto:XXX_SUPPORT_EMAIL_XXX">support team</a></span>.
<br/>
<br/>
<a href="#"><span style="font-style: italic;">top</span></a><br/>
<hr style="width: 100%; height: 2px;">
<br/>
<h3 class="imj_sectionHeadline" style="padding:0"><a name="Create_Collection"></a>Create a Collection</h3>
<span style="text-decoration: underline">Note</span>: Users require the appropriate
authorization to create new collections. Please contact the
<span style="font-style: italic;"><a href="mailto:XXX_SUPPORT_EMAIL_XXX">support team</a></span>
with any question regarding your account.</p>
<ul style="padding:0.5em 2%">
<li>1. Go to <a href="./collections?q=" target="_blank">the collections page</a> and click on <i>New collection</i>
<li>2. Enter the required information (collection name, author name and organization).
Information on further authors and a description of the collections content
can be added optionally.</li>
<li>3. Via the plus (and minus) buttons, further fields for authors and organizations
can be added (or removed).</li>
<li>4. <span style="font-style: italic;">Save</span>.</li>
</ul>
<h3 class="imj_sectionHeadline" style="padding:0"><a name="Edit_Collection_Metadata"></a>Edit the Collection information</h3>
<ul style="padding:0.5em 2%">
<li>1. Go to the collection you want to edit</li>
<li>2. In the menu <i>Collection</i>, click on <i>Edit information</i></li>
<li>3. Modify the values you wish to update and <i>save</i></li>
</ul>
<h3 class="imj_sectionHeadline" style="padding:0"><a name="Share_Collection"></a>Share a Collection</h3>
<ul style="padding:0.5em 2%">
<li>1. Go to the collection you want to share</li>
<li>2. In the menu <i>Collection</i>, click on <i>Share</i></li>
<li>3. Click on
<ul style="padding:0.5em 2%">
<li>a. <i>Share with a user:</i> Enter the email(s) (separated by a semicolon) of the user you want to share with</li>
<li>b. [If available] <i>Share with a user group:</i> Select one user group from the list</li>
</ul>
</li>
<li>4. Select the permission of the user(s) / user group:
<ul style="padding:0.5em 2%">
<li>a. <i>Read:</i> Can view and download the files, the metadata and the collection informations</li>
<li>b. <i>Edit</i> In addition to the Read permission, can upload and delete a file, edit metadata and the licenses of the item, edit the collection informations</li>
<li>c. <i>Admin</i> In addition to the Edit permission, can share, release and delete the collection</li>
</ul>
</li>
<li>5. Share</li>
</ul>
<h3 class="imj_sectionHeadline" style="padding:0"><a name="Release_Collection"></a>Release a Collection</h3>
<span style="text-decoration: underline">Note</span>: You can only
release private collections. A release makes the collection and all
included items visible to the public. Afterwards neither the collection
nor the items can be deleted any longer, but they need to be
<a href="#Delete_Discard_items">discarded</a> instead. The release does
not freeze the collection completely, in particular new items can still
be added.
</p>
<ul style="padding:0.5em 2%">
<li>1. Go to the collection you want to release</li>
<li>2. In the menu <i>Collection</i>, click on <i>Release</i></li>
</ul>
<h3 class="imj_sectionHeadline" style="padding:0"><a name="Delete__Discard_Collection"></a>Delete /Discard a Collection</h3>
<ul style="padding:0.5em 2%">
<li>1. Go to the collection you want to delete / discard</li>
<li>2. In the menu <i>Collection</i>, click on
<ul style="padding:0.5em 2%; list-style-type: square;">
<li>[IF the collection is private] <i>Delete</i>: The collection, the items and the files are all deleted</li>
<li>[IF the collection is released] <i>Discard</i>: The files are deleted, but the collection and items remains, with the discard comment</li>
</ul>
</ul>
<h3 class="imj_sectionHeadline" style="padding:0"><a name="Assign_DOI_to_Collection"></a>Assign a DOI to a Collection</h3>
<span style="text-decoration: underline">Note</span>: You can only assign a DOI to a released
collection and you can only assign one DOI per collection.</p>
<ul style=" padding:0.5em 2%">
<li>1. Go to the collection you want to assign a DOI to</li>
<li>2. In the menu <i>Collection</i>, click on <i>Add DOI to collection</i></li>
<li>3. Accept the Terms of Use</li>
<li>4. You can now <a href="#Cite_Collection">cite your collection</a> with the assigned DOI<li/>
</ul>
<h3 class="imj_sectionHeadline" style="padding:0"><a name="Cite_Collection"></a>Cite a collection</h3>
<ul style="padding:0.5em 2%">
<li>1. Go to the collection you want to cite</li>
<li>2. Click on <i>more</i>, right under the collection title</li>
<li>3. Copy the text <i>Cite as</i></span>.
</ul>
<br/><br/>
<a href="#"><span style="font-style: italic;">top</span></a><br/>
<hr style="width: 100%; height: 2px;">
<h3 class="imj_sectionHeadline" style="padding:0"><a name="upload"></a>Upload files</h3>
<ol style="padding:0 0 0.5em 2%">
<li>1. Go to <a href="./upload" target="_blank">the upload page</a></li>
<li>2. Choose in a existing collection (if you already have one) or <a href="#Create_Collection">create a new collection</a> to upload your files</li>
<li>3. Select file(s) or drag and drop file(s) into the drop area</li>
</ol>
<br/>
<h4 class="imj_sectionHeadline" style="padding:0"><a name="upload_error_quota"></a>Data quota exceeded</h4>
Please contact:
<ul style="list-style-type: square; padding:0 0 0.5em 2%">
<li><a href="mailto:XXX_SUPPORT_EMAIL_XXX">The support team</a> if you are the creator of this collection</li>
<li>The owner of the collection, if the collection has been shared. You can find the owner of the collection on the share icon</li>
</ul>
<br/>
<h4 class="imj_sectionHeadline" style="padding:0"><a name="upload_error_file_format"></a>File format not allowed</h4>
For security reasons, imeji restrict the list of authorized file formats. To get more information, <a href="mailto:XXX_SUPPORT_EMAIL_XXX">contact the support team</a></span>
<br/><br/>
<h4 class="imj_sectionHeadline" style="padding:0"><a name="upload_error_not_allowed_upload"></a>You do not have any permissions to upload items or create collections</h4>
Your account is not authorized to create a new collection, and you don't have permission to upload files in at least one collection. Please aks the <a href="mailto:XXX_SUPPORT_EMAIL_XXX">support team</a> for the authorization to create a new collection
<br/><br/>
<h3 class="imj_sectionHeadline" style="padding:0"><a name="edit_item"></a>Describe item(s) with metadata</h3>
imeji offers you 3 different ways to describe your items with metadata:
<ul style="padding:0 0 0.5em 2%">
<li>a. <a href="#edit_item_single">Describe one item</a></li>
<li>b. <a href="#edit_item_selected">Describe many items of a collection</a></li>
<li>c. <a href="#edit_item_all">Describe all items of a collection</a></li>
</ul>
<br/>
<h4 class="imj_sectionHeadline" style="padding:0"><a name="edit_item_single"></a>Describe one item</h4>
<ul style="padding:0 0 0.5em 2%">
<li>1. Go the item you want to describe with metadata</li>
<li>2. Click on <i>Edit</i></li>
<li>3. Fill the form</li>
<li>4. [If you want to add a new entry] Click on <i>Add metadata</i>:
<ul style="padding:0 0 0.5em 2%">
<li>a. Select a metadata from the list</li>
<li>b. [If you want to add a new metadata] Click on <i>Add metadata</i> at the bottom of the list and create a new metadata</li>
</ul>
</li>
<li>5. Save</li>
</ul>
<br/>
<h4 class="imj_sectionHeadline" style="padding:0"><a name="edit_item_selected"></a>Describe many items of a collection</h4>
<ul style="padding:0 0 0.5em 2%">
<li>1. Go the collection containing the items you want to edit</li>
<li>2. Select the items you want to edit</li>
<li>3. In the menu <i>X Selected Items</i>, click on <i>Edit</i></li>
<li>4. Add metadata:
<ul style="padding:0 0 0.5em 2%">
<li>a. Edit a single cell, by clicking on <span class="fa fa-plus"/> to add a new value, or <span class="fa fa-times"/> to remove a value</li>
<li>b. Add a value to a whole column, by clicking on <span class="fa fa-pencil-square-o"></span></li>
<li>c. Remove all values of a column, by clicking on <span class="fa fa-times"></span></li>
<li>d. Remove a column, by clicking on <span class="fa fa-trash"></span></li>
<li>e. Change the name of column by clicking on <span class="fa fa-cog"></span></li>
<li>d. Add a new column by clicking on <i>Add column</i></li>
</ul>
</li>
<li>5. Save</li>
</ul>
<br/>
<h4 class="imj_sectionHeadline" style="padding:0"><a name="edit_item_all"></a>Describe all items of a collection</h4>
<ul style="padding:0 0 0.5em 2%">
<li>1. Go the collection containing the items you want to edit</li>
<li>2. [If some items are selected], click on <i>Select none</i></li>
<li>3. In the menu <i>X Items</i>, click on <i>Edit all</i></li>
<li>4. Click on <i>Select a metadata</i>
<ul style="padding:0 0 0.5em 2%">
<li>a. Select a metadata from the list</li>
<li>b. [If you want to add a new metadata] Click on <i>Add metadata</i> at the bottom of the list and create a new metadata</li>
</ul>
</li>
<li>5. Enter a value</li>
<li>6. Choose one method to add the metadata to the collection items:
<ul style="padding:0 0 0.5em 2%">
<li>a. <i>Add a new value to all</i>: The value will be append to all items of the collection, no matter whether the items have already a value for with this metadata</li>
<li>b. <i>Add only if value is empty</i>: The value will only be append to the items of the collection which don't have any value for this metadata</li>
<li>c. <i>Overwrite all values</i>: The value will be append to all items of the collection. Previous values for this metadata will be removed</li>
</ul>
</li>
</ul>
<br/>
<h3 class="imj_sectionHeadline" style="padding:0"><a name="edit_license"></a>Add license to item(s)</h3>
<ul style="padding:0 0 0.5em 2%">
<li>1. Go the collection containing the items you want add the metadata</li>
<li>2. Choose one the following option:
<ul style="padding:0 0 0.5em 2%">
<li>a. Go to the page of an item and click on <i>Edit</i></li>
<li>b. Select some items and click on <i>Edit all licenses</i> in menu <i>X Selected Items</i></li>
<li>c. Click on <i>Edit all licenses</i> in menu <i>X Items</i> (Ensure that no item is selected)</li>
</ul>
</li>
<li>3. Enter a a license:
<ul style="padding:0 0 0.5em 2%">
<li>a. Select one predefined license from the list</li>
<li>b. OR, click on <li> Enter your own license</li> and enter you license informations</li>
</ul>
</li>
<li>4. Save
<ul style="padding:0 0 0.5em 2%">
<li>a. [If the collection is private] Choose if you want to replace license of the items having already a license</li>
<li>b. [If the collection is released] the new license will be append to the item(s). To the previous license will be added a validity period.</li>
</ul>
</li>
</ul>
<br/>
<h3 class="imj_sectionHeadline" style="padding:0"><a name="delete_item"></a>Delete / Discard item(s)</h3>
<ul style="padding:0 0 0.5em 2%">
<li>1. Go the collection containing the items you want to delete / discard</li>
<ul style="padding:0 0 0.5em 2%">
<li>a. [If the collection is private] Choose one the following option:
<ul style="padding:0 0 0.5em 2%">
<li>i. Go to the page of an item and click on <i>Delete</i></li>
<li>ii. Select some items and click on <i>Delete</i> in menu <i>X Selected Items</i></li>
<li>iii. Click on <i>Delete all</i> in menu <i>X Items</i> (Ensure that no item is selected)</li>
</ul>
</li>
<li>b. [If the collection is public] Choose one the following option:
<ul style="padding:0 0 0.5em 2%">
<li>i. Go to the page of an item and click on <i>Discard</i></li>
<li>ii. Select some items and click on <i>Discard items</i> in menu <i>X Selected Items</i></li>
</ul>
</li>
</ul>
</ul>
<br/>
<h3 class="imj_sectionHeadline" style="padding:0"><a name="move_item"></a>Move item(s) to another collection</h3>
<span style="text-decoration: underline">Note</span>: You can only move item(s) of a private collection.
<br/><br/>
<ul style="padding:0 0 0.5em 2%">
<li>1. Go to the collection containing the items you want to move</li>
<ul style="padding:0 0 0.5em 2%">
<li>a. Go to the page of an item and click on <i>Move</i></li>
<li>b. Select some items and click on <i>Move</i> in menu <i>X Selected Items</i></li>
</ul>
<li>2. Select the collection you want to move the item(s) to</li>
<li>3. [If the target collection is released] Select a license to be added to the moved items</li>
</ul>
<br/><br/>
<a href="#"><span style="font-style: italic;">top</span></a><br/>
<hr style="width: 100%; height: 2px;">
<br/>
<h3 class="imj_sectionHeadline"><a name="simple_search"></a>Simple Search</h3>
<ul style="padding:0.5em 2%; list-style-type: square;">
<li>
The simple search allows the user the search for all available metadata (item metadata, filename, collection information) as well as for the full text (in case of text document, like pdf or doc).
</li>
<li>
The simple search allows to search either for:
<ul style="padding:0.5em 2%;">
<li>a. All items of all collections</li>
<li>b. All items of one collection (available only from collection page)</li>
<li>c. All collections.
</ul>
</li>
<li>
The simple search is compatible with the <a href="https://github.com/MPDL/imeji/wiki/imeji-search-syntax" target="_blank">imeji search syntax</a>
</li>
</ul>
<br/>
<h3 class="imj_sectionHeadline"><a name="advanced_search"></a>Advanced Search</h3>
<span style="text-decoration: underline">Note</span>: The advanced search is restricted to items.
<br/><br/>
<ul style="padding:0 0 0.5em 2%">
<li>1. Go to the <a href="./search" target="_blank">simple search page</a></li>
<li>2. Search for
<ul style="padding:0 0 0.5em 2%">
<li>a. All fields (item metadata, filename and optionally the fulltext)</li>
<li>b. Specific metadata</li>
<li>c. File types</li>
<li>d. Licenses</li>
<li>e. Technical metadata of files</li>
</ul>
</li>
</ul>
<span style="text-decoration: underline">Note</span>: The advanced search produced query according to the <a href="https://github.com/MPDL/imeji/wiki/imeji-search-syntax" target="_blank">imeji search syntax</a>.
<br/><br/>
<a href="#"><span style="font-style: italic;">top</span></a><br/>
<hr style="width: 100%; height: 2px;"><br style="font-weight: bold;">