[
https://issues.apache.org/jira/browse/SOLR-10871?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16046743#comment-16046743
]
Hoss Man commented on SOLR-10871:
---------------------------------
bq. I'm not a fan of using quotes, since I think we already use them very
inconsistently...
That's the argument for why i originally used monospoace in the headers - to
try and be consistent :)
bq. Probably 80% or more of the usages are in regard to parameters, and like
the example I showed, the heading clearly states the section is about "The
start Parameter", ...
my only concern (in the past) about having no typographic distrinction is the
risk of a "Who's on First" situation? ... things like "The facet.query
Parameter" are pretty self describing, but something like "The start Parameter"
or "The sort Parameter" _might_ be confusing to new users w/o quotes or some
other form of indication that it's a "literal" parameter name... "Yes, i am in
fact interested in the parameter for doing a sort - please tell me what it's
name is!"
But this is likely just a theoretical problem that doesn't really exist -- if
the sections are written well, as soon as the reader gets to the first sentence
after the heading, it should be obvious.
> Remove monospace text from headings in Ref Guide
> ------------------------------------------------
>
> Key: SOLR-10871
> URL: https://issues.apache.org/jira/browse/SOLR-10871
> Project: Solr
> Issue Type: Improvement
> Security Level: Public(Default Security Level. Issues are Public)
> Components: documentation
> Reporter: Cassandra Targett
> Assignee: Cassandra Targett
> Fix For: master (7.0)
>
> Attachments: monospace-in-header-new.png,
> monospace-in-header-old.png, Screen Shot 2017-06-12 at 11.20.04 AM.png
>
>
> Monospace text doesn't look great in section headings in the PDF - the font
> color is different and the size is smaller. With the old way of generating
> the PDF we could make it the same color & adjust the font size so it was less
> jarring. We don't have that option now, so the difference is much more
> pronounced.
> I found 148 instances of this in 40 files. I think we can make that "normal"
> text without losing any important information for the reader.
> Attaching screenshots of what it used to look like and what it now looks
> like, to illustrate the difference.
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
