Changes for page EditSheet

Last modified by teamwire005 on 2025/05/06 08:20

From 3.1 to 4.1

From version 1.1

edited by teamwire001
on 2021/06/11 07:39

Change comment: Install extension [org.xwiki.contrib:application-ckeditor-ui/1.53.2]

To version 3.1

edited by teamwire004
on 2024/01/16 09:33

Change comment: Install extension [org.xwiki.platform:xwiki-platform-ckeditor-ui/14.10.13]

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)
Objects (5 modified, 0 added, 0 removed)

Details

Page properties

Author

@@ -1,1 +1,1 @@
--XWiki.teamwire001
++XWiki.teamwire004

XWiki.JavaScriptExtension[0]

Code

@@ -1,49 +1,40 @@
  /*
--#set ($ckeditorPath = $services.webjars.url('org.xwiki.contrib:application-ckeditor-webjar', 'ckeditor'))
--#set ($bootstrap3typeaheadPath = $services.webjars.url('org.webjars.npm:bootstrap-3-typeahead', 'bootstrap3-typeahead.min'))
--#set ($fastDiffPath = $services.webjars.url('org.webjars.npm:fast-diff', 'diff'))
--#if ($ckeditorPath.indexOf('?') >= 0)
--  ## Before XWiki 7.1M1 the WebJar resource path was included in the query string which means we have to specify the
--  ## '.js' extension (Require.js doesn't add it in this case).
--  #set ($ckeditorPath = "${ckeditorPath}.js")
--  #set ($bootstrap3typeaheadPath = "${bootstrap3typeaheadPath}.js")
--  #set ($fastDiffPath = "${$fastDiffPath}.js")
++#if ($services.debug.minify)
++  #set ($jsExtension = '.min')
++#else
++  #set ($jsExtension = '')
  #end
++#set ($ckeditorPath = $services.webjars.url('org.xwiki.platform:xwiki-platform-ckeditor-webjar', 'ckeditor'))
  #set ($ckeditorBasePath = $stringtool.removeEnd($stringtool.removeEnd($ckeditorPath, '.js'), 'ckeditor'))
--#set ($resourcePickerBundlePath = "${ckeditorBasePath}plugins/xwiki-resource/resourcePicker.bundle.min")
--#set ($macroWizardBundlePath = "${ckeditorBasePath}plugins/xwiki-macro/macroWizard.bundle.min")
++#set ($resourcePickerBundlePath = "${ckeditorBasePath}plugins/xwiki-resource/resourcePicker.bundle$jsExtension")
++#set ($macroWizardBundlePath = "${ckeditorBasePath}plugins/xwiki-macro/macroWizard.bundle$jsExtension")
++#set ($imageWizardBundlePath = "${ckeditorBasePath}plugins/xwiki-image/imageWizard.bundle$jsExtension")
  #set ($modalPath = "${ckeditorBasePath}plugins/xwiki-dialog/modal.min")
  #set ($l10nPath = "${ckeditorBasePath}plugins/xwiki-localization/l10n.min")
--#if ($resourcePickerBundlePath.indexOf('?') >= 0)
--  ## Before XWiki 7.1M1 the WebJar resource path was included in the query string which means we have to specify the
--  ## '.js' extension (Require.js doesn't add it in this case).
--  #set ($resourcePickerBundlePath = "${resourcePickerBundlePath}.js")
--  #set ($macroWizardBundlePath = "${macroWizardBundlePath}.js")
--  #set ($modalPath = "${modalPath}.js")
--  #set ($l10nPath = "${l10nPath}.js")
--#end
  */
  require.config({
    paths: {
      ckeditor: '$!ckeditorPath',
--    resource: '$!resourcePickerBundlePath',
--    resourcePicker: '$!resourcePickerBundlePath',
--    entityResourcePicker: '$!resourcePickerBundlePath',
--    entityResourceSuggester: '$!resourcePickerBundlePath',
--    entityResourceDisplayer: '$!resourcePickerBundlePath',
++    resourcePickerBundle: '$!resourcePickerBundlePath',
      modal: '$!modalPath',
      l10n: '$!l10nPath',
      macroWizard: '$!macroWizardBundlePath',
++    imageWizard: '$!imageWizardBundlePath',
      // This is used by the resource suggest picker on the link modal.
--    'bootstrap3-typeahead': '$!bootstrap3typeaheadPath',
++    'bootstrap3-typeahead': $jsontool.serialize($services.webjars.url('org.webjars.npm:bootstrap-3-typeahead',
++      'bootstrap3-typeahead.min')),
      // This is used to preserve the selection when switching between WYSIWYG and Source modes.
--    'fast-diff': '$!fastDiffPath'
++    'fast-diff': $jsontool.serialize($services.webjars.url('org.webjars.npm:fast-diff', 'diff'))
    },
++  bundles: {
++    'resourcePickerBundle': ['resource', 'resourcePicker', 'entityResourcePicker', 'entityResourceSuggester',
++      'entityResourceDisplayer']
++  },
    shim: {
      ckeditor: {
        exports: 'CKEDITOR',
        // This includes dependencies of the plugins bundled with the CKEditor code.
--      deps: ['jquery', 'resource', 'resourcePicker', 'macroWizard']
++      deps: ['jquery', 'resource', 'resourcePicker', 'macroWizard', 'imageWizard']
      }
    },
    config: {
@@ -72,53 +72,6 @@
    "$!services.webjars.url('org.xwiki.platform:xwiki-platform-tree-webjar', 'require-config.min.js', {'evaluate': true})"
  ], function($, ckeditor, xwikiMeta) {
    var deferred = $.Deferred();
--
--  var loadJavaScriptSkinExtensions = $jsontool.serialize($xwiki.getDocument('CKEditor.Config'
--    ).getValue('loadJavaScriptSkinExtensions')) === 1;
--
--  // See http://docs.ckeditor.com/#!/guide/dev_allowed_content_rules
--  var allowedContentBySyntax = {
--    'xwiki/2.1': {
--      '$1': {
--        elements: {
--          // Elements required because the editor input is a full HTML page.
--          html: true, head: true, link: true, script: loadJavaScriptSkinExtensions, body: true,
--          // Headings
--          h1: true, h2: true, h3: true, h4: true, h5: true, h6: true,
--          // Lists
--          dl: true, ol: true, ul: true,
--          // Tables
--          table: true, tr: true, th: true, td: true,
--          // Formatting
--          span: true, strong: true, em: true, ins: true, del: true, sub: true, sup: true, tt: true, pre: true,
--          // Others
--          div: true, hr: true, p: true, a: true, img: true, blockquote: true
--        },
--        // The elements above can have any attribute, through the parameter (%%) syntax.
--        attributes: '*',
--        styles: '*',
--        classes: '*'
--      },
--      '$2': {
--        // The XWiki syntax doesn't support parameters for the following elements.
--        elements: {br: true, dd: true, dt: true, li: true, tbody: true}
--      },
--      '$3': {
--        // Wiki syntax macros can output any HTML.
--        match: CKEDITOR.plugins.xwikiMacro.isMacroOutput,
--        attributes: '*',
--        styles: '*',
--        classes: '*'
--      }
--    },
--    'plain/1.0': ';'
--  };
--  allowedContentBySyntax['xwiki/2.0'] = allowedContentBySyntax['xwiki/2.1'];
--  // This is a hack, increasing the technical debt since the CKEditor module should not know about the Markdown
--  // syntax. Actually it should not know either about the xwiki/2.0 and xwiki/2.1 syntaxes ;)
--  // This should be fixed by implementing https://jira.xwiki.org/browse/CKEDITOR-319
--  allowedContentBySyntax['markdown/1.2'] = allowedContentBySyntax['xwiki/2.1'];
--
    var currentLocale = $('html').attr('lang') || '';
    // We have to pass the plugin that makes the request (the initiator) because the expected response can be different
@@ -127,6 +127,7 @@
      return document.getURL('get', $.param({
        sheet: 'CKEditor.FileUploader',
        outputSyntax: 'plain',
++      // The syntax and language are important especially when the upload request creates a new document.
        syntax: document.syntax,
        language: currentLocale,
        form_token: xwikiMeta.form_token,
@@ -136,45 +136,26 @@
    // Extend the default CKEditor configuration with settings that depend on the source document.
    var getConfig = function(element) {
++    var sourceSyntax = $(element).attr('data-syntax');
      var sourceDocument = XWiki.currentDocument;
--    var sourceDocumentReference = $(element).attr('data-sourceDocumentReference');
--    if (sourceDocumentReference) {
--      sourceDocument = new XWiki.Document(XWiki.Model.resolve(sourceDocumentReference, XWiki.EntityType.DOCUMENT));
++    sourceDocument.syntax = XWiki.docsyntax;
++    var sourceDocumentReference = XWiki.Model.resolve($(element).attr('data-sourceDocumentReference'),
++      XWiki.EntityType.DOCUMENT, XWiki.currentDocument.documentReference);
++    if (!XWiki.currentDocument.documentReference.equals(sourceDocumentReference)) {
++      sourceDocument = new XWiki.Document(sourceDocumentReference);
++      // We assume the syntax of the source document is the same as the syntax of the edited content.
++      sourceDocument.syntax = sourceSyntax;
      }
--    sourceDocument.syntax = $(element).attr('data-sourceDocumentSyntax');
++
++    var uploadDisabled = element.hasAttribute('data-upload-disabled');
++
      var config = {
--      allowedContent: allowedContentBySyntax[sourceDocument.syntax],
--      editorplaceholder: $jsontool.serialize($services.localization.render('ckeditor.content.placeholder')),
--      filebrowserUploadUrl: getUploadURL(sourceDocument, 'filebrowser'),
--      // This is used in CKEditor.FileUploader so we must keep them in sync.
--      fileTools_defaultFileName: '__fileCreatedFromDataURI__',
++      filebrowserUploadUrl: uploadDisabled ? '' : getUploadURL(sourceDocument, 'filebrowser'),
        height: $(element).height(),
--      // CKEditor uses '-' (dash) as locale separator (between the language code and the country code).
--      language: currentLocale.toLowerCase().replace('_', '-'),
--      uploadUrl: getUploadURL(sourceDocument, 'filetools'),
--      'xwiki-link': {
--        labelGenerator: sourceDocument.getURL('get', $.param({
--          sheet: 'CKEditor.LinkLabelGenerator',
--          outputSyntax: 'plain',
--          language: currentLocale
--        }))
--      },
--      'xwiki-resource': {
--        dispatcher: sourceDocument.getURL('get', $.param({
--          sheet: 'CKEditor.ResourceDispatcher',
--          outputSyntax: 'plain',
--          language: currentLocale
--        }))
--      },
--      'xwiki-source': {
--        htmlConverter: sourceDocument.getURL('get', $.param({
--          sheet: 'CKEditor.HTMLConverter',
--          outputSyntax: 'plain',
--          language: currentLocale
--        }))
--      },
        mentions: [
          {
++          // We use the source document to compute the feed URL because we want the suggested link references to be
++          // relative to the edited document (we want the editor to output relative references as much as possible).
            feed: sourceDocument.getURL('get', $.param({
              sheet: 'CKEditor.LinkSuggestions',
              outputSyntax: 'plain',
@@ -195,20 +195,28 @@
                '<div class="ckeditor-autocomplete-item-hint">{hint}</div>',
              '</li>'].join(''),
            outputTemplate: '<a href="{url}" data-reference="{typed}|-|{type}|-|{reference}">{label}</a>',
++          followingSpace: true,
            marker: '[',
            minChars: 0,
            itemsLimit: 6
          }
--      ]
--    };
--    if ($(element).attr('data-officeImporterSupported') === 'true') {
--      config['xwiki-office'] = {
--        importer: sourceDocument.getURL('get', $.param({
--          sheet: 'CKEditor.OfficeImporter',
++      ],
++      // Used to resolve and serialize relative references. Also used to make HTTP requests with the right context.
++      sourceDocument: sourceDocument,
++      // The syntax of the edited content is not always the same as the syntax of the source document (which applies to
++      // the source document content, but we might be editing something else, like an object property).
++      sourceSyntax: sourceSyntax,
++      uploadUrl: uploadDisabled ? '' : getUploadURL(sourceDocument, 'filetools'),
++      'xwiki-link': {
++        // We use the source document to compute the link label generator URL because we want the link references to be
++        // resolved relative to the edited document (as they were inserted).
++        labelGenerator: sourceDocument.getURL('get', $.param({
++          sheet: 'CKEditor.LinkLabelGenerator',
++          outputSyntax: 'plain',
            language: currentLocale
          }))
--      };
--    }
++      }
++    };
      return config;
    };

XWiki.JavaScriptExtension[1]

Code

@@ -163,16 +163,3 @@
    ckeEditMeta.attr('id', 'editMeta').addClass('col-md-pull-5')
      .before($('#contentmenu').parent('.col-md-5').addClass('col-md-push-7'));
  });
--
--// Activate the auto-save feature on XWiki versions older than 8.2RC1 (XE-1562), where CKEditor is not the default
--// WYSIWYG editor and thus it is loaded with a sheet (CKEditor.EditSheet). Note that for XWiki 8.2RC1 and 8.2 (where
--// CKEditor is the default WYSIWYG editor) the auto-save feature is not activated because the WYSIWYG edit mode doesn't
--// active it. This has been fixed in 8.2.1 and 8.3M1 (XWIKI-8614).
--// Note that we can't enable auto-save by loading autosave.js from the editing sheet (CKEditor.EditSheet) because on
--// older versions of XWiki (XWIKI-8614) autosave.js needs to be loaded after actionbuttons.js, which is loaded after the
--// editing sheet is rendered.
--require(['jquery'], function($) {
--  if ($('#xwikieditcontent').data('autosave')) {
--    require(["$xwiki.getSkinFile('js/xwiki/editors/autosave.js', true)"]);
--  }
--});

XWiki.JavaScriptExtension[2]

Code

@@ -1,4 +1,11 @@
  require(['jquery', 'xwiki-ckeditor', 'xwiki-events-bridge'], function($, ckeditorPromise) {
++  // Make sure we don't create the editors twice because this file can be loaded twice (by RequireJS, for in-place
++  // editing, and as a JSX resource, for standalone editing).
++  if (ckeditorPromise.__editSheetLoaded) {
++    return;
++  }
++  ckeditorPromise.__editSheetLoaded = true;
++
    var createEditors = function(ckeditor, container) {
      container.find('.ckeditor-textarea').each(function() {
        // Wrap in try/catch so that a failure to load one editor doesn't affect the other editors.
@@ -13,9 +13,9 @@
    var createEditor = function(ckeditor, textArea, instanceConfig) {
      var deferred = $.Deferred();
      var editor = ckeditor.replace(textArea, instanceConfig);
--    editor.once('instanceReady', $.proxy(deferred, 'resolve', editor));
++    editor.once('instanceReady', deferred.resolve.bind(deferred, editor));
      editor.once('reload', function(event) {
--      event.data.promise = event.data.promise.then($.proxy(createEditor, null, ckeditor, textArea));
++      event.data.promise = event.data.promise.then(createEditor.bind(null, ckeditor, textArea));
      });
      return deferred.promise();
    };

XWiki.StyleSheetExtension[0]

Code

@@ -1,7 +1,7 @@
  #template('colorThemeInit.vm')
  /*
--#set ($ckeditorSkinPath = $services.webjars.url('org.xwiki.contrib:application-ckeditor-webjar', 'skins/moono-lisa'))
++#set ($ckeditorSkinPath = $services.webjars.url('org.xwiki.platform:xwiki-platform-ckeditor-webjar', 'skins/moono-lisa'))
  #if ($ckeditorSkinPath.indexOf('?') >= 0)
    ## The WebJar resource path was specified in the query string before 7.1M1 which prevented the browser from resolving
    ## relative paths. See XWIKI-10880 (A CSS file inside a webjar cannot use a resource from that webjar).

XWiki.UIExtensionClass[0]

Extension Parameters

@@ -1,2 +1,2 @@
  id=xwiki-ckeditor
--path=$xwiki.getURL('CKEditor.EditSheet', 'jsx', $escapetool.url({'v': $services.extension.installed.getInstalledExtension('org.xwiki.contrib:application-ckeditor-ui', "wiki:$xcontext.database").version.value, 'xwiki-version': $services.extension.core.getCoreExtension('org.xwiki.platform:xwiki-platform-tree-webjar').version.value, 'fast-diff-version': $services.extension.installed.getInstalledExtension('org.webjars.npm:fast-diff', "wiki:$xcontext.database").version.value, 'bs3typeahead-version': $services.extension.installed.getInstalledExtension('org.webjars.npm:bootstrap-3-typeahead', "wiki:$xcontext.database").version.value}))
++path=$xwiki.getURL('CKEditor.EditSheet', 'jsx', $escapetool.url({'v': $services.extension.installed.getInstalledExtension('org.xwiki.platform:xwiki-platform-ckeditor-ui', "wiki:$xcontext.database").version.value, 'xwiki-version': $services.extension.core.getCoreExtension('org.xwiki.platform:xwiki-platform-tree-webjar').version.value, 'fast-diff-version': $services.extension.installed.getInstalledExtension('org.webjars.npm:fast-diff', "wiki:$xcontext.database").version.value, 'bs3typeahead-version': $services.extension.installed.getInstalledExtension('org.webjars.npm:bootstrap-3-typeahead', "wiki:$xcontext.database").version.value}))

Changes for page EditSheet

Summary

Details

Last edited

Content