Fragmentos de texto/markdown insertables y centralmente mantenidos

Wiki de la comunidad Desarrolladores
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 Me gusta
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 Me gusta
3

That’s awesome! Thanks @Johani

Added to Tips’n’Tricks.

2 Me gusta
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 Me gusta
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 Me gusta
6

La sugerencia de @pacharanero también sería fantástica para nosotros. En nuestro caso, serían solo para el personal, por lo que no querríamos que nada se mostrara en la barra de herramientas del editor, pero sería increíble poder ingresar un código corto para insertar el bloque de actualización automática :+1:

1 me gusta
7

Por ahora, una forma no centralizada y no de Discourse de lograr este comportamiento hoy en día es usar un administrador de portapapeles multiplataforma como CopyQ y configurar la sección ‘Comandos/Atajos globales’ para que pueda insertar texto arbitrario en el portapapeles.

Estos fragmentos se pueden administrar en la interfaz de usuario de CopyQ, asignar a una tecla de acceso rápido o aparecer en el menú contextual derecho de CopyQ. No es tan bueno como un plugin integrado en Discourse, pero tiene la ventaja de funcionar en todas las aplicaciones, ¡y ya existe!

(Tenga en cuenta que esto tendría que configurarse en cada una de las computadoras que desee utilizar de esta manera. Puede exportar e importar estos comandos y atajos globales a un archivo, para permitir la configuración de la misma configuración en varias máquinas o en un equipo)

8

Eso estaría absolutamente bien para mí. Creo que, a diferencia de DiscoTOC y Placeholders, necesitaría ser renderizado correctamente en el panel de vista previa, pero en el compositor podría simplemente mostrar la frase desencadenante que se eligiera: :slug:.

9

Gracias por la respuesta. La solución de CopyQ no hace lo que busco (creo, al menos).

Por ejemplo, me gustaría introducir un fragmento en una publicación (por ejemplo, :slug:) y luego, siempre que se renderice, se renderizará el contenido actual de este slug (que podría contener markdown). Si cambio el contenido de este slug, todas las publicaciones que lo utilicen se actualizarán inmediatamente para tener el nuevo contenido (la publicación en sí solo contiene el slug y el contenido se inserta al renderizar).

Me parecería bien que la búsqueda no supiera que el contenido existe (y solo mostrar la versión final cocinada está bien para mí).

Saludos.

10

Aquí hay un enfoque diferente…

1 me gusta