Author: gpittman
Date: Fri Feb 23 19:08:27 2018
New Revision: 22406
URL: http://scribus.net/websvn/listing.php?repname=Scribus&sc=1&rev=22406
Log:
Updated manual to clarify usage of PAPER_* constants, which can only be used
with points as page unit
Modified:
trunk/Scribus/doc/en/scripterapi-constants.html
trunk/Scribus/doc/en/scripterapi-doc.html
Modified: trunk/Scribus/doc/en/scripterapi-constants.html
URL:
http://scribus.net/websvn/diff.php?repname=Scribus&rev=22406&path=/trunk/Scribus/doc/en/scripterapi-constants.html
==============================================================================
--- trunk/Scribus/doc/en/scripterapi-constants.html (original)
+++ trunk/Scribus/doc/en/scripterapi-constants.html Fri Feb 23 19:08:27 2018
@@ -69,6 +69,7 @@
</dl>
<h4>Definitions for Page Formats: </h4>
+<p>If you are using these, it's important to understand that these constants
are simply tuples of these specific numbers. Therefore, they must be used with
the UNIT_POINTS constant. What you can do, for example, is use them to create a
document in points, then switch the units of the document with the setUnit()
command.</p>
<dl>
<dt>PAPER_A0</dt>
<dd>Paperformat A0 = 2380 x 3368 Points</dd>
Modified: trunk/Scribus/doc/en/scripterapi-doc.html
URL:
http://scribus.net/websvn/diff.php?repname=Scribus&rev=22406&path=/trunk/Scribus/doc/en/scripterapi-doc.html
==============================================================================
--- trunk/Scribus/doc/en/scripterapi-doc.html (original)
+++ trunk/Scribus/doc/en/scripterapi-doc.html Fri Feb 23 19:08:27 2018
@@ -62,7 +62,7 @@
<li>facingPages = FACINGPAGES, NOFACINGPAGES</li>
<li>firstSideLeft = FIRSTPAGELEFT, FIRSTPAGERIGHT</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>The values for width, height and the margins are expressed in the given
unit for the document. PAPER_* constants are a series of tuples specific to the
document size, with the values corresponding to points. Therefore, if you are
creating a document and using UNIT_MILLIMETERS for example, DO NOT USE the
PAPER_* constants. A workaround can be to use the PAPER_* constant along with
UNIT_POINTS, then follow the command with another command,
setUnit(UNIT_MILLIMETERS).</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>
@@ -90,8 +90,7 @@
<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>
+for the document. PAPER_* constants are a series of tuples specific to the
document size, with the values corresponding to points. Therefore, if you are
creating a document and using UNIT_MILLIMETERS for example, DO NOT USE the
PAPER_* constants. A workaround can be to use the PAPER_* constant along with
UNIT_POINTS, then follow the command with another command,
setUnit(UNIT_MILLIMETERS).</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>
_______________________________________________
scribus-commit mailing list
scribus-commit@lists.scribus.net
http://lists.scribus.net/mailman/listinfo/scribus-commit
