xwikisas / xwiki-pro-macros

XWiki rendering macros useful when migrating content from Confluence
GNU Lesser General Public License v2.1
3 stars 12 forks source link

Add confluence toc-zone macro bridge. #349

Closed douakli closed 1 month ago

douakli commented 1 month ago

Hi,

Here is an implementation proposal for a confluence toc-zone macro bridge. See #350

Details

It is based on the following documentation: https://confluence.atlassian.com/doc/table-of-content-zone-macro-189890742.html As well as from experimenting with the extension on a confluence instance.

All the parameters are implemented. The bridge behave similarly to the original toc-zone macro.

Screenshots

See some comparative screenshots to have an overview.

Default parameters

Default Default_XWiki

Bottom, Flat and Outline

BottomFlatOutline BottomFlatOutline_XWiki

Include .*First.* and levels 2-3.

2-3FirstRegex 2-3FirstRegex_XWiki

Reviewing

This is my first macro implementation. I believe having a review, even a quick one, could be highly beneficial both for the quality of the result, as well as the quality of my future code. I want to bring the eventual reviewer(s) attention to escaping. I tried making something that seemed safe to me, I'd like to have a confirmation that user input is properly handled.

Thank you,

Dorian.

douakli commented 1 month ago

Hi, Thank you Raphael! I appreciate the suggestions and will keep them in mind for next times :)

I do not have the permission to merge this PR, I updated the since versions.

Thanks, Dorian.

raphj commented 1 month ago

I do not have the permission to merge this PR

Done. Please: