[
https://issues.apache.org/jira/browse/SOLR-10871?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16046774#comment-16046774
]
Steve Rowe edited comment on SOLR-10871 at 6/12/17 4:55 PM:
------------------------------------------------------------
Attaching what {{egrep -r --include="\*.adoc" '^=+.*`'}} finds for me on master
under {{solr/solr-ref-guide/}}: 188 instances, of which 103 include "aram"
(54%).
For those 54%, I agree that "The XXX Parameter" wouldn't benefit much from
highlighting XXX.
Similarly, 28 of the headings (14%) consist of a heading that is entirely in
monospace. These also wouldn't benefit much from highlighting.
Looking at the remaining 57 (30%), I don't see any that would be irreparably
harmed by removing all highlighting. In some cases, using italics for symbols
(e.g. {{!}}, {{||}}, {{+}}, {{-}}, {{&&}}) might actual make them look worse.
On balance, I guess I'm +1 to removing all highlighting (rather than
substituting e.g. italics).
was (Author: steve_rowe):
Attaching what {{egrep -r --include="*.adoc" '^=+.*`}} finds for me on master
under {{solr/solr-ref-guide/}}: 188 instances, of which 103 include "aram"
(54%).
For those 54%, I agree that "The XXX Parameter" wouldn't benefit much from
highlighting XXX.
Similarly, 28 of the headings (14%) consist of a heading that is entirely in
monospace. These also wouldn't benefit much from highlighting.
Looking at the remaining 57 (30%), I don't see any that would be irreparably
harmed by removing all highlighting. In some cases, using italics for symbols
(e.g. {{!}}, {{||}}, {{+}}, {{-}}, {{&&}}) might actual make them look worse.
On balance, I guess I'm +1 to removing all highlighting (rather than
substituting e.g. italics).
> 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, ref-guide-monospace-headings.txt, 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]
