Add optional description for folders

[philip-n]

Sometimes it would be nice to be able to add a description/annotation to folders, which would then be displayed in the nextcloud clients. Basic use cases that I encountered are folders which are shared between multiple persons (description of content or usage rules) and special folders (use description as a reminder e.g. not to rename folders that are used by apps).

Frontend realization

In the different nextcloud views (e.g. browser-based, mobile clients, ...) the description is shown as smaller text below the folder name. Editing is performed in the same way as tags are added in the browser-based view (and maybe in mobile clients in future releases?).

Backend realization

Technically, the description might be stored as a yaml-file "folder.cnf" in the according folder, similar to the way descriptions are handled in the gallery app [1]. This would allow to introduce additional features later that need a per-folder way of storing information (e.g. selectable folder icons, marking folder as "always on top of folder list", ...).

[1] https://docs.nextcloud.com/server/10/user_manual/files/gallery_app.html

[manicmarvin]

I would suggest that this feature not be restricted to folders, but apply to all file types. Enhancing the amount of metadata we can attach to each file/folder would vastly improve collaborative and archival use-cases.

There was an owncloud plugin that was never maintained that attempted to do this. It's here.

[MorrisJobke]

cc @karlitschek @oparoz @rullzer @icewind1991 @schiessle @nextcloud/sharing Opinions on this?

I would say, that this is a bit too much for all folders in the beginning, but maybe we start with shared links and then enhance.

[karlitschek]

not a bad idea. But might be trick to show on some platform. (Desktop/WebDAV/...)

[schiessle]

Just a idea. Maybe we could use the comments feature for it and always show the last comment on the file listing? This would also make comments more visible and easier to discover... To always show a specific comment we could add the possibility to pin a comment. If there is a pinned comment we will show this, if not we show the latest comment.

[MorrisJobke]

cc @nextcloud/designers

[jancborchardt]

Regardless of how we implement it, we need to make sure it works cross-platform. Proper integration into the desktop will already be difficult. On mobile, the comments should be easy to access anyway, but are still todo also. So we’re getting a bit ahead of ourselves by introducing another thing.

But in general yes, using comments for any further explanation seems to make the most sense.

[MorrisJobke]

ref #2019

[jonathanpantall]

I'll go ahead and chime in here. We have a user that has a set / generic folder structure for projects. When he shares a sub-folder out to a client, he would like the ability to display the full folder path to the external user so they have context of what they're viewing.

I'm not sure if this has been requested as an enhancement yet or not.

A folder description field could fit this purpose. Maybe if it was blank it could display the full folder path to the external share screen.

Thanks much!

[jancborchardt]

@jonathanpantall this is a different issue though as it relates to sharing. Please open a separate issue. :)

[mmuman]

Ideally this (and many other things) should be properly exposed on client side using xattrs when supported. For example, on Linux, FreeDesktop has a proposed spec for those, including user.xdg.comment. Just sayin…
(but I'd rather see proper xattr support when syncing files first, as BeOS and Haiku user I don't really see the point of porting the tools if they don't support what we so extensively use… 😅)

[spoorun]

See #4216 #4217
It's still quite disappointing that Nextcloud lose/destroy xattr data (extended attribute data, such as tags and descriptions) when syncing files from, for example, Linux distributions where Users carefully tag files (such as under KDE).

[wiswedel]

You might want to take a look at https://apps.nextcloud.com/apps/files_readmemd

[skjnldsv]

Implemented