N0taN3rd/wail

(Rework) Collection Name vs. Title vs. Description

weiglemc opened this issue · 2 comments

What is the difference between Collection Name, Collection Title, and Collection Description? Collection Name and Collection Title seem redundant. What are the purposes of each of these?

@weiglemc per your wishes during the initial OpenWayback to Pywb switch these fields were kept as is.
The name of the collection is the "name" of the collection folder on disk

The title is more descriptive than name which is on disk. It allows for the user to give a better presentation of for the collection.
Pywb's wb-manager does not allow for spaces to in collection name as it is the name of the directory on disk it will create

The description is a description of the collection per the name.
Users can put what they like in it.
The meat of the what the collection contains is what this field is used for.

I propose one of the following options:

  1. remove title and keep only name and description
  2. keep all 3, but only name is required (title and description are optional)

No matter what, we should make sure that there's a note by name that no spaces are allowed.