Categorías de Documentos en Discourse

[pacharanero (Marcus Baw)]

Creo que la confusión y la dificultad podrían deberse a que el Tema Índice debe tener un formato determinado, y esto no está completamente claro en la documentación (publicación principal).

Instalé este plugin yo mismo, siguiendo cuidadosamente las instrucciones, pero no funcionaba exactamente de la misma manera que experimentaba @dennisjbr.

Podría ser útil tener un ejemplo del Markdown requerido en lugar de enlazar al ejemplo de Meta, porque la única regla clave es que DEBE HABER UNA LISTA CON VIÑETAS/NUMERADA EN MARKDOWN. La documentación dice “una lista”, ¡pero la palabra “lista” tiene un uso común en inglés que incluye listas no Markdown!

Esto funcionará como un Tema Índice:

* https://meta.discourse.org/t/discourse-doc-categories/322376
* Texto arbitrario: https://meta.discourse.org/t/discourse-doc-categories/322376

Esto no funcionará:

https://meta.discourse.org/t/discourse-doc-categories/322376
Texto arbitrario: https://meta.discourse.org/t/discourse-doc-categories/322376

Más allá de esto, puedes usar encabezados Markdown para crear secciones y usar múltiples listas, pero nada aparecerá en la barra lateral a menos que haya una lista Markdown. Aprecio que esto sea un poco obvio y puede que no haya confundido a nadie más, pero me pilló desprevenido (tonta o no) y no soy nuevo en Discourse, TCs y Plugins.

[hugh (Hugh Lashbrooke)]

Añadí un ejemplo más explícito de un tema de índice formateado a la publicación original aquí: https://meta.discourse.org/t/discourse-doc-categories/322376#p-1584993-formatting-index-topics-4

Échale un vistazo y dime si todavía no puedes resolverlo.

[pacharanero (Marcus Baw)]

¡Me parece bien @hugh!

[MarcP]

Tengo una persona de IA para mi categoría de documentación. ¿Se ha pensado en hacer que una persona de IA esté disponible para los anónimos? Creo que, al menos, en un chat DM temporal y anónimo. ¿Es esto siquiera posible?

[MarcP]

Cuando visitas una página que está muy abajo en el índice (requiere desplazarse para llegar), la página principal también se desplaza hacia abajo a una posición en algún lugar del medio: por ejemplo, en este elemento de documentación

[hugh (Hugh Lashbrooke)]

¡Gracias por señalar esto! Veremos qué podemos hacer para evitarlo en el futuro.

[Heliosurge (Dan DeMontmorency)]

@pacharanero

Encabezados de Markdown para crear secciones y usar varias listas, pero nada aparecerá en la barra lateral a menos que haya una lista de Markdown. Agradezco que esto sea un poco obvio y que no haya pillado a nadie más, pero me pilló desprevenido (estúpidamente o no) y no soy nuevo en Discourse, TCs y Plugins.

En realidad, uno nunca debería considerar que algo es “obvio” al documentar nada. Este tipo de comentarios es vital en cualquier tipo de proyecto para garantizar la claridad.

Cualquier cosa escrita normalmente tendrá sentido para el autor debido a su profundo conocimiento de lo que escribió. Para otros, por otro lado, puede ser menos claro.

Yo mismo no me gustan términos como “intuitivo”, ya que algo solo es intuitivo si se tiene experiencia usando algo similar.

[dennisjbr]

¡Gracias! Esto ayuda mucho.

[James_Harakaly]

¡Increíble trabajo a todos en este plugin!

SOY NOVATO, así que me disculpo de antemano. He estado tratando de resolver esto por mi cuenta durante un tiempo, pero no encuentro ninguna solución en ninguna parte.

Estoy tratando de usar este plugin como una forma de organizar los proyectos individuales de los usuarios a nivel de categoría.

Estamos tratando de crear un foro que tenga un montón de proyectos de usuarios diferentes. Originalmente, los teníamos todos bajo la categoría de “proyectos”, de modo que cuando alguien hacía clic en proyectos, veía todas las subcategorías que enumeraban todos los proyectos individuales en una interfaz de usuario atractiva (una especie de mercado de proyectos).
Pero al hacer eso, perdemos ese nivel de organización de datos porque los proyectos individuales comienzan como subcategorías en lugar de categorías.

Estaba súper emocionado cuando encontré este plugin porque pensé que sería perfecto para organizar todos los proyectos a nivel de categoría, lo que nos permitiría tener una mejor organización de datos dentro de los proyectos.

Así que ahora estoy creando proyectos individuales como categorías individuales (señuelo de pesca, proyecto 2, proyecto 3) y usando el plugin de categorías de documentos para crear básicamente una tabla de contenido de todos los proyectos para que las personas puedan hacer clic en la nueva categoría de proyectos que está siendo administrada por el plugin de categorías de documentos y usar el menú desplegable para navegar por las subcategorías y temas que elegimos enumerar en el tema del índice.

¿Hay alguna forma de que las categorías se muestren en la columna central para que se parezca a la vista de la página “todas las categorías” en el feed normal de Discourse?

Quiero que sea así, que cuando haga clic en la categoría de documentos de proyectos, enumere todos los proyectos a la izquierda en el menú, pero que también los muestre en los cuadros en el feed principal, tal como lo hace normalmente con las subcategorías. Solo se me permitió poner una imagen en esta publicación, así que puse la imagen de los proyectos en el menú de la izquierda y me gustaría tener los cuadros de categoría que se muestran en el medio, donde se muestra mi publicación de tema.

Gracias de antemano por cualquier ayuda y orientación.

[qianping_chen (rouin)]

¿Puede añadir “enlaces relativos”, como “/t/topic/463”, que serían muy eficaces para cambiar “nombres de dominio” sin mucho trabajo.

[MarcP]

@qianping_chen

lo que sería muy efectivo para cambiar los “nombres de dominio” sin mucho trabajo.

Actualmente no es mucho trabajo. Simplemente haz un buscar y reemplazar - ¿con qué frecuencia cambias de dominio?

[hugh (Hugh Lashbrooke)]

@James_Harakaly

Quiero que al hacer clic en la categoría de documentación de proyectos, se listen todos los proyectos en el menú de la izquierda, pero que también se muestren en los cuadros del feed principal, tal como sucede normalmente con las subcategorías.

Esto suena a lo que hemos hecho aquí en Meta para las subcategorías de documentación.

Puedes ver las subcategorías en la vista principal y también están enlazadas en la barra lateral aquí: Documentation - Discourse Meta

Para que esto funcione, añadimos un tema de índice para la categoría principal de documentación que incluye los enlaces a cada subcategoría: Documentation Index.

¿Te ayuda esto a encontrar una buena solución en tu instancia?

[Heliosurge (Dan DeMontmorency)]

@MarcP

@qianping_chen

lo que sería muy efectivo para cambiar los “nombres de dominio” sin mucho trabajo.

Actualmente no es mucho trabajo. Simplemente haz una búsqueda y reemplazo - ¿con qué frecuencia cambias de dominio?

Dado que la vinculación relativa ya funciona. ¿Por qué no añadirlo y eliminar cualquier trabajo innecesario? Después de todo, estos son enlaces internos y esto contribuiría a la paridad de Discourse, ya que los enlaces internos también funcionan con una variedad de TC y complementos.

[James_Harakaly]

¡Gracias Hugh!
Lo que están haciendo con las subcategorías va por buen camino, pero principalmente quería que la interfaz de usuario mostrara las categorías en las casillas de la columna central, como lo hace con las subcategorías.

Terminé encontrando e instalando el complemento de sub-subcategorías. Así que ahora lo estoy usando para agrupar subcategorías, de modo que realmente actúen como ‘categorías’ porque tenemos dos niveles de distribución de datos debajo de ellas: sub-subcategorías y temas.
Esto cumplió mi objetivo principal de aumentar la cantidad de distribución de datos y los niveles de organización dentro de nuestros proyectos de usuario. Así que ahora estoy usando las sub-subcategorías junto con el complemento para obtener lo mejor de ambos mundos en el nivel de categoría principal.
Estaba tratando de crear la categoría de proyecto solo con el complemento de categorías de pato, pero no nos gustó la interfaz de usuario de tener solo un menú a la izquierda y nada en el medio para que el usuario navegue. Por lo tanto, quería que los (proyectos que son categorías) se mostraran dentro de una Categoría (todos los proyectos) como lo pueden hacer normalmente las subcategorías. (mi foto en la última publicación de mi maqueta)

aquí está la categoría principal de proyectos: BETA - tendrá otras subcategorías

y aquí están las ‘sub-subcategorías’ haciendo su trabajo, convirtiendo la subcategoría en una categoría.
junto con la fácil navegación del tema del índice.

Gracias de nuevo por todo el trabajo que están haciendo.
Espero haber sido un poco más claro en esta publicación.

He encontrado una solución con la que estamos muy contentos y es una combinación de los 2 complementos.

[hugh (Hugh Lashbrooke)]

¡Me alegra que hayas encontrado una solución que te funcione!

[hellekin]

¿Cuál es la ventaja de este plugin sobre el plugin de documentación heredado?

En el plugin heredado, puedo tener documentación en cualquier categoría, siempre que mantenga las etiquetas. Ahora parece que todos los temas de documentación deben vivir bajo una sola categoría. ¿Es eso correcto? En este caso, se pierde el contexto, ya que parte de la documentación (existente) podría verse afectada a grupos/categorías específicos (por ejemplo, solo disponible para el personal).

¿Podrían aclarar las diferencias entre los dos enfoques, por qué eligieron este enfoque y cómo pretenden cerrar la brecha entre el plugin heredado y el nuevo?

Comentario OT sobre "callouts"

@MarcP

Diferentes tipos de callouts

HedgeDoc utiliza la siguiente extensión de Markdown para admitir callouts (lo llaman alert areas):

### Alert Area

:::success
Sí :tada:
:::

:::info
Este es un mensaje :mega:
:::

:::warning
Cuidado :zap:
:::

:::danger
¡Oh no! :fire:
:::

mostrará

(esto sería bastante fácil de estilizar con CSS dada una clase).

Comentario OT sobre la pereza y la IA

@Jagster

Soy perezoso, así que no lo hice manualmente, pero usé la IA del foro.

¿Se imaginan el exceso de energía y agua consumidos para solo tres líneas de Markdown que podrían haber copiado y pegado manualmente?

Comentario OT sobre URL relativas vs. absolutas

@qianping_chen

¿Puedes agregar “enlaces relativos”, como “/t/topic/463”, que serían muy efectivos para cambiar “nombres de dominio” sin mucho trabajo.

En realidad, copiar y pegar URL de temas es más fácil, y si cambias de dominio, probablemente exportarías/importarías temas, y Discourse reemplazaría el dominio por ti.

---

Después de experimentar un poco, estas son mis conclusiones (temporales):

1. Usar el tema de descripción de la categoría para proporcionar un índice de documentación es útil (por ejemplo, Singular Docs - Documentation - petites singularités)
2. Una categoría de Documentación de nivel superior permite usar subcategorías para cambiar el índice de la barra lateral de documentación (por ejemplo, “Instalar Ruby” aparece en “Guías prácticas” en Documentation - petites singularités, pero en “Consejos y trucos” en Sysadmin Docs - petites singularités) para proporcionar una buena estructura (ver Documentation aquí, mostrando subcategorías como cuadros)
3. Los temas de documentación pueden estar en cualquier lugar del foro, incluso en espacios privados, aunque el índice de documentación revela su existencia.
4. La barra lateral es actualmente inestable:
   • a veces muestra URL, a veces el título
   • a veces solo texto prefijado
   • cuando no se ha iniciado sesión, puede faltar algunos temas indexados
5. Al migrar desde el plugin de documentación heredado, el enlace de documentación debe recrearse en la sección personalizada de la barra lateral (pero podría generarse automáticamente cambiando /docs a la categoría de documentación en la configuración del plugin, o creando/cambiando el permalink /docs para que enlace a esa categoría)
6. El enlace “Volver al foro” se siente extraño, porque los temas de documentación siguen siendo temas del foro: ¡todavía estamos allí leyendo la documentación!
7. El filtrado aún no tiene en cuenta los nombres de (sub)categorías a las que pertenece el tema de documentación.

[MarcP]

La última actualización introduce un pequeño error de interfaz de usuario cuando hay una barra de desplazamiento.

También creo que este cuadro de búsqueda de “filtro” sería mucho más efectivo si fuera simplemente una consulta de búsqueda personalizada en la categoría actual por defecto (en lugar de preguntar esto si no hay resultado). Los títulos son muy cortos, por lo que en la mayoría de los casos no habrá una coincidencia para algo que un usuario no familiarizado escribiría allí.

@hellekin

• El enlace “Volver al foro” se siente raro, porque los temas de documentación siguen siendo temas del foro: ¡todavía estamos allí leyendo la documentación!

Pero estás perdiendo la barra lateral habitual del “foro”, por lo que “volver al foro” tiene sentido aquí.

[kakaroto (Youness Alaoui)]

Me tomó un tiempo darme cuenta de que la barra lateral no aparecía porque, por alguna razón, la configuración del menú de navegación estaba establecida en “menú desplegable del encabezado” en lugar de “barra lateral”. Para aquellos que tampoco pudieron hacer que apareciera la barra lateral, esa podría ser la razón.

Ahora estoy atascado tratando de averiguar cómo agregar el encabezado de categoría y las cajas de subcategoría como las vemos aquí:

No veo ninguna configuración para habilitar/deshabilitar eso y, desafortunadamente, simplemente no parece querer aparecer.
Si alguien tiene alguna idea, agradecería su opinión.
Gracias.

[Moin]

Category Banners

Summary Category Banners uses existing category details to create banners for your category pages (for tags check out Discourse Tag Banners). Preview Preview on Discourse Theme Creator Repository Link https://github.com/discourse/discourse-category-banners New to Discourse Themes? Beginner’s guide to using Discourse Themes Install this theme component Features Category Banners uses existing category details to cr…

Display boxes for subcategories above topic list

This guide explains how to display boxes for subcategories above the topic list in Discourse. Required user level: Administrator (or moderator if the moderators manage categories and groups setting is enabled) There are two ways to display a list of sub-categories within the parent category: in boxes with only the name, logo, and description in boxes with name, logo, and a list of some featured topics You can enable these styles by visiting the parent cate…

[omarfilip]

La falta de filtrado por etiqueta disminuye en gran medida la utilidad del plugin. En una comunidad donde un documento puede aplicarse a varias categorías, el filtrado por etiqueta es esencial.

Por ejemplo, un documento llamado Ensamblaje de tren de aterrizaje se aplica a varios modelos de aeronaves y también puede contener varias etiquetas. Encontrar el correcto es muy fácil con el filtrado por etiquetas.

Si tiene que elegir una categoría para el documento, ¿qué hace cuando ese mismo documento también debería estar en varias otras categorías?

Las etiquetas eran el índice automático que ahora tiene que crearse y mantenerse manualmente.