Zum Inhalt springen

Änderungen von Dokument Button

Zuletzt geändert von xwikiadmin am 2025/05/21 09:38
Von Version 1.1
bearbeitet von xwikiadmin
am 2022/08/11 17:57
Änderungskommentar: Install extension [com.xwiki.pro:xwiki-pro-macros/1.3]
Auf Version 7.1
bearbeitet von xwikiadmin
am 2025/05/21 09:38
Änderungskommentar: Install extension [com.xwiki.pro:xwiki-pro-macros-ui/1.26.19]

Zusammenfassung

Details

Seiteneigenschaften
Übergeordnete Seite
... ... @@ -1,1 +1,1 @@
1 -xwiki:XWiki.Macros.WebHome
1 +WebHome
Versteckt
... ... @@ -1,1 +1,1 @@
1 -false
1 +true
Inhalt
... ... @@ -10,6 +10,9 @@
10 10  |width|$services.localization.render('rendering.macro.button.parameter.width.description')|-
11 11  |newTab|$services.localization.render('rendering.macro.button.parameter.newTab.description')|false
12 12  |icon|$services.localization.render('rendering.macro.button.parameter.icon.description')|-
13 +|type|$services.localization.render('rendering.macro.button.parameter.type.description')|Default
14 +|id|$services.localization.render('rendering.macro.button.parameter.id.description')|Default
15 +|class|$services.localization.render('rendering.macro.button.parameter.class.description')|Default
13 13  
14 14  == Examples ==
15 15  
... ... @@ -31,4 +31,8 @@
31 31  {{code}}{{button label="Store" url="http://store.xwiki.com" color="#889cb8" newTab="true" icon="page" width="100%"/}}{{/code}}
32 32  
33 33  {{button label="Store" url="http://store.xwiki.com" color="#889cb8" newTab="true" icon="page" width="100%"/}}
37 +
38 +{{code}}{{button label="Delete example" url="http://store.xwiki.com" type="DANGER"/}}{{/code}}
39 +
40 +{{button label="Delete example" url="http://store.xwiki.com" type="DANGER"/}}
34 34  {{/velocity}}
XWiki.WikiMacroClass[0]
Makro-Code
... ... @@ -24,42 +24,74 @@
24 24   #fff
25 25   #end
26 26  #end
27 +#macro (executeMacro)
28 + ## Retrieve macro parameters
29 + #set ($label = $escapetool.xml($wikimacro.parameters.label))
30 + #set ($url = $escapetool.xml($wikimacro.parameters.url))
31 + #set ($color = $wikimacro.parameters.color)
32 + #set ($width = $escapetool.xml($wikimacro.parameters.width))
33 + #set ($newTab = $escapetool.xml($wikimacro.parameters.newTab))
34 + #set ($icon = $escapetool.xml($xcontext.macro.params.icon))
35 + #set ($macro.id = $wikimacro.parameters.id)
36 + #set ($macro.classParam = $wikimacro.parameters.get('class'))
37 + #set ($macro.type = $wikimacro.parameters.type)
38 + ## Resolve the url as a Wiki Document if it exists, else assume it is an external link
39 + #if ($xwiki.exists($url))
40 + #set ($url = $xwiki.getDocument($url).getURL())
41 + #end
42 + ## The color will be a java.awt.Color object
43 + ## Transform it into an array of Integers for better malleability: [x, y, z]
44 + #if ($color)
45 + #set ($colors = [$color.Red, $color.Green, $color.Blue])
46 + #else
47 + #set ($colors = [255, 255, 255])
48 + #end
49 + #set ($macro.additionalClass = '')
50 + #if ("$!macro.classParam" != '')
51 + #set ($macro.additionalClass = "$macro.additionalClass $macro.classParam")
52 + #end
53 + #if ("$!macro.type" != '')
54 + #set ($macro.additionalClass = "$macro.additionalClass btn-$macro.type.name().toLowerCase()")
55 + #end
56 + #set ($darkenedColors = [])
57 + #darken($colors, $darkenedColors)
58 + {{html clean=false}}
59 + ## #124: The Button macro deletes followup content when inserted from wysiwyg
60 + ## Wrap the macro output inside a block element if the context where the macro is inserted is not inline, e.g. if the
61 + ## macro is inserted between paragraphs rather than between the text of a paragraph. Otherwise the generated HTML is
62 + ## invalid which breaks the WYSIWYG editing because the browser tries to fix the invalid HTML and messes up the macro
63 + ## output markers that protect the macro output.
64 + #if (!$wikimacro.context.isInline())<p>#end
65 + <a href="$url" #if($newTab == 'true')target="_blank"#end>
66 + <button
67 + #if ("$!macro.id" != '')
68 + id="$escapetool.xml($macro.id)"
69 + #end
70 + style="
71 + #if ("$!color" != '')
72 + background-color: #toCssRGB($colors);
73 + border-color: #toCssRGB($darkenedColors);
74 + color: #fontColor($colors);
75 + #end
76 + width: $!width;
77 + "
78 + class="btn $escapetool.xml($macro.additionalClass)">
79 + $!services.icon.renderHTML($!icon)
80 + $label
81 + </button>
82 + </a>
83 + #if (!$wikimacro.context.isInline())</p>#end
84 + {{/html}}
85 +#end
27 27  {{/velocity}}
28 28  
29 29  {{velocity}}
30 -## Retrieve macro parameters
31 -#set ($label = $escapetool.xml($wikimacro.parameters.label))
32 -#set ($url = $escapetool.xml($wikimacro.parameters.url))
33 -#set ($color = $wikimacro.parameters.color)
34 -#set ($width = $escapetool.xml($wikimacro.parameters.width))
35 -#set ($newTab = $escapetool.xml($wikimacro.parameters.newTab))
36 -#set ($icon = $escapetool.xml($xcontext.macro.params.icon))
37 -## Resolve the url as a Wiki Document if it exists, else assume it is an external link
38 -#if ($xwiki.exists($url))
39 - #set ($url = $xwiki.getDocument($url).getURL())
40 -#end
41 -## The color will be a java.awt.Color object
42 -## Transform it into an array of Integers for better malleability: [x, y, z]
43 -#if ($color)
44 - #set ($colors = [$color.Red, $color.Green, $color.Blue])
89 +## We need to check if there is a valid license because the macro is registered even if the user doesn't have view right
90 +## on the macro definition page. See XWIKI-14828: Rendering macros defined in wiki pages are available to users that
91 +## don't have view right on those pages.
92 +#if ($services.promacrolicensing.hasLicensureForEntity($xcontext.macro.doc.documentReference))
93 + #executeMacro
45 45  #else
46 - #set ($colors = [255, 255, 255])
95 + {{missingLicenseMessage extensionName="proMacros.extension.name"/}}
47 47  #end
48 -#set ($darkenedColors = [])
49 -#darken($colors, $darkenedColors)
50 -{{html clean=false}}
51 -<a href="$url" #if($newTab == 'true')target="_blank"#end>
52 - <button
53 - style="
54 - background-color: #toCssRGB($colors);
55 - border-color: #toCssRGB($darkenedColors);
56 - color: #fontColor($colors);
57 - width: $!width;
58 - "
59 - class="btn">
60 - $!services.icon.renderHTML($!icon)
61 - $label
62 - </button>
63 -</a>
64 -{{/html}}
65 65  {{/velocity}}
Makrobeschreibung
... ... @@ -1,1 +1,0 @@
1 -Insert a button!
XWiki.WikiMacroParameterClass[0]
Parameter-Beschreibung
... ... @@ -1,1 +1,0 @@
1 -The label of the button.
XWiki.WikiMacroParameterClass[1]
Parameter-Beschreibung
... ... @@ -1,1 +1,0 @@
1 -A link or a page reference.
XWiki.WikiMacroParameterClass[2]
Parameter-Beschreibung
... ... @@ -1,1 +1,0 @@
1 -The color of the button.
XWiki.WikiMacroParameterClass[3]
Parameter-Beschreibung
... ... @@ -1,1 +1,0 @@
1 -The width of the button specified in pixels, percentage or other valid CSS value (ex. 30px, 30%, 30em). If no value is specified, the width will be determined by the length of the label.
XWiki.WikiMacroParameterClass[4]
Parameter-Beschreibung
... ... @@ -1,1 +1,0 @@
1 -Denotes whether the page will be opened in a new page or not.
XWiki.WikiMacroParameterClass[5]
Parameter-Beschreibung
... ... @@ -1,1 +1,0 @@
1 -Icon associated with the button, placed before the label.
XWiki.WikiMacroParameterClass[6]
Parameter-Vorgabe
... ... @@ -1,0 +1,1 @@
1 +DEFAULT
Parameter-Name
... ... @@ -1,0 +1,1 @@
1 +type
Parameter-Typ
... ... @@ -1,0 +1,1 @@
1 +com.xwiki.macros.button.ButtonType
Parameter verpflichtend
... ... @@ -1,0 +1,1 @@
1 +Nein
XWiki.WikiMacroParameterClass[7]
Parameter-Name
... ... @@ -1,0 +1,1 @@
1 +id
Parameter-Typ
... ... @@ -1,0 +1,1 @@
1 +java.lang.String
Parameter verpflichtend
... ... @@ -1,0 +1,1 @@
1 +Nein
XWiki.WikiMacroParameterClass[8]
Parameter-Name
... ... @@ -1,0 +1,1 @@
1 +class
Parameter-Typ
... ... @@ -1,0 +1,1 @@
1 +java.lang.String
Parameter verpflichtend
... ... @@ -1,0 +1,1 @@
1 +Nein