r25093 by jghali - #16798: importPage() argument usage documentation <MattMiller>

[scribus-commit]

Author: jghali
Date: Wed May 25 06:44:34 2022
New Revision: 25093

URL: http://scribus.net/websvn/listing.php?repname=Scribus&sc=1&rev=25093
Log:
#16798: importPage() argument usage documentation <MattMiller>

Modified:
    branches/Version15x/Scribus/doc/de/scripterapi-page.html
    branches/Version15x/Scribus/doc/en/scripterapi-page.html
    branches/Version15x/Scribus/doc/it/scripterapi-page.html
    branches/Version15x/Scribus/doc/ru/scripterapi-page.html
    branches/Version15x/Scribus/scribus/plugins/scriptplugin/cmdpage.h

Modified: branches/Version15x/Scribus/doc/de/scripterapi-page.html
URL: http://scribus.net/websvn/diff.php?repname=Scribus&rev=25093&path=/branches/Version15x/Scribus/doc/de/scripterapi-page.html
==============================================================================
--- branches/Version15x/Scribus/doc/de/scripterapi-page.html	(original)
+++ branches/Version15x/Scribus/doc/de/scripterapi-page.html	Wed May 25 06:44:34 2022
@@ -101,8 +101,16 @@
 <p>May raise IndexError if the page number is out of range.</p></dd>
 
 <dt><a name="-importPage"><strong>importPage</strong>(...)</a></dt>
-<dd><code></code>
-<p>importPage("fromDoc", (pageList), [create, importwhere, importwherePage]) Imports a set of pages (given as a tuple) from an existing document (the file name must be given). This functions maps the "Page->Import" dropdown menu function. fromDoc: string; the filename of the document to import pages from pageList: tuple with page numbers of pages to import create: number; 0 to replace existing pages, 1 (default) to insert new pages importWhere: number; the page number (of the current document) at which import the pages importWherePage: number; used if create==1; 0 to create pages before selected page; 1 to create pages after selected page; 2 (default) to create pages at the end of the document</p></dd>
+<dd><code>importPage("fromDoc", (pageList), [create, importWhere, importWherePage])</code>
+<p>Imports a set of pages (given as a tuple) from an existing document (the file name must be given). This function maps the "Page->Import" dropdown menu function.</p>
+<p>The function accepts following arguments:
+<ul>
+<li>fromDoc: string; the filename of the document to import pages from</li>
+<li>pageList: tuple; page numbers of pages to import</li>
+<li>create: number; 0 to replace existing pages, 1 (default) to insert new pages</li>
+<li>importWhere: number; used if create==1; 0 to create pages before importWherePage, 1 to create pages after importWherePage, 2 (default) to create pages at the end of the document</li>
+<li>importWherePage: number; used if create==1 and importWhere==0|1; zero-based page number (of the current document) before or after which to import the pages</li>
+</ul></p></dd>
 
 <dt><a name="-newPage"><strong>newPage</strong></a>(...)</dt>
 <dd><code>newPage(where [,"masterpage"])</code>
@@ -138,7 +146,7 @@
 
 <dt><a name="-setVGuides"><strong>setVGuides</strong></a>(...)</dt>
 <dd><code>setVGuides()</code>
-<p>The usage is analagous to that of <a href="#-setHGuides">setHGuides</a> for either adding to existing guides or replacing them.</p></dd>
+<p>The usage is analogous to that of <a href="#-setHGuides">setHGuides</a> for either adding to existing guides or replacing them.</p></dd>
 
 </dl>
 </body>

Modified: branches/Version15x/Scribus/doc/en/scripterapi-page.html
URL: http://scribus.net/websvn/diff.php?repname=Scribus&rev=25093&path=/branches/Version15x/Scribus/doc/en/scripterapi-page.html
==============================================================================
--- branches/Version15x/Scribus/doc/en/scripterapi-page.html	(original)
+++ branches/Version15x/Scribus/doc/en/scripterapi-page.html	Wed May 25 06:44:34 2022
@@ -101,8 +101,16 @@
 <p>May raise IndexError if the page number is out of range.</p></dd>
 
 <dt><a name="-importPage"><strong>importPage</strong>(...)</a></dt>
-<dd><code></code>
-<p>importPage("fromDoc", (pageList), [create, importwhere, importwherePage]) Imports a set of pages (given as a tuple) from an existing document (the file name must be given). This functions maps the "Page->Import" dropdown menu function. fromDoc: string; the filename of the document to import pages from pageList: tuple with page numbers of pages to import create: number; 0 to replace existing pages, 1 (default) to insert new pages importWhere: number; the page number (of the current document) at which import the pages importWherePage: number; used if create==1; 0 to create pages before selected page; 1 to create pages after selected page; 2 (default) to create pages at the end of the document</p></dd>
+<dd><code>importPage("fromDoc", (pageList), [create, importWhere, importWherePage])</code>
+<p>Imports a set of pages (given as a tuple) from an existing document (the file name must be given). This function maps the "Page->Import" dropdown menu function.</p>
+<p>The function accepts following arguments:
+<ul>
+<li>fromDoc: string; the filename of the document to import pages from</li>
+<li>pageList: tuple; page numbers of pages to import</li>
+<li>create: number; 0 to replace existing pages, 1 (default) to insert new pages</li>
+<li>importWhere: number; used if create==1; 0 to create pages before importWherePage, 1 to create pages after importWherePage, 2 (default) to create pages at the end of the document</li>
+<li>importWherePage: number; used if create==1 and importWhere==0|1; zero-based page number (of the current document) before or after which to import the pages</li>
+</ul></p></dd>
 
 <dt><a name="-newPage"><strong>newPage</strong></a>(...)</dt>
 <dd><code>newPage(where [,"masterpage"])</code>

Modified: branches/Version15x/Scribus/doc/it/scripterapi-page.html
URL: http://scribus.net/websvn/diff.php?repname=Scribus&rev=25093&path=/branches/Version15x/Scribus/doc/it/scripterapi-page.html
==============================================================================
--- branches/Version15x/Scribus/doc/it/scripterapi-page.html	(original)
+++ branches/Version15x/Scribus/doc/it/scripterapi-page.html	Wed May 25 06:44:34 2022
@@ -101,8 +101,16 @@
 <p>May raise IndexError if the page number is out of range.</p></dd>
 
 <dt><a name="-importPage"><strong>importPage</strong>(...)</a></dt>
-<dd><code></code>
-<p>importPage("fromDoc", (pageList), [create, importwhere, importwherePage]) Imports a set of pages (given as a tuple) from an existing document (the file name must be given). This functions maps the "Page->Import" dropdown menu function. fromDoc: string; the filename of the document to import pages from pageList: tuple with page numbers of pages to import create: number; 0 to replace existing pages, 1 (default) to insert new pages importWhere: number; the page number (of the current document) at which import the pages importWherePage: number; used if create==1; 0 to create pages before selected page; 1 to create pages after selected page; 2 (default) to create pages at the end of the document</p></dd>
+<dd><code>importPage("fromDoc", (pageList), [create, importWhere, importWherePage])</code>
+<p>Imports a set of pages (given as a tuple) from an existing document (the file name must be given). This function maps the "Page->Import" dropdown menu function.</p>
+<p>The function accepts following arguments:
+<ul>
+<li>fromDoc: string; the filename of the document to import pages from</li>
+<li>pageList: tuple; page numbers of pages to import</li>
+<li>create: number; 0 to replace existing pages, 1 (default) to insert new pages</li>
+<li>importWhere: number; used if create==1; 0 to create pages before importWherePage, 1 to create pages after importWherePage, 2 (default) to create pages at the end of the document</li>
+<li>importWherePage: number; used if create==1 and importWhere==0|1; zero-based page number (of the current document) before or after which to import the pages</li>
+</ul></p></dd>
 
 <dt><a name="-newPage"><strong>newPage</strong></a>(...)</dt>
 <dd><code>newPage(where [,"masterpage"])</code>
@@ -138,7 +146,7 @@
 
 <dt><a name="-setVGuides"><strong>setVGuides</strong></a>(...)</dt>
 <dd><code>setVGuides()</code>
-<p>The usage is analagous to that of <a href="#-setHGuides">setHGuides</a> for either adding to existing guides or replacing them.</p></dd>
+<p>The usage is analogous to that of <a href="#-setHGuides">setHGuides</a> for either adding to existing guides or replacing them.</p></dd>
 
 </dl>
 </body>

Modified: branches/Version15x/Scribus/doc/ru/scripterapi-page.html
URL: http://scribus.net/websvn/diff.php?repname=Scribus&rev=25093&path=/branches/Version15x/Scribus/doc/ru/scripterapi-page.html
==============================================================================
--- branches/Version15x/Scribus/doc/ru/scripterapi-page.html	(original)
+++ branches/Version15x/Scribus/doc/ru/scripterapi-page.html	Wed May 25 06:44:34 2022
@@ -101,8 +101,16 @@
 <p>May raise IndexError if the page number is out of range.</p></dd>
 
 <dt><a name="-importPage"><strong>importPage</strong>(...)</a></dt>
-<dd><code></code>
-<p>importPage("fromDoc", (pageList), [create, importwhere, importwherePage]) Imports a set of pages (given as a tuple) from an existing document (the file name must be given). This functions maps the "Page->Import" dropdown menu function. fromDoc: string; the filename of the document to import pages from pageList: tuple with page numbers of pages to import create: number; 0 to replace existing pages, 1 (default) to insert new pages importWhere: number; the page number (of the current document) at which import the pages importWherePage: number; used if create==1; 0 to create pages before selected page; 1 to create pages after selected page; 2 (default) to create pages at the end of the document</p></dd>
+<dd><code>importPage("fromDoc", (pageList), [create, importWhere, importWherePage])</code>
+<p>Imports a set of pages (given as a tuple) from an existing document (the file name must be given). This function maps the "Page->Import" dropdown menu function.</p>
+<p>The function accepts following arguments:
+<ul>
+<li>fromDoc: string; the filename of the document to import pages from</li>
+<li>pageList: tuple; page numbers of pages to import</li>
+<li>create: number; 0 to replace existing pages, 1 (default) to insert new pages</li>
+<li>importWhere: number; used if create==1; 0 to create pages before importWherePage, 1 to create pages after importWherePage, 2 (default) to create pages at the end of the document</li>
+<li>importWherePage: number; used if create==1 and importWhere==0|1; zero-based page number (of the current document) before or after which to import the pages</li>
+</ul></p></dd>
 
 <dt><a name="-newPage"><strong>newPage</strong></a>(...)</dt>
 <dd><code>newPage(where [,"masterpage"])</code>
@@ -138,7 +146,7 @@
 
 <dt><a name="-setVGuides"><strong>setVGuides</strong></a>(...)</dt>
 <dd><code>setVGuides()</code>
-<p>The usage is analagous to that of <a href="#-setHGuides">setHGuides</a> for either adding to existing guides or replacing them.</p></dd>
+<p>The usage is analogous to that of <a href="#-setHGuides">setHGuides</a> for either adding to existing guides or replacing them.</p></dd>
 
 </dl>
 </body>

Modified: branches/Version15x/Scribus/scribus/plugins/scriptplugin/cmdpage.h
URL: http://scribus.net/websvn/diff.php?repname=Scribus&rev=25093&path=/branches/Version15x/Scribus/scribus/plugins/scriptplugin/cmdpage.h
==============================================================================
--- branches/Version15x/Scribus/scribus/plugins/scriptplugin/cmdpage.h	(original)
+++ branches/Version15x/Scribus/scribus/plugins/scriptplugin/cmdpage.h	Wed May 25 06:44:34 2022
@@ -215,12 +215,12 @@
 PyDoc_STRVAR(scribus_importpage__doc__,
 QT_TR_NOOP("importPage(\"fromDoc\", (pageList), [create, imortwhere, importwherePage])\n\
 \n\
-Imports a set of pages (given as a tuple) from an existing document (the file name must be given). This functions maps the \"Page->Import\" dropdown menu function.\n\
+Imports a set of pages (given as a tuple) from an existing document (the file name must be given). This function maps the \"Page->Import\" dropdown menu function.\n\
 fromDoc: string; the filename of the document to import pages from\n\
-pageList: tuple with page numbers of pages to import\n\
+pageList: tuple; page numbers of pages to import\n\
 create: number; 0 to replace existing pages, 1 (default) to insert new pages\n\
-importWhere: number; the page number (of the current document) at which import the pages\n\
-importWherePage: number; used if create==1; 0 to create pages before selected page; 1 to create pages after selected page; 2 (default) to create pages at the end of the document\n\
+importWhere: number; used if create==1; 0 to create pages before importWherePage, 1 to create pages after importWherePage, 2 (default) to create pages at the end of the document\n\
+importWherePage: number; used if create==1 and importWhere==0|1; zero-based page number (of the current document) before or after which to import the pages\n\
 "));
 PyObject *scribus_importpage(PyObject */*self*/, PyObject* args);