[
https://issues.apache.org/jira/browse/SOLR-10670?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16006443#comment-16006443
]
Cassandra Targett commented on SOLR-10670:
------------------------------------------
+1 to adding the favicon, I was going to get to that before release.
The other link changes are fine with me if folks think they are preferable. Go
for it, as we say :)
As for the title...The html file is built after {{BuildNavandPDFBody.java}} is
run. That script develops the data files to populate the sidenav and also the
file that is used to make a single page for PDF generation. I think it would be
too much "magic" to have a script that overwrites the title of any page. Say
someday in the future we decide to change the page, who's going to remember
exactly why we have a file named {{index.adoc}} that declares it's title as
"Apache Solr Reference Guide" but appears online as "Home"? I'd like to
minimize the # of leaps people need to make in order to figure out what's going
on, where possible. And some of us don't know Java so can't just hop into Java
files to figure out why certain things are happening.
If what you prefer is that it appear something like {{Home | Apache Solr
Reference Guide 7.0}}, then I think it would be best just to make the page
title in {{index.adoc}} "Home". However, that means the PDF would have a page
named "Home" for the first page, which doesn't feel right to me.
Unless we can come up with a page name that is short, descriptive for
bookmarks, and works in both formats, there is a possible other option, that I
have not tried yet, which is to add an {{ifdef}} statement that changes the
title for the PDF. That would evaluate if the page is being generated for the
PDF version, and if so, apply a different title. That would go in
{{index.adoc}} so anyone looking at it will see why we are doing that (we can
add a comment to explain). I will give this a try now to see if that solves it
for us.
> [ref-guide] Various top-bar fixes
> ---------------------------------
>
> Key: SOLR-10670
> URL: https://issues.apache.org/jira/browse/SOLR-10670
> Project: Solr
> Issue Type: Improvement
> Security Level: Public(Default Security Level. Issues are Public)
> Components: documentation
> Reporter: Jan Høydahl
> Labels: asciidoc, html
> Fix For: 6.6
>
> Attachments: SOLR-10670.patch
>
>
> A few suggestions for the new ref-guide HTML format:
> * Favicon is not displayed, image missing in folder
> * Topnav link to community should point to
> http://lucene.apache.org/solr/community.html
> * Replace "Solr News" link with a "Solr Website" link - we should link to the
> website
> * Instead of pointint the Source Code link to cryptic apache GIT, point to
> https://lucene.apache.org/solr/community.html#version-control where people
> get more context and can also find the GitHub link
--
This message was sent by Atlassian JIRA
(v6.3.15#6346)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
