[jira] [Commented] (SOLR-15092) Loosen Ref Guide link checking to allow empty anchors in links

["Cassandra Targett (Jira)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/SOLR-15092?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17278092#comment-17278092 ] 

Cassandra Targett commented on SOLR-15092:
------------------------------------------

+1 for this. I tested the patch out and just changed a couple of the references to use an empty anchor (just #), and a couple with anchors I knew didn't exist on the pages. The validation correctly caught the "bad" anchors but passed the empty ones. The resulting HTML links went to the right pages, to the top of the page as expected.

> Loosen Ref Guide link checking to allow empty anchors in links
> --------------------------------------------------------------
>
>                 Key: SOLR-15092
>                 URL: https://issues.apache.org/jira/browse/SOLR-15092
>             Project: Solr
>          Issue Type: Improvement
>      Security Level: Public(Default Security Level. Issues are Public) 
>            Reporter: Cassandra Targett
>            Assignee: Chris M. Hostetter
>            Priority: Major
>         Attachments: SOLR-15092.patch
>
>
> Back when we were publishing the PDF, we needed to be sure to include an explicit section title as an anchor for all inter-document links (such as {{<<page-title.adoc#page-title,Page Title>>}}) because when the entire guide was assembled into a single file the explicit anchor ensured links went to the right spot in the overall Guide.
> Without the PDF, if we want to just link to another page in its entirety and not a sub-section of a page, we can use a shorter syntax with an empty anchor: {{<<page-title.adoc#,Page Title>>}}. I can't find this explicitly documented, but it does construct a correct link (i.e., {{<a href="page-title.html#">Page Title</a>}}).
> However, our link checking will fail this structure because it still assumes we must have a section name in the anchor and won't allow blank anchors. This issue is to loosen that check a bit and update the Ref Guide how-to docs to show it as a possible option.



--
This message was sent by Atlassian Jira
(v8.3.4#803005)

---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org