[
https://issues.apache.org/jira/browse/SOLR-10871?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16046732#comment-16046732
]
Cassandra Targett commented on SOLR-10871:
------------------------------------------
bq. Note that bold doesn't have any effect, I'm assuming because the headings
are already (effectively) bolded.
Yes, headings are already bold.
Italics could work. I wonder about the inconsistency about using italics in
headings and monospace in text - perhaps it's fine, though. I could see the
same argument about removing the monospace from headings - it's inconsistent.
But, in the case of the monospace, the effect turns out to be more jarring than
useful. The goal is to convey information to the reader without causing
unnecessary interruption in the flow of their reading. Italics would flow with
the text.
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", "The fq Parameter", "The facet.query Parameter", etc. Does
differentiating the text style for the name of the parameter help the reader
without interrupting his/her reading? I'm open to being convinced about that,
but I'm not yet.
I'm not a fan of using quotes, since I think we already use them very
inconsistently - for example, sometimes when we refer to the techproducts
example we put "techproducts" in monospace, but sometimes it's in single
quotes, and sometimes it's double quotes, and other times it's a combo of these.
> 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]
