View Issue Details

IDProjectCategoryView StatusLast Update
0016798ScribusScripterpublic2022-05-25 06:45
ReporterMattMiller Assigned Tojghali  
PrioritynormalSeverityminorReproducibilityalways
Status resolvedResolutionfixed 
Product Version1.5.9.svn 
Fixed in Version1.5.9.svn 
Summary0016798: importPage() argument usage documentation
DescriptionThe documentation for the scripter importPage() function doesn't match how the arguments are actually used by the function. The attached patch corrects the documentation to match the behavior of the function, which also matches how the input fields of the GUI "Page -> Import" dialog are used.
Tagsscripter
PatchYes

Activities

MattMiller

2022-05-24 20:22

reporter  

importPage_arg_usage.txt (1,961 bytes)   
Index: Scribus/doc/en/scripterapi-page.html
===================================================================
--- Scribus/doc/en/scripterapi-page.html        (revision 25090)
+++ Scribus/doc/en/scripterapi-page.html        (working copy)
@@ -102,7 +102,7 @@

 <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-&gt;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>
+<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 function maps the "Page-&gt;Import" dropdown menu function. fromDoc: string; the filename of the document to import pages from. pageList: tuple; page numbers of pages to import. create: number; 0 to replace existing pages, 1 (default) to insert new pages. 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. 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.</p></dd>

 <dt><a name="-newPage"><strong>newPage</strong></a>(...)</dt>
 <dd><code>newPage(where [,"masterpage"])</code>
importPage_arg_usage.txt (1,961 bytes)   

MattMiller

2022-05-24 20:49

reporter   ~0049657

Forgot to check that a patch is attached.

jghali

2022-05-25 06:45

administrator   ~0049661

Thanks, I took the opportunity to reformat importPage() documentation for better readability.

Issue History

Date Modified Username Field Change
2022-05-24 20:22 MattMiller New Issue
2022-05-24 20:22 MattMiller Tag Attached: scripter
2022-05-24 20:22 MattMiller File Added: importPage_arg_usage.txt
2022-05-24 20:49 MattMiller Note Added: 0049657
2022-05-25 00:45 jghali Patch No => Yes
2022-05-25 06:43 jghali Summary importPage() Argument Usage Documentation => importPage() argument usage documentation
2022-05-25 06:45 jghali Assigned To => jghali
2022-05-25 06:45 jghali Status new => resolved
2022-05-25 06:45 jghali Resolution open => fixed
2022-05-25 06:45 jghali Fixed in Version => 1.5.9.svn
2022-05-25 06:45 jghali Note Added: 0049661