Commit ea201f75 authored by Etienne Nadji's avatar Etienne Nadji
Browse files

modifié : _modules/pyscribus/colors.html

	modifié :         _modules/pyscribus/exceptions.html
	modifié :         _modules/pyscribus/pageobjects.html
	modifié :         _modules/pyscribus/pages.html
	modifié :         _sources/articles/en/spec.rst.txt
	modifié :         articles/en/spec.html
	modifié :         genindex.html
	modifié :         objects.inv
	modifié :         pyscribus.html
	modifié :         searchindex.js
parent 9b2c51f0
......@@ -208,6 +208,19 @@
<div class="viewcode-block" id="Color"><a class="viewcode-back" href="../../pyscribus.html#pyscribus.colors.Color">[docs]</a><span class="k">class</span> <span class="nc">Color</span><span class="p">(</span><span class="n">xmlc</span><span class="o">.</span><span class="n">PyScribusElement</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> SLA Color (COLOR)</span>
<span class="sd"> :type kwargs: dict</span>
<span class="sd"> :param kwargs: Quick setting (see kwargs table)</span>
<span class="sd"> +------------+---------------------------------+-----------+</span>
<span class="sd"> | Kwargs | Setting | Type |</span>
<span class="sd"> +============+=================================+===========+</span>
<span class="sd"> | default | Equivalent to a ``fromdefault`` | boolean |</span>
<span class="sd"> | | call. | or string |</span>
<span class="sd"> | | | |</span>
<span class="sd"> | | Value being True or the name of | |</span>
<span class="sd"> | | the default set. | |</span>
<span class="sd"> +------------+---------------------------------+-----------+</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">defaults</span> <span class="o">=</span> <span class="p">{</span>
......@@ -264,7 +277,7 @@
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="s2">&quot;Black&quot;</span><span class="p">,</span> <span class="n">space</span><span class="o">=</span><span class="s2">&quot;CMYK&quot;</span><span class="p">,</span> <span class="n">colors</span><span class="o">=</span><span class="p">[</span><span class="mi">0</span><span class="p">,</span><span class="mi">0</span><span class="p">,</span><span class="mi">0</span><span class="p">,</span><span class="mi">100</span><span class="p">],</span>
<span class="n">register</span><span class="o">=</span><span class="s2">&quot;0&quot;</span><span class="p">):</span>
<span class="n">register</span><span class="o">=</span><span class="s2">&quot;0&quot;</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">pyscribus_defaults</span> <span class="o">=</span> <span class="p">[</span><span class="n">k</span> <span class="k">for</span> <span class="n">k</span> <span class="ow">in</span> <span class="n">Color</span><span class="o">.</span><span class="n">defaults</span><span class="o">.</span><span class="n">keys</span><span class="p">()]</span>
......@@ -273,6 +286,8 @@
<span class="bp">self</span><span class="o">.</span><span class="n">register</span> <span class="o">=</span> <span class="n">register</span>
<span class="bp">self</span><span class="o">.</span><span class="n">set_space_colors</span><span class="p">(</span><span class="n">space</span><span class="p">,</span> <span class="n">colors</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_quick_setup</span><span class="p">(</span><span class="n">kwargs</span><span class="p">)</span>
<span class="c1">#--- Color management --------------------------------------</span>
<div class="viewcode-block" id="Color.set_space_colors"><a class="viewcode-back" href="../../pyscribus.html#pyscribus.colors.Color.set_space_colors">[docs]</a> <span class="k">def</span> <span class="nf">set_space_colors</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">space</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">colors</span><span class="p">:</span> <span class="nb">list</span><span class="p">):</span>
......@@ -380,6 +395,28 @@
<span class="c1">#--- PyScribus standard methods ----------------------------</span>
<div class="viewcode-block" id="Color.fromdefault"><a class="viewcode-back" href="../../pyscribus.html#pyscribus.colors.Color.fromdefault">[docs]</a> <span class="k">def</span> <span class="nf">fromdefault</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">default</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;Black&quot;</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Set default attributes for this color.</span>
<span class="sd"> :Example:</span>
<span class="sd"> .. code:: python</span>
<span class="sd"> # with fromdefault method :</span>
<span class="sd"> black = Color()</span>
<span class="sd"> black.fromdefault(&quot;Black&quot;)</span>
<span class="sd"> # with quick setup :</span>
<span class="sd"> blue = Color(default=&quot;Blue&quot;)</span>
<span class="sd"> .. seealso::</span>
<span class="sd"> **For fromdefault explanation**: </span>
<span class="sd"> `pyscribus.common.xml.PyScribusElement.fromdefault`</span>
<span class="sd"> **For current class default sets**: </span>
<span class="sd"> `pyscribus.colors.Color.listdefaults`</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="n">default</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">pyscribus_defaults</span><span class="p">:</span>
......@@ -480,6 +517,21 @@
<span class="k">return</span> <span class="n">xml</span></div>
<span class="k">def</span> <span class="nf">_quick_setup</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">settings</span><span class="p">:</span> <span class="nb">dict</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Method for defining gradient stop settings from class</span>
<span class="sd"> instanciation kwargs.</span>
<span class="sd"> :type settings: dict</span>
<span class="sd"> :param settings: Kwargs dictionnary</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="n">settings</span><span class="p">:</span>
<span class="n">xmlc</span><span class="o">.</span><span class="n">PyScribusElement</span><span class="o">.</span><span class="n">_quick_setup</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">settings</span><span class="p">)</span>
<span class="k">for</span> <span class="n">setting_name</span><span class="p">,</span> <span class="n">setting_value</span> <span class="ow">in</span> <span class="n">settings</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="k">pass</span>
<span class="c1">#--- Python __ methods -------------------------------------</span>
<span class="k">def</span> <span class="nf">__eq__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
......@@ -544,21 +596,24 @@
<span class="sd"> :type kwargs: dict</span>
<span class="sd"> :param kwargs: Quick setting (see kwargs table)</span>
<span class="sd"> +------------+-------------------------------+-----------+</span>
<span class="sd"> | Kwargs | Setting | Type |</span>
<span class="sd"> +============+===============================+===========+</span>
<span class="sd"> | default | Equivalent to a fromdefault | boolean |</span>
<span class="sd"> | | call, value being True or the | or string |</span>
<span class="sd"> | | default name | |</span>
<span class="sd"> +------------+-------------------------------+-----------+</span>
<span class="sd"> | position | | |</span>
<span class="sd"> +------------+-------------------------------+-----------+</span>
<span class="sd"> | color | | |</span>
<span class="sd"> +------------+-------------------------------+-----------+</span>
<span class="sd"> | shade | | |</span>
<span class="sd"> +------------+-------------------------------+-----------+</span>
<span class="sd"> | opacity | | |</span>
<span class="sd"> +------------+-------------------------------+-----------+</span>
<span class="sd"> +------------+---------------------------------+-----------+</span>
<span class="sd"> | Kwargs | Setting | Type |</span>
<span class="sd"> +============+=================================+===========+</span>
<span class="sd"> | default | Equivalent to a ``fromdefault`` | boolean |</span>
<span class="sd"> | | call. | or string |</span>
<span class="sd"> | | | |</span>
<span class="sd"> | | Value being True or the name of | |</span>
<span class="sd"> | | the default set. | |</span>
<span class="sd"> +------------+---------------------------------+-----------+</span>
<span class="sd"> | opacity | Percentage of opacity, | float |</span>
<span class="sd"> | | from 0 to 1. | |</span>
<span class="sd"> +------------+---------------------------------+-----------+</span>
<span class="sd"> | color | Color name | string |</span>
<span class="sd"> +------------+---------------------------------+-----------+</span>
<span class="sd"> | position | | |</span>
<span class="sd"> +------------+---------------------------------+-----------+</span>
<span class="sd"> | shade | | |</span>
<span class="sd"> +------------+---------------------------------+-----------+</span>
<span class="sd"> :Example:</span>
......
......@@ -232,6 +232,14 @@
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">pass</span></div>
<span class="c1"># --- Quick setup ----------------------------------------------</span>
<div class="viewcode-block" id="QuickSetupInvalidValue"><a class="viewcode-back" href="../../pyscribus.html#pyscribus.exceptions.QuickSetupInvalidValue">[docs]</a><span class="k">class</span> <span class="nc">QuickSetupInvalidValue</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Exception raised when a quick setup value is invalid.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">pass</span></div>
<span class="c1"># --- Unknown SLA references -----------------------------------</span>
<div class="viewcode-block" id="UnknownLayer"><a class="viewcode-back" href="../../pyscribus.html#pyscribus.exceptions.UnknownLayer">[docs]</a><span class="k">class</span> <span class="nc">UnknownLayer</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
......
This diff is collapsed.
......@@ -753,52 +753,55 @@
<span class="sd"> :type kwargs: dict</span>
<span class="sd"> :param kwargs: Quick setting (see kwargs table)</span>
<span class="sd"> +--------------+--------------------------------+------------+</span>
<span class="sd"> | Kwargs | Setting | Value type |</span>
<span class="sd"> +==============+================================+============+</span>
<span class="sd"> | default | Equivalent to a fromdefault | boolean or |</span>
<span class="sd"> | | call, value being the default | string |</span>
<span class="sd"> | | name or True | |</span>
<span class="sd"> +--------------+--------------------------------+------------+</span>
<span class="sd"> | posx | X position of the page | float |</span>
<span class="sd"> +--------------+--------------------------------+------------+</span>
<span class="sd"> | posy | Y position of the page | float |</span>
<span class="sd"> +--------------+--------------------------------+------------+</span>
<span class="sd"> | width | Page width | float |</span>
<span class="sd"> +--------------+--------------------------------+------------+</span>
<span class="sd"> | height | Page height | float |</span>
<span class="sd"> +--------------+--------------------------------+------------+</span>
<span class="sd"> | borders | Shorthand for rightborder, | List of |</span>
<span class="sd"> | | leftborder, topborder, | floats |</span>
<span class="sd"> | | bottomborder. | |</span>
<span class="sd"> | | | |</span>
<span class="sd"> | | Read like the CSS margin | |</span>
<span class="sd"> | | property: | |</span>
<span class="sd"> | | | |</span>
<span class="sd"> | | **With 1 float in the list :** | |</span>
<span class="sd"> | | | |</span>
<span class="sd"> | | [top &amp; right &amp; bottom &amp; left] | |</span>
<span class="sd"> | | | |</span>
<span class="sd"> | | **With 2 float in the list :** | |</span>
<span class="sd"> | | | |</span>
<span class="sd"> | | [top &amp; bottom, right &amp; left] | |</span>
<span class="sd"> | | | |</span>
<span class="sd"> | | **With 3 float in the list :** | |</span>
<span class="sd"> | | | |</span>
<span class="sd"> | | [top, right &amp; left, bottom] | |</span>
<span class="sd"> | | | |</span>
<span class="sd"> | | **With 4 float in the list :** | |</span>
<span class="sd"> | | | |</span>
<span class="sd"> | | [top, right, bottom, left] | |</span>
<span class="sd"> +--------------+--------------------------------+------------+</span>
<span class="sd"> | rightborder | | float |</span>
<span class="sd"> +--------------+--------------------------------+------------+</span>
<span class="sd"> | leftborder | | float |</span>
<span class="sd"> +--------------+--------------------------------+------------+</span>
<span class="sd"> | topborder | | float |</span>
<span class="sd"> +--------------+--------------------------------+------------+</span>
<span class="sd"> | bottomborder | | float |</span>
<span class="sd"> +--------------+--------------------------------+------------+</span>
<span class="sd"> +--------------+---------------------------------+------------+</span>
<span class="sd"> | Kwargs | Setting | Value type |</span>
<span class="sd"> +==============+=================================+============+</span>
<span class="sd"> | default | Equivalent to a ``fromdefault`` | boolean |</span>
<span class="sd"> | | call. | or string |</span>
<span class="sd"> | | | |</span>
<span class="sd"> | | Value being True or the name of | |</span>
<span class="sd"> | | the default set. | |</span>
<span class="sd"> +--------------+---------------------------------+------------+</span>
<span class="sd"> | posx | X position of the page | float |</span>
<span class="sd"> +--------------+---------------------------------+------------+</span>
<span class="sd"> | posy | Y position of the page | float |</span>
<span class="sd"> +--------------+---------------------------------+------------+</span>
<span class="sd"> | width | Page width | float |</span>
<span class="sd"> +--------------+---------------------------------+------------+</span>
<span class="sd"> | height | Page height | float |</span>
<span class="sd"> +--------------+---------------------------------+------------+</span>
<span class="sd"> | borders | Shorthand for : | List of |</span>
<span class="sd"> | | | floats |</span>
<span class="sd"> | | *rightborder*, *leftborder*, | |</span>
<span class="sd"> | | *topborder*, *bottomborder* | |</span>
<span class="sd"> | | | |</span>
<span class="sd"> | | Read like the CSS margin | |</span>
<span class="sd"> | | property: | |</span>
<span class="sd"> | | | |</span>
<span class="sd"> | | **With 1 float in the list :** | |</span>
<span class="sd"> | | | |</span>
<span class="sd"> | | [top &amp; right &amp; bottom &amp; left] | |</span>
<span class="sd"> | | | |</span>
<span class="sd"> | | **With 2 float in the list :** | |</span>
<span class="sd"> | | | |</span>
<span class="sd"> | | [top &amp; bottom, right &amp; left] | |</span>
<span class="sd"> | | | |</span>
<span class="sd"> | | **With 3 float in the list :** | |</span>
<span class="sd"> | | | |</span>
<span class="sd"> | | [top, right &amp; left, bottom] | |</span>
<span class="sd"> | | | |</span>
<span class="sd"> | | **With 4 float in the list :** | |</span>
<span class="sd"> | | | |</span>
<span class="sd"> | | [top, right, bottom, left] | |</span>
<span class="sd"> +--------------+---------------------------------+------------+</span>
<span class="sd"> | rightborder | Right border | float |</span>
<span class="sd"> +--------------+---------------------------------+------------+</span>
<span class="sd"> | leftborder | Left border | float |</span>
<span class="sd"> +--------------+---------------------------------+------------+</span>
<span class="sd"> | topborder | Top border | float |</span>
<span class="sd"> +--------------+---------------------------------+------------+</span>
<span class="sd"> | bottomborder | Bottom border | float |</span>
<span class="sd"> +--------------+---------------------------------+------------+</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
......@@ -855,52 +858,55 @@
<span class="sd"> :type kwargs: dict</span>
<span class="sd"> :param kwargs: Quick setting (see kwargs table)</span>
<span class="sd"> +--------------+--------------------------------+------------+</span>
<span class="sd"> | Kwargs | Setting | Value type |</span>
<span class="sd"> +==============+================================+============+</span>
<span class="sd"> | default | Equivalent to a fromdefault | boolean or |</span>
<span class="sd"> | | call, value being the default | string |</span>
<span class="sd"> | | name or True | |</span>
<span class="sd"> +--------------+--------------------------------+------------+</span>
<span class="sd"> | posx | X position of the page | float |</span>
<span class="sd"> +--------------+--------------------------------+------------+</span>
<span class="sd"> | posy | Y position of the page | float |</span>
<span class="sd"> +--------------+--------------------------------+------------+</span>
<span class="sd"> | width | Page width | float |</span>
<span class="sd"> +--------------+--------------------------------+------------+</span>
<span class="sd"> | height | Page height | float |</span>
<span class="sd"> +--------------+--------------------------------+------------+</span>
<span class="sd"> | borders | Shorthand for rightborder, | List of |</span>
<span class="sd"> | | leftborder, topborder, | floats |</span>
<span class="sd"> | | bottomborder. | |</span>
<span class="sd"> | | | |</span>
<span class="sd"> | | Read like the CSS margin | |</span>
<span class="sd"> | | property: | |</span>
<span class="sd"> | | | |</span>
<span class="sd"> | | **With 1 float in the list :** | |</span>
<span class="sd"> | | | |</span>
<span class="sd"> | | [top &amp; right &amp; bottom &amp; left] | |</span>
<span class="sd"> | | | |</span>
<span class="sd"> | | **With 2 float in the list :** | |</span>
<span class="sd"> | | | |</span>
<span class="sd"> | | [top &amp; bottom, right &amp; left] | |</span>
<span class="sd"> | | | |</span>
<span class="sd"> | | **With 3 float in the list :** | |</span>
<span class="sd"> | | | |</span>
<span class="sd"> | | [top, right &amp; left, bottom] | |</span>
<span class="sd"> | | | |</span>
<span class="sd"> | | **With 4 float in the list :** | |</span>
<span class="sd"> | | | |</span>
<span class="sd"> | | [top, right, bottom, left] | |</span>
<span class="sd"> +--------------+--------------------------------+------------+</span>
<span class="sd"> | rightborder | | float |</span>
<span class="sd"> +--------------+--------------------------------+------------+</span>
<span class="sd"> | leftborder | | float |</span>
<span class="sd"> +--------------+--------------------------------+------------+</span>
<span class="sd"> | topborder | | float |</span>
<span class="sd"> +--------------+--------------------------------+------------+</span>
<span class="sd"> | bottomborder | | float |</span>
<span class="sd"> +--------------+--------------------------------+------------+</span>
<span class="sd"> +--------------+---------------------------------+------------+</span>
<span class="sd"> | Kwargs | Setting | Value type |</span>
<span class="sd"> +==============+=================================+============+</span>
<span class="sd"> | default | Equivalent to a ``fromdefault`` | boolean |</span>
<span class="sd"> | | call. | or string |</span>
<span class="sd"> | | | |</span>
<span class="sd"> | | Value being True or the name of | |</span>
<span class="sd"> | | the default set. | |</span>
<span class="sd"> +--------------+---------------------------------+------------+</span>
<span class="sd"> | posx | X position of the page | float |</span>
<span class="sd"> +--------------+---------------------------------+------------+</span>
<span class="sd"> | posy | Y position of the page | float |</span>
<span class="sd"> +--------------+---------------------------------+------------+</span>
<span class="sd"> | width | Page width | float |</span>
<span class="sd"> +--------------+---------------------------------+------------+</span>
<span class="sd"> | height | Page height | float |</span>
<span class="sd"> +--------------+---------------------------------+------------+</span>
<span class="sd"> | borders | Shorthand for : | List of |</span>
<span class="sd"> | | | floats |</span>
<span class="sd"> | | *rightborder*, *leftborder*, | |</span>
<span class="sd"> | | *topborder*, *bottomborder* | |</span>
<span class="sd"> | | | |</span>
<span class="sd"> | | Read like the CSS margin | |</span>
<span class="sd"> | | property: | |</span>
<span class="sd"> | | | |</span>
<span class="sd"> | | **With 1 float in the list :** | |</span>
<span class="sd"> | | | |</span>
<span class="sd"> | | [top &amp; right &amp; bottom &amp; left] | |</span>
<span class="sd"> | | | |</span>
<span class="sd"> | | **With 2 float in the list :** | |</span>
<span class="sd"> | | | |</span>
<span class="sd"> | | [top &amp; bottom, right &amp; left] | |</span>
<span class="sd"> | | | |</span>
<span class="sd"> | | **With 3 float in the list :** | |</span>
<span class="sd"> | | | |</span>
<span class="sd"> | | [top, right &amp; left, bottom] | |</span>
<span class="sd"> | | | |</span>
<span class="sd"> | | **With 4 float in the list :** | |</span>
<span class="sd"> | | | |</span>
<span class="sd"> | | [top, right, bottom, left] | |</span>
<span class="sd"> +--------------+---------------------------------+------------+</span>
<span class="sd"> | rightborder | Right border | float |</span>
<span class="sd"> +--------------+---------------------------------+------------+</span>
<span class="sd"> | leftborder | Left border | float |</span>
<span class="sd"> +--------------+---------------------------------+------------+</span>
<span class="sd"> | topborder | Top border | float |</span>
<span class="sd"> +--------------+---------------------------------+------------+</span>
<span class="sd"> | bottomborder | Bottom border | float |</span>
<span class="sd"> +--------------+---------------------------------+------------+</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
......
[EN] SLA document-able attributes
=================================
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 | | | |
+-----------------------------------+-----------------------+--------------------+------------------+----------+
| ``/CHARSTYLE/@wordTrack`` | Space width | Percentage | | |
| | | 0 -> 1 | | |
+-----------------------------------+-----------------------+--------------------+------------------+----------+
| ``/CHARSTYLE/@KERN`` | Kerning | Percentage | | |
| | | 0 -> 100 | | |
+-----------------------------------+-----------------------+--------------------+------------------+----------+
| ``/Sections/Section/@FillChar`` | | Unicode code | ``0`` | |
| | | point of character | (NULL character) | |
+-----------------------------------+-----------------------+--------------------+------------------+----------+
| ``/Sections/Section/@FieldWidth`` | | | ``0`` | |
+-----------------------------------+-----------------------+--------------------+------------------+----------+
| ``/PAGEOBJECT/@path`` | Path data | SVG path/@d string | ``0`` | |
+-----------------------------------+-----------------------+--------------------+------------------+----------+
| ``/PAGEOBJECT/@copath`` | Path data | Same as @path | | |
+-----------------------------------+-----------------------+--------------------+------------------+----------+
DOCUMENT
--------
Omitted XPath : ``/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 | | |
+--------------------+-----------------------+--------------------+-------------+----------+
DOCUMENT/LAYERS
---------------
Omitted XPath : ``/SCRIBUSUTF8NEW/DOCUMENT``.
+---------------------+-----------------------+--------------------+---------+----------+
| XML | Explanation | Value | Default | Optional |
| element/attribute | | | | |
+=====================+=======================+====================+=========+==========+
| ``/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 | | | |
+---------------------+-----------------------+--------------------+---------+----------+
DOCUMENT/CHARSTYLE
------------------
Omitted XPath : ``/SCRIBUSUTF8NEW/DOCUMENT``.
+------------------------------+--------------------+------------+---------+----------+
| XML | Explanation | Value | Default | Optional |
| element/attribute | | | | |
+==============================+====================+============+=========+==========+
| ``/CHARSTYLE/@DefaultStyle`` | Same as STYLE, but | string | | |
| | not documented | | | |
+------------------------------+--------------------+------------+---------+----------+
| ``/CHARSTYLE/@wordTrack`` | Space width | Percentage | | |
| | | 0 -> 1 | | |
+------------------------------+--------------------+------------+---------+----------+
| ``/CHARSTYLE/@KERN`` | Kerning | Percentage | | |
| | | 0 -> 100 | | |
+------------------------------+--------------------+------------+---------+----------+
DOCUMENT/Sections
-----------------
Omitted XPath : ``/SCRIBUSUTF8NEW/DOCUMENT``.
+-------------------------------------+-------------+--------------------+------------------+----------+
| XML | Explanation | Value | Default | Optional |
| element/attribute | | | | |
+=====================================+=============+====================+==================+==========+
| ``/Sections/Section/@FillChar`` | | Unicode code | ``0`` | |
| | | point of character | (NULL character) | |
+-------------------------------------+-------------+--------------------+------------------+----------+
| ``/Sections/Section/@FieldWidth`` | | | ``0`` | |
+-------------------------------------+-------------+--------------------+------------------+----------+
DOCUMENT/PAGEOBJECT
-------------------
Omitted XPath : ``/SCRIBUSUTF8NEW/DOCUMENT/PAGEOBJECT``.
+--------------------------+--------------------+--------------------+---------+----------+
| XML | Explanation | Value | Default | Optional |
| element/attribute | | | | |
+==========================+====================+====================+=========+==========+
| ``/@path`` | Path data | SVG path/@d string | ``0`` | |
+--------------------------+--------------------+--------------------+---------+----------+
| ``/@copath`` | Path data | Same as @path | | |
+--------------------------+--------------------+--------------------+---------+----------+
| ``[@PTYPE="4"]/@VAlign`` | Vertical alignment | Same as @path | ``0`` | No |
| | of the text within | 0 = top | | |
| | the frame | 1 = center | | |
| | | 2 = bottom | | |
+--------------------------+--------------------+--------------------+---------+----------+
Notes
-----
......
......@@ -100,6 +100,11 @@
</ul>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">[EN] SLA document-able attributes</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#document">DOCUMENT</a></li>
<li class="toctree-l2"><a class="reference internal" href="#document-layers">DOCUMENT/LAYERS</a></li>
<li class="toctree-l2"><a class="reference internal" href="#document-charstyle">DOCUMENT/CHARSTYLE</a></li>
<li class="toctree-l2"><a class="reference internal" href="#document-sections">DOCUMENT/Sections</a></li>
<li class="toctree-l2"><a class="reference internal" href="#document-pageobject">DOCUMENT/PAGEOBJECT</a></li>
<li class="toctree-l2"><a class="reference internal" href="#notes">Notes</a></li>
<li class="toctree-l2"><a class="reference internal" href="#corrections">Corrections</a></li>
<li class="toctree-l2"><a class="reference internal" href="#notable-things">Notable things</a></li>
......@@ -176,14 +181,16 @@
<div class="section" id="en-sla-document-able-attributes">
<h1>[EN] SLA document-able attributes<a class="headerlink" href="#en-sla-document-able-attributes" title="Permalink to this headline"></a></h1>
<p>In all XPath location path listed here, we omit <code class="docutils literal notranslate"><span class="pre">/SCRIBUSUTF8NEW/DOCUMENT</span></code>.</p>
<div class="section" id="document">
<h2>DOCUMENT<a class="headerlink" href="#document" title="Permalink to this headline"></a></h2>
<p>Omitted XPath : <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="23%" />
<col width="27%" />
<col width="23%" />
<col width="15%" />
<col width="12%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">XML
......@@ -229,26 +236,74 @@ background</td>
<td><code class="docutils literal notranslate"><span class="pre">1</span></code></td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">/LAYERS/&#64;BLEND</span></code></td>
</tbody>
</table>
</div>
<div class="section" id="document-layers">
<h2>DOCUMENT/LAYERS<a class="headerlink" href="#document-layers" title="Permalink to this headline"></a></h2>
<p>Omitted XPath : <code class="docutils literal notranslate"><span class="pre">/SCRIBUSUTF8NEW/DOCUMENT</span></code>.</p>
<table border="1" class="docutils">
<colgroup>
<col width="25%" />
<col width="28%" />
<col width="24%" />
<col width="11%" />
<col width="12%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">XML
element/attribute</th>
<th class="head">Explanation</th>
<th class="head">Value</th>
<th class="head">Default</th>
<th class="head">Optional</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">/LAYERS/&#64;BLEND</span></code></td>
<td>Layer blend mode</td>
<td>&#160;</td>
<td>&#160;</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">/LAYERS/&#64;OUTL</span></code></td>
<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">/LAYERS/&#64;OUTL</span></code></td>
<td>Flag for wireframe
view</td>
<td>integer as boolean</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">/LAYERS/&#64;LAYERS</span></code></td>
<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">/LAYERS/&#64;LAYERS</span></code></td>
<td>Color outline of the
layer’s frames</td>
<td>hexadecimal color</td>
<td>&#160;</td>
<td>&#160;</td>
</tr>
</tbody>
</table>