Changeset 3280 for trunk/doc/src/docbook/developerdoc/write_docbook_doc.xml

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:

• trunk/doc/src/docbook/developerdoc/write_docbook_doc.xml (modified) (6 diffs)

trunk/doc/src/docbook/developerdoc/write_docbook_doc.xml

@@ -124 +124 @@
           <mediaobject>
             <imageobject>
-              <imagedata fileref="figures/fileorganization.png" format="PNG"></imagedata>
+              <imagedata contentwidth="15cm" width="15cm" fileref="figures/fileorganization.png" format="PNG"></imagedata>
             </imageobject>
           </mediaobject>
@@ -432 +432 @@
         distribution. Those two types of output are generated with the ant-target:
         <userinput>ant docbook</userinput>
-        .
+        . This documentation is also generated with
+        <command>ant dist</command>
+        , which will put the output files in the right location for distribution.
       </para>
     </sect2>
@@ -802 +804 @@
             <mediaobject>
               <imageobject>
-                <imagedata fileref="figures/menuchoice.png" format="PNG" />
+                <imagedata 
+                  contentwidth="7cm" 
+                  width="7cm" 
+                  fileref="figures/menuchoice.png" format="PNG" 
+                />
               </imageobject>
             </mediaobject>
@@ -837 +843 @@
         ,otherwise the image won't be visible in the generated output files.
       </para>
+      <warning>
+        <para>
+          Images in the pdf-output are, unlike images in html-output, not scaled and can
+          therefore be out of proportion in the document. Avoid this by e.g. setting the
+          attributes
+          <sgmltag class="attribute">contentwidth</sgmltag>
+          and
+          <sgmltag class="attribute">width</sgmltag>
+          in
+          <sgmltag>imagedata</sgmltag>
+          to appropriate values.
+        </para>
+      </warning>
       <example id="write_docbook_doc.examples.screenshot">
         <title>Screen-shot in the documentation</title>
@@ -849 +868 @@
     &lt;mediaobject&gt;
       &lt;imageobject&gt;
-        &lt;imagedata fileref="figures/menuchoice.png" format="PNG" /&gt;
+        &lt;imagedata 
+          contentwidth="7cm" 
+          width="7cm" 
+          fileref="figures/menuchoice.png" format="PNG" 
+        /&gt;
       &lt;/imageobject&gt;
     &lt;/mediaobject&gt;
@@ -864 +887 @@
         of something else.
       </para>
+      <warning>
+        <para>
+          More then 80 characters(including indention) in a row of program
+          listings or other verbatim elements will risk to put the end of the row outside
+          the text area.
+        </para>
+      </warning>
       <example id="write_docbook_doc.examples.example">
         <title>Example in the documentation</title>