Commits (1)
This diff is collapsed.
......@@ -3,40 +3,45 @@
In all XPath location path listed here, we omit ``/SCRIBUSUTF8NEW/DOCUMENT``.
+-----------------------------------+-----------------------+--------------------+------------------+----------+
| XML | Explanation | Value | Default | Optional |
| element/attribute | | | | |
+===================================+=======================+====================+==================+==========+
| ``/@DPInCMYK`` | ICC profile for CMYK | string | | Yes |
| | images | | | |
+-----------------------------------+-----------------------+--------------------+------------------+----------+
| ``/@DPIn3`` | ICC profile for CMYK | string | | Yes |
| | colors | | | |
+-----------------------------------+-----------------------+--------------------+------------------+----------+
| ``/@PAGEC`` | Scribus GUI page | hexadecimal color | ``#ffffff`` | |
| | background | | | |
+-----------------------------------+-----------------------+--------------------+------------------+----------+
| ``/LAYERS/@FLOW`` | | integer as boolean | | |
+-----------------------------------+-----------------------+--------------------+------------------+----------+
| ``/LAYERS/@TRANS`` | Layer’s opacity | percentage | ``1`` | |
| | | 0 -> 1 | | |
+-----------------------------------+-----------------------+--------------------+------------------+----------+
| ``/LAYERS/@BLEND`` | Layer blend mode | | | |
+-----------------------------------+-----------------------+--------------------+------------------+----------+
| ``/LAYERS/@OUTL`` | Flag for wireframe | integer as boolean | ``0`` | |
| | view | | | |
+-----------------------------------+-----------------------+--------------------+------------------+----------+
| ``/LAYERS/@LAYERS`` | Color outline of the | hexadecimal color | | |
| | layer’s frames | | | |
+-----------------------------------+-----------------------+--------------------+------------------+----------+
| ``/CHARSTYLE/@DefaultStyle`` | Same as STYLE, but | string | | |
| | not documented | | | |
+-----------------------------------+-----------------------+--------------------+------------------+----------+
| ``/Sections/Section/@FillChar`` | | Unicode code | ``0`` | |
| | | point of character | (NULL character) | |
+-----------------------------------+-----------------------+--------------------+------------------+----------+
| ``/Sections/Section/@FieldWidth`` | | | ``0`` | |
+-----------------------------------+-----------------------+--------------------+------------------+----------+
+-----------------------------------+-----------------------+-------------------------------------------------------+------------------+----------+
| XML | Explanation | Value | Default | Optional |
| element/attribute | | | | |
+===================================+=======================+=======================================================+==================+==========+
| ``/@DPInCMYK`` | ICC profile for CMYK | string | | Yes |
| | images | | | |
+-----------------------------------+-----------------------+-------------------------------------------------------+------------------+----------+
| ``/@DPIn3`` | ICC profile for CMYK | string | | Yes |
| | colors | | | |
+-----------------------------------+-----------------------+-------------------------------------------------------+------------------+----------+
| ``/@PAGEC`` | Scribus GUI page | hexadecimal color | ``#ffffff`` | |
| | background | | | |
+-----------------------------------+-----------------------+-------------------------------------------------------+------------------+----------+
| ``/LAYERS/@FLOW`` | | integer as boolean | | |
+-----------------------------------+-----------------------+-------------------------------------------------------+------------------+----------+
| ``/LAYERS/@TRANS`` | Layer’s opacity | percentage | ``1`` | |
| | | 0 -> 1 | | |
+-----------------------------------+-----------------------+-------------------------------------------------------+------------------+----------+
| ``/LAYERS/@BLEND`` | Layer blend mode | | | |
+-----------------------------------+-----------------------+-------------------------------------------------------+------------------+----------+
| ``/LAYERS/@OUTL`` | Flag for wireframe | integer as boolean | ``0`` | |
| | view | | | |
+-----------------------------------+-----------------------+-------------------------------------------------------+------------------+----------+
| ``/LAYERS/@LAYERS`` | Color outline of the | hexadecimal color | | |
| | layer’s frames | | | |
+-----------------------------------+-----------------------+-------------------------------------------------------+------------------+----------+
| ``/CHARSTYLE/@DefaultStyle`` | Same as STYLE, but | string | | |
| | not documented | | | |
+-----------------------------------+-----------------------+-------------------------------------------------------+------------------+----------+
| ``/Sections/Section/@FillChar`` | | Unicode code | ``0`` | |
| | | point of character | (NULL character) | |
+-----------------------------------+-----------------------+-------------------------------------------------------+------------------+----------+
| ``/Sections/Section/@FieldWidth`` | | | ``0`` | |
+-----------------------------------+-----------------------+-------------------------------------------------------+------------------+----------+
| ``/PAGEOBJECT/@path`` | Path data | `SVG path/@d string | | |
| | | <https://www.w3.org/TR/SVG/paths.html#TheDProperty>`_ | ``0`` | |
+-----------------------------------+-----------------------+-------------------------------------------------------+------------------+----------+
| ``/PAGEOBJECT/@copath`` | Path data | Same as @path | | |
+-----------------------------------+-----------------------+-------------------------------------------------------+------------------+----------+
Corrections
-----------
......
......@@ -178,11 +178,11 @@
<p>In all XPath location path listed here, we omit <code class="docutils literal notranslate"><span class="pre">/SCRIBUSUTF8NEW/DOCUMENT</span></code>.</p>
<table border="1" class="docutils">
<colgroup>
<col width="33%" />
<col width="22%" />
<col width="19%" />
<col width="17%" />
<col width="9%" />
<col width="25%" />
<col width="16%" />
<col width="39%" />
<col width="13%" />
<col width="7%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">XML
......@@ -269,6 +269,18 @@ point of character</td>
<td><code class="docutils literal notranslate"><span class="pre">0</span></code></td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">/PAGEOBJECT/&#64;path</span></code></td>
<td>Path data</td>
<td><a class="reference external" href="https://www.w3.org/TR/SVG/paths.html#TheDProperty">SVG path/&#64;d string</a></td>
<td><code class="docutils literal notranslate"><span class="pre">0</span></code></td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">/PAGEOBJECT/&#64;copath</span></code></td>
<td>Path data</td>
<td>Same as &#64;path</td>
<td>&#160;</td>
<td>&#160;</td>
</tr>
</tbody>
</table>
<div class="section" id="corrections">
......
......@@ -221,11 +221,15 @@
<li><a href="pyscribus.html#pyscribus.papers.iso216.A9">A9 (class in pyscribus.papers.iso216)</a>
</li>
<li><a href="pyscribus.html#pyscribus.pageobjects.RectPath.add_point">add_point() (pyscribus.pageobjects.RectPath method)</a>
</li>
<li><a href="pyscribus.html#pyscribus.pageobjects.adjust_path_d">adjust_path_d() (in module pyscribus.pageobjects)</a>
</li>
<li><a href="pyscribus.html#pyscribus.common.xml.all_undocumented_to_python">all_undocumented_to_python() (in module pyscribus.common.xml)</a>
</li>
<li><a href="pyscribus.html#pyscribus.common.xml.all_undocumented_to_xml">all_undocumented_to_xml() (in module pyscribus.common.xml)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="pyscribus.html#pyscribus.document.Document.append">append() (pyscribus.document.Document method)</a>
<ul>
......@@ -236,8 +240,6 @@
<li><a href="pyscribus.html#pyscribus.stories.Story.append">(pyscribus.stories.Story method)</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="pyscribus.html#pyscribus.pageobjects.TableObject.append_column">append_column() (pyscribus.pageobjects.TableObject method)</a>
</li>
<li><a href="pyscribus.html#pyscribus.pageobjects.TableObject.append_columns">append_columns() (pyscribus.pageobjects.TableObject method)</a>
......
No preview for this file type
......@@ -2477,15 +2477,50 @@ of defaults available.</p>
<dt id="pyscribus.pageobjects.PathPoint">
<em class="property">class </em><code class="descclassname">pyscribus.pageobjects.</code><code class="descname">PathPoint</code><span class="sig-paren">(</span><em>x=0</em>, <em>y=0</em>, <em>fromsla=False</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyscribus/pageobjects.html#PathPoint"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyscribus.pageobjects.PathPoint" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>Point of a rectangular path in &#64;path/&#64;copath page objects.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>x</strong> (<em>float</em>) – x</li>
<li><strong>y</strong> (<em>float</em>) – y</li>
<li><strong>fromsla</strong> (<em>boolean</em>) – Adjusts x and y value if these value are not immediately
from SLA sources.</li>
</ul>
</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="pyscribus.pageobjects.PathPoint.is_origin">
<code class="descname">is_origin</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyscribus/pageobjects.html#PathPoint.is_origin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyscribus.pageobjects.PathPoint.is_origin" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dd><p>Is this path point the origin point ?</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">boolean</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pyscribus.pageobjects.PathPoint.toxmlstr">
<code class="descname">toxmlstr</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyscribus/pageobjects.html#PathPoint.toxmlstr"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyscribus.pageobjects.PathPoint.toxmlstr" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<code class="descname">toxmlstr</code><span class="sig-paren">(</span><em>move=False</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyscribus/pageobjects.html#PathPoint.toxmlstr"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyscribus.pageobjects.PathPoint.toxmlstr" title="Permalink to this definition"></a></dt>
<dd><p>Returns SVG path &#64;d command version of self.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">SVG path command</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
......@@ -2532,7 +2567,7 @@ of defaults available.</p>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>Path object for easiest manipulation of &#64;path / &#64;copath of rectangular
shapes.</p>
<p>Translate strings like :</p>
<p>Translate SVG path &#64;d strings like :</p>
<p>M0 0 L515.276 0 L515.276 761.89 L0 761.89 L0 0 Z</p>
<p>Into a list of PathPoint instances.</p>
<dl class="method">
......@@ -3477,6 +3512,13 @@ of defaults available.</p>
</dd></dl>
<dl class="function">
<dt id="pyscribus.pageobjects.adjust_path_d">
<code class="descclassname">pyscribus.pageobjects.</code><code class="descname">adjust_path_d</code><span class="sig-paren">(</span><em>d</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyscribus/pageobjects.html#adjust_path_d"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyscribus.pageobjects.adjust_path_d" title="Permalink to this definition"></a></dt>
<dd><p>Adjusts SVG path &#64;d returned by svg.path Path.d() to what Scribus
actually wrotes in SLA files.</p>
</dd></dl>
<dl class="function">
<dt id="pyscribus.pageobjects.new_from_type">
<code class="descclassname">pyscribus.pageobjects.</code><code class="descname">new_from_type</code><span class="sig-paren">(</span><em>ptype</em>, <em>sla_parent=False</em>, <em>doc_parent=False</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyscribus/pageobjects.html#new_from_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyscribus.pageobjects.new_from_type" title="Permalink to this definition"></a></dt>
......
This diff is collapsed.