New Status Macro Extension

Hi,

I would like to contribute to this awesome Wiki a new extension with a macro that adds a “status” as a rendered “bubble”. It should be parameterized with a background color, maybe an icon and a text.

So you can add things like “in progress” “done” , … in a color of your choice. Much like the success, warning etc but for a wider range of statuses.

My GitHub user would be AndreasScharfCPB · GitHub

I am currently testing the new extension locally and would like to get it on GitHub and in the store etc…

I’d say org.xwiki.statusmacro would be the artifact id

Name of the Macro in the Macro Explorer: just “Status”

Sounds great !

For contrib projects, the rules would be more org.xwiki.contrib.statusmacro for the groupId. And then statusmacro for the artifactId I guess, if that’s the only module in your project.

I’m wondering if that’s the best name for what you do. For me a “status” is describing the current state of something/someone.

The standard success, warning, etc. macros are called “message” macros right now, but there is no generic message macro, which is more or less what your macro seems to be ?
Now if the bubble aspect is a core aspect of your macro, maybe another possibility would be to simply call it “Bubble” ? It would avoid collisions with potential future standard message macros.

yeah, sure. I figured that out, since I am having org.xwiki.contrib as parent now. It should be org.xwiki.contrib.

For the name: Honestly, no offense and there certenly is no right or wrong, for me the naming of the Macros is a littlebit hard for users. Its more technical than useful. Lets take “message” as an example. Sure it displayes a “message” what does not, right? And “bubble” is technically correct, but would someone look for a “bubble”? I was just taking the name from confluence and there it is “Status”, which makes a lot of sense to me. Since that what the main aim is - to support the user to add some kind of Status.

see: Insert the status macro | Confluence Cloud | Atlassian Support

In my opinion, if you would like to have the same functionality to add “bubbles” (whatever that is) to your page, you would simply fork the extension and rename it. Why not having very similar macros with different names for different use-cases?

At least from my experience at the moment it is hard for users to choose macros because of the naming. Which is natural for an open source project. It made with love, not with money :wink:

I would go with whatever name you / we choose. Thats not an issue. It’s more like a general question of how to name things. Actually it would be great if one could give macros aliases as well, much like emojis in Rocketchat. They have a name and can have a number of aliases, so let’s say you can find the “shaking head” emoji also by typing “no”.

How about “Status Bubble” ?

I’m not too worried about the display name. My concern is more making sure that the macro identifier fit as well as possible what the macro does to not collide with something else (present or future), as it’s something very hard to change later (it would break any page that use it already). Of course, having an identifier which is very different from the display name would be very weird.

Anyway, if you really feel “status” is the best fit, let’s go with “status”. It’s your macro, I’m just discussing alternatives to be sure you thought about it.

I created the following:

I guess later you will need an entry on l10n.xwiki.org, but we’ll see when you have a file to translate on your github repository.

Actually, I just noticed that a {{status}} macro does exist already, provided by https://store.xwiki.com/xwiki/bin/view/Extension/ProMacros/ (which initial concern was to provide Confluence alternative in the context of an import AFAIK). So you will probably have to choose a different name (it should be easy to rename the github repository and jira project).