PDF Documentation Guide has been edited by Hiram Chirino (Dec 10, 2008).

(View changes)

Content:

Preface

The camel project uses this wiki to generate it's PDF based documentation. It uses the a Boom CSS based style sheet in conjunction with prince to generate the PDF manuals. The Book In One Page stitches together wiki content found through this wiki into a single page with is subsequently downloaded by the PDF generator and transformed into a PDF. This section will help you understand how to best use the wiki markup so that it generates good looking PDF pages.

Images

Images show up differently on the web than on print. You normally need large images with a high DPI for them to print nicely on paper. This chapter will show you how to control the image sizing properties for PDF output.

Standard Image Link

!http://activemq.apache.org/camel/download.data/camel-box-v1.0-150x200.png!


Setting the Image DPI

A Large DPI setting will make the image shrink in the PDF output.

!http://activemq.apache.org/camel/download.data/
    camel-box-v1.0-150x200.png|style=prince-image-resolution:200dpi!

Sample DPI Settings

72 DPI 200 DPI 300 DPI 600 DPI

Tables Figures and Listings

Using the BOOM micro format to add captions to tables and headings. We should really create some confluence macros for this.

Captioned Tables

Use wiki markup similar to:

{html}<div class="table"><p class="caption">
  Example Table
</p>{html}
  || Table || Heading ||
  | value1 | value2 |
  | value3 | value 4 |
{html}</div>{html}

To produce:

Example Table

Table Heading
value1 value2
value3 value 4

Captioned Figures

Use wiki markup similar to:

{html}<div class="figure"><p class="art">
{html} !http://activemq.apache.org/camel/download.data/camel-box-v1.0-150x200.png! {html}
</p><p class="caption">
   Example Figure.
</p></div>
{html}

To produce:

Example Figure.

Captioned Listings

Use wiki markup similar to:

\{code:xml|title=Example}
<bean id="activemq" class="org.apache.camel.component.jms.JmsComponent">
  <property name="connectionFactory">
    <bean class="org.apache.activemq.ActiveMQConnectionFactory">
      <property name="brokerURL" value="vm://localhost?broker.persistent=false"/>
    </bean>
  </property>
</bean>
\{code}

To produce:

Example
<bean id="activemq" class="org.apache.camel.component.jms.JmsComponent">
  <property name="connectionFactory">
    <bean class="org.apache.activemq.ActiveMQConnectionFactory">
      <property name="brokerURL" value="vm://localhost?broker.persistent=false"/>
    </bean>
  </property>
</bean>

Reply via email to