Patch #31302: Customizable wiki assets in plugin - Redmine

Custom queries

Documentation issues
Open defects
Open features
Patch queue
Plugin issues
Translation patches

Actions

Copy link

Patch #31302

closed

Customizable wiki assets in plugin

Added by Masato NODA almost 5 years ago. Updated almost 5 years ago.

Status:

Closed

Priority:

Normal

Assignee:

Category:

Plugin API

Target version:

Start date:

Due date:

% Done:

Estimated time:

Description

Hi.

If we want to customize assets used in wiki from our plugin, we will override heads_for_wiki_formatter directly.

ex:
https://github.com/pinzolo/redmine_persist_wfmt/blob/master/lib/patches/helper/markdown_helper_patch.rb#L8
https://github.com/wate/graphviz/blob/master/lib/graphviz_helper_patch.rb#L19

But this means that only the last plugins loaded will be reflected.

So, I created a patch to separate the definitions of assets.
Please check this.

Files

Download all files

customizable-wiki-assets.patch (3.22 KB) customizable-wiki-assets.patch		Masato NODA, 2019-05-05 14:57
customizable-wiki-assets-fix.patch (3.22 KB) customizable-wiki-assets-fix.patch		Masato NODA, 2019-05-05 18:38

History
Notes
Property changes

Actions

Copy link

Updated by Go MAEDA almost 5 years ago

Please let me know the following points:

1. How do you rewrite your plugin if the patch is merged?
2. Sorry for the basic question but what does the word "renderigns" in the method name mean?

Actions

Copy link

Updated by Masato NODA almost 5 years ago

File customizable-wiki-assets-fix.patch customizable-wiki-assets-fix.patch added

1. How do you rewrite your plugin if the patch is merged?

My plugin is redmine_persist_wfmt.
I will rewrite as follows.

module Pwfmt::MarkdownHelperPatch
  include Pwfmt::Helper

  def wikitoolbar_for(field_id, preview_url = preview_text_path)
    super(field_id, preview_url) + javascript_tag(pwfmt_select_script(field_id, 'markdown'))
  end

  def asset_renderigns_for_wiki_formatter
    base = super
    base[:script_format_adapter] = Proc.new { javascript_include_tag('toolbar', plugin: 'redmine_persist_wfmt') }
    base
  end
end

Redmine::WikiFormatting::Markdown::Helper.prepend(Pwfmt::MarkdownHelperPatch)

If this patch is merged, partial correction of wiki assets is possible.
For example, wiki toolbar can be modified by multiple plugins.
Current heads_for_wiki_formatter returns no value related rendering asset tag of wiki, it's a problem for plugin that extends wiki toolbar .

2. Sorry for the basic question but what does the word "renderigns" in the method name mean?

Sorry, "renderigns" is a miss spell, correctly "renderings".
I reattach a fixed patch.

Actions

Copy link

Updated by Go MAEDA almost 5 years ago

Target version set to Candidate for next major release

Actions

Copy link

Updated by Go MAEDA almost 5 years ago

Category changed from Wiki to Plugin API
Target version changed from Candidate for next major release to 4.1.0

Setting the target version to 4.1.0.

Actions

Copy link

Updated by Seiei Miyagi almost 5 years ago

But this means that only the last plugins loaded will be reflected.

If `script_format_adapter` is updated by some plugins, will only the plugin loaded last be reflected?

Actions

Copy link

Updated by Masato NODA almost 5 years ago

If `script_format_adapter` is updated by some plugins, will only the plugin loaded last be reflected?

Of course there may be so.
But for plugins that add buttons to the toolbar with additional scripts, this change allows them to co-exist.
Under the current, it can not even do it.

Actions

Copy link

Updated by vzvu 3k6k almost 5 years ago

But for plugins that add buttons to the toolbar with additional scripts, this change allows them to co-exist.
Under the current, it can not even do it.

Maybe I miss the point, but in this case, can't we solve conflicts just by appending plugin's assets like this?

# ref. https://github.com/pinzolo/redmine_persist_wfmt/pull/15

module Pwfmt::MarkdownHelperPatch
  # snip

  def heads_for_wiki_formatter
    # loads all default assets and possibly other plugins' assets
    super

    unless @pwfmt_heads_for_wiki_formatter_included
      content_for :header_tags do
        # overwrites default toolbar buttons
        javascript_include_tag('toolbar', plugin: 'redmine_persist_wfmt')
      end
      @pwfmt_heads_for_wiki_formatter_included = true
    end
  end
end