<span class="heading">Parameters:</span><br><br>\r
\r
<div class="code">\r
- kiriwrite_compile_makepages(type, confirm, selectedlist);\r
+ kiriwrite_compile_makepages(type, confirm, override, overridetemplate, selectedlist);\r
</div>\r
\r
<br>\r
<span class="heading">Usage:</span><br><br>\r
\r
<div class="code">\r
- $pagedata = kiriwrite_compile_makepages(“single”, 0, ['database1']);<br>\r
- $pagedata = kiriwrite_compile_makepages(“single”, 1, ['database1']);<br>\r
- $pagedata = kiriwrite_compile_makepages(“multiple”, 0, ['database1','database2','database3','database4']);<br>\r
- $pagedata = kiriwrite_compile_makepages(“multiple”, 1, ['database1','database2','database3','database4']);\r
+ $pagedata = kiriwrite_compile_makepages(“single”, 0, 0, "", ['database1']);<br>\r
+ $pagedata = kiriwrite_compile_makepages(“single”, 1, 0, "", ['database1']);<br>\r
+ $pagedata = kiriwrite_compile_makepages(“multiple”, 0, 1, "template.html", ['database1','database2','database3','database4']);<br>\r
+ $pagedata = kiriwrite_compile_makepages(“multiple”, 1, 0, "", ['database1','database2','database3','database4']);\r
</div>\r
\r
<br>\r
confirm<br>\r
Specifies if the action to compile the selected database should be confirmed by passing a '1'. This is required every time the subroutine is called.<br><br>\r
\r
+override<br>\r
+Override the template being used with the overridetemplate value.<br><br>\r
+\r
+overridetemplate<br>\r
+Override the template using the filename given.<br><br>\r
+\r
selectedlist<br>\r
Specifies the list of databases to compile as an array. This is required every time the subroutine is called.\r
</div>\r
<span class="heading">Parameters:</span><br><br>\r
\r
<div class="code">\r
- kiriwrite_filter_list();\r
+ kiriwrite_filter_list(<i>browsenumber</i>);\r
</div>\r
\r
<br>\r
<span class="heading">Usage:</span><br><br>\r
\r
<div class="code">\r
- $pagedata = kiriwrite_filter_list();\r
+ $pagedata = kiriwrite_filter_list(1);\r
</div>\r
\r
+<br>\r
+\r
+<i>browsenumber</i><br>\r
+Specifies the number of which list of filters to view.\r
</div>\r
</body>\r
</html>\r
<head>\r
<link href="style.css" REL="stylesheet" TYPE="text/css" MEDIA="screen">\r
<meta http-equiv="Content-Type" content="text/html;charset=UTF-8">\r
- <title>Kiriwrite Documentation - Developer Documentation - 1.40: kiriwrite_output_xml</title>\r
+ <title>Kiriwrite Documentation - Developer Documentation - 1.40: kiriwrite_output_config</title>\r
</head>\r
<body>\r
<div class="menubarback">\r
</div>\r
</div>\r
<div class="pageinformation">\r
- <span class="pagetitle">1.40 kiriwrite_output_xml</span><br><br>\r
+ <span class="pagetitle">1.40 kiriwrite_output_config</span><br><br>\r
\r
-kiriwrite_output_xml outputs a file in the XML format and is mainly used for writing a configuration file. All parameters in the subroutine are required.<br><br>\r
+kiriwrite_output_config outputs a configuration file and is mainly used for writing an updated configuration file. All parameters in the subroutine are required.<br><br>\r
\r
<span class="heading">Parameters:</span><br><br>\r
\r
<div class="code">\r
- kiriwrite_output_xml(filename, type, options);\r
+ kiriwrite_output_config(options);\r
</div>\r
\r
<br>\r
<span class="heading">Usage:</span><br><br>\r
\r
<div class="code">\r
- kiriwrite_output_xml("kiriwrite.xml", "config", { DatabaseDirectory => “db”, OutputDirectory => “output”, ImagesURIPath => “/images/kiriwrite”, DateTimeFormat => “DD/MM/YY (hh:mm:ss)”, SystemLanguage => “en-GB”, PresentationModule => “HTML4S”, DatabaseModule => “SQLite”, DatabaseServer => “localhost”, DatabasePort => “3306”, DatabaseProtocol => “tcp”, DatabaseSQLDatabase => “database”, DatabaseUsername => “username”, DatabasePassword => “password”, DatabaseTablePrefix => “tableprefix” });\r
+ kiriwrite_output_config({ DatabaseDirectory => “db”, OutputDirectory => “output”, ImagesURIPath => “/images/kiriwrite”, DateTimeFormat => “DD/MM/YY (hh:mm:ss)”, SystemLanguage => “en-GB”, PresentationModule => “HTML4S”, TextAreaCols => 50, TextAreaRows => 10, DatabaseModule => “SQLite”, DatabaseServer => “localhost”, DatabasePort => “3306”, DatabaseProtocol => “tcp”, DatabaseSQLDatabase => “database”, DatabaseUsername => “username”, DatabasePassword => “password”, DatabaseTablePrefix => “tableprefix” });\r
</div>\r
\r
<br>\r
<td class="tabledata">PresentationModule</td>\r
<td class="tabledata">Specifies the presentation module in Kiriwrite to use.</td>\r
</tr>\r
+ <tr>\r
+ <td class="tabledata">TextAreaCols</td>\r
+ <td class="tabledata">Specifies the width of the text area.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">TextAreaRows</td>\r
+ <td class="tabledata">Specifies the height of the text area.</td>\r
+ </tr>\r
<tr>\r
<td class="tabledata">DatabaseModule</td>\r
<td class="tabledata">Specifies the database module in Kiriwrite to use.</td>\r
<span class="heading">Parameters:</span><br><br>\r
\r
<div class="code">\r
- kiriwrite_page_list(database);\r
+ kiriwrite_page_list(<i>database</i>, <i>browsenumber</i>);\r
</div>\r
\r
<br>\r
<span class="heading">Usage:</span><br><br>\r
\r
<div class="code">\r
- $pagedata = kiriwrite_page_list(“database”);\r
+ $pagedata = kiriwrite_page_list(“database”, 1);\r
</div>\r
\r
<br>\r
\r
-database<br>\r
-Specifies the database to get the list of pages from.\r
+<i>database</i><br>\r
+Specifies the database to get the list of pages from.<br><br>\r
+<i>browsenumber</i><br>\r
+Specifies the number of which list of pages to view.\r
</div>\r
</body>\r
</html>\r
<span class="heading">Usage:</span><br><br>\r
\r
<div class="code">\r
- $pagedata = kiriwrite_settings_edit({ DatabaseDirectory => “db”, OutputDirectory => “output”, ImagesURIPath => “/images/kiriwrite”, DateTimeFormat => “DD/MM/YY (hh:mm:ss)”, SystemLanguage => “en-GB”, PresentationModule => “HTML4S”, DatabaseModule => “SQLite”, DatabaseServer => “localhost”, DatabasePort => “3306”, DatabaseProtocol => “tcp”, DatabaseSQLDatabase => “database”, DatabaseUsername => “username”, DatabasePasswordKeep => 0, DatabasePassword => “password”, DatabaseTablePrefix = “kiridev” });\r
+ $pagedata = kiriwrite_settings_edit({ DatabaseDirectory => “db”, OutputDirectory => “output”, ImagesURIPath => “/images/kiriwrite”, DateTimeFormat => “DD/MM/YY (hh:mm:ss)”, SystemLanguage => “en-GB”, PresentationModule => “HTML4S”, TextAreaCols => 50, TextAreaRows => 10, DatabaseModule => “SQLite”, DatabaseServer => “localhost”, DatabasePort => “3306”, DatabaseProtocol => “tcp”, DatabaseSQLDatabase => “database”, DatabaseUsername => “username”, DatabasePasswordKeep => 0, DatabasePassword => “password”, DatabaseTablePrefix = “kiridev” });\r
</div>\r
\r
<br>\r
<td class="tabledata">PresentationModule</td>\r
<td class="tabledata">Specifies the presentation module in Kiriwrite to use.</td>\r
</tr>\r
+ <tr>\r
+ <td class="tabledata">TextAreaCols</td>\r
+ <td class="tabledata">Specifies the width of the text area.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">TextAreaRows</td>\r
+ <td class="tabledata">Specifies the height of the text area.</td>\r
+ </tr>\r
<tr>\r
<td class="tabledata">DatabaseModule</td>\r
<td class="tabledata">Specifies the database module in Kiriwrite to use.</td>\r
<span class="heading">Parameters:</span><br><br>\r
\r
<div class="code">\r
- kiriwrite_template_list();\r
+ kiriwrite_template_list(<i>browsenumber</i>);\r
</div>\r
\r
<br>\r
<span class="heading">Usage:</span><br><br>\r
\r
<div class="code">\r
- $pagedata = kiriwrite_template_list();\r
+ $pagedata = kiriwrite_template_list(1);\r
</div>\r
+\r
+<br>\r
+\r
+<i>browsenumber</i><br>\r
+Specifies the number of which list of templates to view.\r
</div>\r
</body>\r
</html>\r
<span class="heading">Usage:</span><br><br>\r
\r
<div class="code">\r
- $kiriwrite_presmodule->addcheckbox(“checkbox”, { Description => “Check box”, Style => “checkboxstyle”, LineBreak => 1 } );\r
+ $kiriwrite_presmodule->addcheckbox(“checkbox”, { OptionDescription => “Check box”, Style => “checkboxstyle”, LineBreak => 1 } );\r
</div>\r
\r
<br>\r
--- /dev/null
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">\r
+<html>\r
+ <head>\r
+ <link href="style.css" REL="stylesheet" TYPE="text/css" MEDIA="screen">\r
+ <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">\r
+ <title>Kiriwrite Documentation - Developer Documentation - 3.42: getfiltercount</title>\r
+ </head>\r
+ <body>\r
+ <div class="menubarback">\r
+ <div class="menubar">\r
+ <span class="apptitle">Kiriwrite</span>\r
+ <a href="index.html">Index</a> | <a href="user.html">User \r
+Documentation</a> | <a href="tutorial.html">Tutorial Documentation</a> | \r
+<a href="developer.html">Developer Documentation</a>\r
+ </div>\r
+ </div>\r
+ <div class="pageinformation">\r
+ <div class="pagetitle">3.42 getfiltercount</div><br><br>\r
+\r
+Get the count of how many filters are in the filter database.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->getfiltercount();\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->connectfilter();<br><br>\r
+ $filter_count = $kiriwrite_dbmodule->getfiltercount();\r
+</div>\r
+ </div>\r
+ </body>\r
+</html>\r
\r
<div class="code">\r
$kiriwrite_dbmodule->connectfilter();\r
- $kiriwrite_dbmodule->getfilterinfo({ FilterID => 1 });\r
+ $kiriwrite_dbmodule->getfilterinfo({ FilterID => 1, Reduced => 1 });\r
</div>\r
\r
<br>\r
<td class="tabledata">FilterID</td>\r
<td class="tabledata">Specifies the filter identification number to get the filter information from.</td>\r
</tr>\r
+ <tr>\r
+ <td class="tabledata">Reduced</td>\r
+ <td class="tabledata">Gets a reduced version of the filter information (filter identification number, priority, filter find setting and filter replace setting).</td>\r
+ </tr>\r
</table>\r
\r
<br>\r
<span class="heading">Parameters:</span><br><br>\r
\r
<div class="code">\r
- $kiriwrite_dbmodule->getfilterlist();\r
+ $kiriwrite_dbmodule->getfilterlist(<i>options</i>);\r
</div>\r
\r
<br>\r
\r
<div class="code">\r
$kiriwrite_dbmodule->connectfilter();<br>\r
- @filterlist = $kiriwrite_dbmodule->getfilterlist();\r
+ @filterlist = $kiriwrite_dbmodule->getfilterlist({ StartFrom => 0, Limit => 50 });\r
</div>\r
\r
+<br><br>\r
+\r
+<table class="infotable">\r
+ <tr>\r
+ <td class="tableheading">Value</td>\r
+ <td class="tableheading">Description</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">StartFrom</td>\r
+ <td class="tabledata">Specifies which filter entry to start from.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Limit</td>\r
+ <td class="tabledata">Specifies how many filters should be retrieved.</td>\r
+ </tr>\r
+</table>\r
+\r
<br>\r
\r
If a database error occurs while getting the list of filters from the filter database then the error returned should be 'FilterDatabaseError' in the $error scalar and information about the error should be in the $errorext scalar.\r
--- /dev/null
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">\r
+<html>\r
+ <head>\r
+ <link href="style.css" REL="stylesheet" TYPE="text/css" MEDIA="screen">\r
+ <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">\r
+ <title>Kiriwrite Documentation - Developer Documentation - 3.40: getpagecount</title>\r
+ </head>\r
+ <body>\r
+ <div class="menubarback">\r
+ <div class="menubar">\r
+ <span class="apptitle">Kiriwrite</span>\r
+ <a href="index.html">Index</a> | <a href="user.html">User \r
+Documentation</a> | <a href="tutorial.html">Tutorial Documentation</a> | \r
+<a href="developer.html">Developer Documentation</a>\r
+ </div>\r
+ </div>\r
+ <div class="pageinformation">\r
+ <div class="pagetitle">3.40: getpagecount</div><br><br>\r
+\r
+Get the count of how many pages are in the database.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->getpagecount();\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->selectdb(“database”);<br><br>\r
+ $page_count = $kiriwrite_dbmodule->getpagecount();\r
+</div>\r
+\r
+ </div>\r
+ </body>\r
+</html>\r
\r
<div class="code">\r
$kiriwrite_dbmodule->selectdb(“database”);<br>\r
- %pageinfo = $kiriwrite_dbmodule->getpageinfo({ PageFilename => “pagefilename.html” });\r
+ %pageinfo = $kiriwrite_dbmodule->getpageinfo({ PageFilename => “pagefilename.html”, Reduced => 1 });\r
</div>\r
\r
<br>\r
<span class="heading">Parameters:</span><br><br>\r
\r
<div class="code">\r
- $kiriwrite_dbmodule->getpagelist();\r
+ $kiriwrite_dbmodule->getpagelist(<i>options</i>);\r
</div>\r
\r
<br>\r
\r
<div class="code">\r
$kiriwrite_dbmodule->selectdb(“database”);<br>\r
- @pagelist = $kiriwrite_dbmodule->getpagelist();\r
+ @pagelist = $kiriwrite_dbmodule->getpagelist({ StartFrom => 0, Limit => 50 });\r
</div>\r
\r
+<br><br>\r
+\r
+<table class="infotable">\r
+ <tr>\r
+ <td class="tableheading">Value</td>\r
+ <td class="tableheading">Description</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">StartFrom</td>\r
+ <td class="tabledata">Specifies which page entry to start from.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Limit</td>\r
+ <td class="tabledata">Specifies how many pages that should be retrieved.</td>\r
+ </tr>\r
+</table>\r
+\r
<br>\r
\r
If a database error occurs while getting the list of pages in the database then the error returned should be 'DatabaseError' in the $error scalar and information about the error should be in the $errorext scalar.\r
--- /dev/null
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">\r
+<html>\r
+ <head>\r
+ <link href="style.css" REL="stylesheet" TYPE="text/css" MEDIA="screen">\r
+ <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">\r
+ <title>Kiriwrite Documentation - Developer Documentation - 3.41: gettemplatecount</title>\r
+ </head>\r
+ <body>\r
+ <div class="menubarback">\r
+ <div class="menubar">\r
+ <span class="apptitle">Kiriwrite</span>\r
+ <a href="index.html">Index</a> | <a href="user.html">User \r
+Documentation</a> | <a href="tutorial.html">Tutorial Documentation</a> | \r
+<a href="developer.html">Developer Documentation</a>\r
+ </div>\r
+ </div>\r
+ <div class="pageinformation">\r
+ <div class="pagetitle">3.41: gettemplatecount</div><br><br>\r
+\r
+Get the count of how many templates are in the template database.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->gettemplatecount();\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->connecttemplate();<br><br>\r
+ $template_count = $kiriwrite_dbmodule->gettemplatecount();\r
+</div>\r
+ </div>\r
+ </body>\r
+</html>\r
<span class="heading">Usage:</span><br><br>\r
\r
<div class="code">\r
- $kiriwrite_dbmodule->gettemplateinfo({ TemplateFilename => “template.html” });\r
+ $kiriwrite_dbmodule->gettemplateinfo({ TemplateFilename => “template.html”, Reduced => 1 });\r
</div>\r
\r
<br>\r
<td class="tabledata">TemplateFilename</td>\r
<td class="tabledata">Specifies the template filename to get the information from.</td>\r
</tr>\r
+ <tr>\r
+ <td class="tabledata">Reduced</td>\r
+ <td class="tabledata">Gets a reduced version of the template information (template filename, name, description and last modified date).</td>\r
+ </tr>\r
</table>\r
\r
<br>\r
<span class="heading">Parameters:</span><br><br>\r
\r
<div class="code">\r
- $kiriwrite_dbmodule->gettemplatelist();\r
+ $kiriwrite_dbmodule->gettemplatelist(<i>options</i>);\r
</div>\r
\r
<br>\r
<span class="heading">Usage:</span><br><br>\r
\r
<div class="code">\r
- $kiriwrite_dbmodule->gettemplatelist();\r
+ $kiriwrite_dbmodule->gettemplatelist({ StartFrom => 0, Limit => 50 });\r
</div>\r
\r
<br>\r
\r
+<i>options</i><br>\r
+Specifies the following options as a hash (in any order).<br><br>\r
+\r
+<table class="infotable">\r
+ <tr>\r
+ <td class="tableheading">Value</td>\r
+ <td class="tableheading">Description</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">StartFrom</td>\r
+ <td class="tabledata">Specifies which template entry to start from.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Limit</td>\r
+ <td class="tabledata">Specifies how many templates should be retrieved.</td>\r
+ </tr>\r
+</table>\r
+\r
+<br>\r
+\r
If a database error occurs while getting the list of templates then the error returned should be 'TemplateDatabaseError' in the $error scalar and the information about the error should be placed in the $errorext scalar.\r
</div>\r
</body>\r
<a href="developer-chapter1-kiriwritefilepermissions.html">1.37 kiriwrite_filepermissions</a><br>\r
<a href="developer-chapter1-kiriwriteutf8convert.html">1.38 kiriwrite_utf8convert</a><br>\r
<a href="developer-chapter1-kiriwriteoutputheader.html">1.39 kiriwrite_output_header</a><br>\r
- <a href="developer-chapter1-kiriwriteoutputxml.html">1.40 kiriwrite_output_xml</a><br>\r
+ <a href="developer-chapter1-kiriwriteoutputconfig.html">1.40 kiriwrite_output_config</a><br>\r
<a href="developer-chapter1-kiriwriteoutputpage.html">1.41 kiriwrite_output_page</a><br>\r
<a href="developer-chapter2.html">Chapter 2: Presentation Module</a><br>\r
<a href="developer-chapter2-guidance.html">2.1 Guidance</a><br>\r
<a href="developer-chapter3-addfilter.html">3.37 addfilter</a><br>\r
<a href="developer-chapter3-editfilter.html">3.38 editfilter</a><br>\r
<a href="developer-chapter3-deletefilter.html">3.39 deletefilter</a><br>\r
+ <a href="developer-chapter3-getpagecount.html">3.40 getpagecount</a><br>\r
+ <a href="developer-chapter3-gettemplatecount.html">3.41 gettemplatecount</a><br>\r
+ <a href="developer-chapter3-getfiltercount.html">3.42 getfiltercount</a><br>\r
<a href="developer-chapter4.html">Chapter 4: Kiriwrite Page Format</a><br>\r
<a href="developer-chapter5.html">Chapter 5: Languages</a><br>\r
</div>\r
</div>\r
</div>\r
<div class="pageinformation">\r
- <div class="pagetitle">Introduction</span><br><br>\r
+ <span class="pagetitle">Introduction</span><br><br>\r
\r
This documentation provides a tutorial which allows the main functions of Kiriwrite to be learned.<br><br>\r
\r
-The tutorial consists of the following:<br><br>\r
+The tutorial consists of the following:<br>\r
\r
<ul>\r
<li>Create a 3 page website using the same layout on all of the pages.</li>\r
\r
<span class="heading">Contents</span><br>\r
<a href="tutorial-introduction.html">Introduction</a><br>\r
-<a href="tutorial-1.html">Tutorial 1: Three Page Website with layout</a><br>\r
-<a href="tutorial-2.html">Tutorial 2: 5 page website and also using the filter database</a><br>\r
-<a href="tutorial-3.html">Tutorial 3: 10 page website with 5 pages per layout</a>\r
+<a href="tutorial-tutorial1.html">Tutorial 1: Three Page Website with layout</a><br>\r
+<a href="tutorial-tutorial2.html">Tutorial 2: 5 page website and also using the filter database</a><br>\r
+<a href="tutorial-tutorial3.html">Tutorial 3: 10 page website with 5 pages per layout</a>\r
</div>\r
</body>\r
</html>\r
<td class="tabledata">Images (URI path)</td>\r
<td class="tabledata">Specifies the Images (URI path) to use for displaying images when using the page template with Kiriwrite.</td>\r
</tr>\r
+ <tr>\r
+ <td class="tabledata">Text Area Columns</td>\r
+ <td class="tabledata">Specifies the width of the text area when editing notes, pages and templates.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Text Area Rows</td>\r
+ <td class="tabledata">Specifies the height of the text area when editing notes, pages and templates.</td>\r
+ </tr>\r
<tr>\r
<td class="tabledata">Date Format</td>\r
<td class="tabledata">Specifies the date format to use when list the pages from the database. A selection of date formats are available from the drop down box or a custom one can be entered into the text box next to the drop down box.</td>\r
<b>Presentation</b> – Presentation modules are stored here.<br>\r
<b>db</b> – Default database directory (for file based Database modules).<br>\r
<b>lang</b> – The directory for language files in Kiriwrite.<br>\r
+ <b>lib</b> - Library files that are used by Kiriwrite.<br>\r
<b>output</b> – The output directory when pages are compiled.<br>\r
<b>misc</b> – Miscellaneous files (mainly for developers).<br>\r
<b>non-cgi-files</b> – Non CGI files that need to be placed outside of the cgi-bin folder.<br><br>\r
<td class="tabledata"><i>None</i></td>\r
</tr>\r
<tr>\r
- <td class="tabledata">lang/*.xml</td>\r
+ <td class="tabledata">lang/*.lang</td>\r
+ <td class="tabledata">R</td>\r
+ <td class="tabledata">R</td>\r
+ <td class="tabledata"><i>None</i></td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata"><b>lib</b></td>\r
+ <td class="tabledata">R</td>\r
+ <td class="tabledata">R</td>\r
+ <td class="tabledata"><i>None</i></td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">lib\*.lib</td>\r
<td class="tabledata">R</td>\r
<td class="tabledata">R</td>\r
<td class="tabledata"><i>None</i></td>\r
To extract the bzip2 archive, the following command should be preformed when switched to the correct directory to extract from.<br><br>\r
\r
<div class="code">\r
- bzip2 -d -c <i>(path)</i>/kiriwrite-0.1.0.tar.bzip2 | tar -xv\r
+ bzip2 -d -c <i>(path)</i>/kiriwrite-0.1.0.tar.bz2 | tar -xv\r
</div>\r
\r
<br>\r
\r
<span class="heading">2.5.1 Compiling a database</span><br><br>\r
\r
-To compile a database, click on the 'Compile' link opposite the database name you want to compile, a message then appears asking if the database should really be compiled. Clicking on the 'Compile Database' button will display a log of pages that have been compiled and any error messages that might appear with the link to return to the list of databases to compile at the end of the log. Clicking on the 'Return to the compile database list.' will return to the list of databases to compile.<br><br>\r
+To compile a database, click on the 'Compile' link opposite the database name you want to compile, a message then appears asking if the database should really be compiled. Clicking on the 'Compile Database' button will display a log of pages that have been compiled and any error messages that might appear with the link to return to the list of databases to compile at the end of the log. <br><br>\r
+\r
+When compiling a database, the template being used on the pages in the database selected can be overridden. To override the templates being used, click on the 'Override the template being used' box and select the template to override with.<br><br>\r
+\r
+Clicking on the 'Return to the compile database list.' will return to the list of databases to compile.<br><br>\r
\r
<span class="heading">2.5.2 Compiling multiple databases</span><br><br>\r
\r
-To compile multiple databases click on the check-box to the left of the database name for each database that should have its pages compiled and click on the 'Compile Selected' button which will display a message asking to confirm if the selected databases shown should be compiled. Clicking on the 'Compile Selected Databases' button will display a log of pages that have been compiled and any error messages that might appear with the link to return to the list of databases to compile at the end of the log. Clicking on the 'Return to the compile database list.' will return to the list of databases to compile.<br><br>\r
+To compile multiple databases click on the check-box to the left of the database name for each database that should have its pages compiled and click on the 'Compile Selected' button which will display a message asking to confirm if the selected databases shown should be compiled. Clicking on the 'Compile Selected Databases' button will display a log of pages that have been compiled and any error messages that might appear with the link to return to the list of databases to compile at the end of the log. <br><br>\r
+\r
+When compiling a database, the templates being used on the pages in the databases selected can be overridden. To override the templates being used, click on the 'Override the template being used' box and select the template to override with.<br><br>\r
+\r
+Clicking on the 'Return to the compile database list.' will return to the list of databases to compile.<br><br>\r
\r
<span class="heading">2.5.3 Compiling all databases</span><br><br>\r
\r
-To compile all of the available databases click on the 'Compile All' link in the Compile Pages sub-menu which will display a message asking to confirm if all of the databases should have its pages compiled. Clicking on the 'Compile All Databases' button will display a log of pages that have been compiled and any error messages that might appear with the link to return to the list of databases to compile at the end of the log. Clicking on the 'Return to the compile database list.' link will return to the list of databases to compile.<br><br>\r
+To compile all of the available databases click on the 'Compile All' link in the Compile Pages sub-menu which will display a message asking to confirm if all of the databases should have its pages compiled. Clicking on the 'Compile All Databases' button will display a log of pages that have been compiled and any error messages that might appear with the link to return to the list of databases to compile at the end of the log.<br><br>\r
+\r
+When compiling a database, the templates being used on the pages in all of the databases can be overridden. To override the templates being used, click on the 'Override the template being used' box and select the template to override with.<br><br>\r
+\r
+Clicking on the 'Return to the compile database list.' link will return to the list of databases to compile.<br><br>\r
\r
<span class="heading">2.5.4 Cleaning the output directory</span><br><br>\r
\r
\r
When compiling the pages, the order of the filters list is determined by the filter priority number with the lower numbers being processed first and the filters with the higher filter priority numbers being processed last.<br><br>\r
\r
+To view the next (or previous list) of filters, click on the relevant link at the top of the page and to view a specific list of filters, select the list page number in the drop down menu box at the top of the page and click on the Show button.<br><br>\r
+\r
<span class="heading">2.3.1 Add a filter</span><br><br>\r
\r
To add a filter click on the 'Add Filter' link on the View Filters sub-menu, a form then appears allowing to enter the information about the new filter.<br><br>\r
</div>\r
</div>\r
<div class="pageinformation">\r
- <span class="">2.2 Pages</span><br><br>\r
+ <span class="pagetitle">2.2 Pages</span><br><br>\r
\r
Pages are used for storing information that is relevant to that page.<br><br>\r
\r
Pages can be access from the 'View Pages' menu link. As no database is selected, a drop down box will appear listing the databases that are available, select a database and then click on the View button. A list of pages for that database will then appear and if there are no pages in the database a message will appear saying that no pages exist in this database.<br><br>\r
\r
+To view the next (or previous list) of pages, click on the relevant link at the top of the page and to view a specific list of pages, select the list page number in the drop down menu box at the top of the page and click on the Show button.<br><br>\r
+\r
<span class="heading">2.2.1: Creating a page</span><br><br>\r
A page can be created in the selected database by clicking on the 'Add Page' link in the View Pages sub-menu, a form then appears allowing to enter the information about the new page.<br><br>\r
\r
\r
The list of templates can be accessed by clicking on the 'View Templates' link. A list of templates from the template database should then appear. If the template database does not exist then a message will appear saying that the template database does not exist and will be created when a template is added. If no templates exist in the template database then a message appears saying that there are no templates in the template database.<br><br>\r
\r
+To view the next (or previous list) of templates, click on the relevant link at the top of the page and to view a specific list of templates, select the list page number in the drop down menu box at the top of the page and click on the Show button.<br><br>\r
+\r
<span class="heading">2.4.1 Add a template</span><br><br>\r
\r
To add a template to the template database click on the 'Add Template' link from the View Templates sub-menu, a form then appears allowing to enter the new information about the template.<br><br>\r
<td class="tabledata">Images (URI path)</td>\r
<td class="tabledata">Specifies the Images (URI path) to use for displaying images when using the page template with Kiriwrite.</td>\r
</tr>\r
+ <tr>\r
+ <td class="tabledata">Text Area Columns</td>\r
+ <td class="tabledata">Specifies the width of the text area when editing notes, pages and templates.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Text Area Rows</td>\r
+ <td class="tabledata">Specifies the height of the text area when editing notes, pages and templates.</td>\r
+ </tr>\r
<tr>\r
<td class="tabledata">Date Format</td>\r
<td class="tabledata">Specifies the date format to use when list the pages from the database. A selection of date formats are available from the drop down box or a custom one can be entered into the text box next to the drop down box.</td>\r
<div class="pageinformation">\r
<span class="pagetitle">4.3 Removing unneeded modules and language files</span><br><br>\r
\r
-As Kiriwrite uses a modular system for manipulating the databases, outputting the pages internally by Kiriwrite and language files for each language used, space can be recovered by removing unneeded modules and language files from the Modules directory and the lang directory.<br><br>\r
+As Kiriwrite uses a modular system for manipulating the databases, outputting the pages internally by Kiriwrite and language files for each language used, space can be recovered by removing unneeded modules from the Modules directory and language files from the lang directory.<br><br>\r
\r
To make sure that the currently used database module, presentation module and language file are not deleted from their directories. Check which ones should be kept by clicking on the 'View Settings' menu link.\r
</div>\r
--- /dev/null
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">\r
+<html>\r
+ <head>\r
+ <link href="style.css" REL="stylesheet" TYPE="text/css" MEDIA="screen">\r
+ <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">\r
+ <title>Kiriwrite Documentation - User Documentation - Chapter 6: Contributing to Kiriwrite</title>\r
+ </head>\r
+ <body>\r
+ <div class="menubarback">\r
+ <div class="menubar">\r
+ <span class="apptitle">Kiriwrite</span>\r
+ <a href="index.html">Index</a> | <a href="user.html">User \r
+Documentation</a> | <a href="tutorial.html">Tutorial Documentation</a> | \r
+<a href="developer.html">Developer Documentation</a>\r
+ </div>\r
+ </div>\r
+ <div class="pageinformation">\r
+ <span class="pagetitle">Chapter 6: Contributing to Kiriwrite</span><br><br>\r
+\r
+<span class="heading">6.1: Contributing</span><br><br>\r
+\r
+You can contribute to Kiriwrite in many different ways like the following examples:\r
+<ul>\r
+ <li>Translate Kiriwrite (program or documentation) so that it can be used your own local language.</li>\r
+ <li>Add functionality to Kiriwrite.</li>\r
+ <li>Write a presentation or database module.</li>\r
+ <li>Report a bug or fault (either with Kiriwrite itself or the documentation).</li>\r
+ <ul><li>\r
+ When reporting a bug, you should give the version number of Kiriwrite, what operating system you are using, what web server you are using and the version of it, the version of Perl you are using (and if possible the version of the Perl module that is causing the bug), what the error message of the bug is and how to recreate the bug (if possible).\r
+ <li></ul>\r
+</ul>\r
+\r
+For more information on how to contribute to Kiriwrite visit http://xestia.co.uk/kiriwrite or visit the BerliOS project site at http://developer.berlios.de/projects/kiriwrite . A list of stuff that needs doing can be found in the TODO file in the Kiriwrite package (remember to check the latest Kiriwrite package's TODO file for the latest on what needs doing).\r
+ </div>\r
+ </body>\r
+</html>\r
<a href="user-chapter4-securing.html">4.1: Securing your Kiriwrite installation</a><br>\r
<a href="user-chapter4-renaming.html">4.2: Renaming the Kiriwrite script (kiriwrite.cgi)</a><br>\r
<a href="user-chapter4-removing.html">4.3: Removing unneeded modules and language files</a><br>\r
-<a href="user-chapter5.html">Chapter 5: Troubleshooting</a>\r
-\r
+<a href="user-chapter5.html">Chapter 5: Troubleshooting</a><br>\r
+<a href="user-chapter6.html">Chapter 6: Contributing to Kiriwrite</a>\r
\r
</div>\r
</body>\r
%kiriwrite_version = (
"major" => 0,
- "minor" => 1,
+ "minor" => 2,
"revision" => 0
);
Home |
News |
Projects |
Releases
Bugs |
RFE |
Repositories |
Help
