Zum Inhalt springen

Änderungen von Dokument Expand

Zuletzt geändert von Thorsten Seifert am 2026/03/05 12:12
Von Version 1.1
bearbeitet von xwikiadmin
am 2023/03/07 16:26
Änderungskommentar: Install extension [com.xwiki.pro:xwiki-pro-macros/1.7]
Auf Version 12.1
bearbeitet von Thorsten Seifert
am 2026/03/05 12:12
Änderungskommentar: Install extension [com.xwiki.pro:xwiki-pro-macros-ui/1.30.1]

Zusammenfassung

Details

Seiteneigenschaften
Übergeordnete Seite
... ... @@ -1,1 +1,1 @@
1 -Confluence.Macros
1 +WebHome
Dokument-Autor
... ... @@ -1,1 +1,1 @@
1 -xwiki:XWiki.xwikiadmin
1 +xwiki:XWiki.seifertt
Inhalt
... ... @@ -3,11 +3,13 @@
3 3  = Parameters =
4 4  
5 5  |=Parameter|=Description|=Required|=Default
6 -|**title**|Text displayed on the collaspse toggle|No|Click here to expand...
6 +|**title**|Text displayed on the collaspse toggle|No|(empty)
7 +|**expanded**|If selected the expand will be opened automatically when loading the page.|No|False
7 7  
9 +Note: if no title is provided, the title of the first panel or the first header appearing in the content will be used. if there is no such header or panel title, "Click here to expand…" will be used.
8 8  
9 9  = Example Usage =
10 10  
11 -{{expand}}
12 -Hello 👀
13 +{{expand expanded="false"}}
14 +Hello
13 13  {{/expand}}
XWiki.StyleSheetExtension[0]
Code
... ... @@ -1,38 +1,45 @@
1 -.confluence-expand-macro {
1 +.confluence-expand-macro .glyphicon {
2 + margin-right: 0.5rem;
3 + transform: rotate(0deg);
4 + transition: transform 0.3s;
5 +}
2 2  
3 - .panel-heading {
4 - padding: 0;
5 - .panel-title {
6 - font-size: 1em;
7 +.confluence-expand-macro[open] > summary .glyphicon {
8 + transform: rotate(90deg);
9 +}
7 7  
8 - a {
9 - display: block;
10 - padding: @panel-heading-padding;
11 +.confluence-expand-macro .panel-title{
12 + padding: @panel-heading-padding;
13 + display: flex;
14 +}
11 11  
12 - p {
13 - display: inline;
14 - }
16 +.confluence-expand-macro .panel-body {
17 + transition: linear 0.3s;
18 +}
15 15  
16 - .glyphicon {
17 - margin-right: 0.5rem;
18 - transform: rotate(0deg);
19 - transition: transform 0.1s;
20 - }
21 - &[aria-expanded="true"] .glyphicon {
22 - transform: rotate(90deg);
23 - }
24 - }
25 - }
26 - }
20 +.confluence-expand-macro summary {
21 + font-size: 1em;
22 +}
27 27  
28 - .panel-collapse {
29 - .panel-body {
30 - display: block;
31 - &::before { content: none; }
32 - &::after { content: none; }
24 +.confluence-expand-macro summary:hover {
25 + cursor: pointer;
26 +}
33 33  
34 - & > *:first-child { margin-top: 0; }
35 - & > *:last-child { margin-bottom: 0; }
36 - }
37 - }
28 +.panel-title:hover .title-text {
29 + cursor: pointer;
30 + text-decoration: underline;
38 38  }
32 +
33 +.confluence-expand-macro.panel > .panel-body, .confluence-expand-macro > summary {
34 + background: unset;
35 + border: none;
36 +}
37 +
38 +.confluence-expand-macro.panel.panel-default .panel-body ul {
39 + list-style-type: revert;
40 + padding-left: revert;
41 +}
42 +
43 +.confluence-expand-macro.panel {
44 + background: unset;
45 +}
XWiki.WikiMacroClass[0]
Makro-Code
... ... @@ -1,37 +1,93 @@
1 -{{velocity}}
2 -$xwiki.ssx.use('Confluence.Macros.Expand')
3 -#if (!$expandMacroColllapseId)
4 - #set ($expandMacroColllapseId = 0)
5 -#else
6 - #set ($expandMacroColllapseId = $expandMacroColllapseId + 1)
7 -#end
8 -#set ($opened = $xcontext.action == 'edit')
9 -#set ($accordionId = "accordion-$escapetool.xml($expandMacroColllapseId)")
10 -#set ($toggleId = "toggle-$expandMacroColllapseId")
11 -#set ($expandId = "collapse-$expandMacroColllapseId")
1 +{{velocity output="false"}}
2 +#macro (exportMode $escapedTitle)
3 + ## Use a different structure when exporting to make sure that the pagedjs can properly parse the content.
12 12  
13 -{{html clean="false" wiki="true"}}
14 -<div class="panel-group confluence-expand-macro" id="${accordionId}" role="tablist">
15 - <div class="panel panel-default">
16 - <div class="panel-heading" role="tab" id="${toggleId}">
17 - <h4 class="panel-title">
18 - <a
19 - role="button"
20 - data-toggle="collapse"
21 - data-parent="#${accordionId}"
22 - href="#${expandId}"
23 - #if($opened)aria-expanded="true"#end
24 - aria-controls="${expandId}"
25 - ><span class="glyphicon glyphicon-menu-right" aria-hidden="true"></span>{{wikimacroparameter name="title" /}}</a>
26 - </h4>
5 + {{html clean="false" wiki="true"}}
6 + <div class = "panel panel-default confluence-expand-macro">
7 + <div class>
8 + <span class="panel-title">
9 + <span class="glyphicon glyphicon-menu-down" aria-hidden="true"></span>
10 + <span class="title-text">
11 + $escapedTitle
12 + </span>
13 + </span>
27 27   </div>
28 - <div id="${expandId}" class="panel-collapse collapse #if($opened)in#end" role="tabpanel" aria-labelledby="${toggleId}">
15 + <div class="panel-body">
16 +
17 + {{wikimacrocontent /}}
18 +
19 + </div>
20 + </div>
21 + {{/html}}
22 +
23 +#end
24 +
25 +#macro (executeMacro)
26 +
27 + #set ($discard = $xwiki.ssx.use('Confluence.Macros.Expand'))
28 + #set ($discard = $xwiki.jsx.use('Confluence.Macros.Expand'))
29 + #set ($title = $wikimacro.parameters.title)
30 + #if ("$!title" == "")
31 + #set ($title = $services.promacroexpand.getAutoTitle($wikimacro.content, $xwiki.currentContentSyntaxId))
32 + #end
33 + #if ("$!title" == "")
34 + #set ($title = $services.localization.render("rendering.macro.expand.defaultexpandtitle"))
35 + #end
36 + #set ($escapedTitle = $services.rendering.escape($escapetool.xml($title), $xwiki.currentContentSyntaxId))
37 + #if ($xcontext.action == 'export')
38 + #exportMode($escapedTitle)
39 + #else
40 + ## To avoid an issue regarding {{wikimacroparameter}} and {{wikimacrocontent}} that fail to render when in
41 + ## edit mode while inside a HTML macro, we need to manually write the HTML by using XWiki syntax. This way,
42 + ## while the macro will always be expanded when in edit mode, the user will be able to modify the text inline.
43 + #set ($targetSyntaxId = $wikimacro.context.transformationContext.targetSyntax.type.id)
44 + #if ($targetSyntaxId == 'annotatedhtml' || $targetSyntaxId == 'annotatedxhtml' || $request.outputSyntax == 'annotatedhtml')
45 + (% class="confluence-expand-macro panel panel-default" %)
46 + (((
47 + (((
48 + (% class="panel-title" %)
49 + (((
50 + (% class="glyphicon glyphicon-menu-down" aria-hidden="true" %)
51 + ((()))
52 + {{wikimacroparameter name='title' /}}
53 + )))
54 + )))
55 + (% class="panel-body" %)
56 + (((
57 + {{wikimacrocontent /}}
58 + )))
59 + )))
60 + #else
61 + #set ($opened = $xcontext.action == 'edit'|| $wikimacro.parameters.expanded)
62 + {{html clean="false" wiki="true"}}
63 + <details class="confluence-expand-macro panel panel-default" #if ($opened)open#end>
64 + <summary>
65 + <span class="panel-title">
66 + <span class="glyphicon glyphicon-menu-right" aria-hidden="true"></span>
67 + <span class="title-text">
68 + $escapedTitle
69 + </span>
70 + </span>
71 + </summary>
29 29   <div class="panel-body">
73 +
30 30   {{wikimacrocontent /}}
75 +
31 31   </div>
32 - </div>
33 - </div>
34 - </div>
35 -{{/html}}
77 + </details>
78 + {{/html}}
79 + #end
80 + #end
81 +#end
82 +{{/velocity}}
36 36  
84 +{{velocity}}
85 +## We need to check if there is a valid license because the macro is registered even if the user doesn't have view right
86 +## on the macro definition page. See XWIKI-14828: Rendering macros defined in wiki pages are available to users that
87 +## don't have view right on those pages.
88 +#if ($services.promacrolicensing.hasLicensureForEntity($xcontext.macro.doc.documentReference))
89 + #executeMacro
90 +#else
91 + {{missingLicenseMessage extensionName="proMacros.extension.name"/}}
92 +#end
37 37  {{/velocity}}
Makrobeschreibung
... ... @@ -1,5 +1,0 @@
1 -Add the Expand macro to your page to provide content in an expandable / collapsible section. 
2 -
3 -This is one of Confluence's most popular macros. It's great for: visually reducing the amount of information on a page, breaking process information down into clickable steps, hiding background or obsolete information, while still keeping it on the page for future reference.
4 -
5 -The macro is collapsed by default, people need to click each one to expand it. There's no way to expand all macros on a page at once, however all Expand macros are automatically expanded when you print or export the page to PDF.
Verfügbarkeit von Makroinhalten
... ... @@ -1,1 +1,1 @@
1 -Optional
1 +Mandatory
XWiki.WikiMacroParameterClass[0]
Parameter-Beschreibung
... ... @@ -1,1 +1,0 @@
1 -Defines the text that appears next to the expand/collapse icon.
XWiki.JavaScriptExtension[0]
Pufferstrategie
... ... @@ -1,0 +1,1 @@
1 +long
Code
... ... @@ -1,0 +1,29 @@
1 +// The current versions of Safari don't bundle the latest version of WebKit, and because of this it lacks
2 +// a feature from the HTML standard where the details tag automatically expands when the URL fragment
3 +// targets an element inside it. Here is the WebKit bug report: https://bugs.webkit.org/show_bug.cgi?id=228843,
4 +// and we should follow it so we know when the fix reaches Safari. I also opened
5 +// https://github.com/xwikisas/xwiki-pro-macros/issues/682 on our side to keep track of the issue and avoid forgetting it.
6 +require(['jquery'], function ($) {
7 + var isSafari = navigator.vendor && navigator.vendor.includes('Apple');
8 +
9 + function handleFragment() {
10 + let hash = window.location.hash;
11 + if (!hash) return;
12 +
13 + let target = $(hash);
14 + if (target.length === 0) return;
15 +
16 + target.parents("details").each(function () {
17 + this.open = true;
18 + });
19 +
20 + target[0].scrollIntoView({ behavior: "auto", block: "start" });
21 + }
22 + if (isSafari) {
23 + console.log("Applying Safari fragment workaround");
24 + // On initial load
25 + $(document).ready(handleFragment);
26 + // On fragment updates
27 + $(window).on("hashchange", handleFragment);
28 + }
29 +});
Inhalt parsen
... ... @@ -1,0 +1,1 @@
1 +Nein
Benutze diese Erweiterung
... ... @@ -1,0 +1,1 @@
1 +currentPage
XWiki.WikiMacroParameterClass[1]
Parameter-Vorgabe
... ... @@ -1,0 +1,1 @@
1 +0
Parameter-Name
... ... @@ -1,0 +1,1 @@
1 +expanded
Parameter-Typ
... ... @@ -1,0 +1,1 @@
1 +java.lang.Boolean
Parameter verpflichtend
... ... @@ -1,0 +1,1 @@
1 +Nein