On 2011-01-09, Vinay Sajip wrote:
>> > If would be neater if instead of <strong>param_name</strong>, the
>> > output markup was something like
>> >
>> > <span class="positional-param">param_name</span>
>> >
>> > and
>> >
>> > <span class="keyword-param">param_name</span>
>> They would still all be in one list, so how would you style them
>> differently (without confusing the user)?
> Perhaps using italic for one but not the other. It would be a
> convention that would have to be explained in the "typographic
> conventions" part of the documentation, but that's not a problem.
> Having the markup I suggested would at least allow alternative styling
> to be done, even if the two types of parameters have the same default
> styling and many people leave it as is.
I suggest <emph> or <strong> tags with class="parameter positional" vs.
class="parameter keyword" so that even without a stylesheet the emphasis
is kept (graceful degradation) but configuring the layout with CSS is
easy.
Using two class arguments ("parameter keyword") instead of a hyphenated
one ("parameter-keyword") allows setting shared features in a common rule
and diffentiating with the selectors .parameter.keyword vs.
.parameter.positional.
Günter
--
You received this message because you are subscribed to the Google Groups
"sphinx-dev" group.
To post to this group, send email to sphinx-...@googlegroups.com.
To unsubscribe from this group, send email to
sphinx-dev+unsubscr...@googlegroups.com.
For more options, visit this group at
http://groups.google.com/group/sphinx-dev?hl=en.
