[ 
https://issues.apache.org/jira/browse/SOLR-4886?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
 ]

Hoss Man updated SOLR-4886:
---------------------------

    Attachment: solr-090713-2308-8288.pdf

Thanks for all the info Cassandra,

for now I'm mainly just worried about making sure the PDF is "not terrible" -- 
i'm happy to iterate on "looks good" later.

Things i've done so far...

* knowledge gained
** trying to script/automate this isn't going to be easy -- there is a SOAP API 
call but it's very limited (ie: can't exclude pages like the meta-docs we have 
about hte doc) and is changing between confluence 3.x, 4x, and 5.x ... so 
trying to count on it is a bad idea.  fortunately, manually exporting is 
trivial.
* layout & style customizations
** added a title page with the solr logo and ASL
** added a simple footer
** supressed display of hte table of contents (the PDF structure already 
includes ToC metdata that the PDF viewer can display to the user if they want 
it -- no need to waste 4 pages of the doc with the same info)
** forced each major section to start on a new page (via h2 page-break-before)

Attached is am example of the PDF export as things stand right now.

still to do...

* document how to "release" (ie: export, vote, publish) the PDF
* document basic things that need done after publishing (ie: where does "4.x" 
need changed to "4.y"
* deal with the unicode problems in the Langauge Analysis sub-secion...


I added the "unicode-text" macro and CSS as cassandra suggested in SOLR-4957 , 
which made the macro errors go away, butthe text still isn't appearing in the 
PDF -- my PDF viewer says "Arial" isn't even a font used in the PDF, which 
makes me think that it's not a font available on the CWIKI instance of 
Confluence, so it isn't getting used during hte HTML->PDF translation.  (this 
seems to be verified by the list of fonts in the doc below)

I did find some docs on how to use custom fonts in the exported PDFs (even 
before Confluence 5.x), and from the looks of it:
* we might be able to refer to a font via a public url, ie 
"http://lucene.apache.org/..."; instead of needing to copy it to cwiki.apache.org
** 
https://confluence.atlassian.com/display/CONF35/Advanced+PDF+Stylesheet+Customisations#AdvancedPDFStylesheetCustomisations-IncorporatingOtherFonts
* we should be able to use the "Free UCS Outline Fonts" in the PDF, which seem 
to have good coverage of all the Unicode blocks we might want to have examples o
** https://en.wikipedia.org/wiki/Free_UCS_Outline_Fonts

                
> 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
>         Attachments: solr-090713-2308-8288.pdf
>
>
> * 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]

Reply via email to