Page Comparison

...

1. Create the image file and add to the images directory.

2. Use oXygen to link to the image file and you should be able to navigate to the image file in the GUI and the path will be generated for you. Image paths should be relative, i.e. "../images/image_name.png" and use underscores instead of spaces since they are more web friendly.

    

   Make sure the image is sized properly by building the HTML and PDF versions and ensuring that they show up ok (I mentally calculate the depth for approximately 50% of the image's original size but do not state any width). Improperly sized images can look pretty bad, especially in the PDF output. Tools like Gimp are free and can be used to do the resizing.

3. Image files are inserted in 2 this ways into docbooks. The first method is an inline media object which will not appear in the list of figures. The second method creates an entry in the list of figures at the beginning of the document.

    <inlinemediaobject><imageobject><imagedata fileref="../images/EDL_Guide/example1.png" align="left" scalefit=" 1" width="100%" contentdepth="100%"/>

    -OR-

   <figure>
     <title>labelPlacement Options</title>
     <mediaobject>
       <imageobject>
         <imagedata <inlinemediaobject><imageobject><imagedata fileref="../images/KRADEDL_Guide/labelPlacementexample1.png"/>     </imageobject>
     </mediaobject>
   </figure>

   Note: So far, OLE has only used the first method.
   Unless the image is of a button or tab, leave a paragraph space between the image and the text and start the image on its own line:
   <para>
     <para><inlinemediaobject><imageobject><imagedata fileref="../images/EDL_Guide/example1.png" align="left" scalefit="1" width="100%" contentdepth="100%"/></para>
   <para>The first example is for larger images (anything that looks like it will be too big to fit in a pdf document (8.5 x 11) comfortably).  The second is for any smaller images, smaller than what would fit in the pdf document.  Sometimes you really just have to test locally to see how things fit.

Creating Hyperlinks

In DocBook 5, the preference is to have xlinks for hyperlinks. If you use the oXygen GUI (author view) to add the link, you'll need to right-click on the link and add the xlink:href property with the url of your link as the value.

Links to external documents (in a different module) within a release should be entered like this :

 <link xlink:href="http://site.kuali.org/ole/1.0.0/reference/html/CGADMIN.html#_Describe_Workbench">Describe Workbench</link>

...

Links to internal documents (i.e. another section of the same documentmodule/chapter) should be entered as:

 <link linkend="linkAndLinkField">Uif-Link<_Editors">MARC Editor</link>

where elsewhere in the document there exists:

 <section xml:id="linkAndLinkField_Editors">

To link to a figure, set up the figure to have an xml id as follows:

...

1. Adjust the heading, frame and column data:

   <para role="TableHeading"><emphasis role="bold">Location Information tab definition</emphasis></para>

   <informaltable frame="top">

   <tgroup cols="2">

   <colspec colname="col1" colnum="1" colwidth="1.0*"/>

   <colspec colname="col2" colnum="2" colwidth="1.0*"/>"/>

2. Make sure that the "rowsep" and the "colsep" both equal 1
   

   <row>

   <entry colname="col1" colsep="1" rowsep="1" valign="top">

   <para role="Table Cells">Title</para>

   </entry>

   <entry colname="col2" colsep="0" rowsep="1" valign="top">

   <para role="Table Cells">Description </para>

   </entry>

   </row>

3. Generate and review the PDF and webhelp output, and make any further adjustments

...