[XWI-142] Enable wiki macros in more editors (#24480)

* Centralise CKEditor wiki macro
* Move the `wikisAvailable` check into the central CKEditor macro resolver and add a `wiki` macro preset, so any editor can opt in with a one-liner instead of repeating the logic.
* Add `wiki` macro to the CKeditor in many places

The places are:
- comments (activity)
- custom fields (long text)
- custom fields help text
- meetings:
  - description
  - outcomes
  - agenda item

Author: shiroginne

app/components/open_project/common/inplace_edit_fields/rich_text_area_component.rb

@@ -45,6 +45,8 @@ def initialize(form:, attribute:, model:, show_action_buttons: true, **system_ar
 
           @system_arguments[:rich_text_options] ||= {}
           @system_arguments[:rich_text_options][:primerized] = true
+          # Text custom fields offer the wiki-page-link macros (AC: "custom field of type text").
+          @system_arguments[:rich_text_options][:macros] ||= "wiki" if custom_field?
 
           @system_arguments[:data] = merge_data(
             @system_arguments,

app/forms/custom_fields/inputs/text.rb

@@ -36,7 +36,7 @@ class CustomFields::Inputs::Text < CustomFields::Inputs::Base::Input
   def rich_text_options
     {
       resource: nil,
-      macros: "none",
+      macros: "wiki",
       data: {
         "custom-field-id": @custom_field.id,
         "test-selector": test_selector

app/forms/work_packages/activities_tab/journals/notes_form.rb

@@ -41,7 +41,8 @@ class NotesForm < ApplicationForm
           showAttachments: false,
           resource:,
           storageKey: "work_package-#{object.journable.id}-notes-#{object.id || 'new'}",
-          editor_type: "constrained"
+          editor_type: "constrained",
+          macros: "wiki"
         }
       )
     end

frontend/src/app/features/hal/resources/work-package-resource.ts

@@ -52,7 +52,6 @@ import { ICKEditorContext } from 'core-app/shared/components/editor/components/c
 import isNewResource from 'core-app/features/hal/helpers/is-new-resource';
 import { IWorkPackageTimestamp } from 'core-app/features/hal/resources/work-package-timestamp-resource';
 import { formatWorkPackageId } from 'core-app/shared/helpers/work-package-id-pattern';
-import { ConfigurationService } from 'core-app/core/config/configuration.service';
 
 export interface WorkPackageResourceEmbedded {
   activities:CollectionResource;
@@ -192,8 +191,6 @@ export class WorkPackageBaseResource extends HalResource {
 
   @LazyInject() pathHelper:PathHelperService;
 
-  @LazyInject() configService:ConfigurationService;
-
   readonly attachmentsBackend = true;
 
   /**
@@ -244,13 +241,15 @@ export class WorkPackageBaseResource extends HalResource {
   }
 
   public getEditorContext(fieldName:string):ICKEditorContext {
-    const wikiPageMacros = ['OpMacroWikiPageLinkAddExisting', 'OpMacroWikiPageLinkCreateNew'];
-    const macros:boolean|string[] = this.configService.wikisAvailable ? wikiPageMacros : false;
+    if (fieldName === 'description') {
+      return { type: 'full', macros: 'wiki' };
+    }
 
+    const isCustomField = fieldName.startsWith('customField');
     return {
-      type: fieldName === 'description' ? 'full' : 'constrained',
-      macros,
-      ...(fieldName.startsWith('customField') && { disabledMentions: ['user'] }),
+      type: 'constrained',
+      macros: isCustomField ? 'wiki' : false,
+      ...(isCustomField && { disabledMentions: ['user'] }),
     };
   }
 

frontend/src/app/shared/components/editor/components/ckeditor/ckeditor-setup.service.ts

@@ -38,7 +38,21 @@ import { Constructor } from '@angular/cdk/schematics';
 import { ConfigurationService } from 'core-app/core/config/configuration.service';
 
 export type ICKEditorType = 'full'|'constrained';
-export type ICKEditorMacroType = 'none'|'resource'|'full'|boolean|string[];
+
+// What editor authors pass; resolveMacros() turns it into an ICKEditorResolvedMacros value.
+// The wiki-link macros are appended to any array result when a wiki provider is available.
+//   'none' / false → no macros (dropdown hidden)
+//   'resource'     → ToC, embedded table, WP button/quickinfo (+ wiki links when available)
+//   'wiki'         → only the wiki links, and only when a provider is available (else none)
+//   true           → keep every macro the build ships, regardless of wiki availability
+//   string[]       → exactly these macro plugin names (+ wiki links when available)
+export type ICKEditorMacroType = 'none'|'resource'|'wiki'|boolean|string[];
+
+// What the CKEditor build consumes: false = none, true = all, array = exactly these.
+export type ICKEditorResolvedMacros = boolean|string[];
+
+// Wiki-page-link macros, added to any editor when a wiki provider is configured (see resolveMacros).
+const wikiLinkMacros = ['OpMacroWikiPageLinkAddExisting', 'OpMacroWikiPageLinkCreateNew'];
 
 declare global {
   interface Window {
@@ -132,9 +146,10 @@ export class CKEditorSetupService {
   private createConfig(context:ICKEditorContext, initialData:string|null) {
     const uiLocale = this.loadedLocale;
     const contentLanguage = context.options?.rtl ? 'ar' : 'en';
+    const resolvedContext:ICKEditorContext = { ...context, macros: this.resolveMacros(context.macros) };
 
     const config = {
-      openProject: this.createContext(context),
+      openProject: this.createContext(resolvedContext),
       removePlugins: context.removePlugins,
       initialData,
       ui: {
@@ -148,6 +163,10 @@ export class CKEditorSetupService {
       },
       link: {},
       storageKey: context.storageKey,
+      // Constrained editors have no macro dropdown by default; add one when macros are present.
+      ...(context.type === 'constrained' && Array.isArray(resolvedContext.macros)
+        ? { toolbar: { items: this.constrainedToolbarWithMacroList() } }
+        : {}),
     };
 
     const allowedLinkProtocols = this.configurationService.allowedLinkProtocols;
@@ -209,22 +228,60 @@ export class CKEditorSetupService {
   }
 
   private createContext(context:ICKEditorContext):unknown {
-    if (context.macros === 'none') {
-      context.macros = false;
-    } else if (context.macros === 'resource') {
-      context.macros = [
+    return {
+      context,
+      helpURL: this.PathHelper.textFormattingHelp(),
+      pluginContext: window.OpenProject.pluginContext.value,
+    };
+  }
+
+  // Splice `macroList` into the constrained editor's own toolbar (which omits it by default).
+  private constrainedToolbarWithMacroList():string[] {
+    const items = [...(window.OPConstrainedEditor.defaultConfig?.toolbar?.items ?? [])];
+
+    if (!items.includes('macroList')) {
+      const anchor = items.indexOf('blockQuote');
+      const insertAt = anchor === -1 ? items.length : anchor + 1;
+      items.splice(insertAt, 0, '|', 'macroList');
+    }
+
+    return items;
+  }
+
+  // Expand macro tokens and add/withhold the wiki macros based on `wikisAvailable`.
+  // `false`/`'none'` stay macro-free, keeping custom fields and read-only editors untouched.
+  private resolveMacros(macros:ICKEditorMacroType|undefined):ICKEditorResolvedMacros {
+    let resolved = macros;
+
+    if (!resolved || resolved === 'none') {
+      return false;
+    }
+    if (resolved === true) {
+      return true;
+    }
+    if (resolved === 'resource') {
+      resolved = [
         'OPMacroToc',
         'OPMacroEmbeddedTable',
         'OPMacroWpButton',
         'OPMacroWpQuickinfo',
       ];
+    } else if (resolved === 'wiki') {
+      resolved = [];
     }
 
-    return {
-      context,
-      helpURL: this.PathHelper.textFormattingHelp(),
-      pluginContext: window.OpenProject.pluginContext.value,
-    };
+    if (Array.isArray(resolved)) {
+      resolved = this.configurationService.wikisAvailable
+        ? [...new Set([...resolved, ...wikiLinkMacros])]
+        : resolved.filter((name) => !wikiLinkMacros.includes(name));
+
+      // Empty set ⇒ false, so no (empty) dropdown is shown.
+      if (resolved.length === 0) {
+        return false;
+      }
+    }
+
+    return resolved;
   }
 
   private watchTopLayer() {

frontend/src/app/shared/components/editor/components/ckeditor/ckeditor.types.ts

@@ -89,6 +89,8 @@ export interface ICKEditorStatic {
   create(el:HTMLElement, config?:any):Promise<ICKEditorInstance>;
 
   createCustomized(el:string|HTMLElement, config?:any):Promise<ICKEditorInstance>;
+
+  defaultConfig?:{ toolbar?:{ items:string[] } };
 }
 
 export type ICKEditorState = 'initializing'|'ready'|'crashed'|'crashedPermanently'|'destroyed';

lib/custom_field_form_builder.rb

@@ -73,7 +73,7 @@ def custom_field_input(options = {})
     when "date"
       date_picker(field, input_options)
     when "text"
-      text_area(field, input_options.merge(with_text_formatting: true, macros: false, editor_type: "constrained"))
+      text_area(field, input_options.merge(with_text_formatting: true, macros: "wiki", editor_type: "constrained"))
     when "bool"
       check_box(field, input_options.merge(checked: custom_value.strategy.checked?))
     when "list"

modules/grids/app/components/grids/widgets/description.html.erb

@@ -22,7 +22,7 @@ GNU General Public License for more details.
 
 You should have received a copy of the GNU General Public License
 along with this program; if not, write to the Free Software
-Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 
 See COPYRIGHT and LICENSE files for more details.
 
@@ -37,7 +37,7 @@ See COPYRIGHT and LICENSE files for more details.
       rich_text_options: {
         showAttachments: false,
         editorType: "constrained",
-        macros: false
+        macros: "wiki"
       }
     )
   end

modules/grids/app/components/grids/widgets/project_status.html.erb

@@ -42,7 +42,7 @@ See COPYRIGHT and LICENSE files for more details.
             rich_text_options: {
               showAttachments: false,
               editorType: "constrained",
-              macros: false
+              macros: "wiki"
             }
           )
         end

modules/meeting/app/forms/meeting_agenda_item/outcome/notes.rb

@@ -39,6 +39,7 @@ class MeetingAgendaItem::Outcome::Notes < ApplicationForm
       rich_text_options: {
         resource:,
         editor_type: "constrained",
+        macros: "wiki",
         storageKey: "meeting-agenda-#{object.meeting_agenda_item&.id || 'new'}-outcome-#{object.id || 'new'}",
         showAttachments: false
       }