1. move strokeSVGText documentation from graphics.xml to configuration.xml

2. add summary table in configuration.xml
3. minor cleanup in graphics.xml

git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@196666 13f79535-47bb-0310-9956-ffa450edef68

diff --git a/src/documentation/content/xdocs/configuration.xml b/src/documentation/content/xdocs/configuration.xml
index aeb6e9e2bf87098f51ab57b810e996cab3ed92f1..a1c3b1bcb001814c6579e8fbbda1743f9e779980 100644 (file)
--- a/src/documentation/content/xdocs/configuration.xml
+++ b/src/documentation/content/xdocs/configuration.xml
@@ -16,11 +16,32 @@ It contains templates for the various configuration options, most of which are c
 Be sure to follow any instructions, including comments which specify the value range.
 Also, since the configuration file is XML, be sure to keep it well-formed.</p>
     <note>Do <strong>not</strong> change <code>{fop-dir}/conf/config.xml</code> or use it as the basis for your configuration file. It has an entirely different purpose.</note>
+    <p>The general structure of the configuration file is a series of &lt;entry> tags, each containing a &lt;key> and a &lt;value. (Fonts use a different format). Here is an example:</p>
+    <source><![CDATA[<entry>
+  <key>strokeSVGText</key>
+  <value>false</value>
+</entry>]]></source>
     <p>After creating your configuration file, you must tell FOP how to find it:</p>
     <ul>
       <li>If running FOP from the command-line, see the "-c" command-line option in <link href="running.html">Running FOP</link>.</li>
       <li>If running FOP as an embedded application, see <link href="embedding.html#config-external">FOP: Embedding, Using a Configuration File</link>.</li>
     </ul>
+    <p>See <link href="embedding.html#config-internal">Setting the Configuration Programmatically</link> for instructions on how to do so in an embedded environment.</p>
+  </section>
+  <section id="summary">
+    <title>Summary of Configuration Options</title>
+    <table>
+      <tr>
+        <th>Option (key)</th>
+        <th>Data Type (for the value)</th>
+        <th>Default Value</th>
+      </tr>
+      <tr>
+        <td><link href="#svg-strokeSVGText">strokeSVGText</link></td>
+        <td>Boolean</td>
+        <td>True</td>
+      </tr>
+    </table>
   </section>
   <section id="hyphenation">
     <title>Setting up hyphenation</title>
@@ -82,6 +103,14 @@ in the userconfig.xml in the entry &lt;hyphenation-dir&gt;.
       these conditions.
     </note>
   </section>
+  <section id="svg">
+    <title>SVG</title>
+    <section id="svg-strokeSVGText">
+      <title>strokeSVGText (boolean, True)</title>
+      <p>In some cases, some text in SVG documents is converted to graphical shapes instead of retaining its character as text. To force all text to be rendered as text, set strokeSVGText = false. For a discussion of this issue, see <link href="graphics.html#svg-pdf-text">FOP: Graphics, Placing SVG Text into PDF</link>.</p>
+      <note>strokeSVGText is currently only effective in the PDF renderer.</note>
+    </section>
+  </section>
   </body>
 </document>
 

diff --git a/src/documentation/content/xdocs/graphics.xml b/src/documentation/content/xdocs/graphics.xml
index fd5806fb37c2186a30696444910a907801cc3315..1c8adfa6900888f014cafb58b5772e8e29635036 100644 (file)
--- a/src/documentation/content/xdocs/graphics.xml
+++ b/src/documentation/content/xdocs/graphics.xml
@@ -182,23 +182,10 @@ If the text is inserted into the PDF using the inbuilt text commands
 for PDF it will use a single character.
         </p>
         <p>
-It is possible to make sure that all text is drawn into PDF using the
-PDF text commands (instead of the graphical shapes), by adding the following to the user config:
-        </p>
-        <source><![CDATA[<entry>
-  <key>strokeSVGText</key>
-  <value>false</value>
-</entry>]]></source>
-        <p>In a servlet environment, you can set it directly:</p>
-        <source>org.apache.fop.configuration.Configuration.put("strokeSVGText", Boolean.FALSE);</source>
-        <p>For information on using a configuration file in a servlet, see the <link href="faq.html#usercfg">FAQ</link> on that topic.</p>
-        <p>Note that this configuration setting works only for the PDF renderer.</p>
-        <p>
-The drawback to forcing text to be rendered as text is that it will be confined to text that is
-possible for PDF fonts (including embedded fonts) and implemented with
-this workaround. The fonts available are the standard pdf fonts and any
-fonts that you have embedded using FOP. The font sizes will be rounded
-to an integer value. In future this will be improved.
+For PDF output, there is a <link href="configuration.html#svg-strokeSVGText">configuration option to force SVG text to be rendered as text</link>.
+The drawback to this approach is that it is effective only for available fonts (including embedded fonts).
+Font sizes are rounded to the next integer point size.
+This will be improved in the future.
         </p>
         <p>Note that because SVG text can be rendered as either text or a vector graphic, you may need to consider settings in your viewer for both.
 The Acrobat viewer has both "smooth line art" and "smooth text" settings that may need to be set for SVG images to be displayed nicely on your screen (see Edit / Preferences / Display).