Re: setting up rules on produced HTML class attributes

[Gavin Smith]

On Sun, Jan 09, 2022 at 02:49:04PM +0100, Patrice Dumas wrote:
> > > With these rules some class names already output should change.  One
> > > case of change is the @example arguments which would need to be changed
> > > and contradicts the current manual content.  According to the proposal
> > > @example arguments should not be left as is (for the first rule), but
> > > have something prepended or appended. I would propose prepending arg-.
> > > 
> > > The manual is right now:
> > > 
> > >  You may optionally give arguments to the '@example' command,
> > >  separated by commas if there is more than one.  In the HTML output, any
> > >  such arguments are output as class names.
> > > 
> > > It would become
> > > 
> > >  You may optionally give arguments to the '@example' command,
> > >  separated by commas if there is more than one.  In the HTML output, any
> > >  such arguments are output as class names with 'arg-' prepended.
> > > 
> > > Any comment, remark?
> > 
> > I'm not sure; I wonder if there would be a better prefix than "arg-".
> 
> That's the best I could come up with...

I think 'example-' is better.  I didn't see that this could clash with any
other classes, but in theory it could if other HTML elements were output
for @example with their own classes with names based on 'example'.

Are there any other places where users might create class names?  Maybe
something generic would be better so the same convention could be used
everywhere (or in the future).

Other ideas: 'user-', 'my-'.

'lang-' is another possibility although we left open the possibility of
an argument to @example specifying something other than the language.