Home | News | Projects | Releases
Bugs | RFE | Repositories | Help
Incorrect link fixed.
[kiriwrite/.git] / Documentation / English (British) / developer-chapter1-kiriwritepagemultiedit.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">\r
2 <html>\r
3         <head>\r
4                 <link href="style.css" REL="stylesheet" TYPE="text/css" MEDIA="screen">\r
5                 <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">\r
6                 <title>Kiriwrite Documentation - Developer Documentation - 1.9: kiriwrite_page_multiedit</title>\r
7         </head>\r
8         <body>\r
9                 <div class="menubarback">\r
10                         <div class="menubar">\r
11                                 <span class="apptitle">Kiriwrite</span>\r
12                                 <a href="index.html">Index</a> | <a href="user.html">User \r
13 Documentation</a> | <a href="tutorial.html">Tutorial Documentation</a> | \r
14 <a href="developer.html">Developer Documentation</a>\r
15                         </div>\r
16                 </div>\r
17                 <div class="pageinformation">\r
18                         <span class="pagetitle">1.9 kiriwrite_page_multiedit</span><br><br>\r
19 \r
20 kiriwrite_page_multiedit will edit multiple pages from a database. If no confirm value is specified then it will write a form asking if the selected pages should be edited and which parts should be edited on all pages. If no database or pages were specified then an error is returned.<br><br>\r
21 \r
22 kiriwrite_page_multiedit will return data that is intended for kiriwrite_output_page. All parameters are required for this subroutine.<br><br>\r
23 \r
24 <span class="heading">Parameters:</span><br><br>\r
25 \r
26 <div class="code">\r
27     kiriwrite_page_multiedit(database, newsection, altersection, newtemplate, altertemplate, newsettings, altersettings, confirm, filelist);\r
28 </div>\r
29 \r
30 <br>\r
31 \r
32 <span class="heading">Usage:</span><br><br>\r
33 \r
34 <div class="code">\r
35     $pagedata = kiriwrite_page_multiedit(&quot;database&quot;, &quot;&quot;, &quot;&quot;, &quot;&quot;, &quot;&quot;, &quot;&quot;, &quot;&quot;, 0, ['page1.html', 'page2.html', 'page3.html', 'page4.html']);<br>\r
36     $pagedata = kiriwrite_page_multiedit(&quot;database&quot;, &quot;New Section&quot;, &quot;on&quot;, &quot;newtemplate.html&quot;, &quot;on&quot;, 0, &quot;on&quot;, 1, ['page1.html', 'page2.html', 'page3.html', 'page4.html']);\r
37 </div>\r
38 \r
39 <br>\r
40 \r
41 database<br>\r
42 Specifies the database to edit the selected pages from.<br><br>\r
43 \r
44 newsection<br>\r
45 Specifies the new section for the selected pages.<br><br>\r
46 \r
47 altersection<br>\r
48 Specifies if a new section should be given for the selected pages.<br><br>\r
49 \r
50 newtemplate<br>\r
51 Specifies the new template filename for the selected pages. Specify '!none' to not use a template.<br><br>\r
52 \r
53 altertemplate<br>\r
54 Specifies if a new template filename should be given for the selected pages.<br><br>\r
55 \r
56 newsettings<br>\r
57 Specifies the new page settings to use when editing the selected pages. The following values specify what should be done to the page when using the &lt;kiriwrite:pagetitle&gt; and &lt;kiriwrite:autosection&gt; tags.<br><br>\r
58 \r
59 <table class="infotable">\r
60     <tr>\r
61         <td class="tableheading">Value</td>\r
62         <td class="tableheading">Description</td>\r
63     </tr>\r
64     <tr>\r
65         <td class="tabledata">0</td>\r
66         <td class="tabledata">Don't use the page name or section name.</td>\r
67     </tr>\r
68     <tr>\r
69         <td class="tabledata">1</td>\r
70         <td class="tabledata">Use the page name and section name.</td>\r
71     </tr>\r
72     <tr>\r
73         <td class="tabledata">2</td>\r
74         <td class="tabledata">Use the page name only.</td>\r
75     </tr>\r
76     <tr>\r
77         <td class="tabledata">3</td>\r
78         <td class="tabledata">Use the section name only.</td>\r
79     </tr>\r
80 </table>\r
81 \r
82 altersettings<br>\r
83 Specifies if a new section name should be given for the selected pages.<br><br>\r
84 \r
85 confirm<br>\r
86 Specifies if the action to edit multiple pages should be confirmed by passing a '1'.<br><br>\r
87 \r
88 filelist<br>\r
89 Specifies an array giving the list of pages to edit.\r
90                 </div>\r
91         </body>\r
92 </html>\r
Xestia Software Development
Yn Maystri
© 2006 - 2019 Xestia Software Development
Software

Xestia Address Book
Xestia Calendar
Development

Xestia Gelforn
Everything else

About
News
Privacy Policy