Naming the End of Main Content in XWiki Pages

Development
, ,
1

Hi everyone!

At the moment there is no specific term in XWiki for defining the end of the main content of a page, where the like button, tags and other elements are displayed (see screenshot below). We need to find a terminology so we can refer to that area when documenting.

content-footer
content-footer1270Ă—817 57.4 KB

A couple of initial suggestions for naming the section:

  • Content-end
  • Content-footer

WYT? Do you have other ideas?

Thanks in advance for participating in this discussion!

2

Note that we already have a name for this: Content Footer (or Page Content Footer for the full name)

See https://www.xwiki.org/xwiki/bin/view/Documentation/DevGuide/ExtensionPoint/ContentFooterUIX/

PS: There was a misunderstanding, and what I had asked Eleni was to propose/brainstorm about a name for the docextra area :slight_smile: (since that doesn’t seem a good name). We have https://www.xwiki.org/xwiki/bin/view/Documentation/DevGuide/ExtensionPoint/Document%20Docextra/ that uses “docextra” but I believe it’s not a good name for the documentation and for users.

1 Like
3

About DocExtra, in the hopes that my view on this component of our UI can help us find out what’s it is exactly. I already thought about changing the name but couldn’t find anything non-technical but precise enough.

The UIXP is very generic with what it allows. Technically customizations and extensions can add anything here.

The way I see it, in XS, these few tabs contain information that makes sense only in the context of the document, and are not document content. In addition, this data is of secondary importance and medium in length (fits in a tab).
Primary importance and short data is creation/latest edition date and author, title and tags. This info is important enough to get its own permanent position around the document content. The like button is a bit of an outsider here, I doubt it warrants the important space we give it, but it’s very small.

Tertiary importance data is kept on an alternative view mode or a dialog modal that can be accessed via the More Actions button at the top of the page.

Panels contain metadata which is either:

  • Navigation
  • Data unrelated to the page content

Listing the docextra panels to check how it fits the description above:

  • Comments only make sense in relation to the document they are commenting (else it’s meant that they are used for generic discussion, and it’s not the intended use of the feature :slight_smile: ). Comments are often useful to see but not in all use cases (e.g. using XWiki as a PKM, I don’t think I’d use the comment feature).
  • Attachments [list]: When I want to change an attachment or check the state of attachments on a page, it’s nice to have quite a one click access. However, when reading the content of a page, I usually don’t need to know detail of attachments that it comes with.
  • History: is very useful but contains a lot of info, we want to avoid clutter so it’s relegated in its own tab. The extended history information is in a secondary view mode, too large for a panel.
  • Information: Lots of misc metadata about the page. It’s a bit of a hotpot concept-wise IMO but the amount of content in this tab is appropriate and useful for some use cases.

TLDR. In my opinion, the importance of DocExtra is to access specific data related to the document without commiting into loading a new page and quitting the main view mode. It allows to make a lot of information available onto the main view while creating minimal clutter.

4

Thx @CharpentierLucas

@elenicojocariu could you please start a new thread about the doc extra area naming? Then we can move Lucas’s comment there and brainstorm there. I also have some naming ideas. Thx

5

Here is the new thread: Renaming the "Docextra" Tab