Aller au contenu

Modifications pour le document VelocityMacros

Modifié par Florent Charton le 2026/03/13 11:04
Depuis la version 1.1
modifié par superadmin
sur 2022/06/20 08:49
Commentaire de modification : Install extension [org.xwiki.contrib:application-ckeditor-ui/1.63.1]
À la version 5.1
modifié par Florent Charton
sur 2026/03/13 11:04
Commentaire de modification : Install extension [org.xwiki.platform:xwiki-platform-ckeditor-ui/17.10.4]

Résumé

Détails

Propriétés de la Page
Auteur du document
... ... @@ -1,1 +1,1 @@
1 -XWiki.superadmin
1 +xwiki:XWiki.fcharton
Contenu
... ... @@ -10,7 +10,8 @@
10 10   #if ($toHTML)
11 11   #set ($source = {
12 12   'documentReference': $doc.documentReference,
13 - 'syntax': $sourceSyntax
13 + 'syntax': $sourceSyntax,
14 + 'restricted' : $request.wysiwygRestricted
14 14   })
15 15   #if ($fromHTML)
16 16   #set ($source.html = $text)
... ... @@ -22,9 +22,10 @@
22 22   ## directly in the current page, e.g. when CKEditor is used in-line (no iframe). We still need to send back the
23 23   ## required style sheets and JavaScript files because some of them might not be available in the target page, e.g.
24 24   ## when a macro is inserted and it needs resource files not available on every page.
25 - #ckeditor_initRequiredSkinExtensions()
26 + #template('display_macros.vm')
27 + #initRequiredSkinExtensions()
26 26   #set ($output = "#ckeditor_getRenderedContent($source)$!html")
27 - #set ($discard = $response.setHeader('X-XWIKI-HTML-HEAD', "#ckeditor_getRequiredSkinExtensions()"))
29 + #sendRequiredSkinExtensions()
28 28   #else
29 29   ## Returns a full HTML page, including the HEAD tag with the style sheets and possibly the JavaScript includes.
30 30   ## This is needed when the edited content is loaded in an iframe, which is the case when CKEditor replaces a text
... ... @@ -33,11 +33,6 @@
33 33   #end
34 34   #else
35 35   #set ($output = $services.wysiwyg.fromAnnotatedXHTML($text, $sourceSyntax.toIdString()))
36 - #if ("$!output" == '' && $output != '')
37 - ## $output is null, probably because $services.wysiwyg.fromAnnotatedXHTML() is not available (before 10.10RC1)
38 - #set ($xdom = $services.rendering.parse($text, 'xhtml/1.0'))
39 - #set ($output = $services.rendering.render($xdom, $sourceSyntax.toIdString()))
40 - #end
41 41   #end
42 42   #if ("$!output" != '' || $output == '')
43 43   $output##
... ... @@ -50,19 +50,6 @@
50 50  #macro (ckeditor_renderContentSheet $source)
51 51   ## The $source variable is used inside the content sheet.
52 52   #set ($output = $services.wysiwyg.render('CKEditor.ContentSheet'))
53 - #if ("$!output" == '' && $output != '')
54 - ## $output is null, probably because $services.wysiwyg.render() is not available (before 7.4.1)
55 - #set ($output = $xwiki.getDocument('CKEditor.ContentSheet').getRenderedContent())
56 - #set ($skinExtensionHooks = {
57 - 'ssx': 'CssSkinExtensionPlugin',
58 - 'ssfx': 'CssSkinFileExtensionPlugin',
59 - 'ssrx': 'CssResourceSkinExtensionPlugin'
60 - })
61 - #foreach ($entry in $skinExtensionHooks.entrySet())
62 - #set ($output = $output.replace("<!-- com.xpn.xwiki.plugin.skinx.$entry.value -->",
63 - $xwiki.get($entry.key).importString))
64 - #end
65 - #end
66 66   ## Unescape {{ which happened in CKEditor.ContentSheet for protecting the {{html}} macro.
67 67   $!output.replace('&amp;#123;&amp;#123;', '{{')##
68 68  #end
... ... @@ -71,24 +71,11 @@
71 71   ## Make sure the edited content is rendered for view because this is a WYSIWYG editor.
72 72   #set ($macro.previousDisplayMode = $xcontext.displayMode)
73 73   #set ($discard = $xcontext.setDisplayMode('view'))
74 - #if ($xcontext.displayMode != 'view')
75 - ## Before XWiki 14.0-rc-1, 13.4.7, 13.10.3 and 12.10.12 there's no API to get the current display mode so we can't
76 - ## restore the previous display mode properly. We assume the previous display mode is 'edit' because the WYSIWYG
77 - ## editor is used.
78 - #set ($macro.previousDisplayMode = 'edit')
79 - #end
58 + #set ($restricted = "$!source.restricted" == 'true')
80 80   #if ($source.html)
81 - #set ($html = $services.wysiwyg.parseAndRender($source.html, $source.syntax, $source.documentReference))
82 - #if ("$!html" == '' && $html != '')
83 - ## Before XWiki 11.9RC1 (see XWIKI-16737)
84 - #set ($html = $services.wysiwyg.parseAndRender($source.html, $source.syntax.toIdString()))
85 - #end
60 + #set ($html = $services.wysiwyg.parseAndRender($source.html, $source.syntax, $source.documentReference, $restricted))
86 86   #else
87 - #set ($html = $services.wysiwyg.toAnnotatedXHTML($source.content, $source.syntax, $source.documentReference))
88 - #if ("$!html" == '' && $html != '')
89 - ## Before XWiki 11.9RC1 (see XWIKI-16737)
90 - #set ($html = $services.wysiwyg.toAnnotatedXHTML($source.content, $source.syntax.toIdString()))
91 - #end
62 + #set ($html = $services.wysiwyg.toAnnotatedXHTML($source.content, $source.syntax, $source.documentReference, $restricted))
92 92   #end
93 93   #if ("$!html" == '')
94 94   ## Prevent Firefox from inserting bogus whitespace when the text area is empty.
... ... @@ -104,10 +104,6 @@
104 104   #set ($discard = $xwiki.linkx.use($url, {'type': 'text/css', 'rel': 'stylesheet'}))
105 105  #end
106 106  
107 -#macro (importCKEditorCSS $path $evaluate)
108 - #ckeditor_importCSS('org.xwiki.contrib' 'application-ckeditor-webjar' $path $evaluate)
109 -#end
110 -
111 111  #macro (importCKEditorResources)
112 112   #set ($discard = $xwiki.ssx.use('CKEditor.EditSheet'))
113 113   ## Add the version of each JavaScript dependency of CKEditor Integration to the URL used to load the CKEditor in order
... ... @@ -114,7 +114,7 @@
114 114   ## to make sure the browser cache is invalidated when one of these versions changes (e.g. when we upgrade XWiki or one
115 115   ## of these dependencies but the CKEditor version remains the same).
116 116   #set ($discard = $xwiki.jsx.use('CKEditor.EditSheet', {
117 - 'v': $services.extension.installed.getInstalledExtension('org.xwiki.contrib:application-ckeditor-ui',
84 + 'v': $services.extension.installed.getInstalledExtension('org.xwiki.platform:xwiki-platform-ckeditor-ui',
118 118   "wiki:$xcontext.database").version.value,
119 119   'xwiki-version': $services.extension.core.getCoreExtension(
120 120   'org.xwiki.platform:xwiki-platform-tree-webjar').version.value,
... ... @@ -123,8 +123,7 @@
123 123   'bs3typeahead-version': $services.extension.installed.getInstalledExtension('org.webjars.npm:bootstrap-3-typeahead',
124 124   "wiki:$xcontext.database").version.value
125 125   }))
126 - #importCKEditorCSS('plugins/xwiki-resource/resourcePicker.min.css' true)
127 - #importCKEditorCSS('plugins/xwiki-macro/macroWizard.min.css' true)
93 + #ckeditor_importCSS('org.xwiki.platform' 'xwiki-platform-ckeditor-plugins' 'webjar.bundle.min.css' true)
128 128   ## Tree styles needed for the document/attachment tree picker.
129 129   #set ($discard = $xwiki.linkx.use($services.webjars.url('org.xwiki.platform:xwiki-platform-tree-webjar', 'tree.min.css',
130 130   {'evaluate': true}), {'type': 'text/css', 'rel': 'stylesheet'}))
... ... @@ -134,40 +134,55 @@
134 134  
135 135  #macro (ckeditor $parameters)
136 136   #importCKEditorResources
137 - #set ($sourceDocumentReference = $parameters.attributes.get('data-sourceDocumentReference'))
138 - ## Use the current document as source document, if possible, because it may contain unsaved changes (e.g. changes
139 - ## coming from a template specified in the URL or from other URL parameters). This is important for instance in order
140 - ## to ensure that for new (unsaved) documents we use the syntax that has been copied from the template and not the
141 - ## default wiki syntax.
142 - #if (!$sourceDocumentReference || $sourceDocumentReference.equals($tdoc.documentReference))
143 - #set ($sourceDocument = $tdoc)
144 - #set ($sourceDocumentReference = $tdoc.documentReference)
145 - #else
146 - #set ($sourceDocument = $xwiki.getDocument($sourceDocumentReference))
147 - #end
103 + ##
148 148   #set ($escapedName = $escapetool.xml($parameters.attributes.name))
149 149   <input value="$!escapedName" name="RequiresHTMLConversion" type="hidden"/>
150 - <input value="$!escapetool.xml($sourceDocument.syntax.toIdString())" name="$!{escapedName}_syntax" type="hidden"/>
106 + ##
107 + #set ($syntaxId = $parameters.attributes.get('data-syntax'))
108 + <input value="$!escapetool.xml($syntaxId)" name="$!{escapedName}_syntax" type="hidden"/>
109 + ##
151 151   ## Chrome doesn't cache the enabled/disabled state of the form fields so we must store this state in the value of
152 152   ## another form field. For instance, the enabled/disabled state of the RequiresHTMLConversion hidden input
153 153   ## determines which editor mode (WYSIWYG vs. Source) is loaded initially.
154 154   ## See CKEDITOR-34: Wiki syntax gets escaped when you click "Back" in the browser
155 155   <input value="" name="$!{escapedName}_cache" type="hidden" class="cache"/>
115 + ##
156 156   #set ($discard = $parameters.attributes.putAll({
157 157   'class': "$!parameters.attributes.get('class') ckeditor-textarea loading",
158 - 'spellcheck': false,
159 - 'data-sourceDocumentSyntax': $sourceDocument.syntax.toIdString()
118 + 'spellcheck': false
160 160   }))
120 + ##
121 + #set ($sourceDocumentReference = $parameters.attributes.get('data-sourceDocumentReference'))
122 + #if (!$sourceDocumentReference)
123 + #set ($sourceDocumentReference = $tdoc.documentReference)
124 + #end
125 + #set ($source = {
126 + 'documentReference': $sourceDocumentReference,
127 + 'syntax': $syntaxId,
128 + 'content': $parameters.content,
129 + 'restricted': $parameters.attributes.data-restricted
130 + })
131 + ##
132 + ## Disable the file upload and drag & drop when the current user doesn't have edit right on the source document, if
133 + ## the source is restricted. This is the case for instance when an user with comment right adds a comment to a page
134 + ## they don't have edit right on. They are allowed to add the comment but they can't upload files because that
135 + ## requires edit right. We check if the source is in restricted mode because in some cases (such as for Change Request
136 + ## Application) we want to allow file upload even if the current user doesn't have edit right on the source document.
137 + #if ($source.restricted == 'true' && !$services.security.authorization.hasAccess('edit', $source.documentReference))
138 + #set ($parameters.attributes.data-upload-disabled = 'true')
139 + #end
140 + ## We use the velocity template context to convey the startupFocus parameter to CKEditor.
141 + #if ($wysiwygEditorConfig.startupFocus)
142 + #set ($parameters.attributes.data-startup-focus = 'true')
143 + ## We make sure to clear this context so that it doesn't interfere with CKEditors opened later.
144 + #set ($wysiwygEditorConfig.startupFocus = false)
145 + #end
146 + ##
161 161   <textarea
162 162   #foreach ($entry in $parameters.attributes.entrySet())
163 163   $entry.key="$!escapetool.xml($entry.value)"
164 164   #end
165 165   ## We render the content sheet at the end because the edited content can overwrite the variables used by this macro.
166 - #set ($source = {
167 - 'documentReference': $sourceDocumentReference,
168 - 'syntax': $sourceDocument.syntax,
169 - 'content': $parameters.content
170 - })
171 171   #set ($content = "#ckeditor_renderContentSheet($source)")
172 172   >$!escapetool.xml($content)</textarea>
173 173  #end
... ... @@ -174,7 +174,7 @@
174 174  
175 175  #macro (displayCKEditorConfigProperty $configDoc $propName $action)
176 176   <dt>
177 - <label>$configDoc.displayPrettyName($propName)</label>
158 + <label for="CKEditor.ConfigClass_$escapetool.xml($configDoc.getObject("CKEditor.ConfigClass").getNumber())_${propName}">$configDoc.displayPrettyName($propName)</label>
178 178   <span class="xHint">$escapetool.xml($services.localization.render("CKEditor.ConfigClass_${propName}.hint"))</span>
179 179   </dt>
180 180   <dd>#displayCKEditorConfigPropertyValue($configDoc $propName $action)</dd>
... ... @@ -192,10 +192,7 @@
192 192  #end
193 193  
194 194  #macro (displayCKEditorConfigPropertyValue $configDoc $propName $action)
195 - #set ($output = $configDoc.display($propName, $action))
196 - #set ($output = $stringtool.removeStart($output, '{{html clean="false" wiki="false"}}'))
197 - #set ($output = $stringtool.removeEnd($output, '{{/html}}'))
198 - $output
176 + #unwrapXPropertyDisplay($configDoc.display($propName, $action))
199 199  #end
200 200  
201 201  #macro (displayCKEditorConfig $configDoc $action)
... ... @@ -220,12 +220,11 @@
220 220   </dl>
221 221  #end
222 222  
201 +#**
202 + * Deprecated. Use #initRequiredSkinExtensions() from display_macros.vm instead.
203 +*#
223 223  #macro (ckeditor_initRequiredSkinExtensions)
224 224   #set ($requiredSkinExtensions = $collectiontool.orderedMap)
225 - #if ("$!requiredSkinExtensions" == '')
226 - ## For XWiki versions older than 12.1RC1 fallback on the old $collectionstool (available since 4.0M1).
227 - #set ($requiredSkinExtensions = $collectionstool.orderedMap)
228 - #end
229 229   ## Save the import string for each skin extension plugin in order to be able to remove the always used extensions
230 230   ## (they are aready available on the edit page so there's no need to load them).
231 231   #foreach ($pluginName in ['ssrx', 'ssfx', 'ssx', 'linkx', 'jsrx', 'jsfx', 'jsx'])
... ... @@ -233,6 +233,9 @@
233 233   #end
234 234  #end
235 235  
213 +#**
214 + * Deprecated. Use #getRequiredSkinExtensions() from display_macros.vm instead.
215 +*#
236 236  #macro (ckeditor_getRequiredSkinExtensions)
237 237   #foreach ($entry in $requiredSkinExtensions.entrySet())
238 238   #set ($importString = $xwiki.get($entry.key).importString)
... ... @@ -240,20 +240,4 @@
240 240   $!stringtool.removeStart($importString, $entry.value).trim()##
241 241   #end
242 242  #end
243 -
244 -#macro (ckeditor_defineSortTool $sortToolVariable)
245 - #set ($checkedExtension = "org.xwiki.commons:xwiki-commons-velocity")
246 - ## Because of an API collision, $collectionstool has been replaced by $collectiontool in XCOMMONS-1861
247 - #if ($services.extension.core.getCoreExtension($checkedExtension).id.version.compareTo("12.1-SNAPSHOT") >= 0)
248 - #setVariable ($sortToolVariable, $collectiontool)
249 - ## With the upgrade of Velocity $sorttool has been replaced by $collectionstool (XCOMMONS-1296)
250 - #elseif ($services.extension.core.getCoreExtension($checkedExtension).id.version.compareTo("12.0-SNAPSHOT") >= 0)
251 - #setVariable ($sortToolVariable, $collectionstool)
252 - ## Old API for sorting was $sorttool
253 - #else
254 - #setVariable ($sortToolVariable, $sorttool)
255 - #end
256 -#end
257 -
258 -#ckeditor_defineSortTool("$resolvedSortTool")
259 259  {{/velocity}}