Hello everyone,
I am currently working on Loading... and would like some feedback for a few points.
To sum up, attachment revisions stored in the database currently have a field XWA_COMMENT
that is not used anywhere. The idea would be to add a setting to expose this field to provide a way to upload one or multiple attachments with a comment, and display it both on the list of attachments and the revision history for attachments. Here is a mock-up from the issue for when the setting is enabled:
Now, the field mentions a comment, the issue asks for a description, and in essence the feature is very close to the concept of revision summaries we already have for documents. So a first question would be: how should we name this feature?
Personally, I would be +1 to use “summary” since it would be more aligned to the current UI, but I’m open to other ideas.
Also, note that the current limit on the field is 1023 characters, which seems enough to me for this feature so I would keep it as is.
Finally, where exactly should this be displayed and how should it be edited? The issue mentions only that the field should be set during upload and displayed in the attachments list and the attachments history. If we consider this as a summary, I think it would make sense to have a default value for the different upload methods (upload button, edit mode, API) and to make it non-editable since it is tied to a revision. But there are other pages, such as XWiki.AllAttachments
, where I’m still not sure if it makes sense to display it or not (for the record, the summary for document revisions is not displayed on XWiki.AllDocs
).
WDYT?
Thanks.