Changes for page InplaceEditing
From version 1.1
edited by N Pompei
on 08/06/2020 17:32
on 08/06/2020 17:32
Change comment:
Install extension [org.xwiki.platform:xwiki-platform-edit-ui/12.4]
To version 3.1
edited by Nazzareno Pompei
on 22/12/2021 09:31
on 22/12/2021 09:31
Change comment:
Install extension [org.xwiki.platform:xwiki-platform-edit-ui/13.10.1]
Summary
-
Page properties (2 modified, 0 added, 0 removed)
-
Objects (3 modified, 0 added, 1 removed)
Details
- Page properties
-
- Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki.NPompei 1 +XWiki.NazzarenoPompei - Content
-
... ... @@ -9,11 +9,15 @@ 9 9 #jsonResponse($editConfirmation) 10 10 #else 11 11 ## Lock the document for editing. 12 - #set ($ discard = $response.sendRedirect($tdoc.getURL('lock', $escapetool.url({12 + #set ($lockParams = { 13 13 'ajax': 1, 14 14 'action': $request.lockAction, 15 15 'language': $tdoc.realLocale 16 - })))) 16 + }) 17 + #if ($request.force == 'true') 18 + #set ($lockParams.force = 1) 19 + #end 20 + #set ($discard = $response.sendRedirect($tdoc.getURL('lock', $escapetool.url($lockParams)))) 17 17 #end 18 18 #end 19 19 {{/velocity}}
- XWiki.JavaScriptExtension[0]
-
- Code
-
... ... @@ -1,9 +1,11 @@ 1 +(function(config) { 2 + "use strict"; 3 + 4 +const paths = config.paths; 5 +const l10n = config.l10n; 6 + 1 1 require.config({ 2 - paths: { 3 - 'actionButtons': $jsontool.serialize($xwiki.getSkinFile('js/xwiki/actionbuttons/actionButtons.js', true)), 4 - // Required in case the user needs to resolve merge conflicts on save. 5 - 'diff': $jsontool.serialize($xwiki.getSkinFile('uicomponents/viewers/diff.js')) 6 - } 8 + paths: paths.js 7 7 }); 8 8 9 9 define('xwiki-document-api', ['jquery'], function($) { ... ... @@ -14,13 +14,36 @@ 14 14 15 15 return { 16 16 /** 19 + * @return this document's plain title 20 + */ 21 + getPlainTitle() { 22 + return $('<div/>').html(this.renderedTitle || this.title).text(); 23 + }, 24 + 25 + /** 17 17 * @return this document's real locale 18 18 */ 19 19 getRealLocale: function() { 20 - return this.language || (this.translations && this.translations['default']) || $('html').attr('lang'); 29 + var realLocale = this.language; 30 + if (typeof realLocale !== 'string' || realLocale === '') { 31 + realLocale = this.getDefaultLocale(); 32 + } 33 + return realLocale; 21 21 }, 22 22 23 23 /** 37 + * @return this document's default locale 38 + */ 39 + getDefaultLocale: function() { 40 + if (this.translations && typeof this.translations['default'] === 'string') { 41 + return this.translations['default']; 42 + } else { 43 + // The default locale is not specified. Use the UI locale. 44 + return $('html').attr('lang'); 45 + } 46 + }, 47 + 48 + /** 24 24 * @return the URL that can be used to perform the specified action on this document 25 25 */ 26 26 getURL: function(action, queryString, fragment) { ... ... @@ -55,25 +55,33 @@ 55 55 */ 56 56 render: function(forView) { 57 57 var queryString = { 58 - xpage: ' rendercontent',83 + xpage: 'get', 59 59 outputTitle: true, 60 - outputSyntax: forView ? null : 'annotatedxhtml', 61 61 language: this.getRealLocale(), 62 62 // Make sure the response is not retrieved from cache (IE11 doesn't obey the caching HTTP headers). 63 63 timestamp: new Date().getTime() 64 64 }; 89 + if (!forView) { 90 + // We need the annotated XHTML when editing in order to be able to protect the rendering transformations and to 91 + // be able to recreate the wiki syntax. 92 + queryString.outputSyntax = 'annotatedxhtml'; 93 + // Currently, only the macro transformations are protected and thus can be edited. 94 + // See XRENDERING-78: Add markers to modified XDOM by Transformations/Macros 95 + queryString.transformations = 'macro'; 96 + } 65 65 var thisXWikiDocument = this; 66 66 return $.get(this.getURL('view'), queryString).fail(function() { 67 - new XWiki.widgets.Notification( 68 - $jsontool.serialize($services.localization.render('edit.inplace.page.renderFailed')), 69 - 'error' 70 - ); 99 + new XWiki.widgets.Notification(l10n['edit.inplace.page.renderFailed'], 'error'); 71 71 }).then(function(html) { 101 + // Render succeeded. 72 72 var container = $('<div/>').html(html); 73 73 return $.extend(thisXWikiDocument, { 74 74 renderedTitle: container.find('#document-title h1').html(), 75 75 renderedContent: container.find('#xwikicontent').html() 76 76 }); 107 + }, function() { 108 + // Render failed. 109 + return thisXWikiDocument; 77 77 }); 78 78 }, 79 79 ... ... @@ -88,11 +88,15 @@ 88 88 // Make sure the response is not retrieved from cache (IE11 doesn't obey the caching HTTP headers). 89 89 timestamp: new Date().getTime() 90 90 }).then(function(newXWikiDocument) { 124 + // Reload succeeded. 91 91 // Resolve the document reference. 92 92 thisXWikiDocument.documentReference = XWiki.Model.resolve(newXWikiDocument.id, XWiki.EntityType.DOCUMENT); 93 93 // We were able to load the document so it's not new. 94 94 thisXWikiDocument.isNew = false; 95 95 return $.extend(thisXWikiDocument, newXWikiDocument); 130 + }, function() { 131 + // Reload failed. 132 + return thisXWikiDocument; 96 96 }); 97 97 }, 98 98 ... ... @@ -115,8 +115,19 @@ 115 115 // Make sure the response is not retrieved from cache (IE11 doesn't obey the caching HTTP headers). 116 116 timestamp: new Date().getTime() 117 117 }).then(function() { 155 + // Lock succeeded. 118 118 thisXWikiDocument.locked = action; 119 119 return thisXWikiDocument; 158 + }, function(response) { 159 + // Lock failed. 160 + delete thisXWikiDocument.locked; 161 + // Check if the user can force the lock. 162 + var lockConfirmation = response.responseJSON; 163 + if (response.status === 423 && lockConfirmation) { 164 + // The user can force the lock, but needs confirmation. 165 + thisXWikiDocument.lockConfirmation = lockConfirmation; 166 + } 167 + return thisXWikiDocument; 120 120 }); 121 121 }, 122 122 ... ... @@ -139,6 +139,25 @@ 139 139 // See https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/Synchronous_and_Asynchronous_Requests 140 140 $.ajax({type: 'GET', url: url, async: false}); 141 141 } 190 + }, 191 + 192 + /** 193 + * Makes sure this document matches the current UI locale. 194 + */ 195 + translate: function() { 196 + const realLocale = this.getRealLocale(); 197 + const uiLocale = $('html').attr('lang'); 198 + if (realLocale && realLocale !== uiLocale) { 199 + this.language = uiLocale; 200 + // Set the original document locale. 201 + this.translations = this.translations || {}; 202 + this.translations['default'] = realLocale; 203 + // Update the document fields that are not 'shared' with the original document. 204 + this.isNew = true; 205 + delete this.version; 206 + delete this.majorVersion; 207 + delete this.minorVersion; 208 + } 142 142 } 143 143 }; 144 144 }); ... ... @@ -155,9 +155,7 @@ 155 155 'xwiki-events-bridge' 156 156 ], function($, xcontext, xwikiDocumentAPI) { 157 157 var preload = function() { 158 - loadCSS($jsontool.serialize($xwiki.getSkinFile('js/xwiki/actionbuttons/actionButtons.css', true))); 159 - // Required in case the user needs to resolve merge conflicts on save. 160 - loadCSS($jsontool.serialize($xwiki.getSkinFile('uicomponents/viewers/diff.css', true))); 225 + paths.css.forEach(loadCSS); 161 161 return initActionButtons(); 162 162 }; 163 163 ... ... @@ -177,6 +177,12 @@ 177 177 }); 178 178 }; 179 179 245 + var translatePage = function() { 246 + return editInPlace({ 247 + afterEdit: createTranslation 248 + }); 249 + }; 250 + 180 180 var editSection = function(sectionId) { 181 181 return editInPlace({ 182 182 lockFailed: function() { ... ... @@ -225,26 +225,38 @@ 225 225 lockFailed: function() {} 226 226 }, options); 227 227 $('#xwikicontent').addClass('loading'); 299 + // Lock the document first. 228 228 return lock(currentXWikiDocument).fail(options.lockFailed) 301 + // Then load the document only if we managed to lock it. 229 229 .then(load) 303 + // Then load the editors only if we managed to load the document. 230 230 .then(edit).done(options.afterEdit).always(function() { 231 231 $('#xwikicontent').removeClass('loading'); 306 + // Then wait for an action (save, cancel, reload) only if the editors were loaded successfuly. 232 232 }).then(maybeSave) 233 - .then(unlock) 234 - .then(view); 308 + // Then unlock the document both when the edit ended with success and with a failure. 309 + .then(unlock, unlock) 310 + // Finally view the document both when the edit ended with success and with a failure. 311 + .then(view, view) 312 + .always(function(xwikiDocument) { 313 + // Update the current document for the next edit session. 314 + currentXWikiDocument = xwikiDocument; 315 + }); 235 235 }; 236 236 237 237 var lock = function(xwikiDocument) { 238 - return xwikiDocument.lock().then(null, function(response) { 239 - var confirmation = response.responseJSON; 319 + return xwikiDocument.lock().then(null, function(xwikiDocument) { 240 240 // If the document was already locked then we need to ask the user if they want to force the lock. 241 - if (response.status === 423 && confirmation) { 242 - return maybeForceLock(confirmation).then($.proxy(xwikiDocument, 'lock', 'edit', true)); 321 + if (xwikiDocument.lockConfirmation) { 322 + var confirmation = xwikiDocument.lockConfirmation; 323 + delete xwikiDocument.lockConfirmation; 324 + return maybeForceLock(confirmation).then($.proxy(xwikiDocument, 'lock', 'edit', true), function() { 325 + // Cancel the edit action. 326 + return xwikiDocument; 327 + }); 243 243 } else { 244 - new XWiki.widgets.Notification( 245 - $jsontool.serialize($services.localization.render('edit.inplace.page.lockFailed')), 246 - 'error' 247 - ); 329 + new XWiki.widgets.Notification(l10n['edit.inplace.page.lockFailed'], 'error'); 330 + return xwikiDocument; 248 248 } 249 249 }); 250 250 }; ... ... @@ -292,7 +292,7 @@ 292 292 '</div>', 293 293 '</div>' 294 294 ].join('')); 295 - modal.find('.close').attr('aria-label', $jsontool.serialize($services.localization.render('edit.inplace.close')));378 + modal.find('.close').attr('aria-label', l10n['edit.inplace.close']); 296 296 modal.find('.modal-footer .btn-warning').click(function() { 297 297 // The user has confirmed they want to force the lock. 298 298 modal.data('deferred').resolve(); ... ... @@ -317,8 +317,7 @@ 317 317 renderedContent: $('#xwikicontent').html() 318 318 }, xwikiDocument); 319 319 }).fail(function() { 320 - new XWiki.widgets.Notification($jsontool.serialize($services.localization.render('edit.inplace.page.loadFailed')), 321 - 'error'); 403 + new XWiki.widgets.Notification(l10n['edit.inplace.page.loadFailed'], 'error'); 322 322 // Render the document for edit, in order to have the annotated content HTML. The annotations are used to protect 323 323 // the rendering transformations (e.g. macros) when editing the content. 324 324 }).then($.proxy(render, null, false)); ... ... @@ -357,7 +357,7 @@ 357 357 'xwiki:actions:save', 358 358 'xwiki:actions:reload', 359 359 'xwiki:actions:cancel', 360 - ].join(' '), function(event, data) { 442 + ].join(' '), '.xcontent.form', function(event, data) { 361 361 deferred.resolve({ 362 362 name: event.type.substring('xwiki:actions:'.length), 363 363 document: xwikiDocument, ... ... @@ -368,24 +368,18 @@ 368 368 }; 369 369 370 370 var save = function(data) { 371 - // Push the changes to the server then render the document for view. We need the view HTML both if we stop editing 372 - // now and if we continue but cancel the edit later. 373 - return push(data.document).then($.proxy(render, null, true)).then(function(xwikiDocument) { 453 + // Push the changes to the server. 454 + return push(data.document).then(function(xwikiDocument) { 374 374 // Save succeeded. 375 - if (data['continue']) { 376 - // Update the original version in order to be able to restore it on cancel. 377 - delete xwikiDocument.originalDocument; 378 - xwikiDocument.originalDocument = $.extend(true, {}, xwikiDocument); 379 - // Continue editing. 380 - return maybeSave(xwikiDocument); 381 - } else { 382 - // This is the final version. 383 - return xwikiDocument; 384 - } 385 - }, function(xwikiDocument) { 386 - // Save failed. Continue editing. 387 - return maybeSave(xwikiDocument); 388 - }); 456 + return shouldReload(xwikiDocument).then( 457 + // The document was saved with merge and thus if we want to continue eding we need to reload the editor (because 458 + // its content doesn't match the saved content). 459 + reload, 460 + // No need to reload the editor because either the action was Save & View or there was no merge on save. 461 + $.proxy(maybeContinueEditing, null, data['continue']) 462 + ); 463 + // Save failed. Continue editing because we may have unsaved content. 464 + }, maybeSave); 389 389 }; 390 390 391 391 var push = function(xwikiDocument) { ... ... @@ -396,11 +396,35 @@ 396 396 // once it was resolved or rejected. So the first event that fires will resolve/reject the promise and the remaining 397 397 // event won't be able to change that. The remaining event listener could be called later but it won't have any 398 398 // effect. 399 - $(document).one('xwiki:document:saved', $.proxy(deferred, 'resolve', xwikiDocument)); 400 - $(document).one('xwiki:document:saveFailed', $.proxy(deferred, 'reject', xwikiDocument)); 401 - return deferred.promise() .then($.proxy(xwikiDocument, 'reload'));475 + $(document).one('xwiki:document:saved', '.xcontent.form', $.proxy(deferred, 'resolve', xwikiDocument)); 476 + $(document).one('xwiki:document:saveFailed', '.xcontent.form', $.proxy(deferred, 'reject', xwikiDocument)); 477 + return deferred.promise(); 402 402 }; 403 403 480 + var maybeContinueEditing = function(continueEditing, xwikiDocument) { 481 + var afterReloadAndRender = function(success, xwikiDocument) { 482 + if (continueEditing) { 483 + if (success) { 484 + // Update the original version in order to be able to restore it on cancel. 485 + delete xwikiDocument.originalDocument; 486 + xwikiDocument.originalDocument = $.extend(true, {}, xwikiDocument); 487 + } 488 + // Continue editing. 489 + return maybeSave(xwikiDocument); 490 + } else { 491 + // This is the final version. We stop editing even if the reload / render failed. 492 + return xwikiDocument; 493 + } 494 + }; 495 + 496 + // Reload the document JSON data (to have the new version) and render the document for view. We need the view HTML 497 + // both if we stop editing now and if we continue but cancel the edit later. 498 + return xwikiDocument.reload().then($.proxy(render, null, true)).then( 499 + $.proxy(afterReloadAndRender, null, /* success: */ true), 500 + $.proxy(afterReloadAndRender, null, /* success: */ false) 501 + ); 502 + }; 503 + 404 404 var cancel = function(xwikiDocument) { 405 405 // Simply return the original version to be restored. 406 406 return xwikiDocument.originalDocument; ... ... @@ -418,6 +418,25 @@ 418 418 // Make sure we unlock the document when the user navigates to another page. 419 419 $(window).on('unload pagehide', $.proxy(unlock, null, currentXWikiDocument)); 420 420 521 + var shouldReload = function(xwikiDocument) { 522 + var reloadEventFired = false; 523 + $(document).one('xwiki:actions:reload.maybe', '.xcontent.form', function() { 524 + reloadEventFired = true; 525 + }); 526 + var deferred = $.Deferred(); 527 + // Wait a bit to see if the reload event is fired. 528 + setTimeout(function() { 529 + // Remove the listener in case the reload event wasn't fired. 530 + $(document).off('xwiki:actions:reload.maybe'); 531 + if (reloadEventFired) { 532 + deferred.resolve(xwikiDocument); 533 + } else { 534 + deferred.reject(xwikiDocument); 535 + } 536 + }, 0); 537 + return deferred.promise(); 538 + }; 539 + 421 421 var reload = function(xwikiDocument) { 422 422 // Leave the edit mode and then re-enter. 423 423 return view(xwikiDocument, true).then(editInPlace); ... ... @@ -424,21 +424,33 @@ 424 424 }; 425 425 426 426 var view = function(xwikiDocument, reload) { 546 + var viewContent = $('#xwikicontent'); 427 427 // Destroy the editors before returning to view. 428 - $(document).trigger('xwiki:actions:view', {document: xwikiDocument});548 + viewContent.trigger('xwiki:actions:view', {document: xwikiDocument}); 429 429 $('#document-title h1').html(xwikiDocument.renderedTitle); 430 - $('#xwikicontent').html(xwikiDocument.renderedContent);550 + viewContent.html(xwikiDocument.renderedContent); 431 431 if (!reload) { 432 432 // If the user has canceled the edit then the restored page content may include the section edit links. Show them 433 433 // in case they were hidden. 434 - $('#xwikicontent').children(':header').children('.edit_section').removeClass('hidden');554 + viewContent.children(':header').children('.edit_section').removeClass('hidden'); 435 435 // Let others know that the DOM has been updated, in order to enhance it. 436 - $(document).trigger('xwiki:dom:updated', {'elements': $('#xwikicontent').toArray()});556 + $(document).trigger('xwiki:dom:updated', {'elements': viewContent.toArray()}); 437 437 } 558 + // Remove the action events scope. 559 + viewContent.closest('.form').removeClass('form'); 560 + // Update the URL. 561 + if (window.location.hash === '#edit' || window.location.hash === '#translate') { 562 + history.replaceState(null, null, '#'); 563 + } 438 438 return $.Deferred().resolve(xwikiDocument).promise(); 439 439 }; 440 440 441 441 var edit = function(xwikiDocument) { 568 + // By adding the 'form' CSS class we set the scope of the action events (e.g. xwiki:actions:beforeSave or 569 + // xwiki:actions:cancel). We need this because in view mode we can have multiple forms active on the page (e.g. one 570 + // for editing the document content in place and one for editing the document syntax in-place) and we don't want 571 + // them to interfere (e.g. canceling one form shouldn't cancel the other forms). 572 + $('#xwikicontent').closest('.xcontent').addClass('form'); 442 442 return initActionButtons(xwikiDocument).then(initTitleEditor).then(initContentEditor) 443 443 .then(startRealTimeEditingSession); 444 444 }; ... ... @@ -445,7 +445,7 @@ 445 445 446 446 var initActionButtons = function(xwikiDocument) { 447 447 if (xwikiDocument) { 448 - maybeShowTranslateButton(xwikiDocument);579 + initTranslateButton(xwikiDocument); 449 449 } 450 450 var editContent = $('#xwikicontent'); 451 451 // We need the wrapper because #xwikicontent uses Bootstrap grid (col-xs-12) which is implemented with CSS float. ... ... @@ -455,59 +455,86 @@ 455 455 var actionButtonsWrapper = editContent.nextAll('.sticky-buttons-wrapper'); 456 456 if (actionButtonsWrapper.length === 0) { 457 457 actionButtonsWrapper = $('<div class="sticky-buttons-wrapper col-xs-12">' + 458 - '<div class="inplace-editing-buttons sticky-buttons"/></div>').insertAfter(editContent); 459 - var actionButtons = actionButtonsWrapper.children('.sticky-buttons').data('xwikiDocument', xwikiDocument) 460 - .toggle(!!xwikiDocument); 589 + '<div class="inplace-editing-buttons sticky-buttons"/></div>').insertAfter(editContent).toggle(!!xwikiDocument); 590 + var actionButtons = actionButtonsWrapper.children('.sticky-buttons') 591 + .data('xwikiDocument', xwikiDocument) 592 + // Expose the fake form if an extension needs to manipulate it. 593 + .data('fakeForm', fakeForm); 461 461 return loadActionButtons(actionButtons); 462 462 } else { 463 463 // If we're editing a page.. 464 464 if (xwikiDocument) { 465 465 // ..then make sure the action buttons are displayed right away (don't wait for the user to scroll). 466 - actionButtonsWrapper.children('.sticky-buttons').data('xwikiDocument', xwikiDocument).show(); 599 + actionButtonsWrapper.show().children('.sticky-buttons') 600 + .data('xwikiDocument', xwikiDocument) 601 + // Expose the fake form if an extension needs to manipulate it. 602 + .data('fakeForm', fakeForm) 603 + // but make sure the position of the action buttons is updated. 604 + .trigger('xwiki:dom:refresh'); 467 467 // The action buttons are disabled on Save & View. We don't reload the page on Save & View and we reuse the 468 468 // action buttons so we need to re-enable them each time we enter the edit mode. 469 469 fakeForm.enable(); 470 - $(document).trigger('xwiki:dom:refresh'); 471 471 } 472 472 return $.Deferred().resolve(xwikiDocument).promise(); 473 473 } 474 474 }; 475 475 476 - var maybeShowTranslateButton = function(xwikiDocument) { 477 - var xwikiDocumentLocale = xwikiDocument.getRealLocale(); 478 - var uiLocale = $('html').attr('lang'); 479 - if (xwikiDocumentLocale && xwikiDocumentLocale !== uiLocale) { 480 - $('#tmTranslate').off('click.translate').on('click.translate', function(event) { 481 - event.preventDefault(); 482 - $(this).addClass('hidden'); 483 - xwikiDocument.language = uiLocale; 484 - // Update the document translation fields that are not 'shared' with the original document. 485 - xwikiDocument.isNew = true; 486 - delete xwikiDocument.version; 487 - delete xwikiDocument.majorVersion; 488 - delete xwikiDocument.minorVersion; 489 - $('#document-title-input').focus().select(); 490 - var message = $jsontool.serialize($services.localization.render('edit.inplace.page.translation', 491 - ['__locale__'])); 492 - new XWiki.widgets.Notification( 493 - message.replace('__locale__', uiLocale), 494 - 'info' 495 - ); 496 - }).removeClass('hidden'); 497 - var message = $jsontool.serialize($services.localization.render('edit.inplace.page.original', ['__locale__'])); 498 - new XWiki.widgets.Notification( 499 - message.replace('__locale__', xwikiDocumentLocale), 500 - 'info' 501 - ); 502 - } 613 + var createTranslation = function(xwikiDocument) { 614 + xwikiDocument.translate(); 615 + $('#document-title-input').focus().select(); 616 + // Let the user know that they are now editing the translation of this page in the current locale. 617 + $('#document-title-input').popover({ 618 + content: l10n['edit.inplace.page.translate.messageAfter'], 619 + placement: 'bottom', 620 + trigger: 'manual' 621 + }).popover('show').one('blur', function() { 622 + // Hide the popover when the title input loses the focus. 623 + $(this).popover('hide'); 624 + }); 503 503 }; 504 504 627 + var initTranslateButton = function(xwikiDocument) { 628 + // Initialize the translate button only if it's visible. 629 + const translateButton = $(config.translateButtonSelector).filter('[data-toggle="popover"]').filter(':visible'); 630 + translateButton.off('click.translate').on('click.translate', function(event) { 631 + event.preventDefault(); 632 + translateButton.parent().addClass('hidden'); 633 + createTranslation(xwikiDocument); 634 + // Let the user know that they are editing the original version of the page and not the translation corresponding 635 + // to the current locale because there isn't one created yet. 636 + }).attr({ 637 + // Backup the initial popover message to be able to restore it on view. 638 + 'data-content-view': translateButton.attr('data-content'), 639 + // Use a custom popover message dedicated to the edit action. 640 + 'data-content': l10n['edit.inplace.page.translate.messageBefore'] 641 + }).popover('show') 642 + // Hide the popover on the next click. The user can still see the message by hovering the translate button. 643 + .closest('html').one('click', function() { 644 + translateButton.popover('hide'); 645 + }); 646 + }; 647 + 505 505 var loadActionButtons = function(actionButtons) { 506 - $(document).on('xwiki:actions:view', function() { 507 - // Hide the action buttons and disable the shortcut keys (by disabling the buttons). 508 - actionButtons.hide().find(':input').prop('disabled', true); 509 - // Hide the translate button because it can be used only in edit mode for the moment. 510 - $('#tmTranslate').addClass('hidden'); 649 + $(document).on('xwiki:actions:view', '.xcontent.form', function(event, data) { 650 + // Blur the action buttons first to re-enable the "disabled in inputs" shortcut keys (e.g. the page edit 651 + // shortcut), then disable the action buttons in order to disable their shortcut keys while we're not editing 652 + // in-place (e.g. prevent the Save shortcut while the user is only viewing the page). Finally hide the action 653 + // buttons to have them ready for the next editing session (the user can save or cancel and then edit again 654 + // without reloading the page). 655 + actionButtons.find(':input').blur().prop('disabled', true).end().parent().hide(); 656 + // Restore the Translate button if the locale of the viewed document doesn't match the current user interface 657 + // locale (because the viewed document doesn't have a translation in the current locale). 658 + var xwikiDocumentLocale = data.document.getRealLocale(); 659 + var uiLocale = $('html').attr('lang'); 660 + if (xwikiDocumentLocale && xwikiDocumentLocale !== uiLocale) { 661 + const translateButton = $(config.translateButtonSelector).filter('[data-toggle="popover"]'); 662 + // Restore the translation button behavior for view action. 663 + translateButton.off('click.translate') 664 + // Restore the popover text for view action. 665 + .attr('data-content', translateButton.attr('data-content-view') || translateButton.attr('data-content')) 666 + // Restore the visibility. 667 + .parent().removeClass('hidden'); 668 + } 511 511 }); 512 512 return $.get(XWiki.currentDocument.getURL('get'), { 513 513 xpage: 'editactions' ... ... @@ -519,10 +519,16 @@ 519 519 $('<input type="hidden" name="form_token" />').val(xcontext.form_token).appendTo(actionButtons); 520 520 // We need a place where actionButtons.js can add more hidden inputs. 521 521 actionButtons.append('<div class="hidden extra"/>'); 680 + // Let the others know that the DOM has been updated, in order to enhance it. 681 + $(document).trigger('xwiki:dom:updated', {'elements': actionButtons.toArray()}); 522 522 var deferred = $.Deferred(); 523 - require(['actionButtons'], function() { 683 + require(['xwiki-actionButtons', 'xwiki-diff', 'xwiki-autoSave'], function() { 524 524 overrideEditActions(); 525 525 overrideAjaxSaveAndContinue(); 686 + // Activate the auto-save feature passing our fake edit form. Note that autosave.js also creates an instance of 687 + // AutoSave but it doesn't do anything because it doesn't find a real edit form in the page. This is why we have 688 + // to create our own instance of AutoSave passing the right (fake) form. 689 + new XWiki.editors.AutoSave({form: fakeForm}); 526 526 var xwikiDocument = actionButtons.data('xwikiDocument'); 527 527 // Enable the action buttons (and their shortcut keys) only if we're editing a document. 528 528 actionButtons.find(':input').prop('disabled', !xwikiDocument); ... ... @@ -530,10 +530,7 @@ 530 530 }); 531 531 return deferred.promise(); 532 532 }, function() { 533 - new XWiki.widgets.Notification( 534 - $jsontool.serialize($services.localization.render('edit.inplace.actionButtons.loadFailed')), 535 - 'error' 536 - ); 697 + new XWiki.widgets.Notification(l10n['edit.inplace.actionButtons.loadFailed'], 'error'); 537 537 }); 538 538 }; 539 539 ... ... @@ -559,6 +559,13 @@ 559 559 insert: function(element) { 560 560 this._getActionButtons().find('.hidden.extra').append(element); 561 561 }, 723 + // Note that this method only works with single argument. 724 + append: function(element) { 725 + this.insert(element); 726 + }, 727 + down: function(selector) { 728 + return this._getActionButtons().find(selector)[0]; 729 + }, 562 562 serialize: function() { 563 563 var extra = this._getActionButtons().find(':input').serializeArray().reduce(function(extra, entry) { 564 564 var value = extra[entry.name] || []; ... ... @@ -568,20 +568,28 @@ 568 568 }, {}); 569 569 var xwikiDocument = this._getActionButtons().data('xwikiDocument'); 570 570 var formData = { 571 - title: xwikiDocument.title, 572 - content: xwikiDocument.renderedContent, 573 - RequiresHTMLConversion: 'content', 574 - content_syntax: xwikiDocument.syntax, 739 + title: xwikiDocument.rawTitle, 575 575 language: xwikiDocument.getRealLocale(), 576 576 isNew: xwikiDocument.isNew 577 577 }; 743 + if (xwikiDocument.content != xwikiDocument.originalDocument.content) { 744 + // Submit the raw (source) content. No syntax conversion is needed in this case. 745 + formData.content = xwikiDocument.content; 746 + } else { 747 + // Submit the rendered content (HTML), but make sure it is converted to the document syntax on the server. 748 + $.extend(formData, { 749 + content: xwikiDocument.renderedContent, 750 + RequiresHTMLConversion: 'content', 751 + content_syntax: xwikiDocument.syntax 752 + }); 753 + } 578 578 // Check for merge conflicts only if the document is not new and we know the current version. 579 579 if (!xwikiDocument.isNew && xwikiDocument.version) { 580 580 formData.previousVersion = xwikiDocument.version; 581 - // It would have been easier to send the timestamp but that's what the Save action expects. 582 - formData.editingVersionDate = new Date(xwikiDocument.modified).toISOString(); 757 + formData.editingVersionDate = new Date(xwikiDocument.modified).getTime(); 583 583 } 584 - return $.extend(formData, extra); 759 + // Ensure that formData information has priority over extra information. 760 + return $.extend({}, extra, formData); 585 585 } 586 586 }; 587 587 ... ... @@ -603,17 +603,21 @@ 603 603 var originalAjaxSaveAndContinue = $.extend({}, XWiki.actionButtons.AjaxSaveAndContinue.prototype); 604 604 $.extend(XWiki.actionButtons.AjaxSaveAndContinue.prototype, { 605 605 reloadEditor: function() { 606 - if ($('.inplace-editing-buttons').is(':visible')) { 607 - $(document).trigger('xwiki:actions:reload'); 782 + var actionButtons = $('.inplace-editing-buttons'); 783 + if (actionButtons.is(':visible')) { 784 + actionButtons.trigger('xwiki:actions:reload'); 608 608 } else { 609 609 return originalAjaxSaveAndContinue.reloadEditor.apply(this, arguments); 610 610 } 611 611 }, 612 - maybeRedirect: function() { 789 + maybeRedirect: function(continueEditing) { 613 613 if ($('.inplace-editing-buttons').is(':visible')) { 614 - // Never redirect when leaving the edit mode because we're already in view mode. 615 - return false; 791 + // Overwrite the default behavior so that we don't redirect when leaving the edit mode because we're already 792 + // in view mode. We still need to report a redirect (return true) if we don't continue editing, so that 793 + // actionButtons.js behaves as if a redirect was done. 794 + return !continueEditing; 616 616 } else { 796 + // Fallback on the default behavior if the in-place editing buttons are hidden. 617 617 return originalAjaxSaveAndContinue.maybeRedirect.apply(this, arguments); 618 618 } 619 619 } ... ... @@ -622,8 +622,8 @@ 622 622 623 623 var initTitleEditor = function(xwikiDocument) { 624 624 var label = $('<label for="document-title-input" class="sr-only"/>') 625 - .text( $jsontool.serialize($services.localization.render('core.editors.content.titleField.label')));626 - var input = $('<input type="text" id="document-title-input"/>').val(xwikiDocument. title);805 + .text(l10n['core.editors.content.titleField.label']); 806 + var input = $('<input type="text" id="document-title-input"/>').val(xwikiDocument.rawTitle); 627 627 var placeholder = xwikiDocument.documentReference.name; 628 628 if (placeholder === 'WebHome') { 629 629 placeholder = xwikiDocument.documentReference.parent.name; ... ... @@ -630,13 +630,13 @@ 630 630 } 631 631 input.attr('placeholder', placeholder); 632 632 $('#document-title h1').addClass('editable').empty().append([label, input]); 633 - $(document).on('xwiki:actions:beforeSave.titleEditor', function(event) { 634 - xwikiDocument. title = input.val();813 + $(document).on('xwiki:actions:beforeSave.titleEditor', '.xcontent.form', function(event) { 814 + xwikiDocument.rawTitle = input.val(); 635 635 }); 636 - $(document).one('xwiki:actions:view', function(event, data) { 816 + $(document).one('xwiki:actions:view', '.xcontent.form', function(event, data) { 637 637 // Destroy the title editor. 638 638 $(document).off('xwiki:actions:beforeSave.titleEditor'); 639 - $('#document-title h1').removeClass('editable').text(xwikiDocument. title);819 + $('#document-title h1').removeClass('editable').text(xwikiDocument.rawTitle); 640 640 }); 641 641 return xwikiDocument; 642 642 }; ... ... @@ -653,24 +653,24 @@ 653 653 // Keep the focus while the edit content is being prepared. 654 654 viewContent.focus(); 655 655 } 656 - var data = { 657 - contentType: 'org.xwiki.rendering.syntax.SyntaxContent', 658 - editMode: 'wysiwyg', 836 + var data = $.extend({}, config, { 659 659 document: xwikiDocument, 660 660 // The content editor is loaded on demand, asynchronously. 661 661 deferred: $.Deferred() 662 - }; 663 - vareditContentPromise=data.deferred.promise();664 - e ditContentPromise.done(function() {840 + }); 841 + editContent.trigger('xwiki:actions:edit', data); 842 + return data.deferred.done(function() { 665 665 editContent.show(); 666 666 viewContent.remove(); 667 667 if (withFocus) { 668 - // Restore the focus when the edit content is ready but make sure we don't scroll the page. 669 - editContent[0].focus({preventScroll: true}); 846 + // Restore the focus when the edit content is ready but make sure we don't scroll the page. We don't restore the 847 + // focus right away because we just made the content visible so it may not be editable yet (e.g. the WYSIWYG 848 + // editor can make the content editable only if it is visible). 849 + setTimeout(function() { 850 + editContent[0].focus({preventScroll: true}); 851 + }, 0); 670 670 } 671 - }); 672 - editContent.trigger('xwiki:actions:edit', data); 673 - return editContentPromise; 853 + }).promise(); 674 674 }; 675 675 676 676 var startRealTimeEditingSession = function(xwikiDocument) { ... ... @@ -689,16 +689,21 @@ 689 689 }; 690 690 691 691 return { 692 - preload: preload, 693 - editPage: editPage, 694 - editSection: editSection 872 + preload, 873 + editPage, 874 + editSection, 875 + translatePage 695 695 }; 696 696 }); 697 697 698 698 require(['jquery'], function($) { 699 - var inplaceEditingConfig = $('div[data-inplace-editing-config]').data('inplaceEditingConfig') || {}; 700 - var wysiwygEditorModule = 'xwiki-' + inplaceEditingConfig.wysiwygEditor + '-inline'; 880 + // We can edit in-place only if the #xwikicontent element is present. 881 + if (!$('#xwikicontent').length) { 882 + return; 883 + } 701 701 885 + var wysiwygEditorModule = 'xwiki-' + config.wysiwygEditor + '-inline'; 886 + 702 702 var preloadEditor = function() { 703 703 require(['editInPlace', wysiwygEditorModule], function(editInPlace) { 704 704 editInPlace.preload(); ... ... @@ -715,44 +715,186 @@ 715 715 }); 716 716 } 717 717 718 - var editButton = $('#tmEdit > a'); 719 - editButton.on('click.inPlaceEditing', function(event) { 720 - event.preventDefault(); 903 + var onInPlaceEditing = function(event) { 721 721 // Make sure the user doesn't try to re-activate the edit mode while we are in edit mode. 722 - editButton.addClass('disabled'); 723 - // Load the code needed to edit in place only when the edit button is clicked. 724 - require(['editInPlace', wysiwygEditorModule], function(editInPlace) { 725 - editInPlace.editPage().always(function() { 726 - editButton.removeClass('disabled'); 727 - }); 728 - // Fallback on the standalone edit mode if we fail to load the required modules. 729 - }, $.proxy(disableInPlaceEditing, event.target)); 730 - }); 731 - 732 - // Section in-place editing. 733 - $('#xwikicontent').on('click.inPlaceEditing', '> :header > a.edit_section:not(.disabled)', function(event) { 905 + if (editButton.hasClass('disabled')) { 906 + return; 907 + } 908 + // Disable the edit buttons and hide the section edit links. 909 + editButton.add(translateButton).addClass('disabled'); 910 + $('#xwikicontent').children(':header').children('.edit_section').addClass('hidden'); 734 734 event.preventDefault(); 735 - // Make sure the user doesn't try to re-activate the edit mode while we are in edit mode. 736 - editButton.addClass('disabled'); 737 - // Hide the section editing links and focus the content right away. We could have replaced the section editing icon 738 - // with a loading animation / spinner but giving instant visual feedback about what is going to happen is perceived 739 - // better by the users (it feels faster). 740 - $('#xwikicontent').attr('tabindex', '0').focus().children(':header').children('.edit_section').addClass('hidden'); 741 - var heading = $(event.target).closest(':header'); 912 + const handler = event.data; 913 + const data = handler.beforeEdit?.(event); 742 742 // Load the code needed to edit in place only when the edit button is clicked. 743 743 require(['editInPlace', wysiwygEditorModule], function(editInPlace) { 744 - editInPlace.editSection(heading.attr('id')).always(function() { 916 + // Re-enable the translate button because it can be used while editing to create the missing translation. 917 + translateButton.removeClass('disabled'); 918 + handler.edit(editInPlace, data).always(function() { 919 + // Restore only the edit button at the end because: 920 + // * the translate button is restored (if needed) by the editInPlace module 921 + // * the section edit links are restored when the document is rendered for view 745 745 editButton.removeClass('disabled'); 746 746 }); 747 747 // Fallback on the standalone edit mode if we fail to load the required modules. 748 748 }, $.proxy(disableInPlaceEditing, event.target)); 749 - } );926 + }; 750 750 751 751 var disableInPlaceEditing = function() { 752 - editButton.off('click.inPlaceEditing').removeClass('disabled'); 929 + editButton.add(translateButton).off('click.inPlaceEditing').removeClass('disabled'); 753 753 $('#xwikicontent').off('click.inPlaceEditing').removeAttr('tabindex').children(':header').children('.edit_section') 754 754 .removeClass('hidden'); 755 755 // Fallback on the standalone edit mode. 756 756 $(this).click(); 757 757 }; 935 + 936 + var editButton = $(config.editButtonSelector); 937 + editButton.on('click.inPlaceEditing', { 938 + beforeEdit: function() { 939 + history.replaceState(null, null, '#edit'); 940 + }, 941 + edit: function(editInPlace) { 942 + return editInPlace.editPage(); 943 + } 944 + }, onInPlaceEditing).attr('data-editor', 'inplace'); 945 + 946 + var translateButton = $(config.translateButtonSelector); 947 + translateButton.on('click.inPlaceEditing', { 948 + beforeEdit: function() { 949 + history.replaceState(null, null, '#translate'); 950 + translateButton.parent().addClass('hidden'); 951 + }, 952 + edit: function(editInPlace) { 953 + return editInPlace.translatePage(); 954 + } 955 + }, onInPlaceEditing); 956 + 957 + // Section in-place editing. 958 + $('#xwikicontent').on('click.inPlaceEditing', '> :header > a.edit_section:not(.disabled)', { 959 + beforeEdit: function(event) { 960 + // Focus the content right away to give the user instant visual feedback about what is going to happen. 961 + $('#xwikicontent').attr('tabindex', '0').focus(); 962 + // Return the id of the edited section. 963 + return $(event.target).closest(':header').attr('id'); 964 + }, 965 + edit: function(editInPlace, sectionId) { 966 + return editInPlace.editSection(sectionId); 967 + } 968 + }, onInPlaceEditing); 969 + 970 + if (window.location.hash === '#edit') { 971 + editButton.click(); 972 + } else if (window.location.hash === '#translate') { 973 + translateButton.click(); 974 + } 758 758 }); 976 + 977 +require(['jquery'], function($) { 978 + // Backup the document title before each editing session in order to catch changes. 979 + var previousPlainTitle; 980 + $('#xwikicontent').on('xwiki:actions:edit', function(event, data) { 981 + previousPlainTitle = data.document.getPlainTitle(); 982 + }); 983 + 984 + // Update the UI after each editing session. 985 + $(document).on('xwiki:actions:view', function(event, data) { 986 + var xwikiDocument = data.document; 987 + updateDocAuthorAndDate(xwikiDocument); 988 + updateDocExtraTabs(xwikiDocument); 989 + updateDrawer(xwikiDocument); 990 + updateContentMenu(xwikiDocument); 991 + if (xwikiDocument.getPlainTitle() !== previousPlainTitle) { 992 + updateDocTrees(xwikiDocument); 993 + updateLinks(xwikiDocument); 994 + } 995 + }); 996 + 997 + var updateDocAuthorAndDate = function(xwikiDocument) { 998 + var urlWithSelector = xwikiDocument.getURL('get', 'xpage=contentheader') + ' .xdocLastModification'; 999 + $('.xdocLastModification').load(urlWithSelector, function() { 1000 + // load() replaces the content of the specified container but we want to replace the container itself. We can't do 1001 + // this from the selector, e.g. by using '.xdocLastModification > *' because we lose the text nodes. 1002 + $(this).children().unwrap(); 1003 + }); 1004 + }; 1005 + 1006 + var updateDocExtraTabs = function(xwikiDocument) { 1007 + // Reload the selected tab and force the reload of the hidden tabs next time they are selected. 1008 + $('#docextrapanes').children().addClass('empty').empty(); 1009 + var selectedTab = $('#docExtraTabs .active[data-template]'); 1010 + if (selectedTab.length) { 1011 + var docExtraId = selectedTab.attr('id'); 1012 + docExtraId = docExtraId.substring(0, docExtraId.length - 'tab'.length); 1013 + XWiki.displayDocExtra(docExtraId, selectedTab.data('template'), false); 1014 + } 1015 + }; 1016 + 1017 + // Update the document trees (e.g. breadcrumb, navigation) if they have nodes that correspond to the edited document. 1018 + // Note that we want to update the internal tree data not just the link label. This is especially useful if we're 1019 + // going to implement refactoring operations (rename) in the document tree. 1020 + var updateDocTrees = function(xwikiDocument) { 1021 + var plainTitle = xwikiDocument.getPlainTitle(); 1022 + $('.jstree-xwiki').each(function() { 1023 + $(this).jstree?.(true)?.set_text?.('document:' + xwikiDocument.id, plainTitle); 1024 + }); 1025 + }; 1026 + 1027 + // Update the links that target the edited document and whose label matches the document title. Note that this can 1028 + // update links whose label was not generated dynamically (e.g. with server side scripting) based on the document 1029 + // title. For instance there could be links with hard-coded labels or with labels generated using a translatin key 1030 + // (like in the Applications panel). For simplicity we assume that if the link matches the document URL and its 1031 + // previous title then it needs to be updated, but this happens only at the UI level. 1032 + var updateLinks = function(xwikiDocument) { 1033 + var docURL = xwikiDocument.getURL(); 1034 + var newPlainTitle = xwikiDocument.getPlainTitle(); 1035 + // Exclude the links from the document content. 1036 + // Update the links that contain only text (no child elements) otherwise we can lose UI elements (e.g. icons). 1037 + $('a').not('#xwikicontent a').not(':has(*)').filter(function() { 1038 + var linkURL = $(this).attr('href')?.split(/[?#]/, 1)[0]; 1039 + return linkURL === docURL && $(this).text() === previousPlainTitle; 1040 + }).text(newPlainTitle); 1041 + }; 1042 + 1043 + // Update the list of available document translations in the drawer menu. This is needed for instance when a new 1044 + // translation is created using the in-place editor. 1045 + var updateDrawer = function(xwikiDocument) { 1046 + var languageMenu = $('#tmLanguages_menu'); 1047 + var locale = xwikiDocument.getRealLocale(); 1048 + // Look for the language query string parameter, either inside or at the end. 1049 + var localeSelector = 'a[href*="language=' + locale + '&"], a[href$="language=' + locale + '"]'; 1050 + // Check if the language menu is present (multilingual is on) and the document locale is not listed. 1051 + if (languageMenu.length && !languageMenu.find(localeSelector).length) { 1052 + // If we get here then it means a new document translation was created and it needs to be listed in the drawer. 1053 + $('<div/>').load(xwikiDocument.getURL('get', $.param({ 1054 + 'xpage': 'xpart', 1055 + 'vm': 'drawer.vm', 1056 + 'useLayoutVars': true 1057 + // Pass the query string from the current URL so that it gets included in the translation URL. 1058 + // XWIKI-11314: Changing the current language from the UI does not preserve the query string of the current URL 1059 + })) + '&' + location.search.substring(1) + ' #tmLanguages_menu', function() { 1060 + $(this).find('a').each(function() { 1061 + // Clean the query string. 1062 + $(this).attr('href', $(this).attr('href').replace(/&?(xpage=xpart|vm=drawer\.vm|useLayoutVars=true)/g, '') 1063 + .replace('?&', '?')); 1064 + }); 1065 + languageMenu.replaceWith($(this).children()); 1066 + }); 1067 + } 1068 + }; 1069 + 1070 + // Update the links from the content menu to point to the real document locale. This is needed especially when a new 1071 + // document translation is created in-place. 1072 + var updateContentMenu = function(xwikiDocument) { 1073 + var realLocale = xwikiDocument.getRealLocale(); 1074 + var defaultLocale = xwikiDocument.getDefaultLocale(); 1075 + if (realLocale != defaultLocale) { 1076 + var defaultLocaleRegex = new RegExp('(\\blanguage=)' + defaultLocale + '($|&|#)'); 1077 + $('#contentmenu a[href*="language=' + defaultLocale + '"]').each(function() { 1078 + $(this).attr('href', $(this).attr('href').replace(defaultLocaleRegex, '$1' + realLocale + '$2')); 1079 + }); 1080 + } 1081 + }; 1082 +}); 1083 + 1084 +})(JSON.parse(document.querySelector('[data-inplace-editing-config]')?.getAttribute('data-inplace-editing-config')) || 1085 + {}); - Parse content
-
... ... @@ -1,1 +1,1 @@ 1 - Yes1 +No
- XWiki.StyleSheetExtension[0]
-
- Code
-
... ... @@ -6,6 +6,7 @@ 6 6 margin-bottom: @line-height-computed / 4; 7 7 } 8 8 9 +@document-title-input-padding-vertical: @line-height-computed / 4 - 1; 9 9 input#document-title-input { 10 10 /* Preserve the heading styles. */ 11 11 border: 1px solid transparent; ... ... @@ -12,9 +12,10 @@ 12 12 box-shadow: none; 13 13 color: inherit; 14 14 font-size: inherit; 15 - height: auto; 16 + /* It seems it's not enough to set the line height for the text input. We also need to set its height. */ 17 + height: @font-size-document-title * @headings-line-height + 2 * (1 + @document-title-input-padding-vertical); 16 16 line-height: @headings-line-height; 17 - padding: (@line-height-computed/ 4-1)(ceil(@grid-gutter-width / 2) - 1);19 + padding: @document-title-input-padding-vertical (ceil(@grid-gutter-width / 2) - 1); 18 18 width: 100%; 19 19 } 20 20 ... ... @@ -47,3 +47,8 @@ 47 47 #xwikicontent { 48 48 padding-top: @line-height-computed * 0.75; 49 49 } 52 + 53 +.sticky-buttons-wrapper { 54 + /* Leave some space for the bottom box shadow of the editing area. */ 55 + margin-top: 7px; 56 +}
- XWiki.UIExtensionClass[0]
-
- Executed Content
-
... ... @@ -1,12 +1,67 @@ 1 +{{velocity output="false"}} 2 +## TODO: Remove this when XWIKI-18511 (Add support for passing a query string when calling getSkinFile) is implemented. 3 +#macro (getSkinFileWithParams $file $params) 4 +#set ($url = $xwiki.getSkinFile($file, true)) 5 +$url#if ($url.contains('?'))&#else?#end$escapetool.url($params) 6 +#end 7 +{{/velocity}} 8 + 1 1 {{velocity}} 2 2 {{html clean="false"}} 3 -#if ($xcontext.action == 'view' && !$doc.isNew()) 11 +#if ($services.edit.document.inPlaceEditingEnabled() && $hasEdit && $xcontext.action == 'view' && !$doc.isNew()) 4 4 ## We support in-place editing only for the WYSIWYG edit mode ATM. 5 5 #getDefaultDocumentEditor($defaultEditMode) 6 6 #if ($defaultEditMode == 'wysiwyg') 15 + #set ($l10nKeys = [ 16 + 'edit.inplace.page.renderFailed', 17 + 'edit.inplace.page.lockFailed', 18 + 'edit.inplace.close', 19 + 'edit.inplace.page.loadFailed', 20 + 'edit.inplace.actionButtons.loadFailed', 21 + 'core.editors.content.titleField.label', 22 + ['edit.inplace.page.translate.messageBefore', $doc.realLocale.getDisplayName($xcontext.locale), 23 + $xcontext.locale.getDisplayName($xcontext.locale)], 24 + ['edit.inplace.page.translate.messageAfter', $xcontext.locale.getDisplayName($xcontext.locale)] 25 + ]) 26 + #set ($l10n = {}) 27 + #foreach ($key in $l10nKeys) 28 + #set ($params = $key.subList(1, $key.size())) 29 + #if ($params) 30 + #set ($discard = $l10n.put($key[0], $services.localization.render($key[0], $params))) 31 + #else 32 + #set ($discard = $l10n.put($key, $services.localization.render($key))) 33 + #end 34 + #end 35 + ## See stylesheets.vm 36 + #set ($cssParams = { 37 + 'skin': $xwiki.skin, 38 + 'colorTheme': $services.model.serialize($themeDoc.documentReference, 'default') 39 + }) 40 + #set ($jsParams = {'language': $xcontext.locale}) 41 + ## We have to explicitly enable the source mode for in-line edit because the latest version of the content editor 42 + ## could be installed on an older version of XWiki where the in-place editor didn't support the source mode (so the 43 + ## content editor cannot enable the source mode by default). 7 7 #set ($inplaceEditingConfig = { 45 + 'contentType': 'org.xwiki.rendering.syntax.SyntaxContent', 8 8 'editMode': $defaultEditMode, 9 - 'wysiwygEditor': $services.edit.syntaxContent.defaultWysiwygEditor.descriptor.id 47 + 'wysiwygEditor': $services.edit.syntaxContent.defaultWysiwygEditor.descriptor.id, 48 + 'editButtonSelector': '#tmEdit > a', 49 + 'translateButtonSelector': '#tmTranslate > a', 50 + 'enableSourceMode': true, 51 + 'enableOfficeImport': $services.officemanager.isConnected(), 52 + 'paths': { 53 + 'js': { 54 + 'xwiki-actionButtons': "#getSkinFileWithParams('js/xwiki/actionbuttons/actionButtons.js' $jsParams)", 55 + 'xwiki-autoSave': "#getSkinFileWithParams('js/xwiki/editors/autosave.js' $jsParams)", 56 + 'xwiki-diff': $xwiki.getSkinFile('uicomponents/viewers/diff.js') 57 + }, 58 + 'css': [ 59 + "#getSkinFileWithParams('js/xwiki/actionbuttons/actionButtons.css' $cssParams)", 60 + "#getSkinFileWithParams('js/xwiki/editors/autosave.css' $cssParams)", 61 + "#getSkinFileWithParams('uicomponents/viewers/diff.css' $cssParams)" 62 + ] 63 + }, 64 + 'l10n': $l10n 10 10 }) 11 11 <div class="hidden" data-inplace-editing-config="$escapetool.xml($jsontool.serialize($inplaceEditingConfig))"></div> 12 12 ## We didn't move this to the file system because it uses LESS and we didn't want to include it in the skin.
- XWiki.UIExtensionClass[1]
-
- Cached
-
... ... @@ -1,1 +1,0 @@ 1 -No - Asynchronous rendering
-
... ... @@ -1,1 +1,0 @@ 1 -No - Executed Content
-
... ... @@ -1,22 +1,0 @@ 1 -{{velocity}} 2 -{{html clean="false"}} 3 -## Output the translation button if all the following conditions are met: 4 -## * multilingual is on 5 -## * we're loading the original document version 6 -## * the original document version has a locale specified (it doesn't make sense to translate technical documents) 7 -## * the current UI locale doesn't match the original document locale 8 -#if ($xwiki.isMultiLingual() && $tdoc.realLocale == $doc.realLocale && "$!doc.realLocale" != '' 9 - && $doc.realLocale != $xcontext.locale) 10 - #set ($url = $doc.getURL('edit', $escapetool.url({'language': $xcontext.locale}))) 11 - #set ($hint = $services.localization.render('edit.inplace.page.translate.hint', 12 - [$xcontext.locale.getDisplayName($xcontext.locale)])) 13 - ## We show the translate button only while editing in-place. 14 - <div class="btn-group hidden" id="tmTranslate"> 15 - <a class="btn btn-default" href="$url" role="button" title="$escapetool.xml($hint)"> 16 - $services.icon.renderHTML('translate') 17 - <span class="btn-label">$escapetool.xml($services.localization.render('edit.inplace.page.translate'))</span> 18 - </a> 19 - </div> 20 -#end 21 -{{/html}} 22 -{{/velocity}} - Extension Point ID
-
... ... @@ -1,1 +1,0 @@ 1 -org.xwiki.plaftorm.menu.content - Extension ID
-
... ... @@ -1,1 +1,0 @@ 1 -org.xwiki.plaftorm.menu.content.translate - Extension Parameters
-
... ... @@ -1,1 +1,0 @@ 1 -order=5000 - Extension Scope
-
... ... @@ -1,1 +1,0 @@ 1 -wiki