GNOME Bugzilla – Bug 737044
gnome-user-docs sometimes uses <gui> or no tag when referring to default folders
Last modified: 2018-03-26 14:33:46 UTC
When referring to the default folders in the user's Home folder, like Documents, Pictures, Music, Downloads, etc. the documentation ought to consistently use <file> tags. The attached patch aims to fix this and does wrapping where it can be done without affecting the entire file.
Created attachment 286707 [details] [review] Proposed patch.
Review of attachment 286707 [details] [review]: The only problem here is that <file> is supposed to be for filenames, and "Home" is not a filename, but a label that is only that is only shown in the UI. Looking at the places sidebar (shared by Nautilus and GTK+), Recent, Home and Trash are UI labels which do not have directly-corresponding filenames, similar to Computer, Browse Network and Connect to Server. The XDG folders are shown as the filenames are found in the home directory, so if an XDG directory is renamed then the new name is shown in the places sidebar. An awkward difference between Nautilus and GTK+ is that the user's home directory is shown as "Home" in the Nautilus path bar, but as "username" in the path bar of the GTK+ file chooser.
While I see your point I'm not convinced it makes sense to make a difference between the two types of labels. From a users point of view they look the same in the UI so why isn't the documentation referring to them in the same way? I'll create a new patch that adds <file> to the XDG folders and hope that this gains traction instead. :)
Created attachment 287263 [details] [review] Proposed patch.
Ok, the new patch only changing the XDG-folders has been attached. One last question though: now Home and Trash are sometimes referred to using <gui> and sometimes without any tag. Should they consistenly be using the <gui> tag? I think that's suitable but I'd like to hear your opinions before investing time in a patch.
20:38 < sebras> kittykat: https://bugzilla.gnome.org/show_bug.cgi?id=737044 hm.. while I see amigadave's point I still think it is strange that the documentation would treat some labels in the file manager differently from the others. 20:39 < sebras> kittykat: how is a user supposed to know that Trash is not a filename but Picture is a filename and why? 22:11 < kittykat> sebras: at the moment, I think that they should all be marked up as <file>, even though some aren't 22:16 < kittykat> I think about it more from a user point of view rather than a technically correct point of view This seems to indicate that my initial patch was correct in some sense..? We need to reach consensus on this matter. I'm happy to provide patches either way. :)
(In reply to comment #6) > 20:38 < sebras> kittykat: https://bugzilla.gnome.org/show_bug.cgi?id=737044 > hm.. while I see amigadave's point I still think it is strange > that the documentation would treat some labels in the file > manager differently from the others. > 20:39 < sebras> kittykat: how is a user supposed to know that Trash is not a > filename but Picture is a filename and why? Good question. Do we explain anywhere in Help that Trash is not a file name but a UI label? If we don't, then there is probably no point in trying to differentiate between Trash or Home, for example, and actual file names.
-- GitLab Migration Automatic Message -- This bug has been migrated to GNOME's GitLab instance and has been closed from further activity. You can subscribe and participate further through the new bug through this link to our GitLab instance: https://gitlab.gnome.org/GNOME/gnome-user-docs/issues/14.