Feature Request: Set HTML "id" for admonition blocks #1174

Activity

1. waylan commented on Aug 13, 2021

   

   waylan

   on Aug 13, 2021

   Member

   More actions

   Interesting proposal. I'm wondering if perhaps a better solution is to add support for attr_list, much like we do with fenced code blocks. The simple (one class) form can continue to work as it does now, but for more complex situations, the user should provide a curly bracket wrapped attr_list. The tricky part about that is that attr_lists always go at the end, but in admonitions, the title is at the end. How about this:

   !!! type "Title" { #id class1 class2 }
   

   Or maybe we use a second line. Like this:

   !!! type "Title" 
       { #id class1 class2 }
   

   The problem is that that is not compatible with #685. In retrospect, we probably should have implemented this instead. But it's too late to change that now. I would propose that the attr_list should only be supported when the attr_list extension is also enabled. When the attr_list extension is not enabled, we can continue to support multiple classes as we do now (but no longer document it).
2. waylan

   added

   extensionRelated to one or more of the included extensions.Related to one or more of the included extensions.

   featureFeature request.Feature request.

   needs-decisionA decision needs to be made regarding request.A decision needs to be made regarding request.

   on Aug 13, 2021
3. waylan commented on Aug 13, 2021

   

   waylan

   on Aug 13, 2021

   Member

   More actions

   BTW, I've been kicking around the idea of creating a new extension for a general purpose block, which could complexly negate the need for the admonition extension. I'm thinking that if this new extension was to be built, then our efforts would be better spent there than on improving the admonitions extension. A rough sketch is outlined in #1175.
4. waylan commented on Nov 7, 2023

   

   waylan

   on Nov 7, 2023

   Member

   More actions

   I'm closing this in favor of admonition blocks, which is the result of my proposal in #1175. As one of the examples in the documentation demonstrates, any HTML attributes can be defined on the admonition:

   /// note | Some title
       attrs: {class: class-name: id: id-name}
   
   Some content
   ///
   
5. waylan

   closed this as not plannedon Nov 7, 2023
6. waylan

   added

   3rd-partyShould be implemented as a third party extension.Should be implemented as a third party extension.

   and removed

   needs-decisionA decision needs to be made regarding request.A decision needs to be made regarding request.

   on Nov 7, 2023