Hierarchy

[JalalWeraach]

Subcollection (subc) Specification [Finalized]

Definitions

Subc: A subc is an item of one collection. A subc itself can have items but doesn’t support Sharing, DOI, Batch Editing, Publishing.

A subc has an owner (=useraccount that created it), date of creation, date modified, title, but NO creator. (= classic properties plus title)

Display Subc

1. Subc appears as an item of the collection
2. Subc appear as the first item of the collection:
   When sorting items and subc, subc will always be displayed first. After all subc the items will appear in the order of the method (a-z, etc..)
3. Subc do not appear in browse COLLECTIONS or browse ITEMS

Create Subc

1. Go to collection
2. Go to the Button „+ New Subc”
3. Enter a title for the subc
4. Click on save
5. The system displays a success message

Edit Subc

1. Select one subc
2. Go to edit subc information
3. Change the subc metadata, add new metadata or delete existing metadata as described in Create Subc
4. Click on save
5. The system displays a success message

Note: To be coherent with the current system it is not possible to batch edit subc. In a collection a subc will not have a checkmark and can therefore not be selected for batch editing.

Consequence: When in a collection “Select all on this page” will select all items without the subc.

Move Subc

Precondition: The subc is not within a published collection!

1. Go to the detail view of a subc
2. Click on Move
3. A list of all collections/subc for which the user has appropriate rights is displayed
4. Select target collection/subc
5. Possible outcomes:
   a. The name of the subcollection isn't used by any subcollection within the target: The subcollection and all its items are moved
   b. The name of the subcollection is already used by another subcollection within the target: A message box warns the user: "Another XX_NAME_XXX subcollection exists already! Create a new subcollection with the same name"

Note: Currently it is technically not possible to merge subc, therefore it is only possible to create a new subc with the same name.

Note: To be coherent with the current system it is not possible to batch move subc.

Delete Subc

1. Select one subc (subc has to be in the state private)
2. Go to delete subc
3. Confirm the deletion of the selected subc
4. The system displays a success message

Discard subc

1. Select one subc (subc has to be in the state published)
2. Go to discard subc
3. Enter a reason for the discard
4. Confirm the discard of the subc
5. The system displays a success message

Postcondition: The subc metadata is still displayed together with the discard comment. The items of the subc are discarded (see Discard Item)

Search Subc

Note: There are two different logic types of Search:

1. Search for Collection/Subcollection
2. Search in Collection/Subcollection

Search for Collection/Subcollection

1. Go to the search field
2. The suggestion „Search for… Collections / Subcollection unfolds and can be chosen.
3. Enter the name of the subc
4. Only the subc with that name will be displayed not the item in the subc
5. The search result will still be shown flat, but either breadcrumb or a mouseover will show the specific path for the subc for clear identification.

Search in Collection/Subcollection

1. Go to collection/subcollection
2. Search for items in the collection
3. The search result will show all items and all subcs.

API
All Subcollection methods must be implemented in the API as well:

• Create
• Retrieve
• Update
• Delete
• Discard
• Search
• Upload in subcollection
• Move in Subcollection
• Get all subcollections of a collection/subcollection
• Get all subcollection and items of a collection/subcollection

Related https://github.com/MPDL/imeji/wiki/Specifications#collections

[JalalWeraach]

Closed Questions:

1. What is the max of subc in a collection?
   ANSWER: We don’t need a max of subc in collection

2. Where should subc be displayed? (collection browse - item/vs. list display, item search)
   ANSWER:

   1. In the item list of one collection
   2. In the search results (after “search for COLLECTIONS/SUBCOLLECTIONS“)

3. How many should be displayed max? (item vs. list display)
   ANSWER: All there are

4. Is there are problem if a collection has a private subc and a published subc?
   ANSWER: Subc cannot be published on its own

5. Should subc be published?
   ANSWER: no

6. Should subc be shared?
   ANSWER: no

7. Should it be possible to discard individual subc?
   ANSWER: Yes

8. Who has the right to delete a subc?
   ANSWER: Everyone with edit rights for the parent collection

9. Is the subc a problem for the history of the collection?
   ANSWER: no

10. Where to change or insert Buttons for subc (instead of collection or additionally)?
    ANSWER: To be discussed with the implementation

11. Do we need a "move items to subc" action?
    ANSWER: no. the normal move action will do it

12. Can various subcollections of a collection share the same name? Note: Files/items can ;)
    ANSWER: yes

13. What are the consequences for the subc being treated partly as an item and partly as a collection?
    ANSWER: none

14. Should it be possible to move subc or items of the subc? What happens if after moving, the exact same item is in the same collection or subc? (merge, overwrite, don’t allow the moving, other options?)
    ANSWER: Yes, moving should be possible (see move sub)

15. Should there be a new button for subc or should “imeji/collections?q=” also show subc? Should the path of the subc be displayed (only in the search results?) via mouseover for better guidance (it is possible that subc titled “my project” exist more than once)
    ANSWER: Design elements will be discussed later

16. What additional data should a subc have. Only title or author as well?
    ANSWER: only title (see create subc)

17. For the simple search the suggestion “Search for… collection” should be replaced with “Search for Collections / Subcollection”. Should the result show only the subc or the items in the subc?
    ANSWER: only the subc

18. Search when inside of a collection: currently one suggestion (the default one) of the search bar is “(Search for…) items of the Collections”. Should this be change to “(Search for…) Items and Subcollection of the Collection”? Should the search also display items of the sub?
    ANSWER: The search result will show all items and all subcs

19. Should admin be able to deactivate subc?
    ANSWER: No, because it makes the system (and its testing) more complicated.

20. We need a Gui-Element for Subc: Any suggestions or preferences?
    ANSWER: Bastien will take care of this and make a proposal

21. The spec states "In a collection a subc will not have a checkmark and can therefore not be selected for ..." - does this also mean that it's not possible to move/delete several subc at once?
    ANSWER: Yes, but must be tested if this is sufficient or if a more context sensitive solution would be required

22. Are the items filter handled identical to the search, i.e. are all items (including those in the sub collections) returned? Note: The "created by me" filter has been removed (see Filters within one collection #790), but the "state" filter is still offered.
    ANSWER: Yes, that is correct.

23. If user downloads a collection should the collection be downloaded INCLUDING the subc and the subcsubc (etc..) or EXLCUDING the subc, subcsub (etc.) ?
    ANSWER: The collection should be downloaded INCLUDING the subc, subcsubc (etc.) in a zip-file that reflects the hierarchy.

24. If a subc is in a collection that is released should moving of the subc still be possible?
    ANSWER: No

25. Should user that subscribes to a collection be notified when an subc or an item of a subc is added?
    ANSWER: Yes

26. Should a subc have a DOI?
    ANSWER: No

27. Should it be possible to cite a subc?
    ANSWER: No, user need to cite the collection

28. After creating a subc, should user be inside the subc?
    ANSWER: Yes

29. Should it be possible to move a collection in a subc?
    ANSWER: No

[ioverka]

OUTDATED

1. there shouldn't be a max
2. as "folder" in the item display, as "line" in the list display, as "included" in in collection list (after search
3. all there are
4. a subc cannot be published by itself therefore there are not mixed lists
5. no
6. no
7. after today's discussion: yes
8. everybody with at least edit rights for collection
9. one for @bastiensaquet

[JalalWeraach]

OUTDATED

After discussion it became clear that

1. We don’t need a max of subc in collection
2. All items should be displayed (in both displays)
3. Cannot be the case
4. Subc cannot be published
5. Subc cannot be shared
6. Subc cannot be discarded

[JalalWeraach]

OUTDATED

To Discuss (2):

1. What are the consequences for the subc being treated partly as an item and partly as a collection?

2. Should it be possible to move subc or items of the subc?
   What happens if after moving, the exact same item is in the same collection or subc? (merge, overwrite, don’t allow the moving, other options?)

3. Should there be a new button for subc or should “imeji/collections?q=” also show subc?
   Should the path of the subc be displayed (only in the search results?) via mouseover for better guidance (it is possible that subc titled “my project” exist more than once)

4. What additional data should a subc have. Only title or author as well?

5. For the simple search the suggestion “Search for… collection” should be replaced with “Search for Collections / Subcollection”.
   Should the result show only the subc or the items in the subc?

6. Search when inside of a collection: currently one suggestion (the default one) of the search bar is “(Search for…) items of the Collections”.
   Should this be change to “(Search for…) Items and Subcollection of the Collection”?
   Should the search also display items of the sub?

[tmader]

OUTDATED

2 it would be nice, but not necessary (for Gluons)

4 no additional data (maybe author)
5 it should show in some point the subc as well
6 Items only (it would only make sense to search after subc, if there is a large number of subc in my opinion), and it should display items of subc

Number 1 and 3 i cant answer that fast - but if you discuss the questions at the meeting today, it is ok for me - otherwise i will answer them later

[JalalWeraach]

OUTDATED

To Discuss:

1. Question from Kristina: Should admin be able to deactivate subc?
   ANSWER: No, because it makes the system (and its testing) more complicated.
2. We need a Gui-Element for Subc: Any suggestions or preferences?
   ANSWER: Bastien will take care of this.
3. MOVE:
   What happens if we move a subc to a collection in which a subc with the same name exists:

Note: We all agreed that it should be the same process as when we move an item to a collection where the item with the same name exists.

Currently it is possible to have two or more items of the same name in a collection unless they don’t have the same checksum.

Should we implement analog to this, or don’t allow subc with the same name in a collection (and therefore change this also for items)?
Should user be warned that a item/subc with the same name already exists in the collection?

[ioverka]

OUTDATED

Additional question:

• Consequences for the API, e.g.
  • will sub collections be available via the "collections" route?
  • will there be a way to list all sub collections of a collection or are they available as "items" for a collection?
  • will it be possible to upload items to a specific sub collection?

[JalalWeraach]

OUTDATED

Poll: Move item and subcollection

We all agreed that it should be the same process as when we move an item to a collection where the item with the same name exists.

Currently it is possible to have two or more items of the same name in a collection unless they don’t have the same checksum. Should we implement analog to this, or don’t allow subc with the same name in a collection (and therefore change this also for items)?

I would prefer NOT to allow two subcollections of the same name in one collection and therefore NOT allow two items of the same name in one collection.

What does the rest vote for?

[ioverka]

OUTDATED

I vote for allowing items/sub collections with the same name (simply because this was changed for items recently)

[tmader]

answered open questions from yesterdays meeting are part of the closed questions now (sorted in)

[hofmannc]

Testserver: qa imeji
Browser: ff
Version: 4.1.1-SNAPSHOT - build date 2018-02-06 15:18:00       
User: standard user

result: from functional point of view, all described features are ok

@JalalWeraach please check if spec complete and close if so

[ioverka]

minor layout issue, see MPDL/imeji_sass#25