[
https://issues.apache.org/jira/browse/SOLR-4886?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13703688#comment-13703688
]
Cassandra Targett commented on SOLR-4886:
-----------------------------------------
Header levels are also problematic and it warrants a separate comment to
explain what's going to happen.
The PDF export uses the page hierarchy to compress all the pages into one
(pretty massive) HTML file. Each page is then given a heading level in the HTML
that corresponds to it's location in the hierarchy. The rest of the heading
levels on all the pages are then compressed under those heading levels.
So, to use the Schema API page as an example
(https://cwiki.apache.org/confluence/display/solr/Schema+API), here is where
it's located in the hierarchy:
Apache Solr Reference Guide -> Documents, Fields, and Schema Design -> Schema
API
In the HTML file, the header for the page "Apache Solr Reference Guide" will be
h1, "Documents, Fields, and Schema Design" will be h2, "Schema API" will be h3.
Taking another example of a page deeper in the hierarchy, "DataDir and
DirectoryFactory in SolrConfig"
(https://cwiki.apache.org/confluence/display/solr/DataDir+and+DirectoryFactory+in+SolrConfig),
will be h4.
So, after all the pages have been assigned heading levels appropriate for their
level in the page hierarchy, all the defined headers within the pages will
start to get numbers. I believe the highest heading level of content (not a
page title) will be h5. The levels then go down from that point, depending on
how they were defined on the page. An h4 will likely end up as an h8.
This is important if you want page titles to appear a certain way - changing h1
will pretty much only change one title. You'll have to modify at h2, h3, and h4
also, depending on how you want to entire document to flow.
I also wanted page breaks on certain pages, so had to define those to happen on
h2 and h3 levels. See also my previous comment about problems with bookmarks
within the PDF - the page breaks were not without their own problems.
> configure and test PDF export of SOLR CWIKI after existing ref guide content
> is loaded
> --------------------------------------------------------------------------------------
>
> Key: SOLR-4886
> URL: https://issues.apache.org/jira/browse/SOLR-4886
> Project: Solr
> Issue Type: Sub-task
> Components: documentation
> Reporter: Hoss Man
> Assignee: Hoss Man
>
> * add the ASL as a page in the wiki such that it appears early in the
> exported PDF
> * test that exporting the PDF works ok with the large space
> * review the exported PDF for problems
> * confirm/tweak-configs so that PDF exporting can done really easily, ideally
> automatically
> * document/script steps to create PDF on each solr release.
> Lots of tips here:
> https://confluence.atlassian.com/display/DOC/Providing+PDF+Versions+of+your+Technical+Documentation
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
