Details

    • Improvement
    • Resolution: Won't Fix
    • Major
    • None
    • 8.2-milestone-1
    • Rendering
    • None
    • Unknown
    • N/A
    • N/A

    Description

      There are some new macros that are placed inside the Macros space (like Macros.Tree for example).

      The problem is that Macros.WebHome is an empty page. IMO the Macros.WebHome should list all the existing macros. This is currently handled by the XWiki.WikiMacros page.

      We should merge the 2 pages, in the try to better organise content and remove stuff from the XWiki space.

      Attachments

        Issue Links

          Activity

            [XWIKI-13498] Move XWiki.WikiMacros to Macros.WebHome
            vmassol Vincent Massol added a comment -

            The problem with moving XWiki.WikiMacros to Macros.WebHome is that it would pollute the navigation tree and we cannot make it visible only to admins since the goal of the list of macros is for any user to know what he/she can use.

            So I'm going to close this issue as won't fix and FTM move the feature to the Help application in the Syntax guide, under the Macro section.

            In the future, we should provide two related features:

            • Provide a Macro Browser for the wiki editor too
            • Add autocomplete inside both WSYSIWYG and wiki editors to autocomplete macros after typing "{{" and pressing ctrl+space (for example). See also
            vmassol Vincent Massol added a comment - The problem with moving XWiki.WikiMacros to Macros.WebHome is that it would pollute the navigation tree and we cannot make it visible only to admins since the goal of the list of macros is for any user to know what he/she can use. So I'm going to close this issue as won't fix and FTM move the feature to the Help application in the Syntax guide, under the Macro section. In the future, we should provide two related features: Provide a Macro Browser for the wiki editor too Add autocomplete inside both WSYSIWYG and wiki editors to autocomplete macros after typing "{{" and pressing ctrl+space (for example). See also
            vmassol Vincent Massol added a comment -

            The only need for this macro index is as a help tool when you develop some apps. And if you're a simple user you don't need it as you have the insert macro dialog box of the WYSIWYG editor. Since you don't need it when you're using XWiki, I was thinking it could be located in the Help app.

            It's also close to the Scripting Documentation Application but for macros. Again this is about documentation.

            Ideally we could have a Developer Documentation Application, which would include the Scripting Documentation App + other content such as AutoCompletion + Syntax Highlighting and it would also draw this Macro index.

            vmassol Vincent Massol added a comment - The only need for this macro index is as a help tool when you develop some apps. And if you're a simple user you don't need it as you have the insert macro dialog box of the WYSIWYG editor. Since you don't need it when you're using XWiki, I was thinking it could be located in the Help app. It's also close to the Scripting Documentation Application but for macros. Again this is about documentation. Ideally we could have a Developer Documentation Application, which would include the Scripting Documentation App + other content such as AutoCompletion + Syntax Highlighting and it would also draw this Macro index.
            vmassol Vincent Massol added a comment -

            I don't think EM will work. EM is about extensions not macros. Any app can provide one or several macros. IMOI it's a bad idea to link it to EM.

            vmassol Vincent Massol added a comment - I don't think EM will work. EM is about extensions not macros. Any app can provide one or several macros. IMOI it's a bad idea to link it to EM.

            I am not sure it should be part of the Help module, since I see more close to Applications and EM.
            Also since the macros are a bit technical I wouldn't either have a "Macro Index" listed in the Drawer.

            Maybe we could have a link from the "Insert Macros" dialogs to this "Macro Index" + add the ability to manage the macros (Delete, Edit).

            Alternatively if we add the filtering functionality inside EM, maybe we could filter there for Applications / Macros / etc. The only difference is that EM just allows Install/Uninstall, not management actions provided by the livetables (View, Edit, Delete, etc.)

            evalica Ecaterina Moraru (Valica) added a comment - I am not sure it should be part of the Help module, since I see more close to Applications and EM. Also since the macros are a bit technical I wouldn't either have a "Macro Index" listed in the Drawer. Maybe we could have a link from the "Insert Macros" dialogs to this "Macro Index" + add the ability to manage the macros (Delete, Edit). Alternatively if we add the filtering functionality inside EM, maybe we could filter there for Applications / Macros / etc. The only difference is that EM just allows Install/Uninstall, not management actions provided by the livetables (View, Edit, Delete, etc.)

            Btw, there is also XWIKI-11884.

            Note that the WYSIWYG editor (both GWT and CK) has a dialog to insert macros which lists all the available macros. So the link on the help panel is not that useful in this case. In any case, the Wiki Macro Index could reuse the display from the Insert Macro wizard (the one from CK is quite reusable).

            mflorea Marius Dumitru Florea added a comment - Btw, there is also XWIKI-11884 . Note that the WYSIWYG editor (both GWT and CK) has a dialog to insert macros which lists all the available macros. So the link on the help panel is not that useful in this case. In any case, the Wiki Macro Index could reuse the display from the Insert Macro wizard (the one from CK is quite reusable).
            vmassol Vincent Massol added a comment -

            We need to rethink this page. Right now there's no way to access it so marking it hidden is the same as removing it completely.

            IMO we should:

            • Make it list all existing macros in the wiki
            • Integrate it in the Help application
            • I think the Help Application might need a Documentation space where we could put various links to documentation on the home page (link to Getting Started tutorial, links to Users/Dev/Admin Guides on xwiki.org, etc, and have a link to Documentation.Macros for example.
            • An alternative is to show the link to the Macros when editing a page in a Help Panel. Make this panel visible in both wiki and wysiwyg edit modes and transform the XWiki Syntax Help panel into this Help Panel (i.e. have a link to the Wiki Syntax in the Help Panel when the edit mode is wiki)
            vmassol Vincent Massol added a comment - We need to rethink this page. Right now there's no way to access it so marking it hidden is the same as removing it completely. IMO we should: Make it list all existing macros in the wiki Integrate it in the Help application I think the Help Application might need a Documentation space where we could put various links to documentation on the home page (link to Getting Started tutorial, links to Users/Dev/Admin Guides on xwiki.org, etc, and have a link to Documentation.Macros for example. An alternative is to show the link to the Macros when editing a page in a Help Panel. Make this panel visible in both wiki and wysiwyg edit modes and transform the XWiki Syntax Help panel into this Help Panel (i.e. have a link to the Wiki Syntax in the Help Panel when the edit mode is wiki)
            evalica Ecaterina Moraru (Valica) added a comment - - edited

            We could also mark it as hidden, since we could consider it a technical page + removing the #docextras

            evalica Ecaterina Moraru (Valica) added a comment - - edited We could also mark it as hidden, since we could consider it a technical page + removing the #docextras

            People

              vmassol Vincent Massol
              evalica Ecaterina Moraru (Valica)
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: