xDocFooter Revamp

From proposal page, I donā€™t understand the functionality of ā€œDocumented byā€

Does it matter who the author and when specifically that page was created if multiple people review, edit, copy, update it?

Does that mean it will collect all the users who not only changed the page, but read it? To me, this is a bit misleading and resembles the collection of statistics of visits and changes to the page.

I think the idea is to list all the authors of the page from the history (so show all the contributors of the page instead of last version author).

Itā€™s not a bad idea, now it might be a bit expensive since itā€™s not an information we have in the current document, it would definitely have too much impact on the page view unless itā€™s asynchronous.

As @tmortagne said, I was only referring to those who modified the page in some way. I can understand the term review have be a bit misleading, will take it out.

These two sentences contradict themselves.

How do they contradict?

ā€œall the people that modified the pageā€ includes ā€œlast people that modified the pageā€

I wrote in the proposal why we shouldnā€™t showcase all of them (because there may be too many)

Let me know if you were referring to something else

Just a note: from a collaboration point of view it doesnā€™t but knowing the creator of a page is a very useful information in XWiki when developing. But I opened recently an improvment ticket to have all current authors information of a document directly in the information tab: Loading... so the creator information wouldnā€™t be lost if this is implemented.

Iā€™m +1 for the general idea.

Some remarks:

  1. the global improvements actually involve several extensions that we could evolve separately (e.g., the like extension or the tag extension)
  2. the ā€œcircle avatarā€ looks good, but it might be interesting to consider using it on all places where the avatar is displayed (either all at once or gradually)
  3. the colored tags look nice but can be an accessibility challenge (e.g., text/background contrast) and would required some discussion (e.g., are the color automatically generated from a palette or based on user choice?)

In general, this looks nice. As noted by others, these are several improvements that should be considered separately.

  1. Colored tags I think needs a proposal on its own and in particular a way how the colors should be defined. Further, we need to make sure that colors are consistently displayed across XWiki and not just in the footer.
  2. For the tags UI, I would prefer to use a standard XWiki UI than to have something custom (the current one is custom, too) to make sure we have a consistent UI experience and design across XWiki - or why should adding a new tag be different from, say, adding a new movie genre in the movies AWM demo app? Therefore, I think we should use a standard suggest widget for editing tags and use standard display code for tags. Now Iā€™m not against improving the suggest experience, but then it should be improved in general and not just for tags. Editing could use in-place editing which is again a standard UI pattern that we also use in many other places in XWiki and users are thus familiar with it.
  3. For the authors, I think we need to clearly define who should be listed here in which order. Like, should people who just wrote a comment be listed? What should happen if a user doesnā€™t exist anymore? Also, I donā€™t like the ā€œDocumented byā€ prefix as it only applies to documentation but XWiki can be used for so much more than just documentation. Further, we currently donā€™t have this information easily available so once we know what we want to display we first need to discuss how to compute and at least cache this information if we donā€™t even want to store. Listing all contributions of a user or all users who contributed to a documented is a need that has been expressed in other contexts, too, so Iā€™m not against it, Iā€™m just saying that this is more than just a design change.
  4. Circled avatars should also be something to propose in general, we shouldnā€™t use circle avatars in one place and square ones in all other.

Maybe Iā€™m looking too much at this as a simple (non-advanced) user.

So here it is ā€¦

When I see the word Documented by, it first conveys to mind the work on the document. In other words, each user can commit any actions on the document based on the permissions granted.

Review refers not to a document but to actions on an article or a review. As far as Iā€™m concerned, it overlaps with the Blog application (which Iā€™ll mention here more than once).

There are no questions regarding visualization. The question is small in functionality and binding. For example, if the point is to display the last 5 unique authors, then this duplicates the History tab, which provides more information (ideally when a summary is also specified). Letā€™s assume a situation where this tab is disabled visually, and the URL processing file is configured to block access. Then, it will be nothing but a Blog where only the owner or a specific group will have all the information. Ordinary visitors/readers will see Documented by. This could be an improvement or a new feature to the existing Blog application.

The very last word Documented by is confusing because, at the сore level of the platform, users edit documents through Edit, and therefore the result is a document modified by.

OMV, the further introduction or discussion of this field has 3 ways:

  • This field is disabled by default (to prevent the display of such field for code documents that are hidden). And can be enabled from page display settings
  • Show by default and replace Last modified by, which is the removed field after title of document.
  • Only add as an improvement to an existing extension

Oh, thanks for pointing this out! Yep, this would definitely be useful to have implemented

Oki doki, makes sense. Does this mean the proposal would be better off splitted in 3 seperate ones (like, tags, creators/modifies in the doc footer)?

Totally agreed. Iā€™ve said in the proposal that we should have all avatars revamped as circles. Iā€™ll try identifying all places where we might need to change CSS classes. Places that I noted so far:

  • user-avatar (
  • .navbar-avatar > a > img (in the navigation bar)
  • .commentavatar img (in the Comments section)
  • img.xwiki-selectize-option-icon (in the User Avatar macro selector)
  • the image afftected by class: _avatar linkview typetext (in User Directory)
  • #avatar img (in the Profile section)
  • .notification-event-user>img (in Activity Stream, Notifications )
  • .drawer-nav .drawer-brand img (in the Drawer menu)
  • .user img.user-avatar, .group img.group-avatar (in LiveData)

I just took the colors for the info, warning, success and error boxes in Iceberg. Iā€™m thinking these could be the colors that define the default suggested tags. They have a good contrast for text readability:

image

So, as Iā€™ve said in the proposal and here as well, I was thinking of using the colors for the info, success, warning, error boxes as they have a pretty good symbolism in relation to the 4 default suggested tags that I was proposing ( done, in progress, to improve, to update)

Iā€™ll have to give more thought to this.

Yep, this is a good idea. Iā€™ll think of some ideas for ordering contributors.

Oki doki, fair enough. Other options would be:

  • Modified by
  • Contributions by
  • Knowledge organized by (pretty long version and a bit marketish)

Feel free to add more ^^

Yep, makes sense

Replied to this to @mleduc , totally agree with this, as said in the proposal. See the earlier reply for places Iā€™ve identified so far that make use of the avatar image (and if you can remember any other places, feel free to add, Iā€™ll search more anyway)

Now that we agreed on the general idea, I indeed think it would be beneficial to split into separate discussions.

Unless I missed something, there is no such thing as ā€œdefault suggested tagsā€. Auto-suggestions are based on existing tags of the wiki.
Anyway, we can discuss this on a discussion dedicated to tags revamp. But I would consider the colors as an improvement on top of the tags UI revamp as this seems to be bringing some additional complexity.

1 Like

I didnā€™t understand that you wanted to propose these tags specific tags, I thought they were just examples. Why do you think they are good tags to propose by default? Would this be configurable?

No, no, there are no defaults. The idea would be to introduce these default suggested tags in the revamp

Agreed

Ideally, they would be configurable, but, initially, I think it could be a good idea to see how people respond to a specific range of default tags for a period of time (until we get questions on it or feedback)

I did suggest these because they are pretty much the most used in project management and Iā€™ve always seen knowledge management kind of motivated and elevated by project management.

As said in the proposal, the tags would mean:

  • done = no need to improve, edit, add to this, it can be even archived
  • to improve = see everything that needs improvements, related to tasks
  • in progress = helps in having an overview
  • to update = when info is old and not accurate, helps in keeping info true

Of course, there could be others as well. If we want to support any popular knowledge management philosophies we could introduce the tags Project, Area, Resource, Archive ( in support of the PARA method developed by Tiago Forte). Not ideal as we would probably need to explain to a lot of people the concepts and it wouldnā€™t help the discoverability.
image

We could also try to organize a small research on this and see which statuses do people usually organize around. :thinking:

XWiki is not a project management tool, even tough it can be used as one.
Therefore, I donā€™t think we should make any effort to support any specific methodology and instead focus on being generic and configurable.

+1 for the idea

The main issue for me is that its style is not consistent with any other button in the UI.

Especially important for accessibility :+1:

Fortunately this shouldnā€™t be too difficult to do from a technical perspective: here is an example of changing an attribute on all ā€˜user avatarā€™ pictures.


Like button change :
Why leave the text in black? I think making the text the same shade of blue as the icon would give more cohesion to the button.
About the tooltips, I worked on them for XWIKI-19139: Like button can't be focused by tabulator (#2107) Ā· xwiki/xwiki-platform@e0b58cb Ā· GitHub, itā€™s pretty new and they are not the best I agree ^^ā€™
For a button, its accessible name should always contain a description of its function (here, like or unlike the page). In this case, we also want to give an idea of what the number next to the button means. Both pieces of info are important, even though you donā€™t need to put the second one in the tooltip.

Tags Changes

  • We have a few default tags that the user can choose from, like:
  • #done - this tag would help put all done projects and tasks in the same subcategory. These would be the pages that would be most likely to get archived or deleted each few years, making the process of cleaning up much easier.
  • #in progress
  • #to improve
  • #to update - if anyone stumbles an outdated page, they can easily mark it for update
  • Because these tags are very close to the Comments section it makes feedback and progress tracking much easier for the reviewer.
  • Each of these default tags should have special colors to be easy to spot. The colors would be based on the info, warning, success and error boxesā€™ colors.

:+1: Those colors schemes have enough contrast (I made sure of it earlier this year :slight_smile: ) and donā€™t bring in too much complexity in the color theme, for a secondary feature.

Great idea +1 for revamping the footer

Like others Iā€™m not convinced the ā€˜documented byā€™, personally Id prefer page statistics such as number of views at that place, perhaps thereā€™s a solution to allow admins to choose context themselves?

I very much like the default tags for progress/status of the page. I can imagine the default tags (specifically those indicating the page is not fully done) could have a little bulb somewhere at the top of the page. That way readers would immediatly be informed about the current state of the page (opposed to currently where theyd read the page, find out parts are missing and then see the tag in the footer)

I also like the colors for the default tag +1

I think that from a collaboration POV itā€™s interesting too to know the creator of a page since, when in doubt about adding something to the page you may want to know who wrote it and contact the person for additional information about the spirit of the page, etc.

Now as others have noted, itā€™s costly to compute and displaying the last one is useful IMO. We could keep displaying the last one but provide a link to the information tab where we would compute and display all authors (possibly starting a job that would take some time).

@amilica I think this thread should be closed and several new threads created with new proposals for all topics, taking into considerations the comments received so far (and mention the new threads in this thread as a follow up). As a general rule, itā€™s much simpler to have small and concise threads, it helps getting feedback and getting something actionable out of it.

Thanks!