Re: [xwiki-devs] [Brainstorming] Best practices on indentation for rendering macros in scripts

On 6 Jun 2018, at 13:24, Vincent Massol <vincent(a)massol.net> wrote: > On 6 Jun 2018, at 12:37, Eduard Moraru <enygma2002(a)gmail.com> wrote: > > +1 for A-2, since I find it more consistent and logical for an element

> accepts inner content to indent that content, once it spans on multiple > lines (since you can also have the inline version). It would be

> with the indentation policy we apply for HTML as well. > > I can't find many arguments for making an exception for them, other than > the fact that the velocity and HTML macros tend to be used quite loosely > (i.e. pages with entire content wrapped by a start and end velocity

> but we are talking generally about all rendering macros, so I think it > makes sense to indent. The SyntaxHighlighting enabled wiki editor also > helps in indenting multiple lines at the same time. > > Note: One thing that I remember that needs fixing in the SH enabled

> is the "decrease indentation" operation (i.e. SHIFT+TAB should decrease

> indentation of the selected lines by one level) which is now configured

> do "auto-indentation" instead (i.e. indent the lines to the level

> by the context, a bit similar to the "Auto-Formatting" option in

> or other IDEs). However, I don't remember hearing many people complain > about this yet, so maybe it's not that painful, but would still need

Well on my side I curse the syntax highlighting almost every single day…

Honestly, right now, I would very much prefer to just disable it by

I do lots of testing every day, using velocity and groovy macros and the

Thanks -Vincent > > Thanks, > Eduard > > On Wed, Jun 6, 2018 at 12:59 PM, Thomas Mortagne <

> wrote: > >> I'm OK with both but I prefer A-2 which is more readable and more

>> IMO. >> >> On Wed, Jun 6, 2018 at 11:49 AM, Vincent Massol &lt;vincent(a)massol.net&gt; >> wrote: >>> Hi, >>> >>> Context 1: https://jira.xwiki.org/browse/WIKIEDITOR-58 >>> Context 2: Fill the “velocity code style” section of >> http://dev.xwiki.org/xwiki/bin/view/Community/CodeStyle/ >>> >>> Option A-1: No top level indentation >>> ========================= >>> >>> {{velocity}} >>> #set ($var = …) >>> #if (…) >>> … >>> #if (…) >>> #end >>> #end >>> {{/velocity}} >>> >>> Nested example: >>> >>> {{velocity}} >>> #if ($doc.fullName != 'XWiki.AdminInlineSheet') >>> #set($formname = 'inline') >>> #set($saveaction = 'save') >>> #set($previewenabled = true) >>> #set($xnotification = $!request.getParameter('xnotification')) >>> {{html}} >>> <form id="inline" method="post" action="$doc.getURL('preview’)"> >>> <div> >>> … >>> {{/velocity}} >>> >>> Pros: >>> * This is what we currently do which IMO means it’s the more natural

>>> * Makes content more visible when editing inside xwiki since it takes >> less horizontal space >>> * Less typing and less chance to make it wrong >>> >>> Option A-2: Top level indentation >>> ======================== >>> >>> {{velocity}} >>> #set ($var = …) >>> #if (…) >>> … >>> #if (…) >>> #end >>> #end >>> {{/velocity}} >>> >>> Nested example: >>> >>> {{velocity}} >>> #if ($doc.fullName != 'XWiki.AdminInlineSheet') >>> #set($formname = 'inline') >>> #set($saveaction = 'save') >>> #set($previewenabled = true) >>> #set($xnotification = $!request.getParameter('xnotification')) >>> {{html}} >>> <form id="inline" method="post" action="$doc.getURL('preview’)"> >>> <div> >>> … >>> {{/velocity}} >>> >>> Pros: >>> * More logical since a macro is a container (even though it’s

>> syntax - wiki markup vs velocity - so it’s arguable) >>> * More legible? >>> >>> Cons >>> * This means slowly changing everywhere we use scripting. >>> >>> WDYT? >>> >>> I think my preference goes to A-1 FTM since I’ve never thought to

>> that it was an issue all these years of using it. >>> >>> Thanks >>> -Vincent >>> >>> >> >> >> >> -- >> Thomas Mortagne