Botón de crear un tema nuevo con categoría y plantilla de tema

Estoy revisando el siguiente tema como referencia.

Mi objetivo es encontrar una forma de agregar un botón secundario para crear nuevos temas que aparezca para los miembros de un grupo específico. Este grupo tiene acceso a un área privada en el foro y me gustaría que el botón en cuestión inicie un nuevo tema en esa área del foro, independientemente de la página en la que se encuentren. También busco utilizar una plantilla de tema o una funcionalidad de plantilla similar con este botón. Creo que he descubierto cómo agregar el botón de manera selectiva basándome en la clase del grupo principal en el body, pero por el momento no estoy lo suficientemente familiarizado para insertar algún texto de plantilla (o plantilla de tema) en los nuevos temas creados con este botón secundario. ¿Alguien tiene algún consejo?

4 Me gusta

Esto es posible. Primero debes preparar tu categoría con una plantilla de tema. Ve a la categoría que deseas usar y edita su plantilla de tema de la siguiente manera:


Luego, averigua cuál es el ID de la categoría. Puedes hacerlo accediendo a your.site.com/categories.json

Aquí en Meta se ve así:

Probablemente exista una forma mejor de encontrar el categoryId, pero esto funciona según lo necesario aquí.

Ahora, digamos que quiero usar la categoría bug. Su ID sería “1” según /categories.json.

Para #feature, sería “2” y así sucesivamente.


Ahora que tienes el ID y la categoría tiene una plantilla de tema, puedes copiar el código del tema, realizar algunas modificaciones y agregarlo a un componente de tema separado.

He realizado las modificaciones aquí para que solo tengas que copiar esto y cambiar los valores según sea necesario:

<script type="text/discourse-plugin" version="0.8.18">
api.decorateWidget("header-buttons:after", helper => {
  if (api.getCurrentUser()) {
      
    // edita estos dos a tu gusto
    var $ntb_text = "texto del botón",
      $ntb_icon = "plus",
      
      // no es necesario editar estos
      $ntb_icon_class = ".fa-" + $ntb_icon,
      $ntb_button_class = "btn btn-default btn btn-icon-text",
      $ntb_button_helper = "button#new-create-topic-custom",
      $ntb_icon_helper =
        "i.fa" + $ntb_icon_class + ".d-icon .d-icon-" + $ntb_icon,
      $ntb_label_helper = "span.d-button-label";

    const createTopicCustom = function() {
      const container = Discourse.__container__;
      const Composer = require("discourse/models/composer").default;
      const controller = container.lookup("controller:navigation/category");
      const composerController = container.lookup("controller:composer");

      composerController.open({
        action: Composer.CREATE_TOPIC,
        draftKey: Composer.DRAFT,

        // establece el ID de la categoría a continuación
        // consulta site.com/categories.json
        // para referencia
        categoryId: 3
      });
    };

    return helper.h(
      $ntb_button_helper,
      {
        className: $ntb_button_class,
        title: $ntb_text,
        onclick: createTopicCustom
      },
      [helper.h($ntb_icon_helper), helper.h($ntb_label_helper, $ntb_text)]
    );
  }
});

</script>

Esto va en la sección <head> bajo Común.


Una vez que termines, deberías tener algo como esto: (he añadido márgenes con CSS)

Al hacer clic en el nuevo botón se abrirá el compositor con la categoría que seleccionaste y también estará presente la plantilla de tema de la categoría.

Asumo que eso es todo lo que necesitas aquí, basado en:

16 Me gusta

Thanks Joe. I’ve already found a use for your instructions above. Very helpful.

Do you know how to create a PM, rather than posting into a category?

eg: Is there a CategoryID specifically for PM messages?

1 me gusta

For a PM you’d need to set a few of the composer options differently.

Something like this:

(Same as above, in a theme component in the </head> section)

<script type="text/discourse-plugin" version="0.8.18">
api.decorateWidget("header-buttons:after", helper => {
  if (Discourse.User.current()) {
    
    // edit these two to your liking
    var $ntb_text = "New Personal Message",
      $ntb_icon = "heart",
        
      // no need to edit these
      $ntb_icon_class = ".fa-" + $ntb_icon,
      $ntb_button_class = "btn btn-default btn btn-icon-text",
      $ntb_button_helper = "button#new-create-topic-custom",
      $ntb_icon_helper =
        "i.fa" + $ntb_icon_class + ".d-icon .d-icon-" + $ntb_icon,
      $ntb_label_helper = "span.d-button-label";

    const createPM = function() {
      const container = Discourse.__container__,
        Composer = require("discourse/models/composer").default,
        composerController = container.lookup("controller:composer");

      composerController.open({
        action: Composer.PRIVATE_MESSAGE,

        // 1- set recipients (Case Sensitive) or comment the line below
        usernames: "discobot,john,mike",

        // 2- set title or comment the line below
        topicTitle: "Title",

        // 3- uncomment the line below to set a "template" for PM.
        // Not really recommended will
        // override any drafts everytime the 
        // button is pressed 
        
        // topicBody: "placeholder content",

        // no need to change these
        archetypeId: "private_message",
        draftKey: Composer.NEW_PRIVATE_MESSAGE_KEY,

      });
    };

    return helper.h(
      $ntb_button_helper,
      {
        className: $ntb_button_class,
        title: $ntb_text,
        onclick: createPM
      },
      [helper.h($ntb_icon_helper), helper.h($ntb_label_helper, $ntb_text)]
    );
  }
});
</script>

Obviously, if you plan on using all three buttons you can reduce the size of the code quite drastically because most of it is shared by all three, but I kept things separate because some might just want to use one and not all three.

What this will do is add a button to the header like so:

Clicking the button will open the composer and the fields will be pre-filled with whatever you chose:

I already left a comment in the code about setting any placeholder content in the body for PMs using this method. It’s not recommended unless you have a very specific template. This will override any previously saved PM drafts everytime you use the button.

That’s why it’s “off” by default in the code above.

I’ve tested this a bit and have not seen any problems. If you encounter anything let me know.

11 Me gusta

Love it. Worked perfectly. Thanks Joe, you’re awesome!

I noticed the user names are case sensitive. If a username’s case is wrong, the name appears in the recipient list, but the PM won’t send. Suggest you add this to your comments: -

    // 1- set recipients (Case Sensitive) or comment the line below 
    usernames: "discobot,john,mike",
3 Me gusta

Hi @Johani - thank you, I have implemented this, but a bit too successfully!

Would it be possible to make a new personal message header button appear only selectively for those who have access to personal messaging? New users by default don’t have access to PM so should not see this button…

We have set the site setting (for our TL0, TL1 and TL2 users (who therefor are restricted from personal messaging))

Thanks again,

1 me gusta

Hi @jerry0

Yes, that is possible!

One way to do this is to look up the current user’s trust level and use that as a base to determine whether or not to create the PM button.

You would use something like this:

<script type="text/discourse-plugin" version="0.8.18">
// no need to edit these
const container = Discourse.__container__,
  controller = container.lookup("controller:application"),
  trust = controller.get("currentUser.trust_level");

api.decorateWidget("header-buttons:after", helper => {
  // change desired trust level here
  if (Discourse.User.current() && trust >= "2") {
    // edit these two to your liking
    var $ntb_text = "New Personal Message",
      $ntb_icon = "heart",
      // no need to edit these
      $ntb_icon_class = ".fa-" + $ntb_icon,
      $ntb_button_class = "btn btn-default btn btn-icon-text",
      $ntb_button_helper = "button#new-create-topic-custom",
      $ntb_icon_helper =
        "i.fa" + $ntb_icon_class + ".d-icon .d-icon-" + $ntb_icon,
      $ntb_label_helper = "span.d-button-label";

    const createPM = function() {
      const Composer = require("discourse/models/composer").default,
        composerController = container.lookup("controller:composer");

      composerController.open({
        action: Composer.PRIVATE_MESSAGE,

        // 1- set recipients (Case Sensitive) or comment the line below
        usernames: "discobot,john,mike",

        // 2- set title or comment the line below
        topicTitle: "Title",

        // 3- uncomment the line below to set a "template" for PM.
        // Not really recommended will
        // override any drafts everytime the
        // button is pressed

        // topicBody: "placeholder content",

        // no need to change these
        archetypeId: "private_message",
        draftKey: Composer.NEW_PRIVATE_MESSAGE_KEY
      });
    };

    return helper.h(
      $ntb_button_helper,
      {
        className: $ntb_button_class,
        title: $ntb_text,
        onclick: createPM
      },
      [helper.h($ntb_icon_helper), helper.h($ntb_label_helper, $ntb_text)]
    );
  }
});
</script>
4 Me gusta

Well that is fab. I will have to wait to get back from my travels tomorrow but will try it out then. Thanks!

2 Me gusta

I’ve now tried it out and it works well. Many thanks.

1 me gusta

Is it only possible to do this if u are able to code?

Um, no - I really can’t :grinning:… just followed the instructions above…

Would it be possible to change the button text for the default + New Topic button based on which category you’re browsing?

2 Me gusta

Yes, that would also be possible as well. You can use something like this in the header section of a theme component

<script type="text/discourse-plugin" version="0.8">
const i18nTopicLable = I18n.lookup("topic.create");
api.modifyClass("component:create-topic-button", {
  didInsertElement: function() {
    var button = $(this),
      category = button[0].parentView.get("category"),
      label = button[0].label,
      newTopicLabel = "topic.create",
      buttonText = "";

    if (category) {
      categoryName = category.name;

      if (label != newTopicLabel) {
        return;
      } else {
        switch (categoryName) {
          case "category1": // category name
            buttonText = "category1 text"; // button text
            break;
          // repeat
          case "category2":
            buttonText = "category2 text";
            break;
          // add more above this line
          default:
            buttonText = i18nTopicLable;
        }
        $("#create-topic .d-button-label").text(buttonText);
      }
    }
  }
});
</script>

To add new categories, you only need to add this above where it says default

case "category":
  buttonText = "text";
  break;

If you have a pending draft and the button says “open draft” the script won’t fire.

I’ve created a small preview on theme creator and changed the text for the movies, tech, school, videos and gaming categories

Edit:
@dax informed me that I had missed something in the snippet I posted previously and so I updated it and the preview so be sure to use the latest one @tophee

13 Me gusta

Esto dejó de funcionar. Se ha publicado una nueva forma de cambiar el nombre del botón según la categoría aquí:

Cómo hacerlo:

  1. Clona o descarga y descomprime el componente del tema desde GitHub - VaperinaDEV/category-btn-name · GitHub
  2. Edita el archivo category-btn-name/locales/en.yml e introduce los distintos textos de botón que quieras usar, por ejemplo:
en:
  new_event: Nuevo evento
  new_deadline: Nueva fecha límite
  1. Edita el archivo category-btn-name/javascripts/discourse/api-initializers/initialize-btn-names.js para definir qué texto de botón usar para qué categorías:
const TRANSLATION_KEYS = {
  "Events": "new_event",
  "Calendar": "new_event",
  "Deadlines": "new_dealine",
};
  1. Instala el componente del tema
2 Me gusta