Ignore:
Timestamp:
Apr 27, 2007, 10:58:19 AM (15 years ago)
Author:
Martin Svensson
Message:

References #580. Added some instructions to get a nice output. Updated some images to have a fixed size.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc/src/docbook/developerdoc/write_docbook_doc.xml

    r3278 r3280  
    124124          <mediaobject>
    125125            <imageobject>
    126               <imagedata fileref="figures/fileorganization.png" format="PNG"></imagedata>
     126              <imagedata contentwidth="15cm" width="15cm" fileref="figures/fileorganization.png" format="PNG"></imagedata>
    127127            </imageobject>
    128128          </mediaobject>
     
    432432        distribution. Those two types of output are generated with the ant-target:
    433433        <userinput>ant docbook</userinput>
    434         .
     434        . This documentation is also generated with
     435        <command>ant dist</command>
     436        , which will put the output files in the right location for distribution.
    435437      </para>
    436438    </sect2>
     
    802804            <mediaobject>
    803805              <imageobject>
    804                 <imagedata fileref="figures/menuchoice.png" format="PNG" />
     806                <imagedata
     807                  contentwidth="7cm"
     808                  width="7cm"
     809                  fileref="figures/menuchoice.png" format="PNG"
     810                />
    805811              </imageobject>
    806812            </mediaobject>
     
    837843        ,otherwise the image won't be visible in the generated output files.
    838844      </para>
     845      <warning>
     846        <para>
     847          Images in the pdf-output are, unlike images in html-output, not scaled and can
     848          therefore be out of proportion in the document. Avoid this by e.g. setting the
     849          attributes
     850          <sgmltag class="attribute">contentwidth</sgmltag>
     851          and
     852          <sgmltag class="attribute">width</sgmltag>
     853          in
     854          <sgmltag>imagedata</sgmltag>
     855          to appropriate values.
     856        </para>
     857      </warning>
    839858      <example id="write_docbook_doc.examples.screenshot">
    840859        <title>Screen-shot in the documentation</title>
     
    849868    &lt;mediaobject&gt;
    850869      &lt;imageobject&gt;
    851         &lt;imagedata fileref="figures/menuchoice.png" format="PNG" /&gt;
     870        &lt;imagedata
     871          contentwidth="7cm"
     872          width="7cm"
     873          fileref="figures/menuchoice.png" format="PNG"
     874        /&gt;
    852875      &lt;/imageobject&gt;
    853876    &lt;/mediaobject&gt;
     
    864887        of something else.
    865888      </para>
     889      <warning>
     890        <para>
     891          More then 80 characters(including indention) in a row of program
     892          listings or other verbatim elements will risk to put the end of the row outside
     893          the text area.
     894        </para>
     895      </warning>
    866896      <example id="write_docbook_doc.examples.example">
    867897        <title>Example in the documentation</title>
Note: See TracChangeset for help on using the changeset viewer.