r20587 by gpittman -
scribus-commit
scribus-commit at lists.scribus.net
Thu Nov 26 20:24:20 UTC 2015
Author: gpittman
Date: Thu Nov 26 20:24:20 2015
New Revision: 20587
URL: http://scribus.net/websvn/listing.php?repname=Scribus&sc=1&rev=20587
Log:
updating Scripter docs in manual (de)
Modified:
trunk/Scribus/doc/de/scripter-extensions.html
trunk/Scribus/doc/de/scripter-faq.html
trunk/Scribus/doc/de/scripter1.html
trunk/Scribus/doc/de/scripterapi-ImageExport.html
trunk/Scribus/doc/de/scripterapi-PDFfile.html
trunk/Scribus/doc/de/scripterapi-Printer.html
trunk/Scribus/doc/de/scripterapi-color.html
trunk/Scribus/doc/de/scripterapi-constants.html
trunk/Scribus/doc/de/scripterapi-dialogs.html
trunk/Scribus/doc/de/scripterapi-doc.html
trunk/Scribus/doc/de/scripterapi-font.html
trunk/Scribus/doc/de/scripterapi-getobjprop.html
trunk/Scribus/doc/de/scripterapi-layer.html
trunk/Scribus/doc/de/scripterapi-object.html
trunk/Scribus/doc/de/scripterapi-page.html
trunk/Scribus/doc/de/scripterapi-select.html
trunk/Scribus/doc/de/scripterapi-setobjprop.html
trunk/Scribus/doc/de/scripterapi-textframes.html
trunk/Scribus/doc/de/scripterapi.html
Modified: trunk/Scribus/doc/de/scripter-extensions.html
URL: http://scribus.net/websvn/diff.php?repname=Scribus&rev=20587&path=/trunk/Scribus/doc/de/scripter-extensions.html
==============================================================================
--- trunk/Scribus/doc/de/scripter-extensions.html (original)
+++ trunk/Scribus/doc/de/scripter-extensions.html Thu Nov 26 20:24:20 2015
@@ -2,6 +2,9 @@
<head>
<title>Scripter: Extension Scripts</title>
</head>
+<style>
+ at import "manual.css";
+</style>
<body>
</head>
<body>
@@ -124,7 +127,7 @@
that program to run in Scribus. Here's the original:</p>
<pre>
-#!/usr/bin/env Python
+#!/usr/bin/env python
import sys
import qt
@@ -220,7 +223,7 @@
<p>The new script looks like:</p>
<pre>
-#!/usr/bin/env Python
+#!/usr/bin/env python
import sys
import qt
@@ -327,7 +330,7 @@
assumes it is not running under Scribus and complains. It's a good idea
to do this in all your scripts so that you don't confuse users who try
to run them with the standalone Python interpreter. Try running the
-script with <code>Python pyqt_tut1.py</code> and note how it tells the user why
+script with <code>python pyqt_tut1.py</code> and note how it tells the user why
it won't work then exits. This is much nicer than an import error or bizarre
behaviour.</p>
Modified: trunk/Scribus/doc/de/scripter-faq.html
URL: http://scribus.net/websvn/diff.php?repname=Scribus&rev=20587&path=/trunk/Scribus/doc/de/scripter-faq.html
==============================================================================
--- trunk/Scribus/doc/de/scripter-faq.html (original)
+++ trunk/Scribus/doc/de/scripter-faq.html Thu Nov 26 20:24:20 2015
@@ -3,6 +3,9 @@
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<title>Scripter FAQ</title>
</head>
+<style>
+ at import "manual.css";
+</style>
<body>
<h2>Scripter FAQ</h2>
<p>Author: Craig Ringer</p>
@@ -11,17 +14,17 @@
<h3>How do I use non-ASCII text in the scripter?</h3>
<p>First, make sure to ensure that your script has a correct coding line. Your script should start with something like:
<pre>
- #!/usr/bin/env Python
+ #!/usr/bin/env python
# -*- coding: latin-1 -*-
</pre>
or
<pre>
- #!/usr/bin/env Python
+ #!/usr/bin/env python
# -*- coding: utf-8 -*-
</pre>
or
<pre>
- #!/usr/bin/env Python
+ #!/usr/bin/env python
# -*- coding: ascii -*-
</pre>
</p>
@@ -57,7 +60,7 @@
<p>For most scripting tasks, building a simple GUI in Tkinter is your best choices at present. If you're looking to extend the user interface or provide palettes the user can work with while they continue to work in Scribus, you'll need to look into writing an 'extension script' with PyQt.
-<p>In most cases it's recommended to just choose Tkinter. It's the only GUI toolkit that works reliably in normal Scribus scripts due to the way they're executed in sub-interpreters. It's also almost universally packaged in Linux distros, though not all install it by default, and it's highly portable. Users may not particularly love the appearance of Tkinter, but it works well.</p>
+<p>In most cases it's recommended to just choose Tkinter. It's the only GUI toolkit that works reliably in normal Scribus scripts due to the way they're executed in sub-interpreters. It's also almost universally packaged in Linux distributions, though not all install it by default. Tkinter is highly portable. Tkinter is also bundled with the Windows installer for Scribus, along with being included with the python on Mac OS X 10.4.x. Users may not particularly love the appearance of Tkinter, but it works well.</p>
<p>If you're looking to write more advanced GUIs, the best choice is currently PyQt. You can write your own custom dialogs and palettes using PyQt, giving you the ability to extend the Scribus interface to a limited extent. PyQt will not work reliably from a normal script, but works fine from scripts that are run using the "Load Extension Script..." menu item. Please see the advanced section of the scripter manual for more details on this.</p>
@@ -69,13 +72,13 @@
<p>While 'import scribus' results in slightly more verbose code, it's generally worth it in improved code readability and explictness.</p>
<h3>What about general programming style?</h3>
-<p>In general, we defer to the Python gurus. Have a look at <a href="http://www.Python.org/peps/pep-0008.html" title="Extern link">http://www.Python.org/peps/pep-0008.html</a> for a rather in-depth look at the subject.</p>
+<p>In general, we defer to the Python gurus. Have a look at <a href="http://www.python.org/peps/pep-0008.html" title="Extern link">http://www.python.org/peps/pep-0008.html</a> for a rather in-depth look at the subject.</p>
<p>An exception is made for source code encodings, where either ASCII with escapes, latin-1, or utf-8 are recommended. Almost any encoding you choose should work fine, though.</p>
<p>Please note that none of this is set in stone - you can code however you like. These recommendations are made for a reason though, and are a good idea to follow especially if you plan to share your code with others.</p>
-<h3>Are there any quirks specific to the Scribus Python interface that I should know about?</h3>
+<h3>Are there any quirks specific to the Scribus python interface that I should know about?</h3>
<p>Yes, there are a few differences you should be aware of:</p>
<ul>
@@ -83,7 +86,7 @@
<li>PyQt does not currently work correctly from Python scripts run from normal Scribus scripts, though it can now be used from the 'extension script' mode. Please enquire on the mailing list if you think you may be able to assist in solving this. Experience with the Python/C API, sub-interpreters, and PyQt would probably be required.</li>
- <li>The Scribus Python plug-in changes the Python default string encoding (sysdefaultencoding) to utf-8. Python defaults to ASCII. Because utf-8 is a (large) superset of ASCII, this should not affect scripts that only use ASCII-encoded strings. The Scribus functions have been tested to work correctly with this for unicode text, so there should not be any issues there either.<br>
+ <li>The Scribus python plug-in changes the Python default string encoding (sysdefaultencoding) to utf-8. Python defaults to ASCII. Because utf-8 is a (large) superset of ASCII, this should not affect scripts that only use ASCII-encoded strings. The Scribus functions have been tested to work correctly with this for unicode text, so there should not be any issues there either.<br>
Nonetheless, it is possible that third party C extension modules may have problems with this, if the author failed to consider the encoding of incoming text. Any such problems are almost always bugs that should be reported to the author of the module, and should be few and far between. If you encounter such an issue, please enquire on the mailing list or on IRC.</li>
<li>Python runs embedded inside Scribus. It is possible that loading certain C extension modules that perform complex initialization tricks may disrupt Scribus or the Python interpreter. If you encounter such a module, please report it on the mailing list or drop in on IRC. Anything that wants to run its own event loop is likely to be problematic, and interfaces to GUI toolkits also seem to be troublesome. Anything that spawns threads is also likely to cause issues.</li>
@@ -129,8 +132,5 @@
<li>Offering to pay somebody to do it. This is probably only practical for larger amounts of work that would require quite a bit of time and effort (and money), but it's there as an option if you really need something.</li>
</ul>
-<h3>Where can I get hints about Unicode ?</h3>
-<p>http://www.cl.cam.ac.uk/~mgk25/unicode.html<a href="http://www.cl.cam.ac.uk/~mgk25/unicode.html" target="http://www.cl.cam.ac.uk/~mgk25/unicode.html"></a></p>
</body>
</html>
-
Modified: trunk/Scribus/doc/de/scripter1.html
URL: http://scribus.net/websvn/diff.php?repname=Scribus&rev=20587&path=/trunk/Scribus/doc/de/scripter1.html
==============================================================================
--- trunk/Scribus/doc/de/scripter1.html (original)
+++ trunk/Scribus/doc/de/scripter1.html Thu Nov 26 20:24:20 2015
@@ -1,29 +1,31 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
- <title>Scripting in Scribus mit Python</title>
+ <title>Scripting Scribus with Python</title>
</head>
+<style>
+ at import "manual.css";
+</style>
<body>
-<h2>Scripting in Scribus mit Python</h2>
+<h2>Scripting Scribus with Python</h2>
-<h3>Übersicht</h3>
-<p>Mit Hilfe des Scripters können Sie die mächtige Programmiersprache Python als Scriptsprache in Scribus verwenden, etwa um sich wiederholende Aufgaben zu automatisieren oder neue Funktionen zu hinzuzufügen.</p>
+<h3>Overview</h3>
+<p>This is the description how to use the scripting plug-in for Scribus. The Scripter allows you to use the powerful Python programming language as a scripting language in Scribus. This can help you to automate otherwise repetitive tasks or add new features.</p>
-<p>Beachten Sie, daß der Scripter häufig erweitert wird, so daß die hier verfügbare Dokumentation teilweise unvollständig sein könnte.</p>
+<p>Note that additions to the Scripter are being made frequently, which means that the available documentation may be incomplete.</p>
-<h3>Nutzung des Plug-ins</h3>
-<p>Scribus wird mit einigen »festverdrahteten« Scripten ausgeliefert, die Sie im Menü <i>Script > Scripte für Scribus</i> finden:</p>
+<h3>Using the Plug-in</h3>
+<p>Scribus is being shipped with some “hard-wired” scripts, which are available via <i>Scripter > Scribus Scripts</i>:</p>
<table width="100%"><tr><td align="center"><img src="images/Scripter.png" align="center" alt="Running a script" title="Running a script" /></td></tr></table>
-<p>Ein paar einfache Beispielscripte finden Sie im Unterverzeichnis <code>samples</code>. Wo sich dieses im einzelnen befindet, hängt vom verwendeten Betriebssystem ab, z.B. <code>/usr/local/share/scribus</code> oder <code>/usr/share/scribus</code> unter Linux. Wenn Sie ein Script geschrieben haben, von dem Sie glauben, daß es für andere nützlich sein könnte, zögern Sie nicht, es zum <a href="http://wiki.scribus.net/">Wiki</a> hinzuzufügen oder es an eine der <a href="mailing_lists.html">Mailinglisten</a> zu senden.</p>
+<p>There are some simple example scripts in the subdirectory “samples.” Its location depends on the operating system you use, e.g. <code>/usr/local/share/scribus</code> or <code>/usr/share/scribus</code> on Linux. If you have created a script which you think could be useful for others, please feel free to add it to the <a href="http://wiki.scribus.net/">Scribus Wiki</a> or paste it into an email and send it to the <a href="http://lists.scribus.info/mailman/listinfo/scribus/">Scribus mailing list</a>.</p>
-<p>Um ein externes Python-Script auszuführen, verwenden Sie <i>Script > Script ausführen</i>. Scribus öffnet dann einen Auswahldialog, in dem Sie das Script (Datei-Endung: *.py) auswählen können. <i>Script > Zuletzt verwendete Scripte</i> zeigt eine Liste der zuletzt ausgeführten Scripte an.</p>
+<p>To execute an external Python script, you have to use <i>Script > Execute Script</i>. Scribus will open a file dialog, which allows you to select a Python script (file extension: *.py). <i>Script > Recent Scripts</i> shows a list of recently executed scripts.</p>
-<p>Mit dem Scripter-Plug-in können Sie zahlreiche Python-Module verwenden. Die einzigen Ausnahmen sind solche, die die Eingabe von Parametern auf der Kommandozeile erwarten. Sie werden nicht funktionieren, weil das Plug-in dem Python-Interpreter eine leere Kommandozeile präsentiert.</p>
+<p>You can use many Python modules with this plug-in, the only exception being scripts that expect parameters from the command Line. These won’t work because the plug-in gives the Python interpreter an empty command line.</p>
-<p>Der Menüpunkt <i>Script > Konsole zeigen</i> startet eine interaktive Python-Konsole, in der Sie Befehle direkt ausführen können. Es ist nicht notwendig <code>from scribus import *</code> zu benutzen, weil dies schon automatisch geschehen ist. Sie können alle Befehle, die auf den folgenden Seiten beschrieben sind, ohne Präfix verwenden.</p>
-<br>
+<p>The menu entry <i>Script > Show Console</i> will launch an interactive Python console, where you can execute commands directly. There is no need to use “<code>from scribus import *</code>”, as this has already been done. You can use all the commands listed in the following pages of the Scripter API documentation directly without any prefix.</p>
</body>
</html>
Modified: trunk/Scribus/doc/de/scripterapi-ImageExport.html
URL: http://scribus.net/websvn/diff.php?repname=Scribus&rev=20587&path=/trunk/Scribus/doc/de/scripterapi-ImageExport.html
==============================================================================
--- trunk/Scribus/doc/de/scripterapi-ImageExport.html (original)
+++ trunk/Scribus/doc/de/scripterapi-ImageExport.html Thu Nov 26 20:24:20 2015
@@ -3,6 +3,9 @@
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<title>Python: class ImageExport</title>
</head>
+<style>
+ at import "manual.css";
+</style>
<body>
<h2>Python: class ImageExport</h2>
<p>
Modified: trunk/Scribus/doc/de/scripterapi-PDFfile.html
URL: http://scribus.net/websvn/diff.php?repname=Scribus&rev=20587&path=/trunk/Scribus/doc/de/scripterapi-PDFfile.html
==============================================================================
--- trunk/Scribus/doc/de/scripterapi-PDFfile.html (original)
+++ trunk/Scribus/doc/de/scripterapi-PDFfile.html Thu Nov 26 20:24:20 2015
@@ -3,6 +3,9 @@
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<title>Python: class PDFfile</title>
</head>
+<style>
+ at import "manual.css";
+</style>
<body>
<h2>Python: class PDFfile</h2>
<p><a name="PDFfile">class <strong>PDFfile</strong></a>(<a href="__builtin__.html#object">object</a>)
@@ -11,98 +14,98 @@
<p>Methods defined here:</p>
<dl>
<dt><a name="PDFfile-Save"><strong>Save</strong></a>(...)</dt>
- <dd><code>This method is deprecated - use <a href="#PDFfile-save">save</a>() instead.</code></dd>
+ <dd><p>This method is deprecated - use <a href="#PDFfile-save">save</a>() instead.</p></dd>
<dt><a name="PDFfile-__init__"><strong>__init__</strong></a>(...)</dt>
- <dd><code>x.<a href="#PDFfile-__init__">__init__</a>(...) initializes x; see x.__class__.__doc__ for signature</code></dd>
+ <dd><p>x.<a href="#PDFfile-__init__">__init__</a>(...) initializes x; see x.__class__.__doc__ for signature</p></dd>
<dt><a name="PDFfile-save"><strong>save</strong></a>(...)</dt>
- <dd><code>Save selected pages to pdf file</code></dd>
+ <dd><p>Save selected pages to pdf file</p></dd>
</dl>
<hr>
<p>Data and other attributes defined here:</p>
<dl>
<dt><strong>__new__</strong> = <built-in method __new__ of type object></dt>
- <dd><code>T.<a href="#PDFfile-__new__">__new__</a>(S, ...) -> a new object with type S, a subtype of T</code></dd>
+ <dd><p>T.<a href="#PDFfile-__new__">__new__</a>(S, ...) -> a new object with type S, a subtype of T</p></dd>
<dt><strong>allowAnnots</strong> = <member 'allowAnnots' of 'PDFfile' objects></dt>
- <dd><code>Allow adding annotations and fields. Bool value</code></dd>
+ <dd><p>Allow adding annotations and fields. Bool value</p></dd>
<dt><strong>allowChange</strong> = <member 'allowChange' of 'PDFfile' objects></dt>
- <dd><code>Allow changing the Document. Bool value</code></dd>
+ <dd><p>Allow changing the Document. Bool value</p></dd>
<dt><strong>allowCopy</strong> = <member 'allowCopy' of 'PDFfile' objects></dt>
- <dd><code>Allow copying text and graphics. Bool value</code></dd>
+ <dd><p>Allow copying text and graphics. Bool value</p></dd>
<dt><strong>allowPrinting</strong> = <member 'allowPrinting' of 'PDFfile' objects></dt>
- <dd><code>Allow printing the Document. Bool value</code></dd>
+ <dd><p>Allow printing the Document. Bool value</p></dd>
<dt><strong>article</strong> = <member 'article' of 'PDFfile' objects></dt>
- <dd><code>Save linked text frames as PDF articles<br/> Bool value</code></dd>
+ <dd><p>Save linked text frames as PDF articles<br/> Bool value</p></dd>
<dt><strong>binding</strong> = <member 'binding' of 'PDFfile' objects></dt>
- <dd><code>Choose binding.<br/>
+ <dd><p>Choose binding.<br/>
0 - Left binding<br/>
- 1 - Right binding</code></dd>
+ 1 - Right binding</p></dd>
<dt><strong>bleedMarks</strong> = <attribute 'bleedMarks' of 'PDFfile' objects></dt>
- <dd><code>Create marks delimiting the bleed area.</code></dd>
+ <dd><p>Create marks delimiting the bleed area.</p></dd>
<dt><strong>bleedb</strong> = <member 'bleedb' of 'PDFfile' objects></dt>
- <dd><code>Bleed Bottom<br/>Distance for bleed from the bottom of the physical page</code></dd>
+ <dd><p>Bleed Bottom<br/>Distance for bleed from the bottom of the physical page</p></dd>
<dt><strong>bleedl</strong> = <member 'bleedl' of 'PDFfile' objects></dt>
- <dd><code>Bleed Left<br/>Distance for bleed from the left of the physical page</code></dd>
+ <dd><p>Bleed Left<br/>Distance for bleed from the left of the physical page</p></dd>
<dt><strong>bleedr</strong> = <member 'bleedr' of 'PDFfile' objects></dt>
- <dd><code>Bleed Right<br/>Distance for bleed from the right of the physical page</code></dd>
+ <dd><p>Bleed Right<br/>Distance for bleed from the right of the physical page</p></dd>
<dt><strong>bleedt</strong> = <member 'bleedt' of 'PDFfile' objects></dt>
- <dd><code>Bleed Top<br/>Distance for bleed from the top of the physical page</code></dd>
+ <dd><p>Bleed Top<br/>Distance for bleed from the top of the physical page</p></dd>
<dt><strong>bookmarks</strong> = <member 'bookmarks' of 'PDFfile' objects></dt>
- <dd><code>Embed the bookmarks you created in your document.<br/>These are useful for navigating long PDF documents.<br/>Bool value</code></dd>
+ <dd><p>Embed the bookmarks you created in your document.<br/>These are useful for navigating long PDF documents.<br/>Bool value</p></dd>
<dt><strong>colorMarks</strong> = <member 'colorMarks' of 'PDFfile' objects></dt>
- <dd><code>Add color calibration bars.</code></dd>
+ <dd><p>Add color calibration bars.</p></dd>
<dt><strong>compress</strong> = <member 'compress' of 'PDFfile' objects></dt>
- <dd><code>Compression switch. Bool value.</code></dd>
+ <dd><p>Compression switch. Bool value.</p></dd>
<dt><strong>compressmtd</strong> = <member 'compressmtd' of 'PDFfile' objects></dt>
- <dd><code>Compression method.<br/>
+ <dd><p>Compression method.<br/>
0 - Automatic<br/>
1 - JPEG<br/>
2 - zip<br/>
- 3 - None.</code></dd>
+ 3 - None.</p></dd>
<dt><strong>cropMarks</strong> = <attribute 'cropMarks' of 'PDFfile' objects></dt>
- <dd><code>Create crop marks in the PDF indicating where the paper should be cut or trimmed after printing.</code></dd>
+ <dd><p>Create crop marks in the PDF indicating where the paper should be cut or trimmed after printing.</p></dd>
<dt><strong>displayBookmarks</strong> = <attribute 'displayBookmarks' of 'PDFfile' objects></dt>
- <dd><code>Display the bookmarks upon opening.</code></dd>
+ <dd><p>Display the bookmarks upon opening.</p></dd>
<dt><strong>displayFullscreen</strong> = <attribute 'displayFullscreen' of 'PDFfile' objects></dt>
- <dd><code>Display the document in full screen mode upon opening.</code></dd>
+ <dd><p>Display the document in full screen mode upon opening.</p></dd>
<dt><strong>displayLayers</strong> = <attribute 'displayLayers' of 'PDFfile' objects></dt>
- <dd><code>Display the layer list upon opening. Useful only for PDF 1.5+.</code></dd>
+ <dd><p>Display the layer list upon opening. Useful only for PDF 1.5+.</p></dd>
<dt><strong>displayThumbs</strong> = <attribute 'displayThumbs' of 'PDFfile' objects></dt>
- <dd><code>Display the page thumbnails upon opening.</code></dd>
+ <dd><p>Display the page thumbnails upon opening.</p></dd>
<dt><strong>docInfoMarks</strong> = <member 'docInfoMarks' of 'PDFfile' objects></dt>
- <dd><code>Add document information which includes the document title and page numbers.</code></dd>
+ <dd><p>Add document information which includes the document title and page numbers.</p></dd>
<dt><strong>doClip</strong> = <attribute 'doClip' of 'PDFfile' objects></dt>
- <dd><code>Do not show objects outside the margins in the exported file.</code></dd>
+ <dd><p>Do not show objects outside the margins in the exported file.</p></dd>
<dt><strong>downsample</strong> = <attribute 'downsample' of 'PDFfile' objects></dt>
- <dd><code>Downsample image resolusion to this value. Values from 35 to 4000<br/>Set 0 for not to downsample</code></dd>
+ <dd><p>Downsample image resolusion to this value. Values from 35 to 4000<br/>Set 0 for not to downsample</p></dd>
<dt><strong>effval</strong> = <attribute 'effval' of 'PDFfile' objects></dt>
- <dd><code>List of effection values for each saved page.<br/>
+ <dd><p>List of effection values for each saved page.<br/>
<pre>
It is list of list of six integers. Those int have the following meaning:
- Length of time the page is shown before the presentation
@@ -129,62 +132,63 @@
2 - Bottom to Top
3 - Right to Left
4 - Top-left to Bottom-Right
-</pre></code></dd>
-
+</pre></p></dd>
+</dl>
+<dl>
<dt><strong>embedPDF</strong> = <member 'embedPDF' of 'PDFfile' objects></dt>
-<dd><code>Export PDFs in image frames as embedded PDFs.<br/>
+<dd><p>Export PDFs in image frames as embedded PDFs.<br/>
This does *not* yet take care of colorspaces, so you should know what you are doing before setting this to 'true'.<br/>
-Bool value.</code></dd>
+Bool value.</p></dd>
<dt><strong>encrypt</strong> = <member 'encrypt' of 'PDFfile' objects></dt>
-<dd><code>Use Encription. Bool value</code></dd>
+<dd><p>Use Encription. Bool value</p></dd>
<dt><strong>file</strong> = <attribute 'file' of 'PDFfile' objects></dt>
-<dd><code>Name of file to save into</code></dd>
+<dd><p>Name of file to save into</p></dd>
<dt><strong>fitWindow</strong> = <attribute 'fitWindow' of 'PDFfile' objects></dt>
-<dd><code>Fit the document page or pages to the available space in the viewer window.</code></dd>
+<dd><p>Fit the document page or pages to the available space in the viewer window.</p></dd>
<dt><strong>fontEmbedding</strong> = <attribute 'fontEmbedding' of 'PDFfile' objects></dt>
-<dd><code>Choose the font embedding mode :<br/>
+<dd><p>Choose the font embedding mode :<br/>
0 - Embed fonts fully or as subset depending on 'fonts' attribute<br/>
1 - Outline fonts: fonts will be converted to vector<br/>
-2 - No embedding: no font will be embedded.</code></dd>
+2 - No embedding: no font will be embedded.</p></dd>
<dt><strong>fonts</strong> = <attribute 'fonts' of 'PDFfile' objects></dt>
-<dd><code>List of fonts to embed.</code></dd>
+<dd><p>List of fonts to embed.</p></dd>
<dt><strong>hideMenuBar</strong> = <attribute 'hideMenuBar' of 'PDFfile' objects></dt>
-<dd><code>Hides the viewer menu bar, the PDF will display in a plain window.</code></dd>
+<dd><p>Hides the viewer menu bar, the PDF will display in a plain window.</p></dd>
<dt><strong>hideToolBar</strong> = <attribute 'hideToolBar' of 'PDFfile' objects></dt>
-<dd><code>Hides the viewer toolbar. The toolbar has usually selection and other editing capabilities.</code></dd>
+<dd><p>Hides the viewer toolbar. The toolbar has usually selection and other editing capabilities.</p></dd>
<dt><strong>imagepr</strong> = <attribute 'imagepr' of 'PDFfile' objects></dt>
-<dd><code>Color profile for images</code></dd>
+<dd><p>Color profile for images</p></dd>
<dt><strong>info</strong> = <attribute 'info' of 'PDFfile' objects></dt>
-<dd><code>Mandatory string for PDF/X-3 or the PDF will fail PDF/X-3 conformance. We recommend you use the title of the document.</code></dd>
+<dd><p>Mandatory string for PDF/X-3 or the PDF will fail PDF/X-3 conformance. We recommend you use the title of the document.</p></dd>
<dt><strong>intenti</strong> = <member 'intenti' of 'PDFfile' objects></dt>
-<dd><code>Rendering intent for images<br/>
+<dd><p>Rendering intent for images<br/>
0 - Perceptual<br/>
1 - Relative Colorimetric<br/>
2 - Saturation<br/>
-3 - Absolute Colorimetric</code></dd>
+3 - Absolute Colorimetric</p></dd>
<dt><strong>intents</strong> = <member 'intents' of 'PDFfile' objects></dt>
-<dd><code>Rendering intent for solid colors<br/>
+<dd><p>Rendering intent for solid colors<br/>
0 - Perceptual<br/>
1 - Relative Colorimetric<br/>
2 - Saturation<br/>
-3 - Absolute Colorimetric</code></dd>
+3 - Absolute Colorimetric</p></dd>
<dt><strong>isGrayscale</strong> = <attribute 'isGrayscale' of 'PDFfile' objects></dt>
-<dd><code>Export PDF in grayscale.</code></dd>
+<dd><p>Export PDF in grayscale.</p></dd>
<dt><strong>lpival</strong> = <attribute 'lpival' of 'PDFfile' objects></dt>
-<dd><code>Rendering Settings for individual colors.<br/>
+<dd><p>Rendering Settings for individual colors.<br/>
<pre>
This is list of values for each color.
Color values have structure [siii] which stand for:
@@ -197,92 +201,92 @@
2 - Round
3 - Ellipse
</pre>
-Be careful when supplying these values as they are not checked for validity.</code></dd>
+Be careful when supplying these values as they are not checked for validity.</p></dd>
<dt><strong>markOffset</strong> = <member 'markOffset' of 'PDFfile' objects></dt>
-<dd><code>Indicate the distance offset between mark and page area.</code></dd>
+<dd><p>Indicate the distance offset between mark and page area.</p></dd>
<dt><strong>markLength</strong> = <member 'markLength' of 'PDFfile' objects></dt>
-<dd><code>Indicate the length of crop and bleed marks.</code></dd>
+<dd><p>Indicate the length of crop and bleed marks.</p></dd>
<dt><strong>mirrorH</strong> = <member 'mirrorH' of 'PDFfile' objects></dt>
-<dd><code>Mirror Page(s) horizontally. Bool value.</code></dd>
+<dd><p>Mirror Page(s) horizontally. Bool value.</p></dd>
<dt><strong>mirrorV</strong> = <member 'mirrorV' of 'PDFfile' objects></dt>
-<dd><code>Mirror Page(s) vertically. Bool value.</code></dd>
+<dd><p>Mirror Page(s) vertically. Bool value.</p></dd>
<dt><strong>noembicc</strong> = <member 'noembicc' of 'PDFfile' objects></dt>
-<dd><code>Don't use embedded ICC profiles. Bool value</code></dd>
+<dd><p>Don't use embedded ICC profiles. Bool value</p></dd>
<dt><strong>outdst</strong> = <member 'outdst' of 'PDFfile' objects></dt>
-<dd><code>Output destination.<br/>
+<dd><p>Output destination.<br/>
0 - screen<br/>
-1 - printer</code></dd>
+1 - printer</p></dd>
<dt><strong>owner</strong> = <attribute 'owner' of 'PDFfile' objects></dt>
-<dd><code>Owner's password</code></dd>
+<dd><p>Owner's password</p></dd>
<dt><strong>pageLayout</strong> = <attribute 'pageLayout' of 'PDFfile' objects></dt>
-<dd><code>Document layout in PDF viewer:<br/>
+<dd><p>Document layout in PDF viewer:<br/>
0 - Show the document in single page mode<br/>
1 - Show the document in single page mode with the pages displayed continuously end to end like a scroll<br/>
2 - Show the document with facing pages, starting with the first page displayed on the left<br/>
-3 - Show the document with facing pages, starting with the first page displayed on the right</code></dd>
+3 - Show the document with facing pages, starting with the first page displayed on the right</p></dd>
<dt><strong>pages</strong> = <attribute 'pages' of 'PDFfile' objects></dt>
-<dd><code>List of pages to print</code></dd>
+<dd><p>List of pages to print</p></dd>
<dt><strong>presentation</strong> = <member 'presentation' of 'PDFfile' objects></dt>
-<dd><code>Enable Presentation Effects.Bool value</code></dd>
+<dd><p>Enable Presentation Effects.Bool value</p></dd>
<dt><strong>printprofc</strong> = <attribute 'printprofc' of 'PDFfile' objects></dt>
-<dd><code>Output profile for printing. If possible, get some guidance from your printer on profile selection.</code></dd>
+<dd><p>Output profile for printing. If possible, get some guidance from your printer on profile selection.</p></dd>
<dt><strong>profilei</strong> = <member 'profilei' of 'PDFfile' objects></dt>
-<dd><code>Embed a color profile for images. Bool value.</code></dd>
+<dd><p>Embed a color profile for images. Bool value.</p></dd>
<dt><strong>profiles</strong> = <member 'profiles' of 'PDFfile' objects></dt>
-<dd><code>Embed a color profile for solid colors. Bool value.</code></dd>
+<dd><p>Embed a color profile for solid colors. Bool value.</p></dd>
<dt><strong>quality</strong> = <member 'quality' of 'PDFfile' objects></dt>
-<dd><code>Image quality<br/>
+<dd><p>Image quality<br/>
0 - Maximum<br/>
1 - High<br/>
2 - Medium<br/>
3 - Low<br/>
-4 - Minimum</code></dd>
+4 - Minimum</p></dd>
<dt><strong>registrationMarks</strong> = <attribute 'registrationMarks' of 'PDFfile' objects></dt>
-<dd><code>Add registration marks to each separation.</code></dd>
+<dd><p>Add registration marks to each separation.</p></dd>
<dt><strong>resolution</strong> = <attribute 'resolution' of 'PDFfile' objects></dt>
-<dd><code>Resolution of output file. Values from 35 to 4000.</code></dd>
+<dd><p>Resolution of output file. Values from 35 to 4000.</p></dd>
<dt><strong>solidpr</strong> = <attribute 'solidpr' of 'PDFfile' objects></dt>
-<dd><code>Color profile for solid colors</code></dd>
+<dd><p>Color profile for solid colors</p></dd>
<dt><strong>thumbnails</strong> = <member 'thumbnails' of 'PDFfile' objects></dt>
-<dd><code>Generate thumbnails. Bool value.</code></dd>
+<dd><p>Generate thumbnails. Bool value.</p></dd>
<dt><strong>useDocBleeds</strong> = <attribute 'useDocBleeds' of 'PDFfile' objects></dt>
-<dd><code>Use the existing bleed settings from the document preferences. Bool value.</code></dd>
+<dd><p>Use the existing bleed settings from the document preferences. Bool value.</p></dd>
<dt><strong>useLayers</strong> = <attribute 'useLayers' of 'PDFfile' objects></dt>
-<dd><code>Layers in your document are exported to the PDF. Only available with PDF >= 1.5.</code></dd>
+<dd><p>Layers in your document are exported to the PDF. Only available with PDF >= 1.5.</p></dd>
<dt><strong>uselpi</strong> = <member 'uselpi' of 'PDFfile' objects></dt>
-<dd><code>Use Custom Rendering Settings. Bool value</code></dd>
+<dd><p>Use Custom Rendering Settings. Bool value</p></dd>
<dt><strong>user</strong> = <attribute 'user' of 'PDFfile' objects></dt>
-<dd><code>User's password</code></dd>
+<dd><p>User's password</p></dd>
<dt><strong>version</strong> = <member 'version' of 'PDFfile' objects></dt>
-<dd><code>Choose PDF version to use:<br/>
+<dd><p>Choose PDF version to use:<br/>
11 = PDF/X-1a<br/>
12 = PDF/X-3<br/>
13 = PDF 1.3 (Acrobat 4)<br/>
14 = PDF 1.4 (Acrobat 5)<br/>
-15 = PDF 1.5 (Acrobat 6)</code></dd>
+15 = PDF 1.5 (Acrobat 6)</p></dd>
</dl>
</body>
Modified: trunk/Scribus/doc/de/scripterapi-Printer.html
URL: http://scribus.net/websvn/diff.php?repname=Scribus&rev=20587&path=/trunk/Scribus/doc/de/scripterapi-Printer.html
==============================================================================
--- trunk/Scribus/doc/de/scripterapi-Printer.html (original)
+++ trunk/Scribus/doc/de/scripterapi-Printer.html Thu Nov 26 20:24:20 2015
@@ -3,6 +3,9 @@
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<title>Python: class Printer</title>
</head>
+<style>
+ at import "manual.css";
+</style>
<body>
<h2>Python: class Printer</h2>
<p>
@@ -11,79 +14,80 @@
<hr />
<p>Methods defined here:</p>
+<dl>
<dd>
<dt><a name="Printer-Print"><strong>Print</strong></a>(...)</dt>
- <dd><code>This method is deprecated - use <a href="#Printer-print">print</a>() instead.</code></dd>
+ <dd><p>This method is deprecated - use <a href="#Printer-print">print</a>() instead.</p></dd>
<dt><a name="Printer-__init__"><strong>__init__</strong></a>(...)</dt>
- <dd><code>x.<a href="#Printer-__init__">__init__</a>(...) initializes x; see x.__class__.__doc__ for signature</code></dd>
+ <dd><p>x.<a href="#Printer-__init__">__init__</a>(...) initializes x; see x.__class__.__doc__ for signature</p></dd>
<dt><a name="Printer-print"><strong>print</strong></a>(...)</dt>
- <dd><code>Prints selected pages.</code></dd>
+ <dd><p>Prints selected pages.</p></dd>
<hr>
<p>Data and other attributes defined here:</p>
<dd>
<dt><strong>__new__</strong> = <built-in method __new__ of type object></dt>
- <dd><code>T.<a href="#Printer-__new__">__new__</a>(S, ...) -> a new object with type S, a subtype of T</code></dd>
+ <dd><p>T.<a href="#Printer-__new__">__new__</a>(S, ...) -> a new object with type S, a subtype of T</p></dd>
<dt><strong>allPrinters</strong> = <attribute 'allPrinters' of 'Printer' objects></dt>
- <dd><code>List of installed printers -- read only</code></dd>
+ <dd><p>List of installed printers -- read only</p></dd>
<dt><strong>cmd</strong> = <attribute 'cmd' of 'Printer' objects></dt>
- <dd><code>Alternative Printer Command</code></dd>
+ <dd><p>Alternative Printer Command</p></dd>
<dt><strong>color</strong> = <member 'color' of 'Printer' objects></dt>
- <dd><code>Print in color.<br>
+ <dd><p>Print in color.<br>
True - color -- Default<br>
-False - greyscale</code></dd>
+False - greyscale</p></dd>
<dt><strong>copies</strong> = <member 'copies' of 'Printer' objects></dt>
- <dd><code>Number of copies</code></dd>
+ <dd><p>Number of copies</p></dd>
<dt><strong>file</strong> = <attribute 'file' of 'Printer' objects></dt>
- <dd><code>Name of file to print into</code></dd>
+ <dd><p>Name of file to print into</p></dd>
<dt><strong>mph</strong> = <member 'mph' of 'Printer' objects></dt>
- <dd><code>Mirror Pages Horizontal<br>
+ <dd><p>Mirror Pages Horizontal<br>
True<br>
-False -- Default</code></dd>
+False -- Default</p></dd>
<dt><strong>mpv</strong> = <member 'mpv' of 'Printer' objects></dt>
- <dd><code>Mirror Pages Vertical<br>
+ <dd><p>Mirror Pages Vertical<br>
True<br>
-False -- Default</code></dd>
+False -- Default</p></dd>
<dt><strong>pages</strong> = <attribute 'pages' of 'Printer' objects></dt>
- <dd><code>List of pages to be printed</code></dd>
+ <dd><p>List of pages to be printed</p></dd>
<dt><strong>printer</strong> = <attribute 'printer' of 'Printer' objects></dt>
- <dd><code>Name of printer to use.<br>
-Default is 'File' for printing into file</code></dd>
+ <dd><p>Name of printer to use.<br>
+Default is 'File' for printing into file</p></dd>
<dt><strong>pslevel</strong> = <member 'pslevel' of 'Printer' objects></dt>
- <dd><code>PostScript Level<br>
-Can be 1 or 2 or 3 -- Default is 3.</code></dd>
+ <dd><p>PostScript Level<br>
+Can be 1 or 2 or 3 -- Default is 3.</p></dd>
<dt><strong>separation</strong> = <attribute 'separation' of 'Printer' objects></dt>
- <dd><code>Print separationl<br>
+ <dd><p>Print separationl<br>
'No' -- Default<br>
'All'<br>
'Cyan'<br>
'Magenta'<br>
'Yellow'<br>
'Black'<br>
-Beware of misspelling because a check is not performed</code></dd>
+Beware of misspelling because a check is not performed</p></dd>
<dt><strong>ucr</strong> = <member 'ucr' of 'Printer' objects></dt>
- <dd><code>Apply Under Color Removal<br>
+ <dd><p>Apply Under Color Removal<br>
True -- Default<br>
-False</code></dd>
+False</p></dd>
<dt><strong>useICC</strong> = <member 'useICC' of 'Printer' objects></dt>
- <dd><code>Use ICC Profile<br>
+ <dd><p>Use ICC Profile<br>
True<br>
-False -- Default</code></dd>
-
+False -- Default</p></dd>
+</dl>
</body>
-</html>
+</html>
Modified: trunk/Scribus/doc/de/scripterapi-color.html
URL: http://scribus.net/websvn/diff.php?repname=Scribus&rev=20587&path=/trunk/Scribus/doc/de/scripterapi-color.html
==============================================================================
--- trunk/Scribus/doc/de/scripterapi-color.html (original)
+++ trunk/Scribus/doc/de/scripterapi-color.html Thu Nov 26 20:24:20 2015
@@ -3,45 +3,84 @@
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<title>Color related Commands</title>
</head>
+<style>
+ at import "manual.css";
+</style>
<body>
<h2>Color related Commands</h2>
<dl>
<dt><a name="-changeColor"><strong>changeColor</strong></a>(...)</dt>
-<dd><code><a href="#-changeColor">changeColor</a>("name", c, m, y, k)</code>
+<dd><code>changeColor("name", c, m, y, k)</code>
+<p>Changes the color "name" to the specified CMYK value. The color value is defined via four components c = Cyan, m = Magenta, y = Yellow and k = Black. Color components should be in the range from 0 to 255.</p>
+<p>Note : deprecated, use changeColorCMYK() instead</p>
+<p>May raise <a href="scripterapi.html#NotFoundError">NotFoundError</a> if the named color wasn't found. May raise ValueError if an invalid color name is specified.</p></dd>
+
+<dt><a name="-changeColorRGB"><strong>changeColorRGB</strong></a>(...)</dt>
+<dd><code>changeColorRGB("name", r, g, b)</code>
+<p>Changes the color "name" to the specified RGB value. The color value is defined via three components r = red, g = green, b = blue. Color components should be in the range from 0 to 255.</p>
+<p>May raise <a href="scripterapi.html#NotFoundError">NotFoundError</a> if the named color wasn't found. May raise ValueError if an invalid color name is specified.</p></dd>
+
+<dt><a name="-changeColorCMYK"><strong>changeColorCMYK</strong></a>(...)</dt>
+<dd><code>changeColorCMYK("name", c, m, y, k)</code>
<p>Changes the color "name" to the specified CMYK value. The color value is defined via four components c = Cyan, m = Magenta, y = Yellow and k = Black. Color components should be in the range from 0 to 255.</p>
<p>May raise <a href="scripterapi.html#NotFoundError">NotFoundError</a> if the named color wasn't found. May raise ValueError if an invalid color name is specified.</p></dd>
<dt><a name="-defineColor"><strong>defineColor</strong></a>(...)</dt>
-<dd><code><a href="#-defineColor">defineColor</a>("name", c, m, y, k)</code>
-<p>Defines a new color "name". The color Value is defined via four components: c = Cyan, m = Magenta, y = Yellow and k = Black. Color components should be in the range from 0 to 255.</p>
+<dd><code>defineColor("name", c, m, y, k)</code>
+<p>Defines a new color "name". The color Value is defined via three components: c = Cyan, m = Magenta, y = Yellow and k = Black. Color components should be in the range from 0 to 255.</p>
+<p>Note : deprecated, use defineColorCMYK() instead.</p>
+<p>May raise ValueError if an invalid color name is specified.</p></dd>
+
+<dt><a name="-defineColorRGB"><strong>defineColorRGB</strong></a>(...)</dt>
+<dd><code>defineColorRGB("name", r, g, b)</code>
+<p>Defines a new color "name". The color Value is defined via three components: r = red, g = green, b = blue. Color components should be in the range from 0 to 255.</p>
+<p>May raise ValueError if an invalid color name is specified.</p></dd>
+
+<dt><a name="-defineColorCMYK"><strong>defineColorCMYK</strong></a>(...)</dt>
+<dd><code>defineColorCMYK("name", c, m, y, k)</code>
+<p>Defines a new color "name". The color Value is defined via three components: c = Cyan, m = Magenta, y = Yellow and k = Black. Color components should be in the range from 0 to 255.</p>
<p>May raise ValueError if an invalid color name is specified.</p></dd>
<dt><a name="-deleteColor"><strong>deleteColor</strong></a>(...)</dt>
-<dd><code><a href="#-deleteColor">deleteColor</a>("name", "replace")</code>
+<dd><code>deleteColor("name", "replace")</code>
<p>Deletes the color "name". Every occurence of that color is replaced by the color "replace". If not specified, "replace" defaults to the color "None" - transparent.</p>
<p>deleteColor works on the default document colors if there is no document open. In that case, "replace", if specified, has no effect.</p>
<p>May raise <a href="scripterapi.html#NotFoundError">NotFoundError</a> if a named color wasn't found. May raise ValueError if an invalid color name is specified.</p></dd>
<dt><a name="-getColor"><strong>getColor</strong></a>(...)</dt>
-<dd><code><a href="#-getColor">getColor</a>("name") -> tuple</code>
+<dd><code>getColor("name") -> tuple</code>
<p>Returns a tuple (C, M, Y, K) containing the four color components of the color "name" from the current document. If no document is open, returns the value of the named color from the default document colors.</p>
<p>May raise <a href="scripterapi.html#NotFoundError">NotFoundError</a> if the named color wasn't found. May raise ValueError if an invalid color name is specified.</p></dd>
-<dt><a name="-getColorAsRGB"><strong>getColorAsRGB</strong></a>(...)</dt>
-<dd><code><a href="#-getColorAsRGB">getColorAsRGB</a>("name") -> tuple</code>
-<p>Returns a tuple (R,G,B) containing the three color components of the color "name" from the current document, converted to the RGB colour space. If no document is open, returns the value of the named color from the default document colors.</p>
+<dt><a name="-getColorAsRGB"><strong>getColorAsRGB</strong>(...)</a></dt>
+<dd><code>getColorAsRGB("name") -> tuple</code>
+<p>Returns a tuple (R,G,B) containing the three color components of the color "name" from the current document, converted to the RGB color space. If no document is open, returns the value of the named color from the default document colors.</p>
<p>May raise NotFoundError if the named color wasn't found. May raise ValueError if an invalid color name is specified.</p></dd>
<dt><a name="-getColorNames"><strong>getColorNames</strong></a>(...)</dt>
-<dd><code><a href="#-getColorNames">getColorNames</a>() -> list</code>
+<dd><code>getColorNames() -> list</code>
<p>Returns a list containing the names of all defined colors in the document. If no document is open, returns a list of the default document colors.</p></dd>
+<dt><a name="-isSpotColor"><strong>isSpotColor</strong></a>(...)</dt>
+<dd><code>isSpotColor("name") -> bool</code>
+<p>Returns True if the color "name" is a spot color.</p>
+<p>See also setSpotColor()</p>
+<p>May raise NotFoundError if a named color wasn't found.</p>
+<p>May raise ValueError if an invalid color name is specified.</p></dd>
+
<dt><a name="-replaceColor"><strong>replaceColor</strong></a>(...)</dt>
-<dd><code><a href="#-replaceColor">replaceColor</a>("name", "replace")</code>
+<dd><code>replaceColor("name", "replace")</code>
<p>Every occurence of the color "name" is replaced by the color "replace".</p>
<p>May raise <a href="scripterapi.html#NotFoundError">NotFoundError</a> if a named color wasn't found. May raise ValueError if an invalid color name is specified.</p></dd>
+
+<dt><a name="-setSpotColor"><strong>setSpotColor</strong></a>(...)</dt>
+<dd><code>setSpotColor("name", spot)</code>
+<p>Set the color "name" as a spot color if spot parameter is True.</p>
+<p>See also isSpotColor().</p>
+<p>May raise NotFoundError if a named color wasn't found.</p>
+<p>May raise ValueError if an invalid color name is specified.</p></dd>
</dl>
Modified: trunk/Scribus/doc/de/scripterapi-constants.html
URL: http://scribus.net/websvn/diff.php?repname=Scribus&rev=20587&path=/trunk/Scribus/doc/de/scripterapi-constants.html
==============================================================================
--- trunk/Scribus/doc/de/scripterapi-constants.html (original)
+++ trunk/Scribus/doc/de/scripterapi-constants.html Thu Nov 26 20:24:20 2015
@@ -3,15 +3,18 @@
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<title>Predefined Constants</title>
</head>
+<style>
+ at import "manual.css";
+</style>
<body>
<h2>Predefined Constants</h2>
<p>There are some Constants defined to help using the Commands: </p>
<h4>Scribus Version:</h4>
- <p>The script interface provides two variables containing the current Scribus version in the <code>scribus</code> module. Scripts can use these variables to check that they're running under the version of Scribus they expect, and to report information about incompatibilities to the user. These two variables, <code>scribus_version</code> and <code>scribus_version_info</code>, were added in 1.2.1 and 1.3.0cvs and will not be present in earlier versions. If you need to, you can check for their presence with <code>hasattr(scribus, 'scribus_version')</code>.</p>
- <p><code>scribus_version</code> contains the current Scribus version as a string. It will usually look like <code>'1.2.1cvs'</code> or <code>'1.3.0'</code>, for example, but is not guaranteed to always follow that format. This variable is useful when you need to display the version to the user, for example when reporting an incompatibility. Do not parse or compare this variable, that is what <code>scribus_version_info</code> is for.</p>
- <p><code>scribus_version_info</code> is a tuple similar to the <code>sys.version_info</code> tuple provided by Python. It is a tuple of the form (majorversion, minorversion, patchlevel, extraversion, build) for example, 1.2.1cvs will have <code>(1,2,1,'cvs',0)</code> and 1.3.2 will have <code>(1,3,2,'',0)<code> . These tuples are ideal for checking for minimum versions, etc, because Python compares tuples element-by-element, left-to-right. For example:</p>
+ <p>The script interface provides two variables containing the current Scribus version in the <code>scribus</code> module. Scripts can use these variables to check that they're running under the version of Scribus they expect, and to report information about incompatibilities to the user. These two variables, <code>scribus_version</code> and <code>scribus_version_info</code>, were added in 1.2.1 and 1.3.0svn and will not be present in earlier versions. If you need to, you can check for their presence with <code>hasattr(scribus, 'scribus_version')</code>.</p>
+ <p><code>scribus_version</code> contains the current Scribus version as a string. It will usually look like <code>'1.2.1svn'</code> or <code>'1.3.0'</code>, for example, but is not guaranteed to always follow that format. This variable is useful when you need to display the version to the user, for example when reporting an incompatibility. Do not parse or compare this variable, that is what <code>scribus_version_info</code> is for.</p>
+ <p><code>scribus_version_info</code> is a tuple similar to the <code>sys.version_info</code> tuple provided by Python. It is a tuple of the form (majorversion, minorversion, patchlevel, extraversion, build) for example, 1.2.1svn will have <code>(1,2,1,'svn',0)</code> and 1.3.2 will have <code>(1,3,2,'',0)<code> . These tuples are ideal for checking for minimum versions, etc, because Python compares tuples element-by-element, left-to-right. For example:</p>
<pre>
if scribus.scribus_version_info[:3] < (1,2,2):
messageBox("Scribus - Python script",
@@ -21,7 +24,7 @@
sys.exit()
</pre>
-<h4>Unit Definitions: </h4>
+<h4>Unit Enumeration Constants: </h4>
<dl>
<dt>UNIT_POINTS</dt>
<dd>Measurement Unit Point = 0</dd>
@@ -31,6 +34,28 @@
<dd>Measurement Unit Inch = 2</dd>
<dt>UNIT_PICAS</dt>
<dd>Measurement Unit Pica = 3</dd>
+</dl>
+
+<h4>Unit Conversion Constants</h4>
+
+<p>These conversion factors can be used to convert units to and from points.
+Thus, to convert inches to points, you can simply write 'value/inch', to
+convert points to inches you write 'value*inch', and to convert inches to mm
+you write 'value*mm/inch' .</p>
+
+<dl>
+ <dt>pt</dt>
+ <dd>points in 1 pt</dd>
+ <dt>inch</dt>
+ <dd>inches in 1 pt</dt>
+ <dt>p</dt>
+ <dt>pica in 1 pt</dt>
+ <dt>cm<dt>
+ <dt>centimetres in 1 pt</dt>
+ <dt>mm</dt>
+ <dt>millimetres in 1 pt</dt>
+ <dt>...</dt>
+ <dt>Other constants will be provided if the Scribus core knows about them.</dt>
</dl>
<h4>Page Orientation Definitions: </h4>
Modified: trunk/Scribus/doc/de/scripterapi-dialogs.html
URL: http://scribus.net/websvn/diff.php?repname=Scribus&rev=20587&path=/trunk/Scribus/doc/de/scripterapi-dialogs.html
==============================================================================
--- trunk/Scribus/doc/de/scripterapi-dialogs.html (original)
+++ trunk/Scribus/doc/de/scripterapi-dialogs.html Thu Nov 26 20:24:20 2015
@@ -3,37 +3,44 @@
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<title>Using Dialogs from Scribus</title>
</head>
+<style>
+ at import "manual.css";
+</style>
<body>
<h2>Using Dialogs from Scribus</h2>
<dl>
<dt><a name="-fileDialog"><strong>fileDialog</strong></a>(...)</dt>
-<dd><code><a href="#-fileDialog">fileDialog</a>("caption", ["filter", "defaultname",haspreview, issave])<br> -> string with filename</code>
-<p>Shows a File Open dialog box with the caption "caption". Files are filtered with the filter string "filter". A default filename or file path can also supplied, leave this string empty when you don't want to use it. A value of True for haspreview enables a small preview widget in the FileSelect box. When the issave parameter is set to True the dialog acts like a "Save As" dialog otherwise it acts like a "File Open Dialog". The default for both of the opional parameters is False.<p>
+<dd><code>fileDialog("caption", ["filter", "defaultname", haspreview, issave, isdir])<br> -> string with filename</code>
+<p>Shows a File Open dialog box with the caption "caption". Files are filtered with the filter string "filter". A default filename or file path can also supplied, leave this string empty when you don't want to use it. A value of True for haspreview enables a small preview widget in the FileSelect box. When the issave parameter is set to True the dialog acts like a "Save As" dialog otherwise it acts like a "File Open Dialog". When the isdir parameter is True the dialog shows and returns only directories. The default for all of the opional parameters is False.<p>
<p>The filter, if specified, takes the form 'comment (*.type *.type2 ...)'. For example 'Images (*.png *.xpm *.jpg)'.</p>
<p>Refer to the Qt-Documentation for QFileDialog for details on filters.</p>
<p>Example: <a href="#-fileDialog">fileDialog</a>('Open input', 'CSV files (*.csv)')<br>
Example: <a href="#-fileDialog">fileDialog</a>('Save report', defaultname='report.txt', issave=True)</p></dd>
-
+
+<dt><a name="-fileQuit"><strong>fileQuit</strong></a>(...)</dt>
+<dd><code>fileQuit()</code>
+<p>Quit Scribus.</p></dd>
+
<dt><a name="-getGuiLanguage"><strong>getGuiLanguage</strong></a>(...)</dt>
-<dd><code><a href="#-getGuiLanguage">getGuiLanguage</a>() -> string</code>
+<dd><code>getGuiLanguage() -> string</code>
<p>Returns a string with the -lang value.</p></dd>
-
+
<dt><a name="-messagebarText"><strong>messagebarText</strong></a>(...)</dt>
-<dd><code><a href="#-messagebarText">messagebarText</a>("string")</code>
+<dd><code>messagebarText("string")</code>
<p>Writes the "string" into the Scribus message bar (status line). The text must be UTF8 encoded or 'unicode' string(recommended).</p></dd>
-
+
<dt><a name="-messageBox"><strong>messageBox</strong></a>(...)</dt>
-<dd><code><a href="#-messageBox">messageBox</a>("caption", "message",
- icon=ICON_NONE, bucodeon1=BUTTON_OK|BUTTONOPT_DEFAULT,
- bucodeon2=BUTTON_NONE, bucodeon3=BUTTON_NONE) -> integer</code>
-<p>Displays a message box with the title "caption", the message "message", and an icon "icon" and up to 3 bucodeons. By default no icon is used and a single bucodeon, OK, is displayed. Only the caption and message arguments are required, though secodeing an icon and appropriate bucodeon(s) is strongly recommended. The message text may contain simple HTML-like markup.</p>
-<p>Returns the number of the bucodeon the user pressed. Bucodeon numbers start at 1.</p>
-<p>For the icon and the bucodeon parameters there are predefined constants available with the same names as in the Qt Documentation. These are the BUTTON_* and ICON_* constants defined in the module. There are also two extra constants that can be binary-ORed with bucodeon constants:</p>
+<dd><code>messageBox("caption", "message",
+icon=ICON_NONE, button1=BUTTON_OK|BUTTONOPT_DEFAULT,
+button2=BUTTON_NONE, button3=BUTTON_NONE) -> integer</code>
+<p>Displays a message box with the title "caption", the message "message", and an icon "icon" and up to 3 buttons. By default no icon is used and a single button, OK, is displayed. Only the caption and message arguments are required, though setting an icon and appropriate button(s) is strongly recommended. The message text may contain simple HTML-like markup.</p>
+<p>Returns the number of the button the user pressed. Button numbers start at 1.</p>
+<p>For the icon and the button parameters there are predefined constants available with the same names as in the Qt Documentation. These are the BUTTON_* and ICON_* constants defined in the module. There are also two extra constants that can be binary-ORed with button constants:</p>
<ul>
- <li>BUTTONOPT_DEFAULT - Pressing enter presses this bucodeon.</li>
- <li>BUTTONOPT_ESCAPE - Pressing escape presses this bucodeon.</li>
+<li>BUTTONOPT_DEFAULT Pressing enter presses this button.</li>
+<li>BUTTONOPT_ESCAPE Pressing escape presses this button.</li>
</ul>
<p>Usage examples:</p>
<pre>
@@ -44,30 +51,34 @@
ICON_WARNING, BUTTON_YES|BUTTONOPT_DEFAULT,
BUTTON_NO, BUTTON_IGNORE|BUTTONOPT_ESCAPE)
</pre>
-<p>Defined bucodeon and icon constants: BUTTON_NONE, BUTTON_ABORT, BUTTON_CANCEL, BUTTON_IGNORE, BUTTON_NO, BUTTON_NOALL, BUTTON_OK, BUTTON_RETRY, BUTTON_YES, BUTTON_YESALL, ICON_NONE, ICON_INFORMATION, ICON_WARNING, ICON_CRITICAL.</p></dd>
-
+<p>Defined button and icon constants: BUTTON_NONE, BUTTON_ABORT, BUTTON_CANCEL, BUTTON_IGNORE, BUTTON_NO, BUTTON_NOALL, BUTTON_OK, BUTTON_RETRY, BUTTON_YES, BUTTON_YESALL, ICON_NONE, ICON_INFORMATION, ICON_WARNING, ICON_CRITICAL.</p></dd>
+
<dt><a name="-newDocDialog"><strong>newDocDialog</strong></a>(...)</dt>
-<dd><code><a href="#-newDocDialog">newDocDialog</a>() -> bool</code>
+<dd><code>newDocDialog() -> bool</code>
<p>Displays the "New Document" dialog box. Creates a new document if the user accepts the settings. Does not create a document if the user presses cancel. Returns true if a new document was created.</p></dd>
-
+
+<dt><a name="-newStyleDialog"><strong>newStyleDialog</strong>(...)</a></dt>
+<dd><code>newStyleDialog() -> string</code>
+<p>Shows 'Create new paragraph style' dialog. Function returns real style name or None when user cancels the dialog.</p></dd>
+
<dt><a name="-statusMessage"><strong>statusMessage</strong></a>(...)</dt>
-<dd><code><a href="#-messagebarText">messagebarText</a>("string")</code>
+<dd><code>messagebarText("string")</code>
<p>Writes the "string" into the Scribus message bar (status line). The text must be UTF8 encoded or 'unicode' string(recommended).</p></dd>
-
+
<dt><a name="-progressReset"><strong>progressReset</strong></a>(...)</dt>
-<dd><code><a href="#-progressReset">progressReset</a>()</code>
-<p>Cleans up the Scribus progress bar previous secodeings. It is called before the new progress bar use. See progressSet.</p></dd>
+<dd><code>progressReset()</code>
+<p>Cleans up the Scribus progress bar previous settings. It is called before the new progress bar use. See progressSet.</p></dd>
<dt><a name="-progressSet"><strong>progressSet</strong></a>(...)</dt>
-<dd><code><a href="#-progressSet">progressSet</a>(nr)</code>
+<dd><code>progressSet(nr)</code>
<p>Set the progress bar position to "nr", a value relative to the previously set progressTotal. The progress bar uses the concept of steps; you give it the total number of steps and the number of steps completed so far and it will display the percentage of steps that have been completed. You can specify the total number of steps with <a href="#-progressTotal">progressTotal</a>(). The current number of steps is set with <a href="#-progressSet">progressSet</a>(). The progress bar can be rewound to the beginning with <a href="#-progressReset">progressReset</a>(). [based on info taken from Trolltech's Qt docs]</p></dd>
<dt><a name="-progressTotal"><strong>progressTotal</strong></a>(...)</dt>
-<dd><code><a href="#-progressTotal">progressTotal</a>(max)</code>
+<dd><code>progressTotal(max)</code>
<p>Sets the progress bar's maximum steps value to the specified number. See progressSet.</p></dd>
<dt><a name="-valueDialog"><strong>valueDialog</strong></a>(...)</dt>
-<dd><code><a href="#-valueDialog">valueDialog</a>(caption, message [,defaultvalue]) -> string</code>
+<dd><code>valueDialog(caption, message [,defaultvalue]) -> string</code>
<p>Shows the common 'Ask for string' dialog and returns its value as a string Parameters: window title, text in the window and optional 'default' value.</p>
<p>Example: <a href="#-valueDialog">valueDialog</a>('title', 'text in the window', 'optional')</p></dd>
Modified: trunk/Scribus/doc/de/scripterapi-doc.html
URL: http://scribus.net/websvn/diff.php?repname=Scribus&rev=20587&path=/trunk/Scribus/doc/de/scripterapi-doc.html
==============================================================================
--- trunk/Scribus/doc/de/scripterapi-doc.html (original)
+++ trunk/Scribus/doc/de/scripterapi-doc.html Thu Nov 26 20:24:20 2015
@@ -3,36 +3,54 @@
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<title>Document related Commands</title>
</head>
+<style>
+ at import "manual.css";
+</style>
<body>
<h2>Document related Commands</h2>
<dl>
<dt><a name="-closeDoc"><strong>closeDoc</strong></a>(...)</dt>
-<dd><code><a href="#-closeDoc">closeDoc</a>()</code>
+<dd><code>closeDoc()</code>
<p>Closes the current document without prompting to save.</p>
<p>May throw <a href="#NoDocOpenError">NoDocOpenError</a> if there is no document to close</p></dd>
<dt><a name="-docChanged"><strong>docChanged</strong></a>(...)</dt>
-<dd><code><a href="#-docChanged">docChanged</a>(bool)</code>
+<dd><code>docChanged(bool)</code>
<p>Enable/disable save icon in the Scribus icon bar and the Save menu item. It's
useful to call this procedure when you're changing the document, because Scribus
won't automatically notice when you change the document using a script.</p></dd>
+<dt><a name="-getDocName"><strong>getDocName</strong>(...)</dt>
+<dd><code>getDocName() -> string</code>
+<p>Returns the name of current file</p>
+</dd>
+</dt>
+
<dt><a name="-getUnit"><strong>getUnit</strong></a>(...)</dt>
-<dd><code><a href="#-getUnit">getUnit</a>() -> integer (Scribus unit constant)</code>
+<dd><code>getUnit() -> integer (Scribus unit constant)</code>
<p>Returns the measurement units of the document. The returned value will be one of the UNIT_* constants: UNIT_INCHES, UNIT_MILLIMETERS, UNIT_PICAS, UNIT_POINTS.</p></dd>
-
+
<dt><a name="-haveDoc"><strong>haveDoc</strong></a>(...)</dt>
-<dd><code><a href="#-haveDoc">haveDoc</a>() -> bool</code>
+<dd><code>haveDoc() -> bool</code>
<p>Returns true if there is a document open.</p></dd>
+<!--<dt><a name="-importSVG"><strong>importSVG</strong>(...)</a></dt>
+<dd><code>importSVG("string")</code>
+<p>The "string" must be a valid filename for a SVG image. The text must be UTF8 encoded or 'unicode' string(recommended).</p></dd> -->
+
<dt><a name="-loadStylesFromFile"><strong>loadStylesFromFile</strong></a>(...)</dt>
-<dd><code><a href="#-loadStylesFromFile">loadStylesFromFile</a>("filename")</code>
+<dd><code>loadStylesFromFile("filename")</code>
<p>Loads paragraph styles from the Scribus document at "filename" into the current document.</p></dd>
-
+
+<dt><a name="-masterPageNames"><strong>masterPageNames</strong>(...)</a></dt>
+<dd><code>masterPageNames()</code>
+<p>Returns a list of the names of all master pages in the document.</p></dd>
+
<dt><a name="-newDoc"><strong>newDoc</strong></a>(...)</dt>
-<dd><code><a href="#-newDoc">newDoc</a>(size, margins, orientation, firstPageNumber, unit, facingPages, firstSideLeft) -> bool</code>
+<dd><code>newDoc(size, margins, orientation, firstPageNumber, unit, facingPages, firstSideLeft) -> bool</code>
+<p>WARNING: Obsolete procedure! Use <a href="#-newDocument">newDocument</a> instead.</p>
<p>Creates a new document and returns true if successful. The parameters have the
following meaning:</p>
<ul>
@@ -47,37 +65,110 @@
<p>The values for width, height and the margins are expressed in the given unit for the document. PAPER_* constants are expressed in points. If your document is not in points, make sure to account for this.</p>
<p>example: <a href="#-newDoc">newDoc</a>(PAPER_A4, (10, 10, 20, 20), LANDSCAPE, 1, UNIT_POINTS, FACINGPAGES, FIRSTPAGERIGHT)</p></dd>
+<dt><a name="-newDocument"><strong>newDocument</strong>(...)</a></dt>
+<dd><code>newDocument(size, margins, orientation, firstPageNumber,
+ unit, pagesType, firstPageOrder, numPages) -> bool</code>
+<p>Creates a new document and returns true if successful. The parameters have the
+following meaning:
+<ul>
+<li>size = A tuple (width, height) describing the size of the document. You can
+use predefined constants named PAPER_<paper_type> e.g. PAPER_A4 etc.</li>
+<li>margins = A tuple (left, right, top, bottom) describing the document
+margins</li>
+<li>orientation = the page orientation - constants PORTRAIT, LANDSCAPE</li>
+<li>firstPageNumer = is the number of the first page in the document used for
+pagenumbering. While you'll usually want 1, it's useful to have higher
+numbers if you're creating a document in several parts.</li>
+<li>unit: this value sets the measurement units used by the document. Use a
+predefined constant for this, one of: UNIT_INCHES, UNIT_MILLIMETERS,
+UNIT_PICAS, UNIT_POINTS.</li>
+<li>pagesType = One of the predefined constants PAGE_n. PAGE_1 is single page,
+PAGE_2 is for double sided documents, PAGE_3 is for 3 pages fold and
+PAGE_4 is 4-fold.</li>
+<li>firstPageOrder = What is position of first page in the document.
+Indexed from 0 (0 = first).</li>
+<li>numPage = Number of pages to be created.</li>
+</ul>
+<p>The values for width, height and the margins are expressed in the given unit
+for the document. PAPER_* constants are expressed in points. If your document
+is not in points, make sure to account for this.</p>
+<p>example: newDocument(PAPER_A4, (10, 10, 20, 20), LANDSCAPE, 7, UNIT_POINTS,
+PAGE_4, 3, 1)</p>
+<p>May raise ScribusError if is firstPageOrder bigger than allowed by pagesType.</p>
+</dd>
+
<dt><a name="-openDoc"><strong>openDoc</strong></a>(...)</dt>
-<dd><code><a href="#-openDoc">openDoc</a>("name")</code>
+<dd><code>openDoc("name")</code>
<p>Opens the document "name".</p>
<p>May raise ScribusError if the document could not be opened.</p></dd>
-
+
+<dt><a name="-placeEPS"><strong>placeEPS</strong>(...)</a></dt>
+<dd><code></code>
+<p>placeEPS("filename", x, y) Places the EPS "filename" onto the current
+page, x and y specify the coordinate of the topleft corner of the EPS
+placed on the page If loading was successful, the selection contains
+the imported EPS</p></dd>
+
+<dt><a name="-placeODG"><strong>placeODG</strong>(...)</a></dt>
+<dd><code></code>
+<p>placeODG("filename", x, y) Places the ODG "filename" onto the current
+page, x and y specify the coordinate of the topleft corner of the ODG
+placed on the page If loading was successful, the selection contains
+the imported ODG</p></dd>
+
+<dt><a name="-placeSVG"><strong>placeSVG</strong>(...)</a></dt>
+<dd><code></code>
+<p>placeSVG("filename", x, y) Places the SVG "filename" onto the current
+page, x and y specify the coordinate of the topleft corner of the SVG
+placed on the page If loading was successful, the selection contains
+the imported SVG</p></dd>
+
+<dt><a name="-placeSXD"><strong>placeSXD</strong>(...)</a></dt>
+<dd><code></code>
+<p>placeSXD("filename", x, y) Places the SXD "filename" onto the current
+page, x and y specify the coordinate of the topleft corner of the SXD
+placed on the page If loading was successful, the selection contains
+the imported SXD</p></dd>
+
<dt><a name="-saveDoc"><strong>saveDoc</strong></a>(...)</dt>
-<dd><code><a href="#-saveDoc">saveDoc</a>()</code>
+<dd><code>saveDoc()</code>
<p>Saves the current document with its current name, returns true if successful. If the document has not already been saved, this may bring up an interactive save file dialog. If the save fails, there is currently no way to tell.</p></dd>
<dt><a name="-saveDocAs"><strong>saveDocAs</strong></a>(...)</dt>
-<dd><code><a href="#-saveDocAs">saveDocAs</a>("name")</code>
+<dd><code>saveDocAs("name")</code>
<p>Saves the current document under the new name "name" (which may be a full or
relative path).</p>
<p>May raise ScribusError if the save fails.</p></dd>
<dt><a name="-setInfo"><strong>setInfo</strong></a>(...)</dt>
-<dd><code><a href="#-saveDocAs">saveDocAs</a>("author", "info", "description") -> bool</code>
+<dd><code>setInfo("author", "info", "description") -> bool</code>
<p>Sets the document information. "Author", "Info", "Description" are strings.</p></dd>
-
+
<dt><a name="-setMargins"><strong>setMargins</strong></a>(...)</dt>
-<dd><code><a href="#-setMargins">setMargins</a>(lr, rr, tr, br)</code>
+<dd><code>setMargins(lr, rr, tr, br)</code>
<p>Sets the margins of the document, Left(lr), Right(rr), Top(tr) and Bottom(br) margins are given in the measurement units of the document - see UNIT_<type> constants.</p></dd>
<dt><a name="-setDocType"><strong>setDocType</strong></a>(...)</dt>
-<dd><code><a href="#-setDocType">setDocType</a>(facingPages, firstPageLeft)</code>
+<dd><code>setDocType(facingPages, firstPageLeft)</code>
<p>Sets the document type. To get facing pages set the first parameter to FACINGPAGES, to switch facingPages off use NOFACINGPAGES instead. If you want to be the first page a left side set the second parameter to FIRSTPAGELEFT, for a right page use FIRSTPAGERIGHT.</p></dd>
-
+
<dt><a name="-setUnit"><strong>setUnit</strong></a>(...)</dt>
-<dd><code><a href="#-setUnit">setUnit</a>(type)</code>
+<dd><code>setUnit(type)</code>
<p>Changes the measurement unit of the document. Possible values for "unit" are defined as constants UNIT_<type>.</p>
<p>May raise ValueError if an invalid unit is passed.</p></dd>
+
+<dt><a name="-setBaseLine"><strong>setBaseLine</strong></a>(...)</dt>
+<dd><code>setBaseLine(grid, offset)</code>
+<p>Sets the base line settings of the document, grid spacing(grid), grid offset(offset). Values are given in the measurement units of the document - see UNIT_<type> constants.</p></dd>
+
+<dt><a name="-scrollDocument"><strong>scrollDocument</strong>(...)</a></dt>
+<dd><code>scrollDocument(x,y)</code>
+<p>Scroll the document in main GUI window by x and y.</p></dd>
+
+<dt><a name="-zoomDocument"><strong>zoomDocument</strong>(...)</a></dt>
+<dd><code>zoomDocument(double)</code>
+<p>Zoom the document in main GUI window. Actions have whole number
+values like 20.0, 100.0, etc. Zoom to Fit uses -100 as a marker.</p></dd>
</dl>
</body>
Modified: trunk/Scribus/doc/de/scripterapi-font.html
URL: http://scribus.net/websvn/diff.php?repname=Scribus&rev=20587&path=/trunk/Scribus/doc/de/scripterapi-font.html
==============================================================================
--- trunk/Scribus/doc/de/scripterapi-font.html (original)
+++ trunk/Scribus/doc/de/scripterapi-font.html Thu Nov 26 20:24:20 2015
@@ -3,23 +3,28 @@
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<title>Font Related Commands</title>
</head>
+<style>
+ at import "manual.css";
+</style>
<body>
<h2>Font Related Commands</h2>
<dl>
<dt><a name="-getFontNames"><strong>getFontNames</strong></a>(...)</dt>
-<dd><code><a href="#-getFontNames">getFontNames</a>() -> list</code>
+<dd><code>getFontNames() -> list</code>
<p>Returns a list with the names of all available fonts.</p></dd>
<dt><a name="-getXFontNames"><strong>getXFontNames</strong></a>(...)</dt>
-<dd><code><a href="#-getXFontNames">getXFontNames</a>() -> list of tuples</code>
-<p>Returns a larger font info. It's a list of the tuples with: [ (Scribus name, Family, Real name, subset (1|0), embed PS (1|0), font file), (...), ... ]</p></dd></dl>
+<dd><code>getXFontNames() -> list of tuples</code>
+<p>Returns a larger font info. It's a list of the tuples with: [ (Scribus name,
+Family, Real name, subset (1|0), embed PS (1|0), font file), (...), ...
+]</p></dd>
<dt><a name="-renderFont"><strong>renderFont</strong></a>(...)</dt>
-<dd><code>rendeFont("name", "filename", "sample", size, format="PPM") -> bool</code>
-<p>Creates an image preview of font "name" with given text "sample" and size. Image is saved into "filename". Returns true when success. The optional "format" argument specifies the image format to generate, and supports any format allowed by QPixmap.save(). Common formats are PPM, JPEG, PNG and XPM.</p>
-<p>May raise <a href="scripterapi.html#NotFoundError">NotFoundError</a> if the specified font can't be found. May raise ValueError if an empty sample or filename is passed.</p></dd></dl>
+<dd><code>renderFont("name", "filename", "sample", size, format="PPM") -> bool</code>
+<p>Creates an image preview of font "name" with given text "sample" and size. If "filename" is not "", image is saved into "filename". Otherwise image data is returned as a string. The optional "format" argument specifies the image format to generate, and supports any format allowed by QPixmap.save(). Common formats are PPM, JPEG, PNG and XPM.</p>
+<p>May raise <a href="scripterapi.html#NotFoundError">NotFoundError</a> if the specified font can't be found. May raise ValueError if an empty sample or filename is passed.</p></dd>
</dl>
</body>
Modified: trunk/Scribus/doc/de/scripterapi-getobjprop.html
URL: http://scribus.net/websvn/diff.php?repname=Scribus&rev=20587&path=/trunk/Scribus/doc/de/scripterapi-getobjprop.html
==============================================================================
--- trunk/Scribus/doc/de/scripterapi-getobjprop.html (original)
+++ trunk/Scribus/doc/de/scripterapi-getobjprop.html Thu Nov 26 20:24:20 2015
@@ -3,65 +3,88 @@
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<title>Getting Object Properties</title>
</head>
+<style>
+ at import "manual.css";
+</style>
<body>
<h2>Getting Object Properties</h2>
<dl>
+<dt><a name="-getObjectType"><strong>getObjectType</strong></a>(...)</dt>
+<dd><code>getObjectType(["name"]) -> string</code>
+<p>Get type of object "name" as a string. If "name" is not given the currently selected item is used.</p></dd>
+
<dt><a name="-getCornerRadius"><strong>getCornerRadius</strong></a>(...)</dt>
-<dd><code><a href="#-getCornerRadius">getCornerRadius</a>(["name"]) -> integer</code>
+<dd><code>getCornerRadius(["name"]) -> integer</code>
<p>Returns the corner radius of the object "name". The radius is expressed in points. If "name" is not given the currently selected item is used.</p></dd>
<dt><a name="-getFillColor"><strong>getFillColor</strong></a>(...)</dt>
-<dd><code><a href="#-getFillColor">getFillColor</a>(["name"]) -> string</code>
+<dd><code>getFillColor(["name"]) -> string</code>
<p>Returns the name of the fill color of the object "name". If "name" is not given the currently selected item is used.</p></dd>
+<dt><a name="-getFillBlendmode"><strong>getFillBlendmode</strong>(...)</a></dt>
+<dd><code>getFillBlendmode(["name"]) -> integer</code>
+<p>Returns the fill blendmode of the object "name". If "name" is not given the currently selected Item is used.</p></dd>
+
<dt><a name="-getFillShade"><strong>getFillShade</strong></a>(...)</dt>
-<dd><code><a href="#-getFillShade">getFillShade</a>(["name"]) -> integer</code>
+<dd><code>getFillShade(["name"]) -> integer</code>
<p>Returns the shading value of the fill color of the object "name". If "name" is not given the currently selected item is used.</p></dd>
-
+
+<dt><a name="-getFillTransparency"><strong>getFillTransparency</strong>(...)</a></dt>
+<dd><code>getFillTransparency(["name"]) -> float</code>
+<p>Returns the fill transparency of the object "name". If "name" is not given the currently selected Item is used.</p></dd>
+
<dt><a name="-getImageFile"><strong>getImageFile</strong></a>(...)</dt>
<dd><code>getImageName(["name"]) -> string</code>
<p>Returns the filename for the image in the image frame. If "name" is not given the currently selected item is used.</p></dd>
<dt><a name="-getImageScale"><strong>getImageScale</strong></a>(...)</dt>
-<dd><code><a href="#-getImageScale">getImageScale</a>(["name"]) -> (x,y)</code>
+<dd><code>getImageScale(["name"]) -> (x,y)</code>
<p>Returns a (x, y) tuple containing the scaling values of the image frame "name". If "name" is not given the currently selected item is used.</p></dd>
+
+<dt><a name="-getLineBlendmode"><strong>getLineBlendmode</strong>(...)</a></dt>
+<dd><code>getLineBlendmode(["name"]) -> integer</code>
+<p>Returns the line blendmode of the object "name". If "name" is not given the currently selected Item is used.</p></dd>
<dt><a name="-getLineCap"><strong>getLineCap</strong></a>(...)</dt>
<dd><code>getLineEnd(["name"]) -> integer (see constants)</code>
<p>Returns the line cap style of the object "name". If "name" is not given the currently selected item is used. The cap types are: CAP_FLAT, CAP_ROUND, CAP_SQUARE</p></dd>
<dt><a name="-getLineColor"><strong>getLineColor</strong></a>(...)</dt>
-<dd><code><a href="#-getLineColor">getLineColor</a>(["name"]) -> string</code>
+<dd><code>getLineColor(["name"]) -> string</code>
<p>Returns the name of the line color of the object "name". If "name" is not given the currently selected item is used.</p></dd>
<dt><a name="-getLineJoin"><strong>getLineJoin</strong></a>(...)</dt>
-<dd><code><a href="#-getLineJoin">getLineJoin</a>(["name"]) -> integer (see contants)</code>
+<dd><code>getLineJoin(["name"]) -> integer (see contants)</code>
<p>Returns the line join style of the object "name". If "name" is not given the currently selected item is used. The join types are: JOIN_BEVEL, JOIN_MITTER, JOIN_ROUND</p></dd>
<dt><a name="-getLineShade"><strong>getLineShade</strong></a>(...)</dt>
-<dd><code><a href="#-getLineShade">getLineShade</a>(["name"]) -> integer</code>
+<dd><code>getLineShade(["name"]) -> integer</code>
<p>Returns the shading value of the line color of the object "name". If "name" is not given the currently selected item is used.</p></dd>
<dt><a name="-getLineStyle"><strong>getLineStyle</strong></a>(...)</dt>
-<dd><code><a href="#-getLineStyle">getLineStyle</a>(["name"]) -> integer (see constants)</code>
+<dd><code>getLineStyle(["name"]) -> integer (see constants)</code>
<p>Returns the line style of the object "name". If "name" is not given the currently selected item is used. Line style constants are: LINE_DASH, LINE_DASHDOT, LINE_DASHDOTDOT, LINE_DOT, LINE_SOLID</p></dd>
+<dt><a name="-getLineTransparency"><strong>getLineTransparency</strong>(...)</a></dt>
+<dd><code>getLineTransparency(["name"]) -> float</code>
+<p>Returns the line transparency of the object "name". If "name" is not given the currently selected Item is used.</p></dd>
+
<dt><a name="-getLineWidth"><strong>getLineWidth</strong></a>(...)</dt>
-<dd><code><a href="#-getLineWidth">getLineWidth</a>(["name"]) -> integer</code>
+<dd><code>getLineWidth(["name"]) -> integer</code>
<p>Returns the line width of the object "name". If "name" is not given the currently selected Item is used.</p></dd>
<dt><a name="-getPosition"><strong>getPosition</strong></a>(...)</dt>
-<dd><code><a href="#-getPosition">getPosition</a>(["name"]) -> (x,y)</code>
+<dd><code>getPosition(["name"]) -> (x,y)</code>
<p>Returns a (x, y) tuple with the position of the object "name". If "name" is not given the currently selected item is used. The position is expressed in the actual measurement unit of the document - see UNIT_<type> for reference.</p></dd>
<dt><a name="-getRotation"><strong>getRotation</strong></a>(...)</dt>
-<dd><code><a href="#-getRotation">getRotation</a>(["name"]) -> integer</code>
+<dd><code>getRotation(["name"]) -> integer</code>
<p>Returns the rotation of the object "name". The value is expressed in degrees, and clockwise is positive. If "name" is not given the currently selected item is used.</p></dd>
<dt><a name="-getSize"><strong>getSize</strong></a>(...)</dt>
-<dd><code><a href="#-getSize">getSize</a>(["name"]) -> (width,height)</code>
+<dd><code>getSize(["name"]) -> (width,height)</code>
<p>Returns a (width, height) tuple with the size of the object "name". If "name" is not given the currently selected item is used. The size is expressed in the current measurement unit of the document - see UNIT_<type> for reference.</p></dd>
</dl>
Modified: trunk/Scribus/doc/de/scripterapi-layer.html
URL: http://scribus.net/websvn/diff.php?repname=Scribus&rev=20587&path=/trunk/Scribus/doc/de/scripterapi-layer.html
==============================================================================
--- trunk/Scribus/doc/de/scripterapi-layer.html (original)
+++ trunk/Scribus/doc/de/scripterapi-layer.html Thu Nov 26 20:24:20 2015
@@ -3,56 +3,107 @@
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<title>Layer related Commands</title>
</head>
+<style>
+ at import "manual.css";
+</style>
<body>
<h2>Layer related Commands</h2>
<dl>
<dt><a name="-createLayer"><strong>createLayer</strong></a>(...)</dt>
-<dd><code><a href="#-createLayer">createLayer</a>(layer)</code>
+<dd><code>createLayer(layer)</code>
<p>Creates a new layer with the name "name".</p>
<p>May raise ValueError if the layer name isn't acceptable.</p></dd>
<dt><a name="-deleteLayer"><strong>deleteLayer</strong></a>(...)</dt>
-<dd><code><a href="#-deleteLayer">deleteLayer</a>("layer")</code>
+<dd><code>deleteLayer("layer")</code>
<p>Deletes the layer with the name "layer". Nothing happens if the layer doesn't exists or if it's the only layer in the document.</p>
<p>May raise <a href="scripterapi.html#NotFoundError">NotFoundError</a> if the layer can't be found. May raise ValueError if the layer name isn't acceptable.</p></dd>
<dt><a name="-getActiveLayer"><strong>getActiveLayer</strong></a>(...)</dt>
-<dd><code><a href="#-getActiveLayer">getActiveLayer</a>() -> string</code>
+<dd><code>getActiveLayer() -> string</code>
<p>Returns the name of the current active layer.</p></dd>
<dt><a name="-getLayers"><strong>getLayers</strong></a>(...)</dt>
-<dd><code><a href="#-getLayers">getLayers</a>() -> list</code>
+<dd><code>getLayers() -> list</code>
<p>Returns a list with the names of all defined layers.</p></dd>
+<dt><a name="-getLayerBlendmode"><strong>getLayerBlendmode</strong>(...)</a></dt>
+<dd><code>getLayerBlendmode("layer") -> int</code>
+<p>Returns the "layer" layer blendmode, May raise NotFoundError if the layer can't be found. May raise ValueError if the layer name isn't acceptable.</p></dd>
+
+<dt><a name="-isLayerFlow"><strong>isLayerFlow</strong>(...)</a></dt>
+<dd><code>isLayerFlow("layer") -> bool</code>
+<p>Returns whether text flows around objects on layer "layer", a value of True means that text flows around, a value of False means that the text does not flow around.</p>
+<p>May raise NotFoundError if the layer can't be found. May raise ValueError if the layer name isn't acceptable.</p></dd>
+
+<dt><a name="-isLayerLocked"><strong>isLayerLocked</strong>(...)</a></dt>
+<dd><code>isLayerLocked("layer") -> bool</code>
+<p>Returns whether the layer "layer" is locked or not, a value of True means that the layer "layer" is editable, a value of False means that the layer "layer" is locked.</p>
+<p>May raise NotFoundError if the layer can't be found. May raise ValueError if the layer name isn't acceptable.</p></dd>
+
+<dt><a name="-getLayerTransparency"><strong>getLayerTransparency</strong>(...)</a></dt>
+<dd><code>getLayerTransparency("layer") -> float</code>
+<p>Returns the "layer" layer transparency, May raise NotFoundError if the layer can't be found. May raise ValueError if the layer name isn't acceptable.</p></dd>
+
+<dt><a name="-isLayerOutlined"><strong>isLayerOutlined</strong>(...)</a></dt>
+<dd><code>isLayerOutlined("layer") -> bool</code>
+<p>Returns whether the layer "layer" is outlined or not, a value of True means that the layer "layer" is outlined, a value of False means that the layer "layer" is normal.</p>
+<p>May raise NotFoundError if the layer can't be found. May raise ValueError if the layer name isn't acceptable.</p></dd>
+
<dt><a name="-isLayerPrintable"><strong>isLayerPrintable</strong></a>(...)</dt>
-<dd><code><a href="#-isLayerPrintable">isLayerPrintable</a>("layer") -> bool</code>
-<p>Returns wether the layer "layer" is printable or not, a value of True means that the layer "layer" can be printed, a value of False means that printing the layer "layer" is disabled.</p>
+<dd><code>isLayerPrintable("layer") -> bool</code>
+<p>Returns whether the layer "layer" is printable or not, a value of True means that the layer "layer" can be printed, a value of False means that printing the layer "layer" is disabled.</p>
<p>May raise <a href="scripterapi.html#NotFoundError">NotFoundError</a> if the layer can't be found. May raise ValueError if the layer name isn't acceptable.</p></dd>
<dt><a name="-isLayerVisible"><strong>isLayerVisible</strong></a>(...)</dt>
-<dd><code><a href="#-isLayerVisible">isLayerVisible</a>("layer") -> bool</code>
-<p>Returns wether the Layer "layer" is visible or not, a value of True means that the layer "layer" is visible, a value of False means that the layer "layer" is invisible.</p>
+<dd><code>isLayerVisible("layer") -> bool</code>
+<p>Returns whether the layer "layer" is visible or not, a value of True means that the layer "layer" is visible, a value of False means that the layer "layer" is invisible.</p>
<p>May raise <a href="scripterapi.html#NotFoundError">NotFoundError</a> if the layer can't be found. May raise ValueError if the layer name isn't acceptable.</p></dd>
<dt><a name="-sentToLayer"><strong>sentToLayer</strong></a>(...)</dt>
-<dd><code><a href="#-sentToLayer">sentToLayer</a>("layer" [, "name"])</code>
+<dd><code>sentToLayer("layer" [, "name"])</code>
<p>Sends the object "name" to the layer "layer". The layer must exist. If "name" is not given the currently selected item is used.</p>
<p>May raise <a href="scripterapi.html#NotFoundError">NotFoundError</a> if the layer can't be found. May raise ValueError if the layer name isn't acceptable.</p></dd>
<dt><a name="-setActiveLayer"><strong>setActiveLayer</strong></a>(...)</dt>
-<dd><code><a href="#-setActiveLayer">setActiveLayer</a>("name")</code>
+<dd><code>setActiveLayer("name")</code>
<p>Sets the active layer to the layer named "name".</p>
<p>May raise <a href="scripterapi.html#NotFoundError">NotFoundError</a> if the layer can't be found. May raise ValueError if the layer name isn't acceptable.</p></dd>
+<dt><a name="-setLayerBlendmode"><strong>setLayerBlendmode</strong>(...)</a></dt>
+<dd><code>setLayerBlendmode"layer", blend)</code>
+<p>Sets the layers "layer" blendmode to blend. May raise NotFoundError if the layer can't be found.</p>
+<p>May raise ValueError if the layer name isn't acceptable.</p></dd>
+
+<dt><a name="-setLayerFlow"><strong>setLayerFlow</strong>(...)</a></dt>
+<dd><code>setLayerFlow"layer", flow)</code>
+<p>Sets the layers "layer" flowcontrol to flow. If flow is set to true text in layers above this one will flow around objects on this layer.</p>
+<p>May raise NotFoundError if the layer can't be found. May raise ValueError if the layer name isn't acceptable.</p></dd>
+
+<dt><a name="-setLayerLocked"><strong>setLayerLocked</strong>(...)</a></dt>
+<dd><code>setLayerLocked("layer", locked)</code>
+<p>Sets the layer "layer" to be locked or not. If locked is set to true the layer will be locked.</p>
+<p>May raise NotFoundError if the layer can't be found. May raise ValueError if the layer name isn't acceptable.</p></dd>
+
+<dt><a name="-setLayerOutlined"><strong>setLayerOutlined</strong>(...)</a></dt>
+<dd><code>setLayerOutlined"layer", outline)</code>
+<p>Sets the layer "layer" to be locked or not. If outline is set to true the layer will be displayed outlined.</p>
+<p>May raise NotFoundError if the layer can't be found. May raise ValueError if the layer name isn't acceptable.</p></dd>
+
<dt><a name="-setLayerPrintable"><strong>setLayerPrintable</strong></a>(...)</dt>
-<dd><code><a href="#-setLayerPrintable">setLayerPrintable</a>("layer", printable)</code>
+<dd><code>setLayerPrintable("layer", printable)</code>
<p>Sets the layer "layer" to be printable or not. If is the printable set to false the layer won't be printed.</p>
<p>May raise <a href="scripterapi.html#NotFoundError">NotFoundError</a> if the layer can't be found. May raise ValueError if the layer name isn't acceptable.</p></dd>
+<dt><a name="-setLayerTransparency"><strong>setLayerTransparency</strong>(...)</a></dt>
+<dd><code>setLayerTransparency"layer", trans)</code>
+<p>Sets the layers "layer" transparency to trans.</p>
+<p>May raise NotFoundError if the layer can't be found. May raise ValueError if the layer name isn't acceptable.</p></dd>
+
<dt><a name="-setLayerVisible"><strong>setLayerVisible</strong></a>(...)</dt>
-<dd><code><a href="#-setLayerVisible">setLayerVisible</a>("layer", visible)</code>
+<dd><code>setLayerVisible("layer", visible)</code>
<p>Sets the layer "layer" to be visible or not. If is the visible set to false the layer is invisible.</p>
<p>May raise <a href="scripterapi.html#NotFoundError">NotFoundError</a> if the layer can't be found. May raise ValueError if the layer name isn't acceptable.</p></dd>
Modified: trunk/Scribus/doc/de/scripterapi-object.html
URL: http://scribus.net/websvn/diff.php?repname=Scribus&rev=20587&path=/trunk/Scribus/doc/de/scripterapi-object.html
==============================================================================
--- trunk/Scribus/doc/de/scripterapi-object.html (original)
+++ trunk/Scribus/doc/de/scripterapi-object.html Thu Nov 26 20:24:20 2015
@@ -3,67 +3,140 @@
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<title>Creating and Destroying Objects</title>
</head>
+<style>
+ at import "manual.css";
+</style>
<body>
<h2>Creating and Destroying Objects</h2>
<dl>
+<dt><a name="-createCharStyle"><strong>createCharStyle</strong></a>(...)</dt>
+<dd><code>createCharStyle(...)</code>
+<p>Creates a character style. This function takes the following keyword parameters:
+<ul>
+<li>"name" [required] -> name of the char style to create</li>
+<li>"font" [optional] -> name of the font to use</li>
+<li>fontsize [optional] -> font size to set (double)</li>
+<li>"features" [optional] -> nearer typographic details can be defined by a string that might contain the following phrases comma-seperated (without spaces!):
+<ul>
+ <li>inherit</li>
+ <li>bold</li>
+ <li>italic</li>
+ <li>underline</li>
+ <li>underlinewords</li>
+ <li>strike</li>
+ <li>superscript</li>
+ <li>subscript</li>
+ <li>outline</li>
+ <li>shadowed</li>
+ <li>allcaps</li>
+ <li>smallcaps</li>
+</ul>
+</li>
+<li>"fillcolor" [optional], "fillshade" [optional] -> specify fill options</li>
+<li>"strokecolor" [optional], "strokeshade" [optional] -> specify stroke options</li>
+<li>baselineoffset [optional] -> offset of the baseline</li>
+<li>shadowxoffset [optional], shadowyoffset [optional] -> offset of the shadow if used</li>
+<li>outlinewidth [optional] -> width of the outline if used</li>
+<li>underlineoffset [optional], underlinewidth [optional] -> underline options if used</li>
+<li>strikethruoffset [optional], strikethruwidth [optional] -> strikethru options if used</li>
+<li>scaleh [optional], scalev [optional] -> scale of the chars</li>
+<li>tracking [optional] -> tracking of the text</li>
+<li>"language" [optional] -> language code</li>
+</ul>
+</p>
+</dd>
+
<dt><a name="-createBezierLine"><strong>createBezierLine</strong></a>(...)</dt>
-<dd><tt><a href="#-createBezierLine">createBezierLine</a>(list, ["name"]) -> string</tt>
+<dd><code>createBezierLine(list, ["name"]) -> string</code>
<p>Creates a new bezier curve and returns its name. The points for the bezier curve are stored in the list "list" in the following order: [x1, y1, kx1, ky1, x2, y2, kx2, ky2...xn. yn, kxn. kyn] In the points list, x and y mean the x and y coordinates of the point and kx and ky meaning the control point for the curve. The coordinates are given in the current measurement units of the document (see UNIT constants). "name" should be a unique identifier for the object because you need this name for further access to that object. If "name" is not given Scribus will create one for you.</p>
<p>May raise <a href="scripterapi.html#NameExistsError">NameExistsError</a> if you explicitly pass a name that's already used. May raise ValueError if an insufficient number of points is passed or if the number of values passed don't group into points without leftovers.</p></dd>
<dt><a name="-createEllipse"><strong>createEllipse</strong></a>(...)</dt>
-<dd><tt><a href="#-createEllipse">createEllipse</a>(x, y, width, height, ["name"]) -> string</tt>
+<dd><code>createEllipse(x, y, width, height, ["name"]) -> string</code>
<p>Creates a new ellipse on the current page and returns its name. The coordinates are given in the current measurement units of the document (see UNIT constants). "name" should be a unique identifier for the object because you need this name for further referencing of that object. If "name" is not given Scribus will create one for you.</p>
<p>May raise <a href="scripterapi.html#NameExistsError">NameExistsError</a> if you explicitly pass a name that's already used.</p></dd></dt>
<dt><a name="-createImage"><strong>createImage</strong></a>(...)</dt>
-<dd><tt><a href="#-createImage">createImage</a>(x, y, width, height, ["name"]) -> string</tt>
+<dd><code>createImage(x, y, width, height, ["name"]) -> string</code>
<p>Creates a new picture frame on the current page and returns its name. The coordinates are given in the current measurement units of the document. "name" should be a unique identifier for the object because you need this name for further access to that object. If "name" is not given Scribus will create one for you.</p>
<p>May raise <a href="scripterapi.html#NameExistsError">NameExistsError</a> if you explicitly pass a name that's already used.</p></dd>
<dt><a name="-createLine"><strong>createLine</strong></a>(...)</dt>
-<dd><tt><a href="#-createLine">createLine</a>(x1, y1, x2, y2, ["name"]) -> string</tt>
+<dd><code>createLine(x1, y1, x2, y2, ["name"]) -> string</code>
<p>Creates a new line from the point(x1, y1) to the point(x2, y2) and returns its name. The coordinates are given in the current measurement unit of the document (see UNIT constants). "name" should be a unique identifier for the object because you need this name for further access to that object. If "name" is not given Scribus will create one for you.</p>
<p>May raise <a href="scripterapi.html#NameExistsError">NameExistsError</a> if you explicitly pass a name that's already used.</p></dd>
+<dt><a name="-createParagraphStyle"><strong>createParagraphStyle</strong></a>(...)</dt>
+<dd><code>createParagraphStyle(...)</code>
+<p>Creates a paragraph style. This function takes the following keyword parameters:
+<ul>
+<li>"name" [required] -> specifies the name of the paragraphstyle to create</li>
+<li>linespacingmode [optional] -> specifies the linespacing mode; possible modes are:
+<ul>
+ <li>fixed linespacing: 0</li>
+ <li>automatic linespacing: 1</li>
+ <li>baseline grid linespacing: 2</li>
+</ul>
+</li>
+<li>linespacing [optional] -> specifies the linespacing if using fixed linespacing</li>
+<li>alignment [optional] -> specifies the alignment of the paragraph
+<ul>
+ <li>left: 0</li>
+ <li>center: 1</li>
+ <li>right: 2</li>
+ <li>justify: 3</li>
+ <li>extend: 4</li>
+</ul>
+</li>
+<li>leftmargin [optional], rightmargin [optional] -> specify the margin</li>
+<li>gapbefore [optional], gapafter [optional] -> specify the gaps to the heading and following paragraphs</li>
+<li>firstindent [optional] -> the indent of the first line</li>
+<li>hasdropcap [optional] -> specifies if there are caps (1 = yes, 0 = no)</li>
+<li>dropcaplines [optional] -> height (in lines) of the caps if used</li>
+<li>dropcapoffset [optional] -> offset of the caps if used</li>
+<li>"charstyle" [optional] -> char style to use</li>
+</ul>
+</p>
+</dd>
+
<dt><a name="-createPathText"><strong>createPathText</strong></a>(...)</dt>
-<dd><tt><a href="#-createPathText">createPathText</a>(x, y, "textbox", "beziercurve", ["name"]) -> string</tt>
+<dd><code>createPathText(x, y, "textbox", "beziercurve", ["name"]) -> string</code>
<p>Creates a new pathText by merging the two objects "textbox" and "beziercurve" and returns its name. The coordinates are given in the current measurement unit of the document (see UNIT constants). "name" should be a unique identifier for the object because you need this name for further access to that object. If "name" is not given Scribus will create one for you.</p>
<p>May raise <a href="scripterapi.html#NameExistsError">NameExistsError</a> if you explicitly pass a name that's already used.
May raise <a href="scripterapi.html#NotFoundError">NotFoundError</a> if one or both of the named base object don't exist.</p></dd>
<dt><a name="-createPolyLine"><strong>createPolyLine</strong></a>(...)</dt>
-<dd><tt><a href="#-createPolyLine">createPolyLine</a>(list, ["name"]) -> string</tt>
+<dd><code>createPolyLine(list, ["name"]) -> string</code>
<p>Creates a new polyline and returns its name. The points for the polyline are stored in the list "list" in the following order: [x1, y1, x2, y2...xn. yn]. The coordinates are given in the current measurement units of the document (see UNIT constants). "name" should be a unique identifier for the object because you need this name for further access to that object. If "name" is not given Scribus will create one for you.</p>
<p>May raise <a href="scripterapi.html#NameExistsError">NameExistsError</a> if you explicitly pass a name that's already used. May raise ValueError if an insufficient number of points is passed or if the number of values passed don't group into points without leftovers.</p></dd>
<dt><a name="-createPolygon"><strong>createPolygon</strong></a>(...)</dt>
-<dd><tt><a href="#-createPolygon">createPolygon</a>(list, ["name"]) -> string</tt>
+<dd><code>createPolygon(list, ["name"]) -> string</code>
<p>Creates a new polygon and returns its name. The points for the polygon are stored in the list "list" in the following order: [x1, y1, x2, y2...xn. yn]. At least three points are required. There is no need to repeat the first point to close the polygon. The polygon is automatically closed by connecting the first and the last point. The coordinates are given in the current measurement units of the document (see UNIT constants). "name" should be a unique identifier for the object because you need this name for further access to that object. If "name" is not given Scribus will create one for you.</p>
<p>May raise <a href="scripterapi.html#NameExistsError">NameExistsError</a> if you explicitly pass a name that's already used. May raise ValueError if an insufficient number of points is passed or if the number of values passed don't group into points without leftovers.</p></dd>
<dt><a name="-createRect"><strong>createRect</strong></a>(...)</dt>
-<dd><tt><a href="#-createRect">createRect</a>(x, y, width, height, ["name"]) -> string</tt>
+<dd><code>createRect(x, y, width, height, ["name"]) -> string</code>
<p>Creates a new rectangle on the current page and returns its name. The coordinates are given in the current measurement units of the document (see UNIT constants). "name" should be a unique identifier for the object because you need this name to reference that object in future. If "name" is not given Scribus will create one for you.</p>
<p>May raise <a href="scripterapi.html#NameExistsError">NameExistsError</a> if you explicitly pass a name that's already used.</p></dd>
<dt><a name="-createText"><strong>createText</strong></a>(...)</dt>
-<dd><tt><a href="#-createText">createText</a>(x, y, width, height, ["name"]) -> string</tt>
+<dd><code>createText(x, y, width, height, ["name"]) -> string</code>
<p>Creates a new text frame on the actual page and returns its name. The coordinates are given in the actual measurement unit of the document (see UNIT constants). "name" should be a unique identifier for the object because you need this name for further referencing of that object. If "name" is not given Scribus will create one for you.</p>
<p>May raise <a href="scripterapi.html#NameExistsError">NameExistsError</a> if you explicitly pass a name that's already used.</p></dd>
<dt><a name="-deleteObject"><strong>deleteObject</strong></a>(...)</dt>
-<dd><tt><a href="#-deleteObject">deleteObject</a>(["name"])</tt>
+<dd><code>deleteObject(["name"])</code>
<p>Deletes the item with the name "name". If "name" is not given the currently selected item is deleted.</p></dd>
<dt><a name="-getAllStyles"><strong>getAllStyles</strong></a>(...)</dt>
-<dd><tt><a href="#-getAllStyles">getAllStyles</a>() -> list</tt>
+<dd><code>getAllStyles() -> list</code>
<p>Return a list of the names of all paragraph styles in the current document.</p></dd>
-
+
<dt><a name="-objectExists"><strong>objectExists</strong></a>(...)</dt>
-<dd><tt><a href="#-objectExists">objectExists</a>(["name"]) -> bool</tt>
+<dd><code>objectExists(["name"]) -> bool</code>
<p>Test if an object with specified name really exists in the document. The optional parameter is the object name. When no object name is given, returns True if there is something selected.</p></dd>
</dl>
Modified: trunk/Scribus/doc/de/scripterapi-page.html
URL: http://scribus.net/websvn/diff.php?repname=Scribus&rev=20587&path=/trunk/Scribus/doc/de/scripterapi-page.html
==============================================================================
--- trunk/Scribus/doc/de/scripterapi-page.html (original)
+++ trunk/Scribus/doc/de/scripterapi-page.html Thu Nov 26 20:24:20 2015
@@ -3,10 +3,17 @@
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<title>Page related Commands</title>
</head>
+<style>
+ at import "manual.css";
+</style>
<body>
<h2>Page related Commands</h2>
<dl>
+
+<dt><a name="-applyMasterPage"><strong>applyMasterPage</strong>(...)</a></dt>
+<dd><code>applyMasterPage(Master Page name, page nr)</code>
+<p>Applies the named master page to the indicated page. Some examples of usage are on the wiki.</a>.</p></dd>
<dt><a name="-closeMasterPage"><strong>closeMasterPage</strong>(...)</a></dt>
<dd><code>closeMasterPage()</code>
Modified: trunk/Scribus/doc/de/scripterapi-select.html
URL: http://scribus.net/websvn/diff.php?repname=Scribus&rev=20587&path=/trunk/Scribus/doc/de/scripterapi-select.html
==============================================================================
--- trunk/Scribus/doc/de/scripterapi-select.html (original)
+++ trunk/Scribus/doc/de/scripterapi-select.html Thu Nov 26 20:24:20 2015
@@ -3,25 +3,36 @@
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<title>Selecting Objects</title>
</head>
+<style>
+ at import "manual.css";
+</style>
<body>
<h2>Selecting Objects</h2>
<dl>
<dt><a name="-deselectAll"><strong>deselectAll</strong></a>(...)</dt>
-<dd><code><a href="#-deselectAll">deselectAll</a>()</code>
+<dd><code>deselectAll()</code>
<p>Deselects all objects in the whole document.</p></dd></dt>
-
+
<dt><a name="-getSelectedObject"><strong>getSelectedObject</strong></a>(...)</dt>
-<dd><code><a href="#-getSelectedObject">getSelectedObject</a>([nr]) -> string</code>
+<dd><code>getSelectedObject([nr]) -> string</code>
<p>Returns the name of the selected object. "nr" if given indicates the number of the selected object, e.g. 0 means the first selected object, 1 means the second selected Object and so on.</p></dd>
-
+
+<dt><a name="-moveSelectionToBack"><strong>moveSelectionToBack</strong></a>(...)</dt>
+<dd><code>moveSelectionToBack()</code>
+<p>Moves the current selection to the back.</p></dd>
+
+<dt><a name="-moveSelectionToFront"><strong>moveSelectionToFront</strong></a>(...)</dt>
+<dd><code>moveSelectionToFront()</code>
+<p>Moves the current selection to the front.</p></dd>
+
<dt><a name="-selectionCount"><strong>selectionCount</strong></a>(...)</dt>
-<dd><code><a href="#-selectionCount">selectionCount</a>() -> integer</code>
+<dd><code>selectionCount() -> integer</code>
<p>Returns the number of selected objects.</p></dd>
-
+
<dt><a name="-selectObject"><strong>selectObject</strong></a>(...)</dt>
-<dd><code><a href="#-selectObject">selectObject</a>("name")</code>
+<dd><code>selectObject("name")</code>
<p>Selects the object with the given "name".</p></dd>
</dl>
Modified: trunk/Scribus/doc/de/scripterapi-setobjprop.html
URL: http://scribus.net/websvn/diff.php?repname=Scribus&rev=20587&path=/trunk/Scribus/doc/de/scripterapi-setobjprop.html
==============================================================================
--- trunk/Scribus/doc/de/scripterapi-setobjprop.html (original)
+++ trunk/Scribus/doc/de/scripterapi-setobjprop.html Thu Nov 26 20:24:20 2015
@@ -9,75 +9,104 @@
<dl>
<dt><a name="-linkTextFrames"><strong>linkTextFrames</strong></a>(...)</dt>
-<dd><code><a href="#-linkTextFrames">linkTextFrames</a>("fromname", "toname")</code>
+<dd><code>linkTextFrames("fromname", "toname")</code>
<p>Link two text frames. The frame named "fromname" is linked to the frame named "toname". The target frame must be an empty text frame and must not link to or be linked from any other frames already.</p>
<p>May throw <a href="#ScribusException">ScribusException</a> if linking rules are violated.</p></dd>
<dt><a name="-loadImage"><strong>loadImage</strong></a>(...)</dt>
-<dd><code><a href="#-loadImage">loadImage</a>("filename" [, "name"])</code>
+<dd><code>loadImage("filename" [, "name"])</code>
<p>Loads the picture "picture" into the image frame "name". If "name" is not given the currently selected item is used.</p>
<p>May raise <a href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a> if the target frame is not an image frame</p></dd></dt>
-
-<dt><a name="-scaleImage"><strong>scaleImage</strong></a>(...)</dt>
-<dd><code><a href="#-scaleImage">scaleImage</a>(x, y [, "name"])</code>
-<p>Sets the scaling factors of the picture in the image frame "name". If "name" is not given the currently selected item is used. A number of 1 means 100 %.</p>
-<p>May raise <a href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a> if the target frame is not an image frame</p></dd>
+
+<dt><a name="-setFillBlendmode"><strong>setFillBlendmode</strong>(...)</a></dt>
+<dd><code>setFillBlendmode(blendmode, ["name"])</code>
+<p>Sets the fill blendmode of the object "name" to blendmode is the name of one of the defined colors. If "name" is not given the currently selected item is used.</p></dd>
<dt><a name="-setCornerRadius"><strong>setCornerRadius</strong></a>(...)</dt>
-<dd><code><a href="#-setCornerRadius">setCornerRadius</a>(radius, ["name"])</code>
+<dd><code>setCornerRadius(radius, ["name"])</code>
<p>Sets the corner radius of the object "name". The radius is expressed in points. If "name" is not given the currently selected item is used.</p>
<p>May raise ValueError if the corner radius is negative.</p></dd>
<dt><a name="-setFillColor"><strong>setFillColor</strong></a>(...)</dt>
-<dd><code><a href="#-setFillColor">setFillColor</a>("color", ["name"])</code>
+<dd><code>setFillColor("color", ["name"])</code>
<p>Sets the fill color of the object "name" to the color "color". "color" is the name of one of the defined colors. If "name" is not given the currently selected item is used.</p></dd>
<dt><a name="-setFillShade"><strong>setFillShade</strong></a>(...)</dt>
-<dd><code><a href="#-setFillShade">setFillShade</a>(shade, ["name"])</code>
+<dd><code>setFillShade(shade, ["name"])</code>
<p>Sets the shading of the fill color of the object "name" to "shade". "shade" must be an integer value in the range from 0 (lightest) to 100 (full Color intensity). If "name" is not given the currently selected Item is used.<p>
<p>May raise ValueError if the fill shade is out of bounds.</p></dd>
+<dt><a name="-setFillTransparency"><strong>setFillTransparency</strong>(...)</a></dt>
+<dd><code>setFillTransparency(transparency, ["name"])</code>
+<p>Sets the fill transparency of the object "name" to transparency is the name of one of the defined colors. If "name" is not given the currently selected item is used.</p></dd>
+
+<dt><a name="-setLineBlendmode"><strong>setLineBlendmode</strong>(...)</a></dt>
+<dd><code>setLineBlendmode(blendmode, ["name"])</code>
+<p>Sets the line blendmode of the object "name" to blendmode is the name of one of the defined colors. If "name" is not given the currently selected item is used.</p></dd>
+
+<dt><a name="-setLineTransparency"><strong>setLineTransparency</strong>(...)</a></dt>
+<dd><code>setLineTransparency(transparency, ["name"])</code>
+<p>Sets the line transparency of the object "name" to transparency is the name of one of the defined colors. If "name" is not given the currently selected item is used.</p></dd>
+
<dt><a name="-setGradientFill"><strong>setGradientFill</strong></a>(...)</dt>
-<dd><code><a href="#-setGradientFill">setGradientFill</a>(type, "color1", shade1, "color2", shade2, ["name"])</code>
+<dd><code>setGradientFill(type, "color1", shade1, "color2", shade2, ["name"])</code>
<p>Sets the gradient fill of the object "name" to type. Color descriptions are the same as for <a href="#-setFillColor">setFillColor</a>() and <a href="#-setFillShade">setFillShade</a>(). See the constants for available types (FILL_<type>).</p></dd>
+
+<dt><a name="-setGradientStop"><strong>setGradientStop</strong></a>(...)</dt>
+<dd><code>setGradientStop("color", shade, opacity, ramppoint, ["name"])</code>
+<p>Set or add a gradient stop to the gradient fill of the object \"name\" at position ramppoint. Color descriptions are the same as for <a href="#-setFillColor">setFillColor</a>() and <a href="#-setFillShade">setFillShade</a>(). setGradientFill() must have been called previously for the gradient fill to be visible.</p></dd>
<dt><a name="-setLineCap"><strong>setLineCap</strong></a>(...)</dt>
<dd><code>setLineCap(captype, ["name"])</code>
<p>Sets the line cap style of the object "name" to the style "cap". If "name" is not given the currently selected item is used. There are predefined constants for "cap" - CAP_<type>.</p></dd>
<dt><a name="-setLineColor"><strong>setLineColor</strong></a>(...)</dt>
-<dd><code><a href="#-setLineColor">setLineColor</a>("color", ["name"])</code>
+<dd><code>setLineColor("color", ["name"])</code>
<p>Sets the line color of the object "name" to the color "color". If "name" is not given the currently selected item is used.</p></dd>
<dt><a name="-setMultiLine"><strong>setMultiLine</strong></a>(...)</dt>
-<dd><code><a href="#-setMultiLine">setMultiLine</a>("namedStyle", ["name"])</code>
+<dd><code>setMultiLine("namedStyle", ["name"])</code>
<p>Sets the line style of the object "name" to the named style "namedStyle". If "name" is not given the currently selected item is used.</p>
<p>May raise <a href="scripterapi.html#NotFoundError">NotFoundError</a> if the line style doesn't exist.</p></dd>
<dt><a name="-setLineJoin"><strong>setLineJoin</strong></a>(...)</dt>
-<dd><code><a href="#-setLineJoin">setLineJoin</a>(join, ["name"])</code>
+<dd><code>setLineJoin(join, ["name"])</code>
<p>Sets the line join style of the object "name" to the style "join". If "name" is not given the currently selected item is used. There are predefined constants for join - JOIN_<type>.</p></dd>
<dt><a name="-setLineShade"><strong>setLineShade</strong></a>(...)</dt>
-<dd><code><a href="#-setLineShade">setLineShade</a>(shade, ["name"])</code>
+<dd><code>setLineShade(shade, ["name"])</code>
<p>Sets the shading of the line color of the object "name" to "shade". "shade" must be an integer value in the range from 0 (lightest) to 100 (full color intensity). If "name" is not given the currently selected item is used.</p>
<p>May raise ValueError if the line shade is out of bounds.</p></dd>
<dt><a name="-setLineStyle"><strong>setLineStyle</strong></a>(...)</dt>
-<dd><code><a href="#-setLineStyle">setLineStyle</a>(style, ["name"])</code>
+<dd><code>setLineStyle(style, ["name"])</code>
<p>Sets the line style of the object "name" to the style "style". If "name" is not given the currently selected item is used. There are predefined constants for "style" - LINE_<style>.</p></dd>
<dt><a name="-setLineWidth"><strong>setLineWidth</strong></a>(...)</dt>
-<dd><code><a href="#-setLineWidth">setLineWidth</a>(width, ["name"])</code>
+<dd><code>setLineWidth(width, ["name"])</code>
<p>Sets line width of the object "name" to "width". "width" must be in the range from 0.0 to 12.0 inclusive, and is measured in points. If "name" is not given the currently selected item is used.</p>
<p>May raise ValueError if the line width is out of bounds.</p></dd>
+<dt><a name="-scaleImage"><strong><em>scaleImage</em></strong></a>(...)</dt>
+<dd><code>scaleImage(x, y [, "name"])</code>
+<p><b>Do not use this command, since it no longer works. Use setImageScale instead.</b></p></dd>
+
+<dt><a name="-setImageScale"><strong>setImageScale</strong></a>(...)</dt>
+<dd><code>setImageScale(x, y [, "name"])</code>
+<p>Sets the scaling factors of the picture in the image frame "name". If "name" is not given the currently selected item is used. A number of 1 means 100 %. Scaling factors are equal to the values shown on properties palette.</p>
+<p>May raise <a href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a> if the target frame is not an image frame</p></dd>
+
+<dt><a name="-setImageOffset"><strong>setImageOffset</strong></a>(...)</dt>
+<dd><code>setImageOffset(x, y [, "name"])</code>
+<p>Sets the position of the picture in the image frame "name". If "name" is not given the currently selected item is used. The specified offset values are equal to the values shown on properties palette when point unit is used.</p>
+<p>May raise <a href="scripterapi.html#WrongFrameTypeError">WrongFrameTypeError</a> if the target frame is not an image frame</p></dd>
+
<dt><a name="-traceText"><strong>traceText</strong></a>(...)</dt>
-<dd><code><a href="#-traceText">traceText</a>(["name"])</code>
+<dd><code>traceText(["name"])</code>
<p>Convert the text frame "name" to outlines. If "name" is not given the currently selected item is used.</p></dd>
<dt><a name="-unlinkTextFrames"><strong>unlinkTextFrames</strong></a>(...)</dt>
-<dd><code><a href="#-unlinkTextFrames">unlinkTextFrames</a>("name")</code>
+<dd><code>unlinkTextFrames("name")</code>
<p>Remove the specified (named) object from the text frame flow/linkage. If the frame was in the middle of a chain, the previous and next frames will be connected, eg 'a->b->c' becomes 'a->c' when you <a href="#-unlinkTextFrames">unlinkTextFrames</a>(b)'</p>
<p>May throw <a href="#ScribusException">ScribusException</a> if linking rules are violated.</p></dd>
Modified: trunk/Scribus/doc/de/scripterapi-textframes.html
URL: http://scribus.net/websvn/diff.php?repname=Scribus&rev=20587&path=/trunk/Scribus/doc/de/scripterapi-textframes.html
==============================================================================
--- trunk/Scribus/doc/de/scripterapi-textframes.html (original)
+++ trunk/Scribus/doc/de/scripterapi-textframes.html Thu Nov 26 20:24:20 2015
@@ -3,120 +3,173 @@
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<title>Handling Text Frames</title>
</head>
+<style>
+ at import "manual.css";
+</style>
<body>
<h2>Handling Text Frames</h2>
<dl>
+<dt><a name="-dehyphenateText"><strong>dehyphenateText</strong></a>(...)</dt>
+<dd><code>dehyphenateText(["name"]) -> bool</code>
+<p>Does dehyphenation on text frame "name". If "name" is not given the currently selected item is used.</p>
+<p>May raise WrongFrameTypeError if the target frame is not a text frame</p></dd>
+
<dt><a name="-deleteText"><strong>deleteText</strong></a>(...)</dt>
-<dd><code><a href="#-deleteText">deleteText</a>(["name"])</code>
+<dd><code>deleteText(["name"])</code>
<p>Deletes any text in the text frame "name". If there is some text selected, only the selected text will be deleted. If "name" is not given the currently selected item is used.</p></dd>
-
+
<dt><a name="-getAllText"><strong>getAllText</strong></a>(...)</dt>
-<dd><code><a href="#-getAllText">getAllText</a>(["name"]) -> string</code>
+<dd><code>getAllText(["name"]) -> string</code>
<p>Returns the text of the text frame "name" and of all text frames which are linked with this frame. If this textframe has some text selected, the selected text is returned. If "name" is not given the currently selected item is used.</p></dd></dt>
-
+
<dt><a name="-getColumnGap"><strong>getColumnGap</strong></a>(...)</dt>
-<dd><code><a href="#-getColumnGap">getColumnGap</a>(["name"]) -> float</code>
+<dd><code>getColumnGap(["name"]) -> float</code>
<p>Returns the column gap size of the text frame "name" expressed in points. If "name" is not given the currently selected item is used.</p></dd>
-
+
<dt><a name="-getColumns"><strong>getColumns</strong></a>(...)</dt>
-<dd><code><a href="#-getColumns">getColumns</a>(["name"]) -> integer</code>
-<p>Gets the number of columns of the text frame "name". If "name" is not given the currently selected item is used.</p></dd>
-
+<dd><code>getColumns(["name"]) -> integer</code>
+<p>Gets the number of columns of the text frame "name". If "name" is not given the currently selected item is used.</p></dd>
+
<dt><a name="-getFont"><strong>getFont</strong></a>(...)</dt>
-<dd><code><a href="#-getFont">getFont</a>(["name"]) -> string</code>
-<p>Returns the font name for the text frame "name". If this text frame has some text selected the value assigned to the first character of the selection is returned. If "name" is not given the currently selected item is used.</p></dd>
-
+<dd><code>getFont(["name"]) -> string</code>
+<p>Returns the font name for the text frame "name". If this text frame has some text selected the value assigned to the first character of the selection is returned. If "name" is not given the currently selected item is used.</p></dd>
+
<dt><a name="-getFontSize"><strong>getFontSize</strong></a>(...)</dt>
-<dd><code><a href="#-getFontSize">getFontSize</a>(["name"]) -> float</code>
+<dd><code>getFontSize(["name"]) -> float</code>
<p>Returns the font size in points for the text frame "name". If this text frame has some text selected the value assigned to the first character of the selection is returned. If "name" is not given the currently selected item is used.</p></dd>
-
+
<dt><a name="-getLineSpacing"><strong>getLineSpacing</strong></a>(...)</dt>
-<dd><code><a href="#-getLineSpacing">getLineSpacing</a>(["name"]) -> float</code>
+<dd><code>getLineSpacing(["name"]) -> float</code>
<p>Returns the line spacing ("leading") of the text frame "name" expressed in points. If "name" is not given the currently selected item is used.</p></dd>
-
+
<dt><a name="-getText"><strong>getText</strong></a>(...)</dt>
-<dd><code><a href="#-getText">getText</a>(["name"]) -> string</code>
+<dd><code>getText(["name"]) -> string</code>
<p>Returns the text of the text frame "name". If this text frame has some text selected, the selected text is returned. All text in the frame, not just currently visible text, is returned. If "name" is not given the currently selected item is used.</p></dd>
<dt><a name="-getTextColor"><strong>getTextColor</strong></a>(...)</dt>
-<dd><code><a href="#-getLineColor">getLineColor</a>(["name"]) -> string</code>
+<dd><code>getLineColor(["name"]) -> string</code>
<p>Returns the name of the line color of the object "name". If "name" is not given the currently selected item is used.</p></dd>
+<dt><a name="-getTextDistances"><strong>getTextDistances</strong></a>(...)</dt>
+<dd><code>getTextDistances(["name"]) -> tuple</code>
+<p>Returns the text distances of the text frame "name" expressed in points. The
+distances are returned as a tuple like (left, right, top, bottom). If "name"
+is not given the currently selected item is used.</p></dd>
+
<dt><a name="-getTextLength"><strong>getTextLength</strong></a>(...)</dt>
-<dd><code><a href="#-getTextLength">getTextLength</a>(["name"]) -> integer</code>
+<dd><code>getTextLength(["name"]) -> integer</code>
<p>Returns the length of the text in the text frame "name". If "name" is not given the currently selected item is used.</p></dd>
+<dt><a name="-getTextLines"><strong>getTextLines</strong>(...)</a></dt>
+<dd><code>getTextLines(["name"]) -> integer</code>
+<p>Returns the number of lines of the text in the text frame "name". If "name" is not given the currently selected item is used.</p></dd>
+
<dt><a name="-getTextShade"><strong>getTextShade</strong></a>(...)</dt>
-<dd><code><a href="#-getLineShade">getLineShade</a>(["name"]) -> integer</code>
+<dd><code>getLineShade(["name"]) -> integer</code>
<p>Returns the shading value of the line color of the object "name". If "name" is not given the currently selected item is used.</p></dd>
-<dt><a name="-isPDFBookmark"><strong>isPDFBookmark</strong></a>(...)</dt>
-<dd><code><a href="#-isPDFBookmark">isPDFBookmark</a>(["name"]) -> bool</code>
-<p>Returns true if the text frame "name" is a PDF bookmark. If "name" is not given the currently selected item is used.</p>
-<p>May raise WrongFrameTypeError if the target frame is not a text frame.</p></dd>
+<dt><a name="-hyphenateText"><strong>hyphenateText</strong></a>(...)</dt>
+<dd><code>hyphenateText(["name"]) -> bool</code>
+<p>Does hyphenation on text frame "name". If "name" is not given the currently selected item is used.</p>
+<p>May raise WrongFrameTypeError if the target frame is not a text frame</p></dd>
+
+<dt><a name="-insertHtmlText"><strong>insertHtmlText</strong></a>(...)</dt>
+<dd><code>insertHtmlText("text", ["name"])</code>
+<p>Inserts the text from "file" into the text frame "name". Text must be UTF encoded (see <a href="#-setText">setText</a>() as reference). If "name" is not given the currently selected Item is used.</p>
+<p>May raise WrongFrameTypeError if the target frame is not a text frame</p></dd>
<dt><a name="-insertText"><strong>insertText</strong></a>(...)</dt>
-<dd><code><a href="#-insertText">insertText</a>("text", pos, ["name"])</code>
-<p>Inserts the text "text" at the position "pos" into the text frame. Text must be UTF encoded (see <a href="#-setText">setText</a>() as reference) The first character has an index of 0. Inserting at position -1 appends text to the frame. "name" If "name" is not given the currently selected Item is used.</p>
+<dd><code>insertText("text", pos, ["name"])</code>
+<p>Inserts the text "text" at the position "pos" into the text frame "name". Text must be UTF encoded (see <a href="#-setText">setText</a>() as reference) The first character has an index of 0. Inserting text at position -1 appends it to the frame. If "name" is not given the currently selected Item is used.</p>
<p>May throw IndexError for an insertion out of bounds.</p></dd>
-
+
+<dt><a name="-isPDFBookmark"><strong>isPDFBookmark</strong>(...)</a></dt>
+<dd><code>isPDFBookmark(["name"]) -> bool</code>
+<p>Returns true if the text frame "name" is a PDF bookmark. If "name" is not given the currently selected item is used.</p>
+<p>May raise WrongFrameTypeError if the target frame is not a text frame</p></dd>
+
<dt><a name="-selectText"><strong>selectText</strong></a>(...)</dt>
-<dd><code><a href="#-selectText">selectText</a>(start, count, ["name"])</code>
+<dd><code>selectText(start, count, ["name"])</code>
<p>Selects "count" characters of text in the text frame "name" starting from the character "start". Character counting starts at 0. If "count" is zero, any text selection will be cleared. If "name" is not given the currently selected item is used.</p>
<p>May throw IndexError if the selection is outside the bounds of the text.</p></dd>
-
+
<dt><a name="-setColumns"><strong>setColumns</strong></a>(...)</dt>
-<dd><code><a href="#-setColumns">setColumns</a>(nr, ["name"])</code>
+<dd><code>setColumns(nr, ["name"])</code>
<p>Sets the number of columns of the text frame "name" to the integer "nr". If "name" is not given the currently selected item is used.</p>
<p>May throw ValueError if number of columns is not at least one.</p></dd>
-
+
<dt><a name="-setColumnGap"><strong>setColumnGap</strong></a>(...)</dt>
-<dd><code><a href="#-setColumnGap">setColumnGap</a>(size, ["name"])</code>
+<dd><code>setColumnGap(size, ["name"])</code>
<p>Sets the column gap of the text frame "name" to the value "size". If "name" is not given the currently selected item is used.</p>
-<p>May throw ValueError if the column gap is out of bounds (must be positive).</p></dd>
-
+<p>May throw ValueError if the column gap is out of bounds (must be positive).</p></dd>
+
<dt><a name="-setFont"><strong>setFont</strong></a>(...)</dt>
-<dd><code><a href="#-setFont">setFont</a>("font", ["name"])</code>
+<dd><code>setFont("font", ["name"])</code>
<p>Sets the font of the text frame "name" to "font". If there is some text selected only the selected text is changed. If "name" is not given the currently selected item is used.</p>
<p>May throw ValueError if the font cannot be found.</p></dd>
<dt><a name="-setFontSize"><strong>setFontSize</strong></a>(...)</dt>
-<dd><code><a href="#-setFontSize">setFontSize</a>(size, ["name"])</code>
+<dd><code>setFontSize(size, ["name"])</code>
<p>Sets the font size of the text frame "name" to "size". "size" is treated as a value in points. If there is some text selected only the selected text is changed. "size" must be in the range 1 to 512. If "name" is not given the currently selected item is used.</p>
<p>May throw ValueError for a font size that's out of bounds.</p></dd>
-
+
<dt><a name="-setLineSpacing"><strong>setLineSpacing</strong></a>(...)</dt>
-<dd><code><a href="#-setLineSpacing">setLineSpacing</a>(size, ["name"])</code>
+<dd><code>setLineSpacing(size, ["name"])</code>
<p>Sets the line spacing ("leading") of the text frame "name" to "size". "size" is a value in points. If "name" is not given the currently selected item is used.</p>
<p>May throw ValueError if the line spacing is out of bounds.</p></dd>
-<dt><a name="-setPDFBookmark"><strong>setPDFBookmark</strong></a>(...)</dt>
-<dd><code><a href="#-setPDFBookmark">setPDFBookmark</a>("toggle", ["name"])</code>
-<p>Sets wether (toggle = 1) the text frame "name" is a bookmark nor not. If "name" is not given the currently selected item is used.</p>
-<p>May raise WrongFrameTypeError if the target frame is not a text frame.</p></dd>
+<dt><a name="-setLineSpacingMode"><strong>setLineSpacingMode</strong></a>(...)</dt>
+<dd><code>setLineSpacingMode(mode, ["name"])</code>
+<p>Sets the line spacing mode of the text frame "name" to "mode". If "name" is not given the currently selected item is used. Mode values are the same as in createParagraphStyle.</p>
+<p>May throw ValueError if the line spacing mode is out of bounds.</p></dd>
+
+<dt><a name="-setPDFBookmark"><strong>setPDFBookmark</strong>(...)</a></dt>
+<dd><code>setPDFBookmark("toggle", ["name"])</code>
+<p>Sets wether (toggle = 1) the text frame "name" is a bookmark nor not. If "name" is not given the currently selected item is used.</p>
+<p>May raise WrongFrameTypeError if the target frame is not a text frame</p></dd>
<dt><a name="-setText"><strong>setText</strong></a>(...)</dt>
-<dd><code><a href="#-setText">setText</a>("text", ["name"])</code>
+<dd><code>setText("text", ["name"])</code>
<p>Sets the text of the text frame "name" to the text of the string "text". Text must be UTF8 encoded - use e.g. unicode(text, 'iso-8859-2'). See the FAQ for more details. If "name" is not given the currently selected item is used.</p></dd>
<dt><a name="-setTextAlignment"><strong>setTextAlignment</strong></a>(...)</dt>
-<dd><code><a href="#-setTextAlignment">setTextAlignment</a>(align, ["name"])</code>
-<p>Sets the text alignment of the text frame "name" to the specified alignment. If "name" is not given the currently selected item is used. "align" should be one of the ALIGN_ constants defined in this module - see dir(scribus).</p>
+<dd><code>setTextAlignment(align, ["name"])</code>
+<p>Sets the text alignment of the text frame "name" to the specified alignment. If "name" is not given the currently selected item is used. "align" should be one of the ALIGN_ constants defined in this module - see dir(scribus).</p>
<p>May throw ValueError for an invalid alignment constant.</p></dd>
+<dt><a name="-setTextDistances"><strong>setTextDistances</strong></a>(...)</dt>
+<dd><code>setTextDistances(left, right, top, bottom, ["name"])</code>
+<p>Sets the text distances of the text frame "name" to the values "left"
+"right", "top" and "bottom". If "name" is not given the currently
+selected item is used.</p>
+<p>May throw ValueError if any of the distances are out of bounds (must be positive).</p></dd>
+
+<dt><a name="-setTextScalingH"><strong>setTextScalingH</strong></a>(...)</dt>
+<dd><code>setTextScalingH(scale, ["name"]))</code>
+<p>Sets the horizontal character scaling of the object "name" to "scale" in percent. If "name" is not given the currently selected item is used.</p></dd>
+
+<dt><a name="-setTextScalingV"><strong>setTextScalingV</strong></a>(...)</dt>
+<dd><code>setTextScalingV(scale, ["name"]))</code>
+<p>Sets the vertical character scaling of the object "name" to "scale" in percent. If "name" is not given the currently selected item is used.</p></dd>
+
<dt><a name="-setTextColor"><strong>setTextColor</strong></a>(...)</dt>
-<dd><code><a href="#-setTextColor">setTextColor</a>("color", ["name"])</code>
+<dd><code>setTextColor("color", ["name"])</code>
<p>Sets the text color of the text frame "name" to the color "color". If there is some text selected only the selected text is changed. If "name" is not given the currently selected item is used.</p></dd>
<dt><a name="-setTextShade"><strong>setTextShade</strong></a>(...)</dt>
-<dd><code><a href="#-setTextShade">setTextShade</a>(shade, ["name"])</code>
+<dd><code>setTextShade(shade, ["name"])</code>
<p>Sets the shading of the text color of the object "name" to "shade". If there is some text selected only the selected text is changed. "shade" must be an integer value in the range from 0 (lightest) to 100 (full color intensity). If "name" is not given the currently selected item is used.</p></dd>
<dt><a name="-setTextStroke"><strong>setTextStroke</strong></a>(...)</dt>
-<dd><code><a href="#-setTextStroke">setTextStroke</a>("color", ["name"])</code>
+<dd><code>setTextStroke("color", ["name"])</code>
<p>Set "color" of the text stroke. If "name" is not given the currently selected item is used.</p></dd>
+
+<dt><a name="-textOverflows"><strong>textOverflows</strong></a>(...)</dt>
+<dd><code>textOverflows(["name", nolinks]) -> integer</code>
+<p>Returns 1 if there are overflowing characters in text frame "name", 0 if not. If is nolinks set to non zero value it takes only one frame - it doesn't use text frame linking. Without this parameter it search all linking chain.</p>
+<p>May raise WrongFrameTypeError if the target frame is not an text frame</p></dd>
</dl>
</body>
Modified: trunk/Scribus/doc/de/scripterapi.html
URL: http://scribus.net/websvn/diff.php?repname=Scribus&rev=20587&path=/trunk/Scribus/doc/de/scripterapi.html
==============================================================================
--- trunk/Scribus/doc/de/scripterapi.html (original)
+++ trunk/Scribus/doc/de/scripterapi.html Thu Nov 26 20:24:20 2015
@@ -3,6 +3,9 @@
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<title>The Available Commands</title>
</head>
+<style>
+ at import "manual.css";
+</style>
<body>
<h2>The Available Commands</h2>
@@ -12,7 +15,7 @@
<ul>
<li>Many functions will raise a NoDocOpenError if you try to use them without a document to operate on.</li>
<li>If you do not pass a frame name to a function that requires one, the function will use the currently selected frame, if any, or raise a NoValidObjectError if it can't find anything to operate on.</li>
- <li>Many functions will raise WrongFrameTypeError if you try to use them on a frame type that they do not make sense with. For example, setting the text colour on a graphics frame doesn't make sense, and will result in this exception being raised.</li>
+ <li>Many functions will raise WrongFrameTypeError if you try to use them on a frame type that they do not make sense with. For example, setting the text color on a graphics frame doesn't make sense, and will result in this exception being raised.</li>
<li>Errors resulting from calls to the underlying Python API will be passed through unaltered. As such, the list of exceptions thrown by any function as provided here and in its docstring is incomplete.</li>
</ul>
<p>Details of what exceptions each function may throw are provided on the function's documentation.</p>
@@ -20,11 +23,11 @@
<p>Conventions used in this Document:</p>
<dl>
<dt><strong>number</strong></dt>
- <dd>means that "number" is an ordinary Interger or Floating Point Number.</dd>
+ <dd>means that "number" is an ordinary Integer or Floating Point Number.</dd>
<dt><strong>"name"</strong></dt>
<dd>means that "name" is a String Literal or Variable.</dd>
<dt><strong><i>list</i></strong></dt>
- <dd>means that "<i>list</i>" is a Python List.</dd>
+ <dd>means that "list" is a Python List.</dd>
</dl>
<p>Variables in angled Brackets are optional.</p>
@@ -47,69 +50,69 @@
</dl>
<h3>NameExistsError</h3>
-<a name="NameExistsError">class NameExistsError</a>(<a href="#ScribusException">ScribusException</a>)
+<dl><a name="NameExistsError">class NameExistsError</a>(<a href="#ScribusException">ScribusException</a>)</dl>
<dl><dt>Method resolution order:</dt>
<dd><a href="#NameExistsError">NameExistsError</a></dd>
<dd><a href="#ScribusException">ScribusException</a></dd>
<dd><a href="#Exception">exceptions.Exception</a></dd>
</dl>
-Methods inherited from <a href="#Exception">exceptions.Exception</a>:<br>
+<dl>Methods inherited from <a href="#Exception">exceptions.Exception</a>:<br></dl>
<dl><dt><a name="NameExistsError-__getitem__"><strong>__getitem__</strong></a>(...)</dt></dl>
<dl><dt><a name="NameExistsError-__init__"><strong>__init__</strong></a>(...)</dt></dl>
<dl><dt><a name="NameExistsError-__str__"><strong>__str__</strong></a>(...)</dt></dl>
<h3>NoDocOpenError</h3>
-<a name="NoDocOpenError">class NoDocOpenError</a>(<a href="#ScribusException">ScribusException</a>)
+<dl><a name="NoDocOpenError">class NoDocOpenError</a>(<a href="#ScribusException">ScribusException</a>)</dl>
<dl><dt>Method resolution order:</dt>
<dd><a href="#NoDocOpenError">NoDocOpenError</a></dd>
<dd><a href="#ScribusException">ScribusException</a></dd>
<dd><a href="#Exception">exceptions.Exception</a></dd>
</dl>
-Methods inherited from <a href="#Exception">exceptions.Exception</a>:<br>
+<dl>Methods inherited from <a href="#Exception">exceptions.Exception</a>:<br></dl>
<dl><dt><a name="NoDocOpenError-__getitem__"><strong>__getitem__</strong></a>(...)</dt></dl>
<dl><dt><a name="NoDocOpenError-__init__"><strong>__init__</strong></a>(...)</dt></dl>
<dl><dt><a name="NoDocOpenError-__str__"><strong>__str__</strong></a>(...)</dt></dl>
<h3>NoValidObjectError</h3>
-<a name="NoValidObjectError">class NoValidObjectError</a>(<a href="#ScribusException">ScribusException</a>)
+<dl><a name="NoValidObjectError">class NoValidObjectError</a>(<a href="#ScribusException">ScribusException</a>)</dl>
<dl><dt>Method resolution order:</dt>
<dd><a href="#NoValidObjectError">NoValidObjectError</a></dd>
<dd><a href="#ScribusException">ScribusException</a></dd>
<dd><a href="#Exception">exceptions.Exception</a></dd>
</dl>
-Methods inherited from <a href="#Exception">exceptions.Exception</a>:<br>
+<dl>Methods inherited from <a href="#Exception">exceptions.Exception</a>:<br></dl>
<dl><dt><a name="NoValidObjectError-__getitem__"><strong>__getitem__</strong></a>(...)</dt></dl>
<dl><dt><a name="NoValidObjectError-__init__"><strong>__init__</strong></a>(...)</dt></dl>
<dl><dt><a name="NoValidObjectError-__str__"><strong>__str__</strong></a>(...)</dt></dl>
<h3>NotFoundError</h3>
-<a name="NotFoundError">class NotFoundError</a>(<a href="#ScribusException">ScribusException</a>)
+<dl><a name="NotFoundError">class NotFoundError</a>(<a href="#ScribusException">ScribusException</a>)</dl>
<dl><dt>Method resolution order:</dt>
<dd><a href="#NotFoundError">NotFoundError</a></dd>
<dd><a href="#ScribusException">ScribusException</a></dd>
<dd><a href="#Exception">exceptions.Exception</a></dd>
</dl>
-Methods inherited from <a href="#Exception">exceptions.Exception</a>:<br>
+<dl>Methods inherited from <a href="#Exception">exceptions.Exception</a>:<br></dl>
<dl><dt><a name="NotFoundError-__getitem__"><strong>__getitem__</strong></a>(...)</dt></dl>
<dl><dt><a name="NotFoundError-__init__"><strong>__init__</strong></a>(...)</dt></dl>
<dl><dt><a name="NotFoundError-__str__"><strong>__str__</strong></a>(...)</dt></dl>
<h3>ScribusException</h3>
-<a name="ScribusException">class ScribusException</a>(<a href="#Exception">exceptions.Exception</a>)
-Methods inherited from <a href="#Exception">exceptions.Exception</a>:<br>
+<dl><a name="ScribusException">class ScribusException</a>(<a href="#Exception">exceptions.Exception</a>)
+Methods inherited from <a href="#Exception">exceptions.Exception</a>:<br></dl>
<dl><dt><a name="ScribusException-__getitem__"><strong>__getitem__</strong></a>(...)</dt></dl>
<dl><dt><a name="ScribusException-__init__"><strong>__init__</strong></a>(...)</dt></dl>
<dl><dt><a name="ScribusException-__str__"><strong>__str__</strong></a>(...)</dt></dl>
<h3>WrongFrameTypeError</h3>
-<a name="WrongFrameTypeError">class <strong>WrongFrameTypeError</strong></a>(<a href="#ScribusException">ScribusException</a>)
+<dl><a name="WrongFrameTypeError">class <strong>WrongFrameTypeError</strong></a>(<a href="#ScribusException">ScribusException</a>)</dl>
<dl>
<dt>Method resolution order:</dt>
<dd><a href="#WrongFrameTypeError">WrongFrameTypeError</a></dd>
<dd><a href="#ScribusException">ScribusException</a></dd>
<dd><a href="#Exception">exceptions.Exception</a></dd>
</dl>
-Methods inherited from <a href="#Exception">exceptions.Exception</a>:<br>
+<dl>Methods inherited from <a href="#Exception">exceptions.Exception</a>:<br></dl>
<dl>
<dt><a name="WrongFrameTypeError-__getitem__"><strong>__getitem__</strong></a>(...)</dt>
<dt><a name="WrongFrameTypeError-__init__"><strong>__init__</strong></a>(...)</dt>
More information about the scribus-commit
mailing list