Image styling for xwiki.org

Hi devs,

Proposal 1

We’re currently using an image macro to have a consistent style on xwiki.org. I wanted to propose to move to the Image Style feature of XWiki. However, we can’t, because of Loading...

Until this is fixed, I propose to continue to use the image macro but to modify it to add a style parameter with the values small, medium, large and extra (for extra large). See https://dev.xwiki.org/xwiki/bin/view/Community/DocGuide#HScreenshots2FImages for the corresponding widths.

This will allow to have consistency in images sizes.

For now we can’t remove the width parameter (to avoid regressions/backward compat) but we will indicate in the doc guide that it must not be used anymore.

Once Loading... is fixed, we will review this proposal again.

Proposal 2

In addition since we now have the Lightbox feature, I propose to remove the ability to click the image to open it in full (as it duplicates the lightbox feature).

WDYT?

Thx

Interesting, I thought the rule was to use the gallery macro for images in documentation.

+1

If it’s a dedicated macro for xwiki.org I’m wondering if we also couldn’t add an optional “version” parameter to use when adding screenshots, to have a better way to know (and let the user knows) the version of XWiki they’re seeing: as mentioned in another topic it’s not easy to maintain all screenshot up to date, but maybe it might help to see the metadata a bit like what we have with the version macro.

+1

That’s a good idea indeed.

We just need to remember to update the content when we update the screenshot (e.g. when uploading a new version of the image with the same name as before, but taken from a diffrent XWiki version).

+1 for the proposal.

Thanks,
Marius

IMO this is already taken care of with the version macro (and it’s more generic than just images). See https://dev.xwiki.org/xwiki/bin/view/Community/DocGuide which explains that we’re already supposed to use it for images (along with text).

There’s also a process to remove that info regularly in the doc guide.

Note: I see no difference between images and text re versioning and maintenance.

I’ve now implemented it, see https://www.xwiki.org/xwiki/bin/view/Macros/ImageMacro?viewer=changes&rev1=20.1&rev2=23.1&

I’ll update the doc guide.

Thanks

Doc updated: https://dev.xwiki.org/xwiki/bin/view/Community/DocGuide?viewer=changes&rev1=42.2&rev2=43.3&