Re: setting up rules on produced HTML class attributes

[Patrice Dumas]

On Sat, Jan 15, 2022 at 11:46:02PM +0000, Gavin Smith wrote:
> > > 
> > > 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'.

It does not clash, but could, if for instance we added
example-preformatted which already exists for @display, for
pre.display-preformatted.

> Are there any other places where users might create class names?

For indices created by users, there are classes added for @printindex
formatting, for example with 

@defindex foo
 
classes like foo-printindex, foo-letters-header-printindex,
foo-entries-printindex.

No other case of user defined things ending up in class for now.

>  Maybe
> something generic would be better so the same convention could be used
> everywhere (or in the future).

I think that something generic would be better, indeed.

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

user- has my preference.

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

Indeed, if we use lang- for the first argument, we should be clearer
that it should only be that.  And it still leaves something to be used
for the other arguments.

-- 
Pat