Home | News | Projects | Releases
Bugs | RFE | Repositories | Help
Even more modifications.
[kiriwrite/.git] / Documentation / English (British) / developer-chapter1-kiriwritepageadd.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.3: kiriwrite_page_add</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.3 kiriwrite_page_add</span><br><br>\r
19 \r
20 kiriwrite_page_add will add a page to the selected database. If the confirm value is not supplied then it will write out a form for adding a page and if no database is specified then an error is returned saying no database was specified.<br><br>\r
21 \r
22 kiriwrite_page_add will return data that is intended for kiriwrite_output_page.<br><br>\r
23 \r
24 <span class="heading">Parameters:</span><br><br>\r
25 \r
26 <div class="code">\r
27     kiriwrite_page_add(database, pagefilename, pagename, pagedescription, pagesection, pagetemplate, pagesettings, pagecontent, confirm);\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_add(“database”);<br>\r
36 $pagedata = kiriwrite_page_add(“database”, “pagefilename.html”, “Page Name”, “Page Description”, “Page Section”, “pagetemplate.html”, 1, “Page Content, blah, blah, blah, blah”, 1);\r
37 </div>\r
38 \r
39 <br>\r
40 \r
41 database<br>\r
42 Specifies the database to add a page to.<br><br>\r
43 \r
44 <i>pagefilename</i><br>\r
45 Specifies the page filename of the page to add. This is required when adding a page and cannot be blank.<br><br>\r
46 \r
47 <i>pagename</i><br>\r
48 Specifies the page name for the new page. This is required when adding a page.<br><br>\r
49 \r
50 <i>pagesection</i><br>\r
51 Specifies the page section for the new page. This is required when adding a page.<br><br>\r
52 \r
53 <i>pagetemplate</i><br>\r
54 Specifies the page template for the new page. This is required when adding a page and cannot be blank. Specifying '!none' will mean that the page will not use a template at all.<br><br>\r
55 \r
56 <i>pagesettings</i><br>\r
57 Specifies the page settings for the new page. This is required when adding a page and cannot be blank. 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 <br>\r
83 \r
84 <i>pagecontent</i><br>\r
85 Specifies the page content to use for the new page.<br><br>\r
86 \r
87 <i>confirm</i><br>\r
88 Specifies if the action to add the page should be confirmed by passing a '1'.\r
89                 </div>\r
90         </body>\r
91 </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