You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@cloudstack.apache.org by "Jessica Tomechak (JIRA)" <ji...@apache.org> on 2012/10/16 08:45:02 UTC

[jira] [Created] (CLOUDSTACK-358) Fix PDF output for docs

Jessica Tomechak created CLOUDSTACK-358:
-------------------------------------------

             Summary: Fix PDF output for docs
                 Key: CLOUDSTACK-358
                 URL: https://issues.apache.org/jira/browse/CLOUDSTACK-358
             Project: CloudStack
          Issue Type: Bug
          Components: Doc
    Affects Versions: 4.0.0
            Reporter: Jessica Tomechak
            Priority: Minor


Our documentation tool, publican, puts out good-looking HTML. But the PDF output lacks some features like running headers and footers, etc. which most people would expect in a professional-grade PDF publication. Need to tweak the transforms underneath the hood in publican to bring the PDF output up to standard.

--
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

[jira] [Commented] (CLOUDSTACK-358) Fix PDF output for docs

Posted by "Jessica Tomechak (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/CLOUDSTACK-358?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13476818#comment-13476818 ] 

Jessica Tomechak commented on CLOUDSTACK-358:
---------------------------------------------

Here's something I found on the web that provides clues on how to start. Jeff Fearn writes the following about how to modify the paper size in the PDFs, which output A4 by default:

I'd create a new xsl file, e.g. pdf-A3.xsl, which imports pdf.xsl
and over rides the required variables to make US Letter look good.

e.g. default.image.width probably needs to be reduced since A4 is fatter
that US letter and won't look quite right on US letter. Larger paper sizes
can handle larger images without breaking in to the border and so will
also want to over ride this value. two column pages would need to have a
different size again and we are quickly in to spaghetti XSL.

You can place pdf-A3.xsl in  /usr/share/publican/xsl/ and then you need to
make 2 other small changes.

1: modify Makefile.template

ifeq "${1}" "pdf"

becomes: (untested)

ifeq "${1}" ($(findstring, "pdf", ${1}))

i.e. any style sheet with pdf in the name


2: add pdf-A3 to FORMATS in Makefile.common

For testing you can set it on the command line: (untested)

make FORMATS='html pdf-A3' html-en-US pdf-A3-en-US

I believe this approach will lead to a more maintainable system than
trying to shoe horn all possible paper sizes in to one XSL file.

Cheers, Jeff.

-- 
Jeff Fearn <jfearn redhat com>
Software Engineer
Engineering Operations
Red Hat, Inc
                
> Fix PDF output for docs
> -----------------------
>
>                 Key: CLOUDSTACK-358
>                 URL: https://issues.apache.org/jira/browse/CLOUDSTACK-358
>             Project: CloudStack
>          Issue Type: Bug
>          Components: Doc
>    Affects Versions: 4.0.0
>            Reporter: Jessica Tomechak
>            Priority: Minor
>
> Our documentation tool, publican, puts out good-looking HTML. But the PDF output lacks some features like running headers and footers, etc. which most people would expect in a professional-grade PDF publication. Need to tweak the transforms underneath the hood in publican to bring the PDF output up to standard.

--
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

[jira] [Commented] (CLOUDSTACK-358) Fix PDF output for docs

Posted by "Rohit Yadav (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/CLOUDSTACK-358?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13481294#comment-13481294 ] 

Rohit Yadav commented on CLOUDSTACK-358:
----------------------------------------

The pdfs are by default A4 size (210mm × 297mm) and this layout/size should be fine, right?
For headers and footers, checkout this example [0][1] for HTML and for printing (not sure, but may work for pdfs) [2].

[0] http://xml.web.cern.ch/XML/www.sagehill.net/xml/docbookxsl/
[1] http://xml.web.cern.ch/XML/www.sagehill.net/xml/docbookxsl/HtmlCustomEx.html#HTMLHeaders
[2] http://xml.web.cern.ch/XML/www.sagehill.net/xml/docbookxsl/PrintCustomEx.html#PrintHeaders
                
> Fix PDF output for docs
> -----------------------
>
>                 Key: CLOUDSTACK-358
>                 URL: https://issues.apache.org/jira/browse/CLOUDSTACK-358
>             Project: CloudStack
>          Issue Type: Bug
>          Components: Doc
>    Affects Versions: 4.0.0
>            Reporter: Jessica Tomechak
>            Priority: Minor
>
> Our documentation tool, publican, puts out good-looking HTML. But the PDF output lacks some features like running headers and footers, etc. which most people would expect in a professional-grade PDF publication. Need to tweak the transforms underneath the hood in publican to bring the PDF output up to standard.

--
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