Trechos de texto/markdown inseríveis, centralmente mantidos

Wiki da comunidade Desenvolvedores
1

I was wondering if there was any way I could define a string of text in a single place and insert it within posts with a single, short reference.

It’s a bit like the out of the box Admin -> Customize -> Text Content, but for my own custom variables that can be inserted into posts.

My use case was adding a disclaimer for my affiliate links. As the number of affiliate links grew across many posts and Topics I noted that my disclaimers were proliferating along with them. I occasionally like to make improvements to the disclaimers and this gets more onerous as the number grows.

I’m also considering making my affiliate links more generic so I have one centrally managed link for each product link, for example, which appears multiple times. If that product link changes, I only have to change it in one place.

Obviously I might be able to do some kind of rails find & replace, but that’s not as clean/safe nor ‘online’.

So I wanted a place to define & maintain a text string in a single place and have changes immediately reflected everywhere that is used on next page view.

Read on for @Johani’s solution!:

3 curtidas
2

One possible option is to use a theme component.

This goes in header.html

<script type="text/discourse-plugin" version="0.8">
var disclaimer = settings.Disclaimer_text,
  disclaimer_selector = 'div[data-theme="disclaimer"]';

$.fn.disclaimer = function() {
  if (!this.length) {
    return;
  } else {
    this.each(function() {
      $(this).html(disclaimer);
    });
    return this;
  }
};

api.decorateCooked($elem => $elem.children(disclaimer_selector).disclaimer());

// create composer button
let currentLocale = I18n.currentLocale();

I18n.translations[currentLocale].js.disclaimer_button = "Add disclaimer";
I18n.translations[currentLocale].js.composer.disclaimer_prompt = ""; // leave empty

api.onToolbarCreate(function(toolbar) {
  toolbar.addButton({
    trimLeading: true,
    id: "disclaimer-button",
    group: "insertions",
    icon: "exclamation-circle", // change icon
    title: "disclaimer_button",
    perform: function(e) {
      return e.applySurround(
        '<div data-theme="disclaimer">',
        "</div>",
        "disclaimer_prompt"
      );
    }
  });
});
</script>

and this goes into your component’s settings.yml file

Disclaimer_text:
  default: "Lorem ipsum dolor sit amet, ei purto complectitur has, per at quas senserit. Et malis libris eos, vix id pericula dissentiet, aliquid apeirian pro eu. Sed ex viderer inciderint, vitae officiis dissentiet eos no. Omnes percipit singulis in has, ne nam nibh tation inciderint. Quas nulla ei sit, ex eam rebum voluptaria. Id eam altera similique. Ex justo assentior persequeris mea, ei hinc paulo ubique mei. <br><br>Cu nam epicurei torquatos, et accusam accommodare vim. Vis sint saperet officiis et. Ad consequat posidonium mea, et duo paulo quidam maluisset, vel an electram expetendis. An vis repudiare tincidunt, mentitum convenire eloquentiam ut vis, summo partiendo pro ad."
  description:
    en: Enter desired disclaimer text. Use &lt;br&gt; for linebreaks.

You would then have a button in the composer that looks like so:

1
1906×1002 20.9 KB

and clicking the button would add

<div data-theme="disclaimer"></div>

which get’s converted to whatever you set in the component’s settings

1
1980×191 10.2 KB

and the end result looks like this

1
11788×556 55.5 KB

and you can use

[data-theme="disclaimer"] {

}

in CSS to style it however you like.

21 curtidas
3

That’s awesome! Thanks @Johani

Added to Tips’n’Tricks.

2 curtidas
4

Hi @merefield - funnily enough I was looking for similar functionality - inserting a standard snippet of text - but rather than a button I wanted a trigger string that would expand out to a piece of markdown. (OK, I suppose alternatively I could modify the button to a dropdown with a few options)

This is probably not a core Discourse feature but a plugin.

Ideal behaviour:

  • I type :stub: (I don’t mind about using something instead of the delimiting : characters, but wondered if hooking into the emoji interface might work since that has the kind of ‘completion’ type behaviour that I’d like)

  • Discourse replaces :stub: with

    > This article is a stub - please improve it by  **editing**  and  **adding links**  and  **detail**  (it’s a ‘wiki’ so any user can edit and add information) or by  **commenting**  below.

  • which is rendered as

    This article is a stub - please improve it by editing and adding links and detail (it’s a ‘wiki’ so any user can edit and add information) or by commenting below

  • and there should be somewhere in the UI to configure these snippets, a bit like the Custom Emoji interface

5 curtidas
5

Great idea for a plugin! Would you be ok for the text to appear only in the preview and the final cooked view?

4 curtidas
6

A sugestão de @pacharanero seria fantástica para nós também. No nosso caso, seria apenas para funcionários, então não gostaríamos que nada fosse exibido na barra de ferramentas do editor, mas inserir um código curto para inserir o bloco de atualização automática seria incrível :+1:

1 curtida
7

Por enquanto, uma forma não-Discourse e não-gerenciada centralmente de obter esse comportamento hoje é usar um gerenciador de área de transferência multiplataforma como o CopyQ e configurar a seção ‘Comandos/Atalhos Globais’ para que você possa inserir texto arbitrário na área de transferência.

Esses trechos podem então ser gerenciados na interface do CopyQ, atribuídos a uma tecla de atalho ou aparecer no menu de contexto do CopyQ. Não é tão bom quanto um plugin incorporado ao Discourse, mas tem a vantagem de funcionar em todos os aplicativos e já existe!

(Observe que isso teria que ser configurado em cada um dos computadores que você gostaria de usar dessa forma. Você pode exportar e importar esses comandos e atalhos globais para um arquivo, para permitir a configuração das mesmas configurações em várias máquinas ou em uma equipe)

8

Isso estaria absolutamente bem para mim. Acho que, ao contrário de DiscoTOC e Placeholders, ele precisaria ser renderizado corretamente no painel de visualização, mas no compositor ele poderia simplesmente mostrar qualquer frase de gatilho :slug: que fosse escolhida.

9

Obrigado pela resposta. A solução do CopyQ não faz o que eu procuro (acho que não, pelo menos).

Por exemplo, eu gostaria de inserir um trecho em uma postagem (por exemplo, :slug:) e, em seguida, sempre que isso for renderizado, ele renderiza o conteúdo atual para este slug (que pode conter markdown). Se eu alterar o conteúdo deste slug, todas as postagens que o utilizam seriam imediatamente atualizadas para ter o novo conteúdo (a postagem em si contém apenas o slug e o conteúdo é inserido na renderização).

Eu ficaria satisfeito se a busca não soubesse que o conteúdo existe também (e apenas mostrar a versão final processada é bom para mim).

Abraços

10

Aqui está uma abordagem diferente…

1 curtida