--- /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 - 1.1: BEGIN</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">1.1 BEGIN</span><br><br>\r
+\r
+BEGIN is a subroutine that is used by the Perl interpreter to do things before running a script (Kiriwrite being the case). For Kiriwrite, it will process the script filename (as it's the full path name and only the last part which is the filename is needed). This allows Kiriwrite to be used with a different script filename.\r
+ </div>\r
+ </body>\r
+</html>\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 - 1.24: kiriwrite_compile_all</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">1.24 kiriwrite_compile_all</span><br><br>\r
+\r
+kiriwrite_compile_all compiles all of the available databases. It writes the list of databases available to compile which will be passed to the kiriwrite_compile_makepages subroutine.<br><br>\r
+\r
+kiriwrite_compile_all will return data that is intended for kiriwrite_output_page.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ kiriwrite_compile_all();\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $pagedata = kiriwrite_compile_all();\r
+</div>\r
+ </div>\r
+ </body>\r
+</html>\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 - 1.25: kiriwrite_compile_clean</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">1.25 kiriwrite_compile_clean</span><br><br>\r
+\r
+kiriwrite_compile_clean cleans the output directory. If no confirm value is given then a form appears asking if the output directory should be cleaned.<br><br>\r
+\r
+kirwirite_compile_clean will return data that is intended for kiriwrite_output_page.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ kiriwrite_compile_clean(confirm);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $pagedata = kiriwrite_compile_clean();<br>\r
+ $pagedata = kiriwrite_compile_clean(1);\r
+</div>\r
+\r
+<br>\r
+\r
+<i>confirm</i><br>\r
+Specifies if the action to clean the output directory should be confirmed by passing a '1'.\r
+ </div>\r
+ </body>\r
+</html>\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 - 1.26: kiriwrite_compile_clean_helper</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">1.26 kiriwrite_compile_clean_helper</span><br><br>\r
+\r
+kiriwrite_compile_clean_helper is a helper subroutine for the kiriwrite_compile_clean subroutine which is called recursively.<br><br>\r
+\r
+kiriwrite_compile_clean_helper returns a value if a file in the directory being cleaned and has invalid permissions set.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ kiriwrite_compile_clean_helper(directory, keepdirectory, permissions);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ kiriwrite_compile_clean_helper(“directory”, 1);<br>\r
+ $permissions = kiriwrite_compile_clean_helper(“directory”, 1);<br>\r
+ kiriwrite_compile_clean_helper(“directory”, 1, 1);\r
+</div>\r
+\r
+<br>\r
+\r
+directory<br>\r
+Specifies the directory which should be cleaned.<br><br>\r
+\r
+keepdirectory<br>\r
+Keeps the parent directory.<br><br>\r
+\r
+<i>permissions</i><br>\r
+Checks if the permissions on all the files processed are valid before deleting and returns a value if they aren't.\r
+ </div>\r
+ </body>\r
+</html>\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 - 1.22: kiriwrite_compile_list</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">1.22 kiriwrite_compile_list</span><br><br>\r
+\r
+kiriwrite_compile_list lists the databases that are available to be compiled.<br><br>\r
+\r
+kiriwrite_compile_list returns data that is intended for kiriwrite_output_page.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ kiriwrite_compile_list();\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $pagedata = kiriwrite_compile_list();\r
+</div>\r
+ </div>\r
+ </body>\r
+</html>\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 - 1.23: kiriwrite_compile_makepages</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">1.23 kiriwrite_compile_makepages</span><br><br>\r
+\r
+kiriwrite_compile_makepages compiles the pages in the database with the templates (if they have one assigned), applies any filter settings (if any are in the filter database) and writes them to the output directory.<br><br>\r
+\r
+kiriwrite_compile_makepages will return data that is intended for kiriwrite_output_page.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ kiriwrite_compile_makepages(type, confirm, selectedlist);\r
+</div>\r
+\r
+<br>\r
+\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
+</div>\r
+\r
+<br>\r
+\r
+type<br>\r
+Specifies the type meaning if a single or multiple databases should be compiled. This is required every time the subroutine is called.<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">single</td>\r
+ <td class="tabledata">Specifies that a single database should be compiled.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">multiple</td>\r
+ <td class="tabledata">Specifies that multiple databases should be compiled.</td>\r
+ </tr>\r
+</table>\r
+\r
+<br>\r
+\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
+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
+ </body>\r
+</html>\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 - 1.35: kiriwrite_critical</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">1.35 kiriwrite_critical</span><br><br>\r
+\r
+kiriwrite_critical processes critical errors when using Kiriwrite.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ kiriwrite_critical(errortype);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ kiriwrite_critical(“generic”);\r
+</div>\r
+\r
+<br>\r
+ \r
+errortype<br>\r
+Specifies the critical error message to use.<br><br>\r
+For more information on the error messages used look at the kiriwrite_critical subroutine in the Kiriwrite source code.\r
+ </div>\r
+ </body>\r
+</html>\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 - 1.11: kiriwrite_database_add</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">1.11 kiriwrite_database_add</span><br><br>\r
+\r
+kiriwrite_database_add adds a database. If the confirm value is not given then it will write a form for adding a database.<br><br>\r
+\r
+kiriwrite_database_add will return data that is intended for kiriwrite_output_page.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ kiriwrite_database_add(filename, name, description, notes, categories, confirm);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+$pagedata = kiriwrite_database_add();<br>\r
+$pagedata = kiriwrite_database_add(“database”, “New Database”, “New Database Description”, “New Database Notes”, “new, database, categories”, 1);\r
+</div>\r
+\r
+<br>\r
+\r
+filename<br>\r
+Specifies the filename of the database to add. This is required when actually adding a database.<br><br>\r
+\r
+name<br>\r
+Specifies the name of the database to add. This is required when actually adding a database.<br><br>\r
+\r
+description<br>\r
+Specifies the description of the database to add. This is required when actually adding a database.<br><br>\r
+\r
+notes<br>\r
+Specifies the notes of the database to add. This is required when actually adding a database.<br><br>\r
+\r
+categories<br>\r
+Specifies the categories to the database to add. This is required when actually adding a database.<br><br>\r
+\r
+confirm<br>\r
+Specifies if the action to add a database should be confirmed by passing a '1'.\r
+ </div>\r
+ </body>\r
+</html>\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 - 1.13: kiriwrite_database_delete</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">1.13 kiriwrite_database_delete</span><br><br>\r
+\r
+kiriwrite_database_delete deletes a database. If the confirm value is not given then it will write a form asking if the database should be deleted. If a database filename is not specified then an error is returned.<br><br>\r
+\r
+kiriwrite_database_delete will return data that is intended for kiriwrite_output_page.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ kiriwrite_database_delete(database, confirm);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $pagedata = kiriwrite_database_delete(“database”);<br>\r
+ $pagedata = kiriwrite_database_delete(“database”, 1);\r
+</div>\r
+\r
+<br>\r
+\r
+database<br>\r
+Specifies the database to delete. This is required each time this subroutine is called.<br><br>\r
+\r
+<i>confirm</i><br>\r
+Specifies if the action to delete a database should be confirmed by passing a '1'.\r
+ </div>\r
+ </body>\r
+</html>\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 - 1.12: kiriwrite_database_edit</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">1.12 kiriwrite_database_edit</span><br><br>\r
+\r
+kiriwrite_database_edit edits information about a database. If the confirm value is not given then it will write a form for editing a database. If a database filename (old or new) is blank or the database name is blank when the database is edited then an error is returned.<br><br>\r
+\r
+kiriwrite_database_edit will return data that is intended for kiriwrite_output_page.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ kiriwrite_database_edit(filename, newfilename, newname, newdescription, newnotes, newcategories, confirm);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $pagedata = kiriwrite_database_edit(“database”);<br>\r
+ $pagedata = kiriwrite_database_edit(“database”, “newdatabase”, “New Database Name”, “New Database Description”, “New Notes”, “new, edited, database, categories”, 1);\r
+</div>\r
+\r
+<br>\r
+\r
+filename<br>\r
+Specifies the filename of the database to edit. This is required each time the subroutine is called.<br><br>\r
+\r
+<i>newfilename</i><br>\r
+Specifies the new filename of the database. If the filename given is the same as the filename parameter then the filename does not change. This is required when the database is going to be edited.<br><br>\r
+\r
+<i>newdescription</i><br>\r
+Specifies the new description of the database. This is required when the database is going to be edited.<br><br>\r
+\r
+<i>newnotes</i><br>\r
+Specifies the new notes of the database. This is required when the database is going to be edited.<br><br>\r
+\r
+<i>newcategories</i><br>\r
+Specifies the new categories of the database. This is required when the database is going to be edited.<br><br>\r
+\r
+<i>confirm</i><br>\r
+Specifies if the action to edit a database should be confirmed by passing a '1'.<br><br>\r
+ </div>\r
+ </body>\r
+</html>\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 - 1.10: kiriwrite_database_list</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">1.10 kiriwrite_database_list</span><br><br>\r
+\r
+kiriwrite_database_list gets the list of databases available.<br><br>\r
+\r
+kiriwrite_database_list will return data that is intended for kiriwrite_output_page.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ kiriwrite_database_list();\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $pagedata = kiriwrite_database_list();\r
+</div>\r
+\r
+ </div>\r
+ </body>\r
+</html>\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 - 1.34: kiriwrite_error</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">1.34 kiriwrite_error</span><br><br>\r
+\r
+kiriwrite_error processes errors that occur when using Kiriwrite.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ kiriwrite_error(errortype, errorext);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ kiriwrite_error(“generic”);<br>\r
+ kiriwrite_error(“databaseerror”, “Extended Error Information”);\r
+</div>\r
+\r
+<br>\r
+\r
+errortype<br>\r
+Specifies the error message to return. If the errortype returned is blank then the generic error type is used. This is required when each time the subroutine is called.<br><br>\r
+For more information about the error messages used look at the kiriwrite_error subroutine in the Kiriwrite source code and the language file where each error type should match with the error type given in the language file.<br><br>\r
+\r
+errorext<br>\r
+Specifies the extended error information.\r
+ </div>\r
+ </body>\r
+</html>\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 - 1.36: kiriwrite_fileexists</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">1.36 kiriwrite_fileexists</span><br><br>\r
+\r
+kiriwrite_fileexists checks if the filename given exists. kiriwrite_fileexists will return a value if the filename given does not exist.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ kiriwrite_fileexists(filename);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $file_exists = kiriwrite_fileexists(“filename”);\r
+</div>\r
+\r
+<br>\r
+\r
+filename<br>\r
+Specifies the filename to check to see if it exists.\r
+ </div>\r
+ </body>\r
+</html>\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 - 1.37: kiriwrite_filepermissions</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">1.37 kiriwrite_filepermissions</span><br><br>\r
+\r
+kiriwrite_filepermissions checks if the file permissions of a file to see if they are valid and returns a value if the file permissions are invalid.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ kiriwrite_filepermissions(filename, read, write, filemissingskip);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $file_permissions = kiriwrite_filepermissions(“test.html”, 1);<br>\r
+ $file_permissions = kiriwrite_filepermissions(“test.html”, 1, 1);\r
+ $file_permissions = kiriwrite_filepermissions(“test.html”, 1, 0, 1);\r
+</div>\r
+\r
+<br>\r
+\r
+filename<br>\r
+Specifies the filename to check for valid file permissions. This is required each time the subroutine is called.<br><br>\r
+\r
+<i>read</i><br>\r
+Check if the file with the filename given has valid read permissions.<br><br>\r
+\r
+<i>write</i><br>\r
+Check if the file with the filename given has valid write permissions.<br><br>\r
+\r
+<i>filemissingskip</i><br>\r
+If the file is missing then skip the permissions check (normally used if a file doesn't exist and then has to be created).\r
+ </div>\r
+ </body>\r
+</html>\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 - 1.19: kiriwrite_filter_add</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">1.19 kiriwrite_filter_add</span><br><br>\r
+\r
+kiriwrite_filter_add adds a filter to the filter database. If no confirm value is given then a form for adding a filter to the filter database is written.<br><br>\r
+\r
+kiriwrite_filter_add will return data that is intended for kiriwrite_output_page.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ kiriwrite_filter_add(filterfind, filterreplace, filterpriority, filternotes, confirm);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $pagedata = kiriwrite_filter_add();<br>\r
+ $pagedata = kiriwrite_filter_add(“Find this”, “And replace it with this”, 1, “Some notes about the filter itself for checking up later.”, 1);\r
+</div>\r
+\r
+<br>\r
+\r
+<i>filterfind</i><br>\r
+Specifies the text to find. This is required when adding a filter.<br><br>\r
+\r
+<i>filterreplace</i><br>\r
+Specifies what will replace the text that is found by the filterfind parameter. This is required when adding a filter.<br><br>\r
+\r
+<i>filterpriority</i><br>\r
+Specifies the filter priority. The bigger the priority number is then the filter will be processed earlier than filters with lower priority numbers. This is required when adding a filter.<br><br>\r
+\r
+<i>filternotes</i><br>\r
+Specifies the notes for the filter. This is required when adding a filter.<br><br>\r
+\r
+<i>confirm</i><br>\r
+Specifies if the action to add a filter should be confirmed by passing a '1'.<br><br>\r
+ </div>\r
+ </body>\r
+</html>\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 - 1.21: kiriwrite_filter_delete</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">1.21 kiriwrite_filter_delete</span><br><br>\r
+\r
+kiriwrite_filter_delete will delete a filter that is in the filter database. If no confirm value is given then a form is written asking if the filter should be deleted. If no filter identification number is given then an error is returned.<br><br>\r
+\r
+kiriwrite_filter_delete will return data that is intended for kiriwrite_output_page.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ kiriwrite_filter_delete(filterid, confirm);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $pagedata = kiriwrite_filter_delete(1);<br>\r
+ $pagedata = kiriwrite_filter_delete(1, 1);\r
+</div>\r
+\r
+<br>\r
+\r
+filterid<br>\r
+Specifies the filter to delete from the filter database. This is required every time the subroutine is called.<br><br>\r
+\r
+<i>confirm</i><br>\r
+Specifies if the action to delete a filter should be confirmed by passing a '1'.\r
+ </div>\r
+ </body>\r
+</html>\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 - 1.20: kiriwrite_filter_edit</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">1.20 kiriwrite_filter_edit</span><br><br>\r
+\r
+kiriwrite_filter_edit will edit a filter that is in the filter database. If no confirm value is given then a form will appear for editing a filter. If no filter identification number is given then an error is returned.<br><br>\r
+\r
+kiriwrite_filter_edit will return data that is intended for kiriwrite_output_page.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ kiriwrite_filter_edit(filterid, newfilterfind, newfilterreplace, newfilterpriority, newfilternotes, confirm);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $pagedata = kiriwrite_filter_edit(1);\r
+ $pagedata = kiriwrite_filter_edit(1, “New filter find setting”, “New filter replace setting”, 1, “New filter notes”, 1);\r
+</div>\r
+\r
+<br>\r
+\r
+filterid<br>\r
+Specifies the filter identification number to edit. This is required every time the subroutine is called.<br><br>\r
+\r
+<i>newfilterfind</i><br>\r
+Specifies the new find filter setting. This is required when editing the filter.<br><br>\r
+\r
+<i>newfilterreplace</i><br>\r
+Specifies the new replace filter setting. This is required when editing the filter.<br><br>\r
+\r
+<i>newfilterpriority</i><br>\r
+Specifies the new filter priority. This is required when editing the filter.<br><br>\r
+\r
+<i>newfilternotes</i><br>\r
+Specifies the new filter notes. This is required when editing the filter.<br><br>\r
+\r
+<i>confirm</i><br>\r
+Specifies if the action to edit a filter should be confirmed by passing a '1'.\r
+ </div>\r
+ </body>\r
+</html>\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 - 1.18: kiriwrite_filter_list</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">1.18 kiriwrite_filter_list</span><br><br>\r
+\r
+kiriwrite_filter_list will get the list of available filters in the filter database.<br><br>\r
+\r
+kiriwrite_filter_list will return data that is intended for kiriwrite_output_page.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ kiriwrite_filter_list();\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $pagedata = kiriwrite_filter_list();\r
+</div>\r
+\r
+ </div>\r
+ </body>\r
+</html>\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 - 1.33: kiriwrite_language</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">1.33 kiriwrite_language</span><br><br>\r
+\r
+kiriwrite_language processes language strings that need to have certain pieces of text inserted. This subroutine should be used only if the language string does need to have text to be inserted.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ kiriwrite_language(string, text1, (text2, text3...));\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $string = kiriwrite_language(“%s, %s, %s, %s and %s!”, “one”, “two”, “three”, “four”, “five”);\r
+</div>\r
+\r
+<br>\r
+\r
+string<br>\r
+Specifies the string to insert text into.<br><br>\r
+\r
+text1, text2, text3<br>\r
+Specifies the text to insert into the string and the amount of parameters to pass to depends on how many '%s'es there are in the language string.\r
+ </div>\r
+ </body>\r
+</html>\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 - 1.39: kiriwrite_output_header</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">1.39 kiriwrite_output_header</span>\r
+\r
+kiriwrite_output_header outputs the header that is part of the HTTP specification.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ kiriwrite_output_header();\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ kiriwrite_output_header;\r
+</div>\r
+ </div>\r
+ </body>\r
+</html>\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 - 1.41: kiriwrite_output_page</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">1.41 kiriwrite_output_page</span><br><br>\r
+\r
+kiriwrite_output_page outputs the page to a browser, standard output or a console. All parameters for this subroutine are required.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ kiriwrite_output_page(pagetitle, pagedata, menutype);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ kiriwrite_output_page(“Page Title”, “This is the page data.”, “database”);\r
+</div>\r
+\r
+<br>\r
+\r
+pagetitle<br>\r
+Specifies the page title of the page.<br><br>\r
+\r
+pagedata<br>\r
+Specifies the page data.<br><br>\r
+\r
+menutype<br>\r
+Specifies the menu type to use.<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">database</td>\r
+ <td class="tabledata">Writes the database sub-menu.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">pages</td>\r
+ <td class="tabledata">Writes the pages sub-menu.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">filter</td>\r
+ <td class="tabledata">Writes the filter sub-menu.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">settings</td>\r
+ <td class="tabledata">Writes the settings sub-menu.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">template</td>\r
+ <td class="tabledata">Writes the template sub-menu.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">compile</td>\r
+ <td class="tabledata">Writes the compile sub-menu.</td>\r
+ </tr>\r
+</table>\r
+ </div>\r
+ </body>\r
+</html>\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 - 1.40: kiriwrite_output_xml</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">1.40 kiriwrite_output_xml</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
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ kiriwrite_output_xml(filename, type, options);\r
+</div>\r
+\r
+<br>\r
+\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
+</div>\r
+\r
+<br>\r
+\r
+filename<br>\r
+Specifies the filename to output the configuration file to.<br><br>\r
+\r
+type<br>\r
+Specifies the type of XML file to output (the only available option being 'config').<br><br>\r
+\r
+options<br>\r
+Specifies the options to use as a hash.<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">DatabaseDirectory</td>\r
+ <td class="tabledata">Specifies the database directory to use.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">OutputDirectory</td>\r
+ <td class="tabledata">Specifies the output directory to use.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">ImagesURIPath</td>\r
+ <td class="tabledata">Specifies the URI path of the images directory.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">DateTimeFormat</td>\r
+ <td class="tabledata">Specifies the date and time format that should be used.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">SystemLanguage</td>\r
+ <td class="tabledata">Specifies the language that Kiriwrite will use.</td>\r
+ </tr>\r
+ <tr>\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">DatabaseModule</td>\r
+ <td class="tabledata">Specifies the database module in Kiriwrite to use.</td>\r
+ </tr>\r
+</table>\r
+\r
+<br>\r
+\r
+The following settings are for the server-based database modules:<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">DatabaseServer</td>\r
+ <td class="tabledata">Specifies the location of the database server.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">DatabasePort</td>\r
+ <td class="tabledata">Specifies the port of the database server.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">DatabaseProtocol</td>\r
+ <td class="tabledata">Specifies the protocol to use with the database server.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">DatabaseSQLDatabase</td>\r
+ <td class="tabledata">Specifies the database name to use.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">DatabaseUsername</td>\r
+ <td class="tabledata">Specifies the database username to use.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">DatabasePasswordKeep</td>\r
+ <td class="tabledata">Specifies if the current database password should be kept.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">DatabasePassword</td>\r
+ <td class="tabledata">Specifies the database password to use.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">DatabaseTablePrefix</td>\r
+ <td class="tabledata">Specifies the table prefix to use for the tables used in Kiriwrite when using a server-based database module.</td>\r
+ </tr>\r
+</table>\r
+ </div>\r
+ </body>\r
+</html>\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 - 1.3: kiriwrite_page_add</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">1.3 kiriwrite_page_add</span><br><br>\r
+\r
+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
+\r
+kiriwrite_page_add will return data that is intended for kiriwrite_output_page.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ kiriwrite_page_add(database, pagefilename, pagename, pagedescription, pagesection, pagetemplate, pagesettings, pagecontent, confirm);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+$pagedata = kiriwrite_page_add(“database”);<br>\r
+$pagedata = kiriwrite_page_add(“database”, “pagefilename.html”, “Page Name”, “Page Description”, “Page Section”, “pagetemplate.html”, 1, “Page Content, blah, blah, blah, blah”, 1);\r
+</div>\r
+\r
+<br>\r
+\r
+database<br>\r
+Specifies the database to add a page to.<br><br>\r
+\r
+<i>pagefilename</i><br>\r
+Specifies the page filename of the page to add. This is required when adding a page and cannot be blank.<br><br>\r
+\r
+<i>pagename</i><br>\r
+Specifies the page name for the new page. This is required when adding a page.<br><br>\r
+\r
+<i>pagesection</i><br>\r
+Specifies the page section for the new page. This is required when adding a page.<br><br>\r
+\r
+<i>pagetemplate</i><br>\r
+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
+\r
+<i>pagesettings</i><br>\r
+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 <kiriwrite:pagetitle> and <kiriwrite:autosection> tags.<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">0</td>\r
+ <td class="tabledata">Don't use the page name or section name.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">1</td>\r
+ <td class="tabledata">Use the page name and section name.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">2</td>\r
+ <td class="tabledata">Use the page name only.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">3</td>\r
+ <td class="tabledata">Use the section name only.</td>\r
+ </tr>\r
+</table>\r
+\r
+<br>\r
+\r
+<i>pagecontent</i><br>\r
+Specifies the page content to use for the new page.<br><br>\r
+\r
+<i>confirm</i><br>\r
+Specifies if the action to add the page should be confirmed by passing a '1'.\r
+ </div>\r
+ </body>\r
+</html>\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 - 1.5: kiriwrite_page_delete</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">1.5 kiriwrite_page_delete</span><br><br>\r
+\r
+kirirwite_page_delete will delete a page from the selected database. If the confirm value is not supplied then it will write a form asking if the selected page should be deleted. If the database and page filename values are not given together than an error is returned.<br><br>\r
+\r
+kiriwrite_page_delete will return data that is intended for kiriwrite_output_page.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ kiriwrite_page_delete(database, page, confirm);\r
+</div>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+$pagedata = kiriwrite_page_delete(“database”, “filename.html”);<br>\r
+$pagedata = kiriwrite_page_delete(“database”, “filename.html”, 1);\r
+</div>\r
+\r
+<br>\r
+\r
+database<br>\r
+Specifies the database to delete the selected page from.<br><br>\r
+\r
+page<br>\r
+Specifies the page with the filename given to delete.<br><br>\r
+\r
+<i>confirm</i><br>\r
+Specifies if the action to edit the page should be confirmed by passing a '1'.\r
+ </div>\r
+ </body>\r
+</html>\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 - 1.4: kiriwrite_page_edit</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">1.4 kiriwrite_page_edit</span><br><br>\r
+\r
+kiriwrite_page_edit will edit a page from the selected database. If the confirm value is not supplied then it will write a form for editing a page and if no database and page filename is specified then an error is returned saying no database was specified.<br><br>\r
+\r
+kiriwrite_page_edit will return data that is intended for kiriwrite_output_page.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+kiriwrite_page_edit(database, filename, newfilename, newname, newdescription, newsection, newtemplate, newsettings, newcontent, confirm);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+$pagedata = kiriwrite_page_edit(“database”, “oldfilename.html”);<br>\r
+$pagedata = kiriwrite_page_edit(“database”, “oldfilename.html”, “newfilename.html”, “New Page Filename”, “New Page Description”, “New Page Section”, “newtemplate.html”, 0, “New Page Content, blah, blah, blah, blah“, 1);\r
+</div>\r
+\r
+<br>\r
+\r
+database<br>\r
+Specifies the database to edit the page from. This is required every time the subroutine is called.<br><br>\r
+\r
+filename<br>\r
+Specifies the page with the filename to edit. This is required every time the subroutine is called.<br><br>\r
+\r
+<i>newfilename</i><br>\r
+Specifies the new page filename to use when editing a page. If you specify the same filename as the one given in the filename parameter then the filename of the page is not changed. This is required when actually editing a page and cannot be blank.<br><br>\r
+\r
+<i>newname</i><br>\r
+Specifies the new page name to use when editing a page. This is required when actually editing a page.<br><br>\r
+\r
+<i>newdescription</i><br>\r
+Specifies the new description to use when editing a page. This is required when actually editing a page.<br><br>\r
+\r
+<i>newsection</i><br>\r
+Specifies the new section to use when editing a page. This is required when actually editing a page.<br><br>\r
+\r
+<i>newtemplate</i><br>\r
+Specifies the new template filename to use when editing a page. This is required when actually editing a page and cannot be blank.<br><br>\r
+\r
+<i>newsettings</i><br>\r
+Specifies the new settings to use when editing a page. This is required when actually editing a page and cannot be blank. The following values specify what should be done to the page when using the <kiriwrite:pagetitle> and <kiriwrite:autosection> tags.<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">0</td>\r
+ <td class="tabledata">Don't use the page name or section name.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">1</td>\r
+ <td class="tabledata">Use the page name and section name.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">2</td>\r
+ <td class="tabledata">Use the page name only.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">3</td>\r
+ <td class="tabledata">Use the section name only.</td>\r
+ </tr>\r
+</table>\r
+\r
+<br>\r
+\r
+<i>newcontent</i><br>\r
+Specifies the new content to use when editing a page. This is required when actually editing a page.<br><br>\r
+\r
+<i>confirm</i><br>\r
+Specifies if the action to edit the page should be confirmed by passing a '1'.\r
+ </div>\r
+ </body>\r
+</html>\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 - 1.2: kiriwrite_page_list</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">1.2 kiriwrite_page_list</span><br><br>\r
+\r
+kiriwrite_page_list lists the pages from a given database. If no database is specified then it will write a drop-down box showing the list of available databases instead.<br><br>\r
+\r
+kiriwrite_page_list will return page data which is intended for kiriwrite_output_page.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ kiriwrite_page_list(database);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $pagedata = kiriwrite_page_list(“database”);\r
+</div>\r
+\r
+<br>\r
+\r
+database<br>\r
+Specifies the database to get the list of pages from.\r
+ </div>\r
+ </body>\r
+</html>\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 - 1.8: kiriwrite_page_multicopy</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">1.8 kiriwrite_page_multicopy</span><br><br>\r
+\r
+kiriwrite_page_multicopy will copy pages from one database to another database. If no confirm value is specified then it will write a form asking if the selected pages should be copied to another database and which database the pages should be copied to. If no databases or pages were specified then an error is returned.<br><br>\r
+\r
+kiriwrite_page_multicopy will return data that is intended for kiriwrite_output_page. All parameters are required for this subroutine.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ kiriwrite_page_multicopy(database, olddatabase, confirm, filelist);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $pagedata = kiriwrite_page_multicopy(“database”, “newdatabase”, 0, ['page1.html','page2.html','page3.html','page4.html']);<br>\r
+ $pagedata = kiriwrite_page_multicopy(“database”, “newdatabase”, 1, ['page1.html','page2.html','page3.html','page4.html']);\r
+</div>\r
+\r
+<br>\r
+\r
+database<br>\r
+Specifies the database to copy the pages from.<br><br>\r
+\r
+newdatabase<br>\r
+Specifies the new database to copy the pages to.<br><br>\r
+\r
+confirm<br>\r
+Specifies if the action to delete multiple pages should be confirmed by passing a '1'.<br><br>\r
+\r
+filelist<br>\r
+Specifies an array giving the list of pages to copy.\r
+ </div>\r
+ </body>\r
+</html>\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 - 1.6: kiriwrite_page_multidelete</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">1.6 kiriwrite_page_multidelete</span><br><br>\r
+\r
+kiriwrite_page_multidelete will delete multiple pages from the selected database. If no confirm value is specified then it will write a form asking if the selected pages should be deleted. If no database and pages are specified then an error will be returned.<br><br>\r
+\r
+kiriwrite_page_multidelete will return data that is intended for kiriwrite_output_page. All parameters are required for this subroutine.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ kiriwrite_page_multidelete(database, confirm, filelist);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+$pagedata = kiriwrite_page_multidelete(“database”, 0, ['page1.html','page2.html','page3.html','page4.html']);<br>\r
+$pagedata = kiriwrite_page_multidelete(“database”, 1, ['page1.html','page2.html','page3.html','page4.html']);\r
+</div>\r
+\r
+<br>\r
+\r
+database<br>\r
+Specifies the database to delete multiple pages from.<br><br>\r
+\r
+confirm<br>\r
+Specifies if the action to delete multiple pages should be confirmed by passing a '1'.<br><br>\r
+\r
+filelist<br>\r
+Specifies an array giving the list of pages to delete.<br><br>\r
+ </div>\r
+ </body>\r
+</html>\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 - 1.9: kiriwrite_page_multiedit</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">1.9 kiriwrite_page_multiedit</span><br><br>\r
+\r
+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
+\r
+kiriwrite_page_multiedit will return data that is intended for kiriwrite_output_page. All parameters are required for this subroutine.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ kiriwrite_page_multiedit(database, newsection, altersection, newtemplate, altertemplate, newsettings, altersettings, confirm, filelist);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $pagedata = kiriwrite_page_multiedit(“database”, “”, “”, “”, “”, “”, “”, 0, ['page1.html', 'page2.html', 'page3.html', 'page4.html']);<br>\r
+ $pagedata = kiriwrite_page_multiedit(“database”, “New Section”, “on”, “newtemplate.html”, “on”, 0, “on”, 1, ['page1.html', 'page2.html', 'page3.html', 'page4.html']);\r
+</div>\r
+\r
+<br>\r
+\r
+database<br>\r
+Specifies the database to edit the selected pages from.<br><br>\r
+\r
+newsection<br>\r
+Specifies the new section for the selected pages.<br><br>\r
+\r
+altersection<br>\r
+Specifies if a new section should be given for the selected pages.<br><br>\r
+\r
+newtemplate<br>\r
+Specifies the new template filename for the selected pages. Specify '!none' to not use a template.<br><br>\r
+\r
+altertemplate<br>\r
+Specifies if a new template filename should be given for the selected pages.<br><br>\r
+\r
+newsettings<br>\r
+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 <kiriwrite:pagetitle> and <kiriwrite:autosection> tags.<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">0</td>\r
+ <td class="tabledata">Don't use the page name or section name.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">1</td>\r
+ <td class="tabledata">Use the page name and section name.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">2</td>\r
+ <td class="tabledata">Use the page name only.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">3</td>\r
+ <td class="tabledata">Use the section name only.</td>\r
+ </tr>\r
+</table>\r
+\r
+altersettings<br>\r
+Specifies if a new section name should be given for the selected pages.<br><br>\r
+\r
+confirm<br>\r
+Specifies if the action to edit multiple pages should be confirmed by passing a '1'.<br><br>\r
+\r
+filelist<br>\r
+Specifies an array giving the list of pages to edit.\r
+ </div>\r
+ </body>\r
+</html>\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 - 1.7: kiriwrite_page_multimove</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">1.7 kiriwrite_page_multimove</span><br><br>\r
+\r
+kiriwrite_page_multimove will move multiple pages from one database to another database. If no confirm value is specified then it will write a form asking if the selected pages should be moved to another database and which database the pages should be moved to. If no databases or pages were specified then an error is returned.<br><br>\r
+\r
+kiriwrite_page_multimove will return data that is intended for kiriwrite_output_page. All parameters are required for this subroutine.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ kiriwrite_page_multimove(database, newdatabase, confirm, filelist);\r
+</div>\r
+\r
+<br>\r
+\r
+<spam class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+$pagedata = kiriwrite_page_multimove(“olddatabase”, “newdatabase”, 0, ['page1.html','page2.html','page3.html','page4.html']);<br>\r
+$pagedata = kiriwrite_page_multimove(“olddatabase”, “newdatabase”, 1, ['page1.html','page2.html','page3.html','page4.html']);\r
+</div>\r
+\r
+<br>\r
+\r
+database<br>\r
+Specifies the database the pages are going to be moved from.<br><br>\r
+\r
+newdatabase<br>\r
+Specifies the new database the pages are going to be moved to.<br><br>\r
+\r
+confirm<br>\r
+Specifies if the action to delete multiple pages should be confirmed by passing a '1'.<br><br>\r
+\r
+filelist<br>\r
+Specifies an array giving the list of pages to move.\r
+ </div>\r
+ </body>\r
+</html>\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 - 1.32: kiriwrite_processfilename</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">1.32 kiriwrite_processfilename</span><br><br>\r
+\r
+kiriwrite_processfilename processes a name and turns it into a filename that can be used by Kiriwrite.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ kiriwrite_processfilename(text);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $filename = kiriwrite_processfilename(“For the 3rd time already”);\r
+</div>\r
+\r
+<br>\r
+\r
+text<br>\r
+Specifies the text to create a filename with.\r
+ </div>\r
+ </body>\r
+</html>\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 - 1.29: kiriwrite_selectedlist</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">1.29 kiriwrite_selectedlist</span><br><br>\r
+\r
+kiriwrite_selectedlist gets the list of selected pages and processes them into an array which is used by the kiriwrite_page_multidelete, kiriwrite_page_multimove, kiriwrite_page_multicopy, kiriwrite_page_multiedit and kiriwrite_compile_makepages.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ kiriwrite_selectedlist();\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ @filelist = kiriwrite_selectedlist();\r
+</div>\r
+ </div>\r
+ </body>\r
+</html>\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 - 1.28: kiriwrite_settings_edit</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">1.28 kiriwrite_settings_edit</span><br><br>\r
+\r
+kiriwrite_settings_edit will edit the settings in Kiriwrite and write the new settings to the configuration file.<br><br>\r
+\r
+kiriwrite_settings_edit will return data that is intended for kiriwrite_output_page.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ kiriwrite_settings_edit(options);\r
+</div>\r
+\r
+<br>\r
+\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
+</div>\r
+\r
+<br>\r
+\r
+<i>options</i><br>\r
+Specifies a hash listing the new settings. This is required when editing the settings and all settings are needed.<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">DatabaseDirectory</td>\r
+ <td class="tabledata">Specifies the database directory to use.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">OutputDirectory</td>\r
+ <td class="tabledata">Specifies the output directory to use.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">ImagesURIPath</td>\r
+ <td class="tabledata">Specifies the URI path of the images directory.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">DateTimeFormat</td>\r
+ <td class="tabledata">Specifies the date and time format that should be used.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">SystemLanguage</td>\r
+ <td class="tabledata">Specifies the language that Kiriwrite will use.</td>\r
+ </tr>\r
+ <tr>\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">DatabaseModule</td>\r
+ <td class="tabledata">Specifies the database module in Kiriwrite to use.</td>\r
+ </tr>\r
+</table>\r
+\r
+<br>\r
+\r
+The following settings are for the server-based database modules:<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">DatabaseServer</td>\r
+ <td class="tabledata">Specifies the location of the database server.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">DatabasePort</td>\r
+ <td class="tabledata">Specifies the port of the database server.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">DatabaseProtocol</td>\r
+ <td class="tabledata">Specifies the protocol to use with the database server.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">DatabaseSQLDatabase</td>\r
+ <td class="tabledata">Specifies the database name to use.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">DatabaseUsername</td>\r
+ <td class="tabledata">Specifies the database username to use.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">DatabasePasswordKeep</td>\r
+ <td class="tabledata">Specifies if the current database password should be kept.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">DatabasePassword</td>\r
+ <td class="tabledata">Specifies the database password to use.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">DatabaseTablePrefix</td>\r
+ <td class="tabledata">Specifies the table prefix to use for the tables used in Kiriwrite when using a server-based database module.</td>\r
+ </tr>\r
+</table>\r
+ </div>\r
+ </body>\r
+</html>\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 - 1.30: kiriwrite_settings_load</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">1.30 kiriwrite_settings_load</span><br><br>\r
+\r
+kiriwrite_settings_load loads the settings, presentation module, database module and the language file. Any errors that occur during this subroutine will be critical errors.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ kiriwrite_settings_load();\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ kiriwrite_settings_load();\r
+</div>\r
+ </div>\r
+ </body>\r
+</html>\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 - 1.27: kiriwrite_settings_view</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">1.27 kiriwrite_settings_view</span><br><br>\r
+\r
+kiriwrite_settings_view lists the settings that are currently being used in Kiriwrite.<br><br>\r
+\r
+kiriwrite_settings_view will return data that is intended for kiriwrite_output_page.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ kiriwrite_settings_view();\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $pagedata = kiriwrite_settings_view();\r
+</div>\r
+ </div>\r
+ </body>\r
+</html>\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 - 1.15: kiriwrite_template_add</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">1.15 kiriwrite_template_add</span><br><br>\r
+\r
+kiriwrite_template_add adds a template to the template database. If no confirm value is given then it will write a form for adding a template.<br><br>\r
+\r
+kiriwrite_template_add will return data that is intended for kiriwrite_output_page.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+kiriwrite_template_add(filename, name, description, layout, confirm);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $pagedata = kiriwrite_template_add();<br>\r
+ $pagedata = kiriwrite_template_add(“template.html”, “Template Filename”, “Template Description”, “This is the template layout, blah, blah, blah”, 1);\r
+</div>\r
+\r
+<br>\r
+\r
+<i>filename</i><br>\r
+Specifies the filename of the new template. This is required when adding a template.<br><br>\r
+\r
+<i>name</i><br>\r
+Specifies the name of the new template. This is required when adding a template.<br><br>\r
+\r
+<i>description</i><br>\r
+Specifies the description of the new template. This is required when adding a template.<br><br>\r
+\r
+<i>layout</i><br>\r
+Specifies the layout of the new template. This is required when adding a template.<br><br>\r
+\r
+<i>confirm</i><br>\r
+Specifies if the action to add a template should be confirmed by passing a '1'.<br><br>\r
+ </div>\r
+ </body>\r
+</html>\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 - 1.17: kiriwrite_template_delete</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">1.17 kiriwrite_template_delete</span><br><br>\r
+\r
+kiriwrite_template_delete deletes a template from the template database. If no confirm value is given then a form asking if the template should be deleted. If no template filename is given then an error is returned.<br><br>\r
+\r
+kiriwrite_template_delete will return data that is intended for kiriwrite_output_page.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ kiriwrite_template_delete(filename, confirm);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $pagedata = kiriwrite_template_delete(“template.html”);<br>\r
+ $pagedata = kiriwrite_template_delete(“template.html”, 1);\r
+</div>\r
+\r
+<br>\r
+\r
+filename<br>\r
+Specifies the filename of the template to delete.<br><br>\r
+\r
+<i>confirm</i><br>\r
+Specifies if the action to delete a template should be confirmed by passing a '1'.\r
+ </div>\r
+ </body>\r
+</html>\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 - 1.16: kiriwrite_template_edit</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">1.16 kiriwrite_template_edit</span><br><br>\r
+\r
+kiriwrite_template_edit edits a template in the template database. If no confirm value is given then it will write a form for editing a template. If no template filename is given then an error is returned.<br><br>\r
+\r
+kiriwrite_template_edit will return data that is intended for kiriwrite_output_page.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ kiriwrite_template_edit(filename, newfilename, newname, newdescription, templatelayout, confirm);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $pagedata = kiriwrite_template_edit(“template.html”);<br>\r
+ $pagedata = kiriwrite_template_edit(“template.html”, “newtemplate.html”, “New Template Name”, “New Template Description”, “New Template Layout”, 1);\r
+</div>\r
+\r
+<br>\r
+\r
+filename<br>\r
+Specifies the filename of the template to edit. This is required every time the subroutine is called.<br><br>\r
+\r
+<i>newfilename</i><br>\r
+Specifies the new filename of the template. If the filename is the same as the filename parameter then the template filename isn't changed. This is required when editing the template.<br><br>\r
+\r
+<i>newname</i><br>\r
+Specifies the new name of the template. This is required when editing the template.<br><br>\r
+\r
+<i>newdescription</i><br>\r
+Specifies the new description of the template. This is required when editing the template.<br><br>\r
+\r
+<i>templatelayout</i><br>\r
+Specifies the new template layout for the template. This is required when editing the template.<br><br>\r
+\r
+<i>confirm</i><br>\r
+Specifies if the action to edit a template should be confirmed by passing a '1'.\r
+ </div>\r
+ </body>\r
+</html>\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 - 1.14: kiriwrite_template_list</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">1.14 kiriwrite_template_list</span><br><br>\r
+\r
+kiriwrite_template_list lists the available templates.<br><br>\r
+\r
+kiriwrite_template_list will return data that is intended for kiriwrite_output_page.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ kiriwrite_template_list();\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $pagedata = kiriwrite_template_list();\r
+</div>\r
+ </div>\r
+ </body>\r
+</html>\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 - 1.38: kiriwrite_utf8convert</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">1.38 kiriwrite_utf8convert</span><br><br>\r
+\r
+kiriwrite_utf8convert converts the values into properly formatted UTF-8 values.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ kiriwrite_utf8convert(string);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $utf8_string = kiriwrite_convert(“This string should now be a UTF-8 formatted string.”);\r
+</div>\r
+\r
+<br>\r
+\r
+string<br>\r
+Specifies the string to convert into UTF8.\r
+ </div>\r
+ </body>\r
+</html>\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 - 1.31: kiriwrite_variablecheck</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">1.31 kiriwrite_variablecheck</span><br><br>\r
+\r
+kiriwrite_variablecheck checkes variables that are passed to it to see if the content of that variable is valid and returns an error if it isn't. All the parameters are needed each time the subroutine is called and If the noerror parameter is set to 1 then a value is returned when an error occurs otherwise a standard error message will be given.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ kiriwrite_variablecheck(variable, type, option, noerror);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ kiriwrite_variablecheck(“Test 123”, “lettersnumbers”, “”, 0);<br>\r
+ $letters_letnum_check = kiriwrite_variablecheck(“Test 123”, “lettersnumbers”, “”, 1);\r
+</div>\r
+\r
+<br>\r
+\r
+variable<br>\r
+Specifies the variable to check.<br><br>\r
+\r
+type<br>\r
+Specifies the test to check the variable with.<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">numbers</td>\r
+ <td class="tabledata">Check if the variable given only contains numbers.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">lettersnumbers</td>\r
+ <td class="tabledata">Check if the variable given only contains letters and numbers.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">maxlength</td>\r
+ <td class="tabledata">Check if the variable given does not exceed the specific length given.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">blank</td>\r
+ <td class="tabledata">Check if the variable given is blank.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">filename</td>\r
+ <td class="tabledata">Check if the variable given is a valid filename.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">filenameindir</td>\r
+ <td class="tabledata">Check if the variable given is a valid filename in a directory.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">datetime</td>\r
+ <td class="tabledata">Check if the variable given is a valid date and time format.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">directory</td>\r
+ <td class="tabledata">Check if the variable given is a valid directory name.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">language_filename</td>\r
+ <td class="tabledata">Check if the variable given is a valid language filename.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">page_filename</td>\r
+ <td class="tabledata">Check if the variable given is a valid page filename.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">module</td>\r
+ <td class="tabledata">Check if the variable given is a valid module name.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">utf8</td>\r
+ <td class="tabledata">Check if the variable given is a correctly formatted UTF-8 string.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">serverprotocol</td>\r
+ <td class="tabledata">Check if the variable given is a valid server protocol.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">port</td>\r
+ <td class="tabledata">Check if the variable given is a valid server port number.</td>\r
+ </tr>\r
+</table>\r
+\r
+<br>\r
+\r
+option<br>\r
+Specifies the setting to be used with the test.<br><br>\r
+\r
+noerror<br>\r
+Specifies if noerror message should be returned but a value should be returned so that a more specific error message can be created.<br><br>\r
+\r
+For more information on what values are returned, please look at the kiriwrite_error subroutine in the Kiriwrite source code.\r
+ </div>\r
+ </body>\r
+</html>\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 - Chapter 1: Internal Kiriwrite Subroutines</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 1: Internal Kiriwrite Subroutines</span><br><br>\r
+\r
+The subroutines listed here are used internally by Kiriwrite. Typically most of the subroutines here shouldn't be used anywhere else other than the kiriwrite_filepermissions and kiriwrite_fileexists subroutines which can be used for checking if files exist and have valid permissions set.\r
+ </div>\r
+ </body>\r
+</html>\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 - 2.34: addboldtext</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">2.34 addboldtext</span><br><br>\r
+\r
+Adds some bold text.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->addboldtext(text, options);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->addboldtext(“This is text but formatted in bold.”, { Style => “boldtext” });\r
+</div>\r
+\r
+<br>\r
+\r
+text<br>\r
+Specifies the text that needs to be formatted in bold.<br><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">Style</td>\r
+ <td class="tabledata">Specifies the CSS style to use.</td>\r
+ </tr>\r
+</table>\r
+ </div>\r
+ </body>\r
+</html>\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 - 2.29: addbutton</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">2.29 addbutton</span><br><br>\r
+\r
+Adds a button.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->addbutton(buttonname, options);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->addbutton(“button”, { Value => “clicked”, Description => “Click this button”, Style => “buttonstyle” });\r
+</div>\r
+\r
+<br>\r
+\r
+buttonname<br>\r
+Specifies the button name to use.<br><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">Value</td>\r
+ <td class="tabledata">Specifies a value for the button when clicked on.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Description</td>\r
+ <td class="tabledata">Specifies a description (label) for the button.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Style</td>\r
+ <td class="tabledata">Specifies the CSS style to use.</td>\r
+ </tr>\r
+</table>\r
+ </div>\r
+ </body>\r
+</html>\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 - 2.11: addcell</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">2.11 addcell</span><br><br>\r
+\r
+Adds a table cell.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->addcell(style);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+$kiriwrite_presmodule->addcell(“tablecellstyle”);\r
+</div>\r
+\r
+<br>\r
+\r
+style<br>\r
+Specifies the CSS style to use.\r
+ </div>\r
+ </body>\r
+</html>\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 - 2.19: addcheckbox</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">2.19 addcheckbox</span><br><br>\r
+\r
+Adds a check box.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->addcheckbox(checkboxname, options);\r
+</div>\r
+\r
+<br>\r
+\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
+</div>\r
+\r
+<br>\r
+\r
+checkboxname<br>\r
+Specifies the name of the checkbox.<br><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">OptionDescription</td>\r
+ <td class="tabledata">Specifies a description for the checkbox value.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Style</td>\r
+ <td class="tabledata">Specifies the CSS style to use.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Checked</td>\r
+ <td class="tabledata">Specifies if the checkbox is checked.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">LineBreak</td>\r
+ <td class="tabledata">Specifies if a line break should be added.</td>\r
+ </tr>\r
+</table>\r
+ </div>\r
+ </body>\r
+</html>\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 - 2.8: addheader</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">2.8 addheader</span><br><br>\r
+\r
+Add a table header.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->addheader(headername, options);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->addheader(“Header Name”, { Style => “tableheader” });\r
+</div>\r
+\r
+<br>\r
+\r
+headername<br>\r
+Specifies the header name to use.<br><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">Values</td>\r
+ <td class="tableheading">Description</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Style</td>\r
+ <td class="tabledata">Specifies the CSS style to use.</td>\r
+ </tr>\r
+</table>\r
+ </div>\r
+ </body>\r
+</html>\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 - 2.28: addhiddendata</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">2.28 addhiddendata</span><br><br>\r
+\r
+Adds a hidden data field.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->addhiddendata(name, value);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->addhiddendata(“hidden”, “data”);\r
+</div>\r
+\r
+<br>\r
+\r
+name<br>\r
+Specifies the name of the hidden data field.<br><br>\r
+\r
+value<br>\r
+Specifies the value of the hidden data field.<br><br>\r
+ </div>\r
+ </body>\r
+</html>\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 - 2.37: addhorizontalline</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">2.37 addhorizontalline</span><br><br>\r
+\r
+Adds an horizontal line.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->addhorizontalline();\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->addhorizontalline();\r
+</div>\r
+ </div>\r
+ </body>\r
+</html>\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 - 2.32: addimage</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">2.32 addimage</span><br><br>\r
+\r
+Adds an image.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->addimage(image, options);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->addimage(“image.png”, { Width => “100”, Height => “100”, Description => “This is an image.” });\r
+</div>\r
+\r
+<br>\r
+\r
+image<br>\r
+Specifies the filename of the image to use.<br><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">Style</td>\r
+ <td class="tabledata">Specifies the CSS style to use for the image.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Description</td>\r
+ <td class="tabledata">Specifies the description of the image.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Width</td>\r
+ <td class="tabledata">Specifies the width of the image.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Height</td>\r
+ <td class="tabledata">Specifies the height of the image.</td>\r
+ </tr>\r
+</table>\r
+ </div>\r
+ </body>\r
+</html>\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 - 2.24: addinputbox</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">2.24 addinputbox</span><br><br>\r
+\r
+Adds an input box.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->addinputbox(inputboxname, options);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->addinputbox(“inputbox”, { Size => “64”, MaxLength => “128”, Style => “inputbox”, Value => “Default” });\r
+</div>\r
+\r
+<br>\r
+\r
+inputboxname<br>\r
+Specifies the input box name to use.<br><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">Size</td>\r
+ <td class="tabledata">Specifies the size of the input box.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">MaxLength</td>\r
+ <td class="tabledata">Specifies the maximum length of the input box.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Style</td>\r
+ <td class="tabledata">Specifies the CSS style of the input box.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Value</td>\r
+ <td class="tabledata">Specifies the value of the input box.</td>\r
+ </tr>\r
+</table>\r
+ </div>\r
+ </body>\r
+</html>\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 - 2.35: additalictext</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">2.35 additalictext</span><br><br>\r
+\r
+Adds some italic text.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->additalictext(text, options);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->additalictext(“This is italic formatted text.”, { Style => “italictext” });\r
+</div>\r
+\r
+<br>\r
+\r
+text<br>\r
+Specifies the italic text to use.<br><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">Style</td>\r
+ <td class="tabledata">Specifies the CSS style to use.</td>\r
+ </tr>\r
+</table>\r
+ </div>\r
+ </body>\r
+</html>\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 - 2.39: additem</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">2.39 additem</span><br><br>\r
+\r
+Adds an item to a list.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->additem(text, options);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->additem(“This is an item”, { Style => “itemstyle” });\r
+</div>\r
+\r
+<br>\r
+\r
+text<br>\r
+Specifies the text to use for the item.<br><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">Style</td>\r
+ <td class="tabledata">Specifies the CSS style to use.</td>\r
+ </tr>\r
+</table>\r
+ </div>\r
+ </body>\r
+</html>\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 - 2.36: addlinebreak</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">2.36 addlinebreak</span>\r
+\r
+Adds a line break.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->addlinebreak();\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->addlinebreak();\r
+</div>\r
+ </div>\r
+ </body>\r
+</html>\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 - 2.31: addlink</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">2.31 addlink</span><br><br>\r
+\r
+Adds a link.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->addlink(link, options);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->addlink(“kiriwrite.cgi?mode=db”, { Text => “View the database list.” });\r
+</div>\r
+\r
+<br>\r
+\r
+link<br>\r
+Specifies the location the link should go to when it is clicked on.<br><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">Target</td>\r
+ <td class="tabledata">Specifies the target window for the link.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Text</td>\r
+ <td class="tabledata">Specifies the text to use.</td>\r
+ </tr>\r
+</table>\r
+ </div>\r
+ </body>\r
+</html>\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 - 2.22: addoption</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">2.22 addoption</span><br><br>\r
+\r
+Adds an option.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->addoption(optionname, options);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->addoption(“Option Name”, { Style => “option”, Value => “optionvalue” });\r
+</div>\r
+\r
+<br>\r
+\r
+optionname<br>\r
+Specifies the option name.<br><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">Style</td>\r
+ <td class="tabledata">Specifies the CSS style to use.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Value</td>\r
+ <td class="tabledata">Specifies the value for the option when selected.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Selected</td>\r
+ <td class="tabledata">Specifies if the option should be selected by default.</td>\r
+ </tr>\r
+</table>\r
+ </div>\r
+ </body>\r
+</html>\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 - 2.20: addradiobox</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">2.20 addradiobox</span><br><br>\r
+\r
+Add a radio box.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->addradiobox(radioboxname, options);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->addradiobox(“radiobox”, { Description => “Radio box”, Selected => 1, Value => “radioboxselected” } );\r
+</div>\r
+\r
+<br>\r
+\r
+radioboxname<br>\r
+Specifies the radio box name to use.<br><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">Description</td>\r
+ <td class="tabledata">Specifies a description for the radio box name.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Style</td>\r
+ <td class="tabledata">Specifies the CSS style to use.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Selected</td>\r
+ <td class="tabledata">Specifies if the radio box should be selected.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">LineBreak</td>\r
+ <td class="tabledata">Specifies if a line break should be added.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Value</td>\r
+ <td class="tabledata">Specifies the value of the radio box.</td>\r
+ </tr>\r
+</table>\r
+ </div>\r
+ </body>\r
+</html>\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 - 2.27: addreset</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">2.27 addreset</span><br><br>\r
+\r
+Adds a reset button.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->addreset(resetname, options);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->addreset(“Reset this”, { Style => “resetbutton” });\r
+</div>\r
+\r
+<br>\r
+\r
+resetname<br>\r
+Specifies the label of the reset button.<br><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">Style</td>\r
+ <td class="tabledata">Specifies the CSS style to use.</td>\r
+ </tr>\r
+</table>\r
+ </div>\r
+ </body>\r
+</html>\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 - 2.21: addselectbox</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">2.21 addselectbox</span><br><br>\r
+\r
+Adds a select box.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->addselectbox(selectboxname, options);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->addselectbox(“selectbox”, { Style => “selectbox” });\r
+</div>\r
+\r
+<br>\r
+\r
+style<br>\r
+Specifies the CSS style to use.<br><br>\r
+\r
+<i>options</i><br>\r
+Specifies the following options 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">Style</td>\r
+ <td class="tabledata">Specifies the CSS style to use.</td>\r
+ </tr>\r
+</table>\r
+ </div>\r
+ </body>\r
+</html>\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 - 2.26: addsubmit</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">2.26 addsubmit</span><br><br>\r
+\r
+Adds a submit button.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->addsubmit(submitname, options);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->addsubmit(“Submit This”, { Style => “submitbutton” });\r
+</div>\r
+\r
+<br>\r
+\r
+submitname<br>\r
+Specifies the label of the submit button.<br><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">Style</td>\r
+ <td class="tabledata">Specifies the CSS style to use.</td>\r
+ </tr>\r
+</table>\r
+ </div>\r
+ </body>\r
+</html>\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 - 2.33: addtext</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">2.33 addtext</span><br><br>\r
+\r
+Adds some text.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->addtext(text, options);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->addtext(“Here's some text.”, { Style => “textformat” });\r
+</div>\r
+\r
+<br>\r
+\r
+text<br>\r
+Specifies the text to be added.<br><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">Style</td>\r
+ <td class="tabledata">Specifies the CSS style to use.</td>\r
+ </tr>\r
+</table>\r
+ </div>\r
+ </body>\r
+</html>\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 - 2.25: addtextbox</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">2.25 addtextbox</span><br><br>\r
+\r
+Adds a multiple line text box.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->addtextbox(textboxname, options);\r
+</div>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->addtextbox(“textbox”, { Columns => 25, Rows => 5, Style => “textbox”, Value => “This is a text box.” });\r
+</div>\r
+\r
+<br>\r
+\r
+textboxname<br>\r
+Specifies the name of the multiple line text box.<br><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">Columns</td>\r
+ <td class="tabledata">Specifies the width of the multiple line text box.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Rows</td>\r
+ <td class="tabledata">Specifies the height of the multiple line text box.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Style</td>\r
+ <td class="tabledata">Specifies the CSS style of the multiple line text box.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Value</td>\r
+ <td class="tabledata">Specifies the value of the multiple line text box.</td>\r
+ </tr>\r
+</table>\r
+ </div>\r
+ </body>\r
+</html>\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 - 2.3: clear</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">2.3 clear</span><br><br>\r
+\r
+Clears the current layout created by the presentation module.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->clear();\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->clear();\r
+</div>\r
+ </div>\r
+ </body>\r
+</html>\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 - 2.5: convert</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">2.5 convert</span><br><br>\r
+\r
+Converts the data passed into data that is compliant with the format used by the presentation module. All parameters in the subroutine will be used.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->convert(data, type);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->convert();\r
+</div>\r
+\r
+<br>\r
+\r
+data<br>\r
+Specifies the data to convert.<br><br>\r
+\r
+type<br>\r
+Specifies the type of data to convert.<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">content</td>\r
+ <td class="tabledata">Specifies the data to convert is for content.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">link</td>\r
+ <td class="tabledata">Specifies the data to convert is for a link.</td>\r
+ </tr>\r
+</table>\r
+\r
+<br>\r
+\r
+Bear in mind that while convert is not used by the main Kiriwrite script it can be used internally to convert text to be used in links and forms.\r
+ </div>\r
+ </body>\r
+</html>\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 - 2.17: endbox</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">2.17 endbox</span><br><br>\r
+\r
+Ends an information box.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->endbox();\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->endbox();\r
+</div>\r
+ </div>\r
+ </body>\r
+</html>\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 - 2.12: endcell</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">2.12 endcell</span><br><br>\r
+\r
+Ends a table cell.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->endcell();\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+$kiriwrite_presmodule->endcell();\r
+</div>\r
+ </div>\r
+ </body>\r
+</html>\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 - 2.30: endform</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">2.30 endform</span><br><br>\r
+\r
+Ends a form.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->endform();\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->endform();\r
+</div>\r
+ </div>\r
+ </body>\r
+</html>\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 - 2.9: endheader</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">2.9 endheader</span><br><br>\r
+\r
+Ends a table header.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->endheader();\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->endheader();\r
+</div>\r
+ </div>\r
+ </body>\r
+</html>\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 - 2.40: endlist</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">2.40 endlist</span><br><br>\r
+\r
+Ends a list.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->endlist();\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->endlist();\r
+</div>\r
+ </div>\r
+ </body>\r
+</html>\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 - 2.13: endrow</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">2.13 endrow</span><br><br>\r
+\r
+Ends a table row.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->endrow();\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->endrow();\r
+</div>\r
+ </div>\r
+ </body>\r
+</html>\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 - 2.23: endselectbox</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">2.23 endselectbox</span><br><br>\r
+\r
+Ends a select box.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->endselectbox();\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->endselectbox();\r
+</div>\r
+ </div>\r
+ </body>\r
+</html>\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 - 2.14: endtable</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">2.14 endtable</span><br><br>\r
+\r
+Ends a table.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->endtable();\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->endtable();\r
+</div>\r
+ </div>\r
+ </body>\r
+</html>\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 - 2.16: enterdata</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">2.16 enterdata</span><br><br>\r
+\r
+Enter data into an information box.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->enterdata(data);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->enterdata(“Data for the information box.”);\r
+</div>\r
+\r
+<br>\r
+\r
+data<br>\r
+Specifies the data to enter into the information box.\r
+ </div>\r
+ </body>\r
+</html>\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 - 2.4: grab</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">2.4 grab</span><br><br>\r
+\r
+Grab the current layout created by this module.<br><br>\r
+\r
+<span class="heading">Presentation:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->grab();\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Module:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->grab();\r
+</div>\r
+ </div>\r
+ </body>\r
+</html>\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 - 2.1: Guidance</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">2.1 Guidance</span><br><br>\r
+\r
+When creating a new presentation module to be used in Kiriwrite, the following is required.<br><br>\r
+\r
+When creating a new presentation module, at the top of the page the following should be inserted:<br><br>\r
+\r
+<div class="code">\r
+ package Kiriwrite::Presentation::(modulename);<br><br>\r
+\r
+ use strict;<br>\r
+ use warnings;<br><br>\r
+\r
+ our $VERSION = “(version)”;<br>\r
+ my $pagedata = “”;\r
+</div>\r
+\r
+<br>\r
+\r
+Replace (modulename) with the name of the module like HTML4S (which means HTML 4.01 Strict. When specifying the module name it should be the name of the format (HTML) and version (4S as in 4.01 Strict).<br><br>\r
+'use strict' and 'use warnings' isn't required but it is generally accepted that Perl scripts and modules should have 'use strict' and 'use warnings' lines written.<br><br>\r
+Replace (version) with the internal version number of the module.<br><br>\r
+'my $pagedata' doesn't need to be $pagedata and can be something else like $data but it's somewhere where the page data can be stored until it is needed.\r
+Presentation modules are stored in the Modules/Presentation directory. For an example of a written presentation module look at the HTML4S.pm file.\r
+ </div>\r
+ </body>\r
+</html>\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 - 2.2: new</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">2.2 new</span><br><br>\r
+\r
+Creates a new instance of the presentation module.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<code class="code">\r
+ Kiriwrite::Presentation::(modulename)->new();\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule = Kiriwrite::Presentation::HTML4S->new();\r
+</div>\r
+\r
+<br>\r
+\r
+(modulename)<br>\r
+Specifies the name of the presentation module.\r
+ </div>\r
+ </body>\r
+</html>\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 - 2.15: startbox</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">2.15 startbox</span><br><br>\r
+\r
+Starts an information box.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->startbox(style);\r
+</div>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->startbox(“boxstyle”);\r
+</div>\r
+\r
+style<br>\r
+Specifies the CSS style to use.\r
+ </div>\r
+ </body>\r
+</html>\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 - 2.18: startform</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">2.18 startform</span><br><br>\r
+\r
+Start a form.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->startform(action, method);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->startform(“kiriwrite.cgi”, “POST”);\r
+</div>\r
+\r
+<br>\r
+\r
+action<br>\r
+Specifies where the form data should be sent to.<br><br>\r
+\r
+method<br>\r
+Specifies the method of posting the data.<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">POST</td>\r
+ <td class="tabledata">Posts the form data. The data does not appear in the address bar.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">GET</td>\r
+ <td class="tabledata">Gets the form data. The data appears in the address bar.</td>\r
+ </tr>\r
+</table>\r
+ </div>\r
+ </body>\r
+</html>\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 - 2.7: startheader</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">2.7 startheader</span><br><br>\r
+\r
+Starts a table header.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->startheader();\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->startheader();\r
+</div>\r
+ </div>\r
+ </body>\r
+</html>\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 - 2.38: startlist</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">2.38 startlist</span><br><br>\r
+\r
+Begin a list.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->startlist();\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->startlist();\r
+</div>\r
+ </div>\r
+ </body>\r
+</html>\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 - 2.10: startrow</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">2.10 startrow</span><br><br>\r
+\r
+Starts a table row.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->startrow();\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->startrow();\r
+</div>\r
+ </div>\r
+ </body>\r
+</html>\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 - 2.6: starttable</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">2.6 starttable</span><br><br>\r
+\r
+Starts a table.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->starttable(cssstyle, options);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_presmodule->starttable(“tablestyle”);<br>\r
+ $kiriwrite_presmodule->starttable(“tablestyle”, { CellSpacing => 1, CellPadding => 1});\r
+</div>\r
+\r
+<br>\r
+\r
+cssstyle<br>\r
+Specifies the cascading style sheet (CSS) style to use.<br><br>\r
+\r
+options<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">CellSpacing</td>\r
+ <td class="tabledata">Specifies the cell spacing to use.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">CellPadding</td>\r
+ <td class="tabledata">Specifies the cell padding to use.</td>\r
+ </tr>\r
+</table>\r
+ </div>\r
+ </body>\r
+</html>\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 - Chapter 2: Presentation Module</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 2: Presentation Module</span><br><br>\r
+\r
+The subroutines listed here in this chapter are used by the presentation module. The presentation module outputs the page data in Kiriwrite as the specified format. An example of this is the HTML4S module which writes the page in the HTML 4.0 Strict format.<br><br>\r
+\r
+When the presentation module is loaded the subroutines for it can be called from the $kiriwrite_presmodule scalar.\r
+ </div>\r
+ </body>\r
+</html>\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.16: adddatabase</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">3.16 adddatabase</span><br><br>\r
+\r
+Adds a database.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->adddatabase(options);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->adddatabase({ DatabaseFilename => “database”, DatabaseName => “Database Name”, DatabaseDescription => “Database Description”, DatabaseNotes => “Some notes about the database”, DatabaseCategories => “database, new, categories”, VersionMajor => 0, VersionMinor => 1, VersionRevision => 0 });\r
+</div>\r
+\r
+<br>\r
+\r
+options<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">DatabaseFilename</td>\r
+ <td class="tabledata">Specifies the filename of the new database.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">DatabaseName</td>\r
+ <td class="tabledata">Specifies the name of the new database.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">DatabaseDescription</td>\r
+ <td class="tabledata">Specifies the description of the new database.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">DatabaseNotes</td>\r
+ <td class="tabledata">Specifies the notes of the new database.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">DatabaseCategories</td>\r
+ <td class="tabledata">Specifies the categories of the new database.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">VersionMajor</td>\r
+ <td class="tabledata">Specifies the major version number of the new database.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">VersionMinor</td>\r
+ <td class="tabledata">Specifies the minor version number of the new database.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">VersionRevision</td>\r
+ <td class="tabledata">Specifies the revision version number of the new database.</td>\r
+ </tr>\r
+</table>\r
+\r
+<br>\r
+\r
+If a database is created but the filename already exists (after checking if it does exist using the dbexists subroutine) then the error returned should be 'DatabaseExists' in the $error scalar.<br><br>\r
+\r
+If a database error occurs while adding the database, the error returned should be 'DatabaseError' in the $error scalar and the information about the error placed in the $errorext scalar.\r
+ </div>\r
+ </body>\r
+</html>\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.37: addfilter</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">3.37 addfilter</span><br><br>\r
+\r
+Adds a filter to the filter database.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->addfilter(options);\r
+</div>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->connectfilter(1);\r
+ $kiriwrite_dbmodule->addfilter({ FindFilter => “This is the find filter.”, ReplaceFilter => “This is the replace filter.”, Priority => 1, Notes => “Some notes about the filter.” });\r
+</div>\r
+\r
+<br>\r
+\r
+options<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">FindFilter</td>\r
+ <td class="tabledata">Specifies the find filter setting of the new filter.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">ReplaceFilter</td>\r
+ <td class="tabledata">Specifies the replace filter setting of the new filter.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Priority</td>\r
+ <td class="tabledata">Specifies the priority setting of the new filter.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Notes</td>\r
+ <td class="tabledata">Specifies the notes for the new filter.</td>\r
+ </tr>\r
+</table>\r
+\r
+<br>\r
+\r
+If the filter database cannot be created when adding a filter and the filter database doesn't already exist then the error returned should be 'FilterDatabaseFileUncreatable' in the $error scalar.<br><br>\r
+\r
+If (when using the file-based database module) the filter database has invalid permissions set then the error returned should be 'FilterDatabaseInvalidPermissionsSet' in the $error scalar.\r
+ </div>\r
+ </body>\r
+</html>\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.28: addpage</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">3.28 addpage</span><br><br>\r
+\r
+Adds a page to the selected database.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->addpage(options);\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>\r
+ $kiriwrite_dbmodule->addpage({ PageFilename => “newpage.html”, PageName => “New Page Name”, PageDescription => “New Page Description”, PageSection => “New Page Section”, PageTemplate => “pagetemplate.html”, PageContent => “This is the new page content.”, PageSettings => 0 });\r
+</div>\r
+\r
+<br>\r
+\r
+options<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">PageFilename</td>\r
+ <td class="tabledata">Specifies the page filename to use.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">PageName</td>\r
+ <td class="tabledata">Specifies the page name.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">PageDescription</td>\r
+ <td class="tabledata">Specifies the page description.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">PageSection</td>\r
+ <td class="tabledata">Specifies the page section.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">PageTemplate</td>\r
+ <td class="tabledata">Specifies the page template to use.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">PageContent</td>\r
+ <td class="tabledata">Specifies the content of the page.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">PageSettings</td>\r
+ <td class="tabledata">Specifies the page settings to use.<br><br>\r
+ 1: Use page name and section name.<br>\r
+ 2: Use the page name only.<br>\r
+ 3: Use the section name only.<br>\r
+ 0: Don't use page name or section name.\r
+ </td>\r
+ </tr>\r
+</table>\r
+\r
+<br>\r
+\r
+If a page with the filename given already exists then the error returned should be 'PageExists' in the $error scalar.<br><br>\r
+\r
+If a database error occurs while adding a page 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
+ </div>\r
+ </body>\r
+</html>\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.23: addtemplate</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">3.23 addtemplate</span><br><br>\r
+\r
+Add a template to the template database. If the template database doesn't exist then it should be created in this subroutine.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->addtemplate(options);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->addtemplate({ TemplateFilename => “template.html”, TemplateName => “Template Name”, TemplateDescription => “Template Description”, TemplateLayout => “This is the template layout.” });\r
+</div>\r
+\r
+<br>\r
+\r
+options<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">TemplateFilename</td>\r
+ <td class="tabledata">Specifies the template filename to use.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">TemplateName</td>\r
+ <td class="tabledata">Specifies the template name to use.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">TemplateDescription</td>\r
+ <td class="tabledata">Specifies the template description to use.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">TemplateLayout</td>\r
+ <td class="tabledata">Specifies the template layout to use.</td>\r
+ </tr>\r
+</table>\r
+\r
+<br>\r
+\r
+If the template filename already exists when adding the template then the error returned should be 'TemplatePageExists' in the $error scalar.<br><br>\r
+\r
+If the template database cannot be created when adding a template and the template database doesn't already exist then the error returned should be 'TemplateDatabaseFileUncreatable' in the $error scalar.<br><br>\r
+\r
+If (when using a file-based database module) the template database has invalid permissions set then the error returned should be 'TemplateDatabaseInvalidPermissionsSet' in the $error scalar.<br><br>\r
+\r
+If a database error occurs while adding a template to the template database then the error returned should be 'TemplateDatabaseError' in the $error scalar and information about the error should be placed in the $errorext scalar.\r
+ </div>\r
+ </body>\r
+</html>\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.9: connect</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">3.9 connect</span><br><br>\r
+\r
+Connect to the database server.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->connect();\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->connect();\r
+</div>\r
+\r
+<br>\r
+\r
+This subroutine is only required if your database module is a server-based database module. If it's a file-based database module then the subroutine should be created, but left blank.<br><br>\r
+\r
+If a database error occurs while connecting, the error returned should be 'DatabaseError' in the $error scalar and the information about the error placed in the $errorext scalar.\r
+ </div>\r
+ </body>\r
+</html>\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.33: connectfilter</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">3.33 connectfilter</span><br><br>\r
+\r
+Connects to the filter database.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->connectfilter(missingignore);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->connectfilter(1);\r
+</div>\r
+\r
+<br>\r
+\r
+missingignore<br>\r
+Specifies that an error should not be returned if the filter database does not exist.<br><br>\r
+\r
+If the filter database does not exist then the error returned should be 'FilterDatabaseDoesNotExist' in the $error scalar.<br><br>\r
+\r
+If (when using the file-based database module) the filter database has invalid permissions set then the error returned should be 'FilterDatabaseInvalidPermissionsSet' in the $error scalar.<br><br>\r
+\r
+If a database error occurs while accessing 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
+ </div>\r
+ </body>\r
+</html>\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.19: connecttemplate</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">3.19 connecttemplate</span><br><br>\r
+\r
+Connects to the template database.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->connecttemplate(missingignore);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->connecttemplate(1);\r
+</div>\r
+\r
+<br>\r
+\r
+missingignore<br>\r
+Specifies that an error should not be returned if the template database does not exist.<br><br>\r
+\r
+If the template database does not exist then the error returned should be 'TemplateDatabaseDoesNotExist' in the $error scalar.<br><br>\r
+\r
+If (when using a file-based database module) the template database has invalid permissions set then the error returned should be 'TemplateDatabaseInvalidPermissionsSet' in the $error scalar.<br><br>\r
+\r
+If a database error occurs while connecting to the template database, 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
+</html>\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.4: convert</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">3.4 convert</span><br><br>\r
+\r
+Convers the data passed to the subroutine into SQL-formatted data.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->convert(data);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $data_sql = $kiriwrite_dbmodule->convert(“This 'data' should be SQL formatted.”);\r
+</div>\r
+\r
+<br>\r
+\r
+data<br>\r
+Specifies the data to be converted into SQL formatted data.\r
+ </div>\r
+ </body>\r
+</html>\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.32: copypage</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">3.32 copypage</span><br><br>\r
+\r
+Copies pages from one database to another database.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->copypage(options);\r
+</div>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->selectdb(“database”);<br>\r
+ $kiriwrite_dbmodule->selectseconddb(“newdatabase”);<br>\r
+ $kiriwrite_dbmodule->copypage({ PageFilename => “page.html” });\r
+</div>\r
+\r
+<br>\r
+\r
+options<br>\r
+Specifies the following options as a hash.<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">PageFilename</td>\r
+ <td class="tabledata">Specifies the page with the filename to copy.</td>\r
+ </tr>\r
+</table>\r
+\r
+<br>\r
+\r
+If the page does not exist in the database the page is being copied from then the error returned should be 'PageDoesNotExist' in the $error scalar.<br><br>\r
+\r
+If the page already exists in the database the page is being copied to then the error returned should be 'PageAlreadyExists' in the $error scalar.<br><br>\r
+\r
+If a database error occurs in the database the page is being copied from then the error returned should be 'OldDatabaseError' in the $error scalar and information about the error should be in the $errorext scalar.<br><br>\r
+\r
+If a database error occurs in the database the page is being copied to then the error returned should be 'NewDatabaseError' in the $error scalar and information about the error should be in the $errorext scalar.\r
+ </div>\r
+ </body>\r
+</html>\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.5: dateconvert</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">3.5 dateconvert</span><br><br>\r
+\r
+Converts a SQL date into a proper date that is used by Kiriwrite.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->dateconvert(date);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $date_converted = $kiriwrite_dbmodule->dateconvert(“2007-08-25 20:36:00”);\r
+</div>\r
+\r
+<br>\r
+\r
+date<br>\r
+Specifies the date that should be converted into a date that can be used by Kiriwrite.\r
+ </div>\r
+ </body>\r
+</html>\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.8: dbexists</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">3.8 dbexists</span><br><br>\r
+\r
+Specifies if the database exists with the name given. A value is returned if the database exists.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->dbexists(dbname);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $db_exists = $kiriwrite_dbmodule->dbexists(“database”);\r
+</div>\r
+\r
+<br>\r
+\r
+dbname<br>\r
+Specifies the database name to check.\r
+ </div>\r
+ </body>\r
+</html>\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.7: dbpermissions</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">3.7 dbpermissions</span><br><br>\r
+\r
+Checks if the Kiriwrite database permissions given are valid.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->dbpermissions(database, read, write);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $database_permissions = $kiriwrite_dbmodule->dbpermissions(“database”, 1, 1);\r
+</div>\r
+\r
+<br>\r
+\r
+database<br>\r
+Specifies the database to check.<br><br>\r
+\r
+<i>read</i><br>\r
+Check if the database can be read from.<br><br>\r
+\r
+<i>write</i><br>\r
+Check if the database can be written to.\r
+ </div>\r
+ </body>\r
+</html>\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.18: deletedatabase</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">3.18 deletedatabase</span><br><br>\r
+\r
+Deletes a database.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->deletedatabase(options);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->deletedatabase({ DatabaseName => “database” });\r
+</div>\r
+\r
+<br>\r
+\r
+options<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">DatabaseName</td>\r
+ <td class="tabledata">Specifies the database to delete.</td>\r
+ </tr>\r
+</table>\r
+\r
+<br>\r
+\r
+If the database with the name given does not exist then the error returned should be 'DoesNotExist' in the $error scalar.<br><br>\r
+If a database error occurs while deleting the database, the error returned should be 'DatabaseError' in the $error scalar and the information about the error placed in the $errorext scalar.<br><br>\r
+If (when using a file-based database module) the database module can't be deleted because of invalid permissions set then the error returned should be 'InvalidPermissionsSet' in the $error scalar.\r
+ </div>\r
+ </body>\r
+</html>\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.39: deletefilter</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">3.39 deletefilter</span><br><br>\r
+\r
+Deletes a filter in the filter database.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->deletefilter(options);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->connectfilter();<br>\r
+ $kiriwrite_dbmodule->deletefilter({ FilterID => 1 });\r
+</div>\r
+\r
+<br>\r
+\r
+options<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">FilterID</td>\r
+ <td class="tabledata">Specifies the filter with the identification number given to delete.</td>\r
+ </tr>\r
+</table>\r
+\r
+<br>\r
+\r
+If the filter with the filter identification number given does not exist then the error returned should be 'FilterDoesNotExist' in the $error scalar.<br><br>\r
+\r
+If a database error occurs while deleting the filter 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
+ </div>\r
+ </body>\r
+</html>\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.30: deletepage</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">3.30 deletepage</span><br><br>\r
+\r
+Deletes a page from the selected database.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->deletepage(options);\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>\r
+ $kiriwrite_dbmodule->deletepage({ PageFilename => “page.html” });\r
+</div>\r
+\r
+<br>\r
+\r
+options<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">PageFilename</td>\r
+ <td class="tabledata">Specifies the page filename to delete.</td>\r
+ </tr>\r
+</table>\r
+\r
+<br>\r
+\r
+If the page does not already exist then the error returned should be 'PageDoesNotExist' in the $error scalar.<br><br>\r
+\r
+If a database error occurs while editing a page 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
+ </div>\r
+ </body>\r
+</html>\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.25: deletetemplate</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">3.25 deletetemplate</span><br><br>\r
+\r
+Deletes a template from the template database.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->deletetemplate(options);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->deletetemplate({ TemplateFilename => “template.html” });\r
+</div>\r
+\r
+<br>\r
+\r
+options<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">TemplateFilename</td>\r
+ <td class="tabledata">Specifies the template with the filename to delete.</td>\r
+ </tr>\r
+</table>\r
+\r
+<br>\r
+\r
+If the template being deleted does not exist then the error returned should be 'TemplateDoesNotExist' in the $error scalar.<br><br>\r
+\r
+If a database error occurs while deleting a template in the template database then the error returned should be 'TemplateDatabaseError' in the $error scalar and information about the error should be placed in the $errorext scalar.\r
+ </div>\r
+ </body>\r
+</html>\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.10: disconnect</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">3.10 disconnect</span><br><br>\r
+\r
+Disconnect from the database server.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->disconnect();\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->disconnect();\r
+</div>\r
+\r
+<br>\r
+\r
+This subroutine is only required if your database module is a server-based database module. If it's a file-based database module then the subroutine should be created but (usually) left blank.\r
+ </div>\r
+ </body>\r
+</html>\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.34: disconnectfilter</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">3.34 disconnectfilter</span><br><br>\r
+\r
+Disconnect from the filter database.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->disconnectfilter();\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->disconnectfilter();\r
+</div>\r
+ </div>\r
+ </body>\r
+</html>\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.20: disconnecttemplate</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">3.20 disconnecttemplate</span><br><br>\r
+\r
+Disconnects from the template database.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->disconnecttemplate();\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->disconnecttemplate();\r
+</div>\r
+\r
+<br>\r
+\r
+If the database module is a server-based module then typically the subroutine only needs to be created but left blank.\r
+ </div>\r
+ </body>\r
+</html>\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.17: editdatabase</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">3.17 editdatabase</span><br><br>\r
+\r
+Edits a database.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->editdatabase(options);\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>\r
+ $kiriwrite_dbmodule->editdatabase({ DatabaseNewFilename => “newdatabase”, DatabaseName => “New Database Name”, DatabaseDescription => “New Database Description”, DatabaseNotes => “New Database Notes”, DatabaseCategories => “new, database, categories” });\r
+</div>\r
+\r
+<br>\r
+\r
+options<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">DatabaseNewFilename</td>\r
+ <td class="tabledata">Specifies the new filename of the database.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">DatabaseName</td>\r
+ <td class="tabledata">Specifies the new database name.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">DatabaseDescription</td>\r
+ <td class="tabledata">Specifies the new database description.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">DatabaseNotes</td>\r
+ <td class="tabledata">Specifies the new notes.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">DatebaseCategories</td>\r
+ <td class="tabledata">Specifies the new categories.</td>\r
+ </tr>\r
+</table>\r
+\r
+<br>\r
+\r
+If a database is edited but the filename already exists (after checking if it does exist using the dbexists subroutine) then the error returned should be 'DatabaseExists' in the $error scalar.<br><br>\r
+\r
+If a database error occurs while editing the database, the error returned should be 'DatabaseError' in the $error scalar and the information about the error placed in the $errorext scalar.<br><br>\r
+\r
+If (when using a file-based database module) the database module can't be edited because of invalid permissions set then the error returned should be 'InvalidPermissionsSet' in the $error scalar.\r
+ </div>\r
+ </body>\r
+</html>\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.38: editfilter</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">3.38 editfilter</span><br><br>\r
+\r
+Edits a filter in the filter database.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->editfilter(options);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->connectfilter();<br>\r
+ $kiriwrite_dbmodule->editfilter({ FilterID => 1, NewFindFilter => “The new find filter setting.”, NewReplaceFilter => “The new replace filter setting.”, NewFilterPriority => 2, NewFilterNotes => “The new notes of the filter.” });\r
+</div>\r
+\r
+options<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">FilterID</td>\r
+ <td class="tabledata">Specifies the filter with the identification number to edit.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">NewFindFilter</td>\r
+ <td class="tabledata">Specifies the new find filter setting.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">NewReplaceFilter</td>\r
+ <td class="tabledata">Specifies the new replace filter setting.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">NewFilterPriority</td>\r
+ <td class="tabledata">Specifies the new filter priority setting.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">NewFilterNotes</td>\r
+ <td class="tabledata">Specifies the new filter notes.</td>\r
+ </tr>\r
+</table>\r
+\r
+<br>\r
+\r
+If the filter with the filter identification number given does not exist then the error returned should be 'FilterDoesNotExist' in the $error scalar.<br><br>\r
+\r
+If (when using the file-based database module) the filter database has invalid permissions set then the error returned should be 'FilterDatabaseInvalidPermissionsSet' in the $error scalar.<br><br>\r
+\r
+If a database error occurs while editing the filter in 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
+ </div>\r
+ </body>\r
+</html>\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.29: editpage</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">3.29 editpage</span><br><br>\r
+\r
+Edits a page in the selected database.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->editpage(options);\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>\r
+ $kiriwrite_dbmodule->editpage({ PageFilename => “page.html”, PageNewFilename => “editedpage.html”, PageNewName => “Edited Page Name”, PageNewDescription => “Edited Page Description”, PageNewSection => “Edited Page Section”, PageNewTemplate => “editedpagetemplate.html”, PageNewContent => “This is the edited page content.”, PageNewSettings => 0 });\r
+</div>\r
+\r
+<br>\r
+\r
+options<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">PageFilename</td>\r
+ <td class="tabledata">Specifies the page with the filename to edit.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">PageNewFilename</td>\r
+ <td class="tabledata">Specifies the new filename of the page.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">PageNewName</td>\r
+ <td class="tabledata">Specifies the new name of the page.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">PageNewDescription</td>\r
+ <td class="tabledata">Specifies the new description of the page.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">PageNewSection</td>\r
+ <td class="tabledata">Specifies the new section of the page.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">PageNewTemplate</td>\r
+ <td class="tabledata">Specifies the new template filename to use.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">PageNewContent</td>\r
+ <td class="tabledata">Specifies the new page content to use.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">PageNewSettings</td>\r
+ <td class="tabledata">Specifies the new page settings to use.<br>\r
+ 1: Use page name and section name.<br>\r
+ 2: Use the page name only.<br>\r
+ 3: Use the section name only.<br>\r
+ 0: Don't use page name or section name.\r
+ </td>\r
+ </tr>\r
+</table>\r
+\r
+<br>\r
+\r
+If the page does not already exist then the error returned should be 'PageDoesNotExist' in the $error scalar.<br><br>\r
+\r
+If a page with the filename given already exists when renaming the filename of the page then the error returned should be 'PageExists' in the $error scalar.<br><br>\r
+\r
+If a database error occurs while editing a page 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
+ </div>\r
+ </body>\r
+</html>\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.24: edittemplate</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">3.24 edittemplate</span><br><br>\r
+\r
+Edits a template from the template database.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->edittemplate(options);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->edittemplate({ TemplateFilename => “template.html”, NewTemplateFilename => “newtemplate.html”, NewTemplateName => “New Template Name”, NewTemplateDescription => “New Template Description”, NewTemplateLayout => “This is the new template layout.” });\r
+</div>\r
+\r
+<br>\r
+\r
+options<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">TemplateFilename</td>\r
+ <td class="tabledata">Specifies the template filename to edit.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">NewTemplateFilename</td>\r
+ <td class="tabledata">Specifies the new template filename to use.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">NewTemplateName</td>\r
+ <td class="tabledata">Specifies the new template name to use.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">NewTemplateDescription</td>\r
+ <td class="tabledata">Specifies the new template description to use.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">NewTemplateLayout</td>\r
+ <td class="tabledata">Specifies the new template layout to use.</td>\r
+ </tr>\r
+</table>\r
+\r
+<br>\r
+\r
+If the template being edited does not exist then the error returned should be 'TemplateDoesNotExist' in the $error scalar.<br><br>\r
+\r
+If (when using a file-based database module) the template database has invalid permissions set then the error returned should be 'TemplateDatabaseInvalidPermissionsSet' in the $error scalar.<br><br>\r
+\r
+If a database error occurs while editing a template in the template database then the error returned should be 'TemplateDatabaseError' in the $error scalar and information about the error should be placed in the $errorext scalar.\r
+ </div>\r
+ </body>\r
+</html>\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.13: getdatabaseinfo</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">3.13 getdatabaseinfo</span><br><br>\r
+\r
+Gets information about the database that was selected from the selectdb subroutine. The information will be returned as a hash.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->getdatabaseinfo();\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>\r
+ %database_info = $kiriwrite_dbmodule->getdatabaseinfo();\r
+</div>\r
+\r
+<br>\r
+\r
+If a database error occurs while getting the information about the database, the error returned should be 'DatabaseError' in the $error scalar and the information about the error placed in the $errorext scalar.\r
+ </div>\r
+ </body>\r
+</html>\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.11: getdblist</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">3.11 getdblist</span><br><br>\r
+\r
+Gets the list of available databases and returns it as an array.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->getdblist();\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->getdblist();\r
+</div>\r
+\r
+<br>\r
+\r
+If a database error occurs while getting the list of databases, the error returned should be 'DatabaseError' in the $error scalar and the information about the error placed in the $errorext scalar.\r
+ </div>\r
+ </body>\r
+</html>\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.6: geterror</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">3.6 geterror</span><br><br>\r
+\r
+Gets the error message stored in the $error scalar (or extended error message stored in the $errorext scalar).<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->geterror(extendederror);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $errormessage = $kiriwrite_dbmodule->geterror();<br>\r
+ $extendederrormessage = $kiriwrite_dbmodule->geterror(1);\r
+</div>\r
+\r
+<br>\r
+\r
+extendederror<br>\r
+Specifies if the extended error information should be returned.\r
+ </div>\r
+ </body>\r
+</html>\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.36: getfilterinfo</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">3.36 getfilterinfo</span><br><br>\r
+\r
+Gets information about the filter. Returns the information about the filter as a hash.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->getfilterinfo(options);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->connectfilter();\r
+ $kiriwrite_dbmodule->getfilterinfo({ FilterID => 1 });\r
+</div>\r
+\r
+<br>\r
+\r
+options<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">FilterID</td>\r
+ <td class="tabledata">Specifies the filter identification number to get the filter information from.</td>\r
+ </tr>\r
+</table>\r
+\r
+<br>\r
+\r
+If the filter with the filter identification number given does not exist then the error returned should be 'FilterDoesNotExist' in the $error scalar.\r
+ </div>\r
+ </body>\r
+</html>\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.35: getfilterlist</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">3.35 getfilterlist</span><br><br>\r
+\r
+Gets the list of available filters. Returns the list of filters as an array.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->getfilterlist();\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->connectfilter();<br>\r
+ @filterlist = $kiriwrite_dbmodule->getfilterlist();\r
+</div>\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
+ </div>\r
+ </body>\r
+</html>\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.27: getpageinfo</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">3.27 getpageinfo</span><br><br>\r
+\r
+Gets information about the page. The page information is returned as a hash.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->getpageinfo(options);\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>\r
+ %pageinfo = $kiriwrite_dbmodule->getpageinfo({ PageFilename => “pagefilename.html” });\r
+</div>\r
+\r
+<br>\r
+\r
+options<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">PageFilename</td>\r
+ <td class="tabledata">The page filename to get the page information from.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Reduced</td>\r
+ <td class="tabledata">Returns a reduced version of the page information (page filename, page name, page description and last modified).</td>\r
+ </tr>\r
+</table>\r
+\r
+<br>\r
+\r
+If the page with the filename given does not exist then the error returned should be 'PageDoesNotExist' in the $error scalar.<br><br>\r
+\r
+If a database error occurs while getting the information about the page 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
+ </div>\r
+ </body>\r
+</html>\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.26: getpagelist</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">3.26 getpagelist</span><br><br>\r
+\r
+Gets the page list from a database. The page list is returned as an array.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->getpagelist();\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>\r
+ @pagelist = $kiriwrite_dbmodule->getpagelist();\r
+</div>\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
+ </div>\r
+ </body>\r
+</html>\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.15: getseconddatabaseinfo</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">3.15 getseconddatabaseinfo</span><br><br>\r
+\r
+Gets information about the database that was selected from the selectseconddb subroutine. The information will be returned as a hash.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->getseconddatabaseinfo();\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->selectseconddatabase(“database”);<br>\r
+ %database_info = $kiriwrite_dbmodule->getseconddatabaseinfo();\r
+</div>\r
+\r
+<br>\r
+\r
+If a database error occurs while getting the information about the database, the error returned should be 'DatabaseError' in the $error scalar and the information about the error placed in the $errorext scalar.\r
+ </div>\r
+ </body>\r
+</html>\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.22: gettemplateinfo</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">3.22 gettemplateinfo</span><br><br>\r
+\r
+Gets information about the template. The information is returned as a hash.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->gettemplateinfo(options);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->gettemplateinfo({ TemplateFilename => “template.html” });\r
+</div>\r
+\r
+<br>\r
+\r
+options<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">TemplateFilename</td>\r
+ <td class="tabledata">Specifies the template filename to get the information from.</td>\r
+ </tr>\r
+</table>\r
+\r
+<br>\r
+\r
+If the template with the filename given does not exist then the error returned should be 'TemplateDoesNotExist' in the $error scalar.<br><br>\r
+\r
+If a database error occurs while getting the template information then the error returned should be 'TemplateDatabaseError' in the $error scalar and information about the error should be placed in the $errorext scalar.\r
+ </div>\r
+ </body>\r
+</html>\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.21: gettemplatelist</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">3.21 gettemplatelist</span><br><br>\r
+\r
+Gets the list of templates. The information is returned as an array.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->gettemplatelist();\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->gettemplatelist();\r
+</div>\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
+</html>\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.1: Guidance</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">3.1 Guidance</span><br><br>\r
+\r
+When creating a new database module to be used in Kiriwrite, the following is required.<br><br>\r
+\r
+When creating a new database module, at the top of the page the following should be inserted:<br><br>\r
+\r
+<div class="code">\r
+ package Kiriwrite::Database::(modulename);<br><br>\r
+\r
+ use strict;<br>\r
+ use warnings;<br><br>\r
+\r
+ our $VERSION = “(version)”;<br>\r
+ my ($options, %options);<br>\r
+ my $database_handle;<br>\r
+ my $string_handle;<br>\r
+ my $error;<br>\r
+ my $errorext;<br>\r
+ my $database_filename;<br>\r
+ my $second_database_filename;\r
+</div>\r
+\r
+<br>\r
+\r
+Replace (modulename) with the name of the module like MySQL5 (which means MySQL database server version 5.x). When specifying the module name it should be the name of the format (MySQL) and version (5 as in 6.x).<br><br>\r
+\r
+'use strict' and 'use warnings' isn't required but it is generally accepted that Perl scripts and modules should have 'use strict' and 'use warnings' lines written.<br><br>\r
+\r
+Replace (version) with the internal version number of the module.<br><br>\r
+\r
+If you're writing a file-based database module, additional code will need to be added for handling a second database, template database and filter database. An example of this is in the SQLite.pm source code.<br><br>\r
+\r
+The file-based database module should end with the filename .db.(modulename) such as .db.sqlite when using the SQLite module.<br><br>\r
+\r
+Database modules are stored in the Modules/Database directory. For an example of a written database module look at the MySQL5.pm/SQLite.pm files.<br><br>\r
+\r
+If a database error occurs while preforming a database operation then the error string from the database handle scalar ($database_handle) should be placed in the $errorext scalar.\r
+ </div>\r
+ </body>\r
+</html>\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.3: loadsettings</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">3.3 loadsettings</span><br><br>\r
+\r
+Loads the settings needed for the database module.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->loadsettings(options);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->loadsettings({ Directory => “db”, DateTime => “DD/MM/YY (hh:mm:ss)”, Server => “localhost”, Port => “3306”, Protocol => “tcp”, Database => “database”, Username => “username”, Password => “password”, TablePrefix => “tableprefix” });\r
+</div>\r
+\r
+<br>\r
+\r
+options<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">Directory</td>\r
+ <td class="tabledata">Specifies the directory where the databases are stored.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">DateTime</td>\r
+ <td class="tabledata">Specifies the date and time settings to use.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Server</td>\r
+ <td class="tabledata">Specifies the location of the server.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Port</td>\r
+ <td class="tabledata">Specifies the port number of the server.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Protocol</td>\r
+ <td class="tabledata">Specifies the protocol type to use.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Database</td>\r
+ <td class="tabledata">Specifies the name of the database to use.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Username</td>\r
+ <td class="tabledata">Specifies the username to use.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Password</td>\r
+ <td class="tabledata">Specifies the password to use.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">TablePrefix</td>\r
+ <td class="tabledata">Specifies the table prefix to use.</td>\r
+ </tr>\r
+</table>\r
+\r
+<br>\r
+\r
+Typically all the settings except for Directory are used by a server-based database module, while only the Directory and DateTime settings will be used by a file-based database module.\r
+ </div>\r
+ </body>\r
+</html>\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.31: movepage</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">3.31 movepage</span><br><br>\r
+\r
+Moves pages from one database to another database.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->movepage(options);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->selectdb(“olddatabase”);<br>\r
+ $kiriwrite_dbmodule->selectseconddb(“newdatabase”);<br>\r
+ $kiriwrite_dbmodule->movepage({ PageFilename => “page.html” });\r
+</div>\r
+\r
+<br>\r
+\r
+options<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">PageFilename</td>\r
+ <td class="tabledata">Specifies the page with the filename to move to the new database.</td>\r
+ </tr>\r
+</table>\r
+\r
+<br>\r
+\r
+If the page does not exist in the database the page is moving from then the error returned should be 'PageDoesNotExist' in the $error scalar.<br><br>\r
+\r
+If the page already exists in the database the page is moving to then the error returned should be 'PageAlreadyExists' in the $error scalar.<br><br>\r
+\r
+If a database error occurs in the database the page is moving from then the error returned should be 'OldDatabaseError' in the $error scalar and information about the error should be in the $errorext scalar.<br><br>\r
+\r
+If a database error occurs in the database the page is moving to then the error returned should be 'NewDatabaseError' in the $error scalar and information about the error should be in the $errorext scalar.\r
+ </div>\r
+ </body>\r
+</html>\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.2: new</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">3.2 new</span><br><br>\r
+\r
+Creates a new instance of the database module.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ Kiriwrite::Database::(modulename)->new();\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule = Kiriwrite::Database::SQLite->new();\r
+</div>\r
+ </div>\r
+ </body>\r
+</html>\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.12: selectdb</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">3.12 selectdb</span><br><br>\r
+\r
+Selects a database to use.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->selectdb(options);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->selectdb({ DatabaseName => “database” });\r
+</div>\r
+\r
+<br>\r
+\r
+options<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">DatabaseName</td>\r
+ <td class="tabledata">Specifies the database to select.</td>\r
+ </tr>\r
+</table>\r
+\r
+<br>\r
+\r
+If the database does not exist then the error returned should be 'DoesNotExist' in the $error scalar.\r
+ </div>\r
+ </body>\r
+</html>\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.14: selectseconddb</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">3.14 selectseconddb</span><br><br>\r
+\r
+Select a second database which can be used for copying or moving pages to.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->selectseconddb(options);\r
+</div>\r
+\r
+<br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+\r
+<div class="code">\r
+ $kiriwrite_dbmodule->selectseconddb({ DatabaseName => “database” });\r
+</div>\r
+\r
+<br>\r
+\r
+options<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">DatabaseName</td>\r
+ <td class="tabledata">Specifies the database to select.</td>\r
+ </tr>\r
+</table>\r
+\r
+<br>\r
+\r
+If the database does not exist then the error returned should be 'DoesNotExist' in the $error scalar.\r
+ </div>\r
+ </body>\r
+</html>\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 - Chapter 3: Database Module</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 3: Database Module</span><br><br>\r
+\r
+The subroutines listed here in this chapter are used by the database module. The database module allows the data in the database to be easily manipulated. There are two types of database module with one being a server-based module and a file-based module. Both modules do not use all the subroutines but those subroutines which are not used.<br><br>\r
+\r
+An example of a file-based database module is the SQLite module and an example of a server-based database module is the MySQL5 module (which is a database module for the MySQL 5.x database servers).<br><br>\r
+\r
+When the database module is loaded the subroutines for it can be called from the $kiriwrite_dbmodule scalar.\r
+ </div>\r
+ </body>\r
+</html>\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 - Chapter 4: Kiriwrite Page Format</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 4: Kiriwrite Page Format</span><br><br>\r
+\r
+The Kiriwrite page format is the page format that is used internally for displaying the generated content from the presentation module.<br><br>\r
+\r
+It is stored in the page.html file and can be changed to show the generated content from the presentation module in a different way. Typically the page format would be formatted as the style the presentation module would output.<br><br>\r
+\r
+The content generated from the presentation module and other information (such as page title) can be inserted into the page.html file by using the tags below:<br><br>\r
+\r
+<table class="infotable">\r
+ <tr>\r
+ <td class="tableheading">Tag</td>\r
+ <td class="tableheading">Description</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata"><kiriwrite:menu></td>\r
+ <td class="tabledata">Writes the menu where this tag is specified.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata"><kiriwrite:imagespath></td>\r
+ <td class="tabledata">Writes the URI path the images directory.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata"><kiriwrite:title></td>\r
+ <td class="tabledata">Writes the title of the page.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata"><kiriwrite:pagedata></td>\r
+ <td class="tabledata">Writes the page data generated by the presentation module.</td>\r
+ </tr>\r
+</table>\r
+ </div>\r
+ </body>\r
+</html>\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 - Chapter 5: Languages</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 5: Languages</span><br><br>\r
+\r
+The language files that are used by Kiriwrite are stored in the 'lang' directory. The language filenames used are typically formatted as ISO 639-1 codes with the “local” dialect appened to it.<br><br>\r
+\r
+An example of this is English (British), as it is the English language it begins with the ISO 639-1 code of en and is then appended with -GB for the “local” dialect making it en-GB. Typically if it's a language specific for a country the local dialect is in capitals, while variations of the language are typically in small letters.<br><br>\r
+\r
+When translating Kiriwrite to another language, the default language of Kiriwrite is English (British). This is the en-GB.xml file in the 'lang' directory and will always contain the most recent language strings. However, if there are already completed and translated files in other languages, you can base the translation from that language if it is easier that way.<br><br>\r
+\r
+The settings in the 'about' tag provide information about the language file. 'name' specifies the name of the language, 'creator' specifies who created the language file while 'mailaddress' specifies an e-mail address (if desired).<br><br>\r
+\r
+The remaining tags contain all of the strings that are used within Kiriwrite.\r
+ </div>\r
+ </body>\r
+</html>\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 - Introduction</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">Introduction</span><br><br>\r
+This documentation provides information about the following: <br>\r
+\r
+<ul>\r
+<li>Internal Kiriwrite subroutines</li>\r
+<li>Application programming interfaces (APIs) for the database and presentation modules.</li>\r
+<li>The Kiriwrite page format.</li>\r
+<li>The language strings used in Kiriwrite for the language files.</li>\r
+</ul>\r
+\r
+<div class="warningbox">\r
+ <div class="message warning">\r
+ <span class="warningtext">\r
+ <b>Warning</b><br>\r
+ As Kiriwrite in the early stages of development (as such), the way data is passed to the subroutines could possibly change.\r
+ </span>\r
+ </div>\r
+</div>\r
+\r
+ </div>\r
+ </body>\r
+</html>\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</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">Developer Documentation</span><br>\r
+\r
+The Developer Documentation contains information on how to create presentation modules, database modules, language files, altering the page layout used internally by Kiriwrite and a list of subroutines used internally by Kiriwrite.\r
+\r
+<br><br>\r
+\r
+<a href="developer-introduction.html">Introduction</a><br>\r
+<a href="developer-chapter1.html">Chapter 1: Internal Kiriwrite Subroutines</a><br>\r
+ <a href="developer-chapter1-begin.html">1.1 BEGIN</a><br>\r
+ <a href="developer-chapter1-kiriwritepagelist.html">1.2 kiriwrite_page_list</a><br>\r
+ <a href="developer-chapter1-kiriwritepageadd.html">1.3 kiriwrite_page_add</a><br>\r
+ <a href="developer-chapter1-kiriwritepageedit.html">1.4 kiriwrite_page_edit</a><br>\r
+ <a href="developer-chapter1-kiriwritepagedelete.html">1.5 kiriwrite_page_delete</a><br>\r
+ <a href="developer-chapter1-kiriwritepagemultidelete.html">1.6 kiriwrite_page_multidelete</a><br>\r
+ <a href="developer-chapter1-kiriwritepagemultimove.html">1.7 kiriwrite_page_multimove</a><br>\r
+ <a href="developer-chapter1-kiriwritepagemulticopy.html">1.8 kiriwrite_page_multicopy</a><br>\r
+ <a href="developer-chapter1-kiriwritepagemultiedit.html">1.9 kiriwrite_page_multiedit</a><br>\r
+ <a href="developer-chapter1-kiriwritedatabaselist.html">1.10 kiriwrite_database_list</a><br>\r
+ <a href="developer-chapter1-kiriwritedatabaseadd.html">1.11 kiriwrite_database_add</a><br>\r
+ <a href="developer-chapter1-kiriwritedatabaseedit.html">1.12 kiriwrite_database_edit</a><br>\r
+ <a href="developer-chapter1-kiriwritedatabasedelete.html">1.13 kiriwrite_database_delete</a><br>\r
+ <a href="developer-chapter1-kiriwritetemplatelist.html">1.14 kiriwrite_template_list</a><br>\r
+ <a href="developer-chapter1-kiriwritetemplateadd.html">1.15 kiriwrite_template_add</a><br>\r
+ <a href="developer-chapter1-kiriwritetemplateedit.html">1.16 kiriwrite_template_edit</a><br>\r
+ <a href="developer-chapter1-kiriwritetemplatedelete.html">1.17 kiriwrite_template_delete</a><br>\r
+ <a href="developer-chapter1-kiriwritefilterlist.html">1.18 kiriwrite_filter_list</a><br>\r
+ <a href="developer-chapter1-kiriwritefilteradd.html">1.19 kiriwrite_filter_add</a><br>\r
+ <a href="developer-chapter1-kiriwritefilteredit.html">1.20 kiriwrite_filter_edit</a><br>\r
+ <a href="developer-chapter1-kiriwritefilterdelete.html">1.21 kiriwrite_filter_delete</a><br>\r
+ <a href="developer-chapter1-kiriwritecompilelist.html">1.22 kiriwrite_compile_list</a><br>\r
+ <a href="developer-chapter1-kiriwritecompilemakepages.html">1.23 kiriwrite_compile_makepages</a><br>\r
+ <a href="developer-chapter1-kiriwritecompileall.html">1.24 kiriwrite_compile_all</a><br>\r
+ <a href="developer-chapter1-kiriwritecompileclean.html">1.25 kiriwrite_compile_clean</a><br>\r
+ <a href="developer-chapter1-kiriwritecompilecleanhelper.html">1.26 kiriwrite_compile_clean_helper</a><br>\r
+ <a href="developer-chapter1-kiriwritesettingsview.html">1.27 kiriwrite_settings_view</a><br>\r
+ <a href="developer-chapter1-kiriwritesettingsedit.html">1.28 kiriwrite_settings_edit</a><br>\r
+ <a href="developer-chapter1-kiriwriteselectedlist.html">1.29 kiriwrite_selectedlist</a><br>\r
+ <a href="developer-chapter1-kiriwritesettingsload.html">1.30 kiriwrite_settings_load</a><br>\r
+ <a href="developer-chapter1-kiriwritevariablecheck.html">1.31 kiriwrite_variablecheck</a><br>\r
+ <a href="developer-chapter1-kiriwriteprocessfilename.html">1.32 kiriwrite_processfilename</a><br>\r
+ <a href="developer-chapter1-kiriwritelanguage.html">1.33 kiriwrite_language</a><br>\r
+ <a href="developer-chapter1-kiriwriteerror.html">1.34 kiriwrite_error</a><br>\r
+ <a href="developer-chapter1-kiriwritecritical.html">1.35 kiriwrite_critical</a><br>\r
+ <a href="developer-chapter1-kiriwritefileexists.html">1.36 kiriwrite_fileexists</a><br>\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-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-chapter2-new.html">2.2 new</a><br>\r
+ <a href="developer-chapter2-clear.html">2.3 clear</a><br>\r
+ <a href="developer-chapter2-grab.html">2.4 grab</a><br>\r
+ <a href="developer-chapter2-convert.html">2.5 convert</a><br>\r
+ <a href="developer-chapter2-starttable.html">2.6 starttable</a><br>\r
+ <a href="developer-chapter2-startheader.html">2.7 startheader</a><br>\r
+ <a href="developer-chapter2-addheader.html">2.8 addheader</a><br>\r
+ <a href="developer-chapter2-endheader.html">2.9 endheader</a><br>\r
+ <a href="developer-chapter2-startrow.html">2.10 startrow</a><br>\r
+ <a href="developer-chapter2-addcell.html">2.11 addcell</a><br>\r
+ <a href="developer-chapter2-endcell.html">2.12 endcell</a><br>\r
+ <a href="developer-chapter2-endrow.html">2.13 endrow</a><br>\r
+ <a href="developer-chapter2-endtable.html">2.14 endtable</a><br>\r
+ <a href="developer-chapter2-startbox.html">2.15 startbox</a><br>\r
+ <a href="developer-chapter2-enterdata.html">2.16 enterdata</a><br>\r
+ <a href="developer-chapter2-endbox.html">2.17 endbox</a><br>\r
+ <a href="developer-chapter2-startform.html">2.18 startform</a><br>\r
+ <a href="developer-chapter2-addcheckbox.html">2.19 addcheckbox</a><br>\r
+ <a href="developer-chapter2-addradiobox.html">2.20 addradiobox</a><br>\r
+ <a href="developer-chapter2-addselectbox.html">2.21 addselectbox</a><br>\r
+ <a href="developer-chapter2-addoption.html">2.22 addoption</a><br>\r
+ <a href="developer-chapter2-endselectbox.html">2.23 endselectbox</a><br>\r
+ <a href="developer-chapter2-addinputbox.html">2.24 addinputbox</a><br>\r
+ <a href="developer-chapter2-addtextbox.html">2.25 addtextbox</a><br>\r
+ <a href="developer-chapter2-addsubmit.html">2.26 addsubmit</a><br>\r
+ <a href="developer-chapter2-addreset.html">2.27 addreset</a><br>\r
+ <a href="developer-chapter2-addhiddendata.html">2.28 addhiddendata</a><br>\r
+ <a href="developer-chapter2-addbutton.html">2.29 addbutton</a><br>\r
+ <a href="developer-chapter2-endform.html">2.30 endform</a><br>\r
+ <a href="developer-chapter2-addlink.html">2.31 addlink</a><br>\r
+ <a href="developer-chapter2-addimage.html">2.32 addimage</a><br>\r
+ <a href="developer-chapter2-addtext.html">2.33 addtext</a><br>\r
+ <a href="developer-chapter2-addboldtext.html">2.34 addboldtext</a><br>\r
+ <a href="developer-chapter2-additalictext.html">2.35 additalictext</a><br>\r
+ <a href="developer-chapter2-addlinebreak.html">2.36 addlinebreak</a><br>\r
+ <a href="developer-chapter2-addhorizontalline.html">2.37 addhorizontalline</a><br>\r
+ <a href="developer-chapter2-startlist.html">2.38 startlist</a><br>\r
+ <a href="developer-chapter2-additem.html">2.39 additem</a><br>\r
+ <a href="developer-chapter2-endlist.html">2.40 endlist</a><br>\r
+<a href="developer-chapter3.html">Chapter 3: Database Module</a><br>\r
+ <a href="developer-chapter3-guidance.html">3.1 Guidance</a><br>\r
+ <a href="developer-chapter3-new.html">3.2 new</a><br>\r
+ <a href="developer-chapter3-loadsettings.html">3.3 loadsettings</a><br>\r
+ <a href="developer-chapter3-convert.html">3.4 convert</a><br>\r
+ <a href="developer-chapter3-dateconvert.html">3.5 dateconvert</a><br>\r
+ <a href="developer-chapter3-geterror.html">3.6 geterror</a><br>\r
+ <a href="developer-chapter3-dbpermissions.html">3.7 dbpermissions</a><br>\r
+ <a href="developer-chapter3-dbexists.html">3.8 dbexists</a><br>\r
+ <a href="developer-chapter3-connect.html">3.9 connect</a><br>\r
+ <a href="developer-chapter3-disconnect.html">3.10 disconnect</a><br>\r
+ <a href="developer-chapter3-getdblist.html">3.11 getdblist</a><br>\r
+ <a href="developer-chapter3-selectdb.html">3.12 selectdb</a><br>\r
+ <a href="developer-chapter3-getdatabaseinfo.html">3.13 getdatabaseinfo</a><br>\r
+ <a href="developer-chapter3-selectseconddb.html">3.14 selectseconddb</a><br>\r
+ <a href="developer-chapter3-getseconddatabaseinfo.html">3.15 getseconddatabaseinfo</a><br>\r
+ <a href="developer-chapter3-adddatabase.html">3.16 adddatabase</a><br>\r
+ <a href="developer-chapter3-editdatabase.html">3.17 editdatabase</a><br>\r
+ <a href="developer-chapter3-deletedatabase.html">3.18 deletedatabase</a><br>\r
+ <a href="developer-chapter3-connecttemplate.html">3.19 connecttemplate</a><br>\r
+ <a href="developer-chapter3-disconnecttemplate.html">3.20 disconnecttemplate</a><br>\r
+ <a href="developer-chapter3-gettemplatelist.html">3.21 gettemplatelist</a><br>\r
+ <a href="developer-chapter3-gettemplateinfo.html">3.22 gettemplateinfo</a><br>\r
+ <a href="developer-chapter3-addtemplate.html">3.23 addtemplate</a><br>\r
+ <a href="developer-chapter3-edittemplate.html">3.24 edittemplate</a><br>\r
+ <a href="developer-chapter3-deletetemplate.html">3.25 deletetemplate</a><br>\r
+ <a href="developer-chapter3-getpagelist.html">3.26 getpagelist</a><br>\r
+ <a href="developer-chapter3-getpageinfo.html">3.27 getpageinfo</a><br>\r
+ <a href="developer-chapter3-addpage.html">3.28 addpage</a><br>\r
+ <a href="developer-chapter3-editpage.html">3.29 editpage</a><br>\r
+ <a href="developer-chapter3-deletepage.html">3.30 deletepage</a><br>\r
+ <a href="developer-chapter3-movepage.html">3.31 movepage</a><br>\r
+ <a href="developer-chapter3-copypage.html">3.32 copypage</a><br>\r
+ <a href="developer-chapter3-connectfilter.html">3.33 connectfilter</a><br>\r
+ <a href="developer-chapter3-disconnectfilter.html">3.34 disconnectfilter</a><br>\r
+ <a href="developer-chapter3-getfilterlist.html">3.35 getfilterlist</a><br>\r
+ <a href="developer-chapter3-getfilterinfo.html">3.36 getfilterinfo</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-chapter4.html">Chapter 4: Kiriwrite Page Format</a><br>\r
+<a href="developer-chapter5.html">Chapter 5: Languages</a><br>\r
+ </div>\r
+ </body>\r
+</html>\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 - Documentation Guide</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">Documentation Guide</span><br>\r
+\r
+Throughout the documentation in Kiriwrite, certain icons will appear which will mean the following:<br><br>\r
+\r
+<div class="warningbox">\r
+ <div class="message warning">\r
+ <span class="warningtext">\r
+ <b>Warning</b><br>\r
+ This is a warning message meaning that a certain action you take may cause consequences to your Kiriwrite installation.\r
+ </span>\r
+ </div>\r
+</div>\r
+\r
+<br>\r
+\r
+<div class="messagebox">\r
+ <div class="message note">\r
+ <b>Note</b><br>\r
+ This is a note which gives some information.\r
+ </div>\r
+</div>\r
+\r
+<br>\r
+\r
+<div class="messagebox">\r
+ <div class="message hint">\r
+ <b>Hint</b><br>\r
+ This is a hint to give you some helpful advice.\r
+ </div>\r
+</div>\r
+\r
+<br>\r
+\r
+<div class="code">\r
+ This is where the code will be displayed using a fixed font.\r
+</div>\r
+\r
+<br>\r
+\r
+<div class="specific apache132x">\r
+ This is a section of the documentation which contains instructions for Apache HTTP Web Server versions 1.3 and 2.x.\r
+</div>\r
+ </div>\r
+ </body>\r
+</html>\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 - Index page</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">Welcome</span><br>\r
+\r
+This is the documentation for Kiriwrite and it is split into three parts:\r
+\r
+<ul>\r
+<li><span class="heading"><a href="user.html">User Documentation</a></span><br>\r
+The User Documentation provides information on how to install and use your Kiriwrite installation.\r
+</li>\r
+<li><span class="heading"><a href="tutorial.html">Tutorial Documentation</a></span><br>\r
+The Tutorial Documentation provides some tutorials on how to use certain featurs of Kiriwrite.\r
+</li>\r
+<li><span class="heading"><a href="developer.html">Developer Documentation</a></span><br>\r
+The Developer Documentation provides information on how to create additional presentation modules, database modules and information on translating Kiriwrite into another language.\r
+</li>\r
+</ul>\r
+\r
+The <a href="guide.html">Kiriwrite Documentation Guide</a> provides information about the symbols that appear while reading the documentation.\r
+ </div>\r
+ </body>\r
+</html>\r
--- /dev/null
+a {
+ color: #FFFFFF;
+}
+
+a:hover {
+ color: #EEEEEE;
+}
+
+body {
+ background-repeat: repeat-x;
+ background-image: url('images/background.png');
+ background-color: #408080;
+ color: #FFFFFF;
+ margin: 0px;
+ padding: 0px;
+ font-family: sans-serif;
+ font-size: 13px;
+}
+
+.footnote {
+ height: 1px;
+ background-color: #FFFFFF;
+ width: 25%;
+}
+
+.apptitle {
+ position: absolute;
+ font-weight: bold;
+ text-align: left;
+ z-index: 1;
+ left: 0;
+ padding-left: 6px;
+ font-size: 16px;
+}
+
+.menubarback {
+ background-image: url('images/menutop.png');
+ background-repeat: repeat-x;
+ background-position: bottom;
+}
+
+.menubar {
+ border-bottom-width: 1px;
+ border-bottom-color: #AAFFFF;
+ border-bottom-style: solid;
+ text-align: right;
+ padding: 4px;
+ padding-right: 6px;
+}
+
+.pageinformation {
+ padding: 8px;
+}
+
+.message {
+ background-color: #transparent;
+ padding: 5px;
+ border-color: #70D0D0;
+ border-width: 1px;
+ border-style: solid;
+}
+
+.warning {
+ background-image: url('images/warning.png');
+ background-repeat: no-repeat;
+ border-color: #FF1010;
+ background-color: transparent;
+ padding-left: 50px;
+ background-position: 9 7;
+}
+
+.messagebox {
+ background-image: url('images/messageback.png');
+ background-repeat: repeat-x;
+ background-color: #307070;
+ width: 60%;
+ margin-left: auto;
+ margin-right: auto;
+}
+
+.warningbox {
+ background-image: url('images/warningback.png');
+ background-repeat: repeat-x;
+ background-color: #701010;
+ width: 60%;
+ margin-left: auto;
+ margin-right: auto;
+}
+
+.note {
+ background-image: url('images/note.png');
+ background-repeat: no-repeat;
+ padding-left: 50px;
+ background-position: 9 7;
+}
+
+.hint {
+ background-image: url('images/hint.png');
+ background-repeat: no-repeat;
+ padding-left: 50px;
+ background-position: 8 7;
+}
+
+.specific {
+ min-height:64px;
+}
+
+.apache132x {
+ background-image: url('images/apache132x.png');
+ background-repeat: no-repeat;
+ padding-left: 70px;
+}
+
+.code {
+ background-image: url('images/messageback.png');
+ background-color: #307070;
+ border-color: #70D0D0;
+ border-style: solid;
+ border-width: 1px;
+ font-family: fixed;
+ padding: 5px;
+ width: 80%;
+ margin-left: auto;
+ margin-right: auto;
+}
+
+.pagetitle {
+ font-weight: bold;
+ font-size: 16px;
+}
+
+.heading {
+ font-weight: bold;
+ font-size: 14px;
+}
+
+.infotable {
+ margin-left: auto;
+ margin-right: auto;
+ cell-padding: 0px;
+ border-collapse: collapse;
+ border-width: 1px;
+ border-style: solid;
+ border-color: #70D0D0;
+}
+
+.tableheading {
+ background-image: url('images/messageback.png');
+ padding: 5px;
+ border-bottom-width: 1px;
+ border-bottom-style: solid;
+ border-color: #60B0B0;
+ font-size: 13px;
+}
+
+.tabledata {
+ padding: 5px;
+ background-color: #204040;
+ font-size: 13px;
+}
\ No newline at end of file
--- /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 - Tutorial Documentation - Introduction</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">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
+\r
+<ul>\r
+<li>Create a 3 page website using the same layout on all of the pages.</li>\r
+<li>Create a 3 page website using the same layout on all of the pages but with certain words changed using the filters database.</li>\r
+<li>Create a 10 page website with 5 pages using one layout and another 5 pages using another layout.</li>\r
+</ul>\r
+ </div>\r
+ </body>\r
+</html>\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 - Tutorial Documentation - Tutorial 1: Three Page Website with layout</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">Tutorial 1: Three Page Website with layout</span><br><br>\r
+\r
+This tutorial is to show how Kiriwrite works in a basic form by creating a three page website which all use the same layout.<br><br>\r
+\r
+To begin, start by going to the location where Kiriwrite is installed and then click on the View Templates menu link. Click on the Add Template sub-menu link and enter the following settings for the new template:<br><br>\r
+\r
+<table class="infotable">\r
+ <tr>\r
+ <td class="tableheading">Setting</td>\r
+ <td class="tableheading">Value</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Template Name</td>\r
+ <td class="tabledata">The First Template</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Template Description</td>\r
+ <td class="tabledata">The First Template for the Kiriwrite tutorial.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Template Filename</td>\r
+ <td class="tabledata">firsttemplate.html</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Template Layout</td>\r
+ <td class="tabledata"><html><br>\r
+ <head><br>\r
+ <title>First Website - <kiriwrite:pagetitle></title><br>\r
+ </head><br>\r
+ <body><br>\r
+ <kiriwrite:pagecontent><br>\r
+ </body><br>\r
+</html></td>\r
+ </tr>\r
+</table>\r
+\r
+<br>\r
+\r
+After the template settings have been entered, click on the 'Add Template' button. The template should be added to the template database (and the template database created if it doesn't exist).<br><br>\r
+\r
+Click on the 'View Databases' link and then click on the 'Add Database' button and enter the following settings for the new database:<br><br>\r
+\r
+<table class="infotable">\r
+ <tr>\r
+ <td class="tableheading">Setting</td>\r
+ <td class="tableheading">Value</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Database Name</td>\r
+ <td class="tabledata">Tutorial 1</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Database Description</td>\r
+ <td class="tabledata">The database for Tutorial 1</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Database Categories</td>\r
+ <td class="tabledata"></td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Database Notes</td>\r
+ <td class="tabledata"></td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Database Filename</td>\r
+ <td class="tabledata">tutorial1</td>\r
+ </tr>\r
+</table>\r
+\r
+<br>\r
+\r
+After the database settings have been entered, click on the 'Add Database' button to create a database with the settings given and then click on the 'Return to the database list link'. When the list of databases appears click on the link for the 'Tutorial 1' database and the page list for the database will appear. As there are no pages in the database a message will appear saying that there are no pages in the database.<br><br>\r
+\r
+Click on the 'Add Page' link the sub-menu and then enter the following information for the new page.<br><br>\r
+\r
+<table class="infotable">\r
+ <tr>\r
+ <td class="tableheading">Setting</td>\r
+ <td class="tableheading">Value</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Page Name</td>\r
+ <td class="tabledata">The first page</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Page Description</td>\r
+ <td class="tabledata">This is the first page.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Page Section</td>\r
+ <td class="tabledata">Section</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Page Template</td>\r
+ <td class="tabledata">The First Template (firsttemplate.html)</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Page Filename</td>\r
+ <td class="tabledata">firstpage.html</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Page Content</td>\r
+ <td class="tabledata">This is the content for the first page.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Page Settings</td>\r
+ <td class="tabledata">Use page name and section name.</td>\r
+ </tr>\r
+</table>\r
+\r
+<br>\r
+\r
+After the page settings have been entered, click on the 'Add Page' button and the page should be added to the Tutorial 1 database. Click on the 'Return to the page list for the 'Tutorial 1' database.' link to return to the page list. Repeat this same process for the next two pages.<br><br>\r
+\r
+<table class="infotable">\r
+ <tr>\r
+ <td class="tableheading">Setting</td>\r
+ <td class="tableheading">secondpage.html</td>\r
+ <td class="tableheading">thirdpage.html</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Page Name</td>\r
+ <td class="tabledata">The second page</td>\r
+ <td class="tabledata">The third page</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Page Description</td>\r
+ <td class="tabledata">This is the second page.</td>\r
+ <td class="tabledata">This is the third page.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Page Section</td>\r
+ <td class="tabledata">Section</td>\r
+ <td class="tabledata">Section</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Page Template</td>\r
+ <td class="tabledata">The First Template (firsttemplate.html)</td>\r
+ <td class="tabledata">The First Template (firsttemplate.html)</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Page Filename</td>\r
+ <td class="tabledata">secondpage.html</td>\r
+ <td class="tabledata">thirdpage.html</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Page Content</td>\r
+ <td class="tabledata">This is the content for the second page.</td>\r
+ <td class="tabledata">This is the content for the third page.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Page Settings</td>\r
+ <td class="tabledata">Use page name and section name.</td>\r
+ <td class="tabledata">Use page name and section name.</td>\r
+ </tr>\r
+</table>\r
+\r
+<br>\r
+\r
+Once those two pages have been added, click on the 'Compile Pages' menu link. From the list of available databases to compile, click on the Compile link that to the right of the database with the name 'Tutorial 1'. A confirmation message then asking if it should be compiled and clicking on the 'Compile Database' will compile the pages in that database with the template and put them in the Output Directory.<br><br>\r
+\r
+Look in the output directory and you will see three files: firstpage.html, secondpage.html and thirdpage.html. Check the source code of each page to see if they've used the same layout but using different content that was specified by each page.\r
+ </div>\r
+ </body>\r
+</html>\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 - Tutorial Documentation - Tutorial 2: 5 page website and also using the filters database</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">Tutorial 2: 5 page website and also using the filter database.</span><br><br>\r
+\r
+This tutorial is to show how Kiriwrite works by creating a five page website which uses the layout from the first tutorial but also uses filters from the filter database.<br><br>\r
+\r
+To begin, create a new database (as shown in Tutorial 1) with the following settings:<br><br>\r
+\r
+<table class="infotable">\r
+ <tr>\r
+ <td class="tableheading">Setting</td>\r
+ <td class="tableheading">Value</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Database Name</td>\r
+ <td class="tabledata">Tutorial 2</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Database Description</td>\r
+ <td class="tabledata">The database for Tutorial 2</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Database Categories</td>\r
+ <td class="tabledata"></td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Database Notes</td>\r
+ <td class="tabledata"></td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Database Filename</td>\r
+ <td class="tabledata">tutorial2</td>\r
+ </tr>\r
+</table>\r
+\r
+<br>\r
+\r
+From knowing how to add pages from tutorial 1, add five pages with the following settings as written below:<br><br>\r
+\r
+<table class="infotable">\r
+ <tr>\r
+ <td class="tableheading">Setting</td>\r
+ <td class="tableheading">pets.html</td>\r
+ <td class="tableheading">family.html</td>\r
+ <td class="tableheading">computer.html</td>\r
+ <td class="tableheading">profile.html</td>\r
+ <td class="tableheading">index.html</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Page Name</td>\r
+ <td class="tabledata">My Pets</td>\r
+ <td class="tabledata">My Family</td>\r
+ <td class="tabledata">My Computer</td>\r
+ <td class="tabledata">Personal Profile</td>\r
+ <td class="tabledata">Index Page</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Page Description</td>\r
+ <td class="tabledata">A page about my pets.</td>\r
+ <td class="tabledata">A page about my family.</td>\r
+ <td class="tabledata">A page about my computer.</td>\r
+ <td class="tabledata">A page that gives information about me.</td>\r
+ <td class="tabledata"></td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Page Section</td>\r
+ <td class="tabledata">Section</td>\r
+ <td class="tabledata">Section</td>\r
+ <td class="tabledata">Section</td>\r
+ <td class="tabledata">Section</td>\r
+ <td class="tabledata">Section</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Page Template</td>\r
+ <td class="tabledata">The First Template (firsttemplate.html)</td>\r
+ <td class="tabledata">The First Template (firsttemplate.html)</td>\r
+ <td class="tabledata">The First Template (firsttemplate.html)</td>\r
+ <td class="tabledata">The First Template (firsttemplate.html)</td>\r
+ <td class="tabledata">The First Template (firsttemplate.html)</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Page Filename</td>\r
+ <td class="tabledata">pets.html</td>\r
+ <td class="tabledata">family.html</td>\r
+ <td class="tabledata">computer.html</td>\r
+ <td class="tabledata">profile.html</td>\r
+ <td class="tabledata">index.html</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Page Content</td>\r
+ <td class="tabledata">I have three dogs, two cats, four tortoises and one crocodile.</td>\r
+ <td class="tabledata">I have twenty-six nephews, six sisters, two brothers, a mother and a father.</td>\r
+ <td class="tabledata">I built my computer seven years ago and at the time was a fairly decent machine which could run most of the stuff available at the time.</td>\r
+ <td class="tabledata">I am around thirty years old, I like going out for most of the time and I enjoy eating sausage rolls.</td>\r
+ <td class="tabledata">Welcome to the index page. This page gives a list of all the other pages available.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Page Settings</td>\r
+ <td class="tabledata">Use page name and section name.</td>\r
+ <td class="tabledata">Use page name and section name.</td>\r
+ <td class="tabledata">Use page name and section name.</td>\r
+ <td class="tabledata">Use page name and section name.</td>\r
+ <td class="tabledata">Use page name and section name.</td>\r
+ </tr>\r
+</table>\r
+\r
+<br>\r
+\r
+After entering all of the five pages into the 'Tutorial 2' database, compile the pages using the method described in Tutorial 1 and go into the Output Directory. You should see all of the pages from the 'Tutorial 2' database compiled.<br><br>\r
+\r
+If you wanted to change a line in one of the pages or where a custom tag was defined and replace that tag with a certain piece of text. This is where the filter database comes into use.<br><br>\r
+\r
+As an example, using the existing 'Tutorial 2' database, the pets.html page had to be changed because there really isn't one crocodile but two hamsters instead and for the family.html page there was twenty nephews and nieces instead of twenty-six nephews.<br><br>\r
+\r
+Click on the 'View Filters' menu link and then click on the 'Add Filter' link and enter the following settings for the new filter:<br><br>\r
+\r
+<table class="infotable">\r
+ <tr>\r
+ <td class="tableheading">Setting</td>\r
+ <td class="tableheading">Value</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Find...</td>\r
+ <td class="tabledata">one crocodile</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Replace with...</td>\r
+ <td class="tabledata">two hamsters</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Priority</td>\r
+ <td class="tabledata"></td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Notes</td>\r
+ <td class="tabledata"></td>\r
+ </tr>\r
+</table>\r
+\r
+<br>\r
+\r
+After the settings have been entered, click on the 'Add Filter' button which adds the filter to the filter database and then click on the 'Return to the filter list.' link. Repeat this process for the next filter:<br><br>\r
+\r
+<table class="infotable">\r
+ <tr>\r
+ <td class="tableheading">Setting</td>\r
+ <td class="tableheading">Value</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Find...</td>\r
+ <td class="tabledata">twenty-six nephews</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Replace with...</td>\r
+ <td class="tabledata">twenty nephews and nieces</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Priority</td>\r
+ <td class="tabledata"></td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Notes</td>\r
+ <td class="tabledata"></td>\r
+ </tr>\r
+</table>\r
+\r
+<br>\r
+\r
+Once the filter has been added, compile the pages from the database again and this time check the pets.html and family.html files to see if they have been changed and if it's been done correctly then the pages should have been changed to the new values specified by the filters. Filters should be used sparingly or used for replacing tags as it will replace all text that is matched with the find setting.<br><br>\r
+\r
+Before starting tutorial 3, you may want to delete the two filters that were created in the filters database.\r
+ </div>\r
+ </body>\r
+</html>\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 - Tutorial Documentation - Tutorial 3: 10 page website with 5 pages per layout.</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">Tutorial 3: 10 page website with 5 pages per layout.</span><br><br>\r
+\r
+This tutorial is to show that Kiriwrite isn't limited to one layout per database as each page is defined by a page template.<br><br>\r
+\r
+To begin, from knowing how to create a template from Tutorial 1, create a template using the following settings:<br><br>\r
+\r
+<table class="infotable">\r
+ <tr>\r
+ <td class="tableheading">Setting</td>\r
+ <td class="tableheading">Value</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Template Name</td>\r
+ <td class="tabledata">The Second Template</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Template Description</td>\r
+ <td class="tabledata">The Second Template for the Kiriwrite tutorial.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Template Filename</td>\r
+ <td class="tabledata">secondtemplate.html</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Template Layout</td>\r
+ <td class="tabledata"><html><br>\r
+ <head><br>\r
+ <title>Second Website - <kiriwrite:pagetitle></title><br>\r
+ </head><br>\r
+ <body bgcolor=”#000000”><br>\r
+ <font color=”#FFFFFF”><br>\r
+ <kiriwrite:pagecontent><br>\r
+ </font><br>\r
+ </body><br>\r
+</html>\r
+ </td>\r
+ </tr>\r
+</table>\r
+\r
+<br>\r
+\r
+This template will have a black background with white text.<br><br>\r
+\r
+After creating the template, create a new database (as shown in Tutorial 1) with the following settings:<br><br>\r
+\r
+<table class="infotable">\r
+ <tr>\r
+ <td class="tableheading">Setting</td>\r
+ <td class="tableheading">Value</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Database Name</td>\r
+ <td class="tabledata">Tutorial 3</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Database Description</td>\r
+ <td class="tabledata">The database for Tutorial 3</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Database Categories</td>\r
+ <td class="tabledata"></td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Database Notes</td>\r
+ <td class="tabledata"></td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Database Filename</td>\r
+ <td class="tabledata">tutorial3</td>\r
+ </tr>\r
+</table>\r
+\r
+<br>\r
+\r
+From knowing how to add pages from tutorial 1, add ten pages with the following settings as written below to the 'Tutorial 3' database:<br><br>\r
+\r
+<table class="infotable">\r
+ <tr>\r
+ <td class="tableheading">Setting</td>\r
+ <td class="tableheading">page1.html</td>\r
+ <td class="tableheading">page2.html</td>\r
+ <td class="tableheading">page3.html</td>\r
+ <td class="tableheading">page4.html</td>\r
+ <td class="tableheading">page5.html</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Page Name</td>\r
+ <td class="tabledata">Page One</td>\r
+ <td class="tabledata">Page Two</td>\r
+ <td class="tabledata">Page Three</td>\r
+ <td class="tabledata">Page Four</td>\r
+ <td class="tabledata">Page Five</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Page Description</td>\r
+ <td class="tabledata">This is page one.</td>\r
+ <td class="tabledata">This is page two.</td>\r
+ <td class="tabledata">This is page three.</td>\r
+ <td class="tabledata">This is page four.</td>\r
+ <td class="tabledata">This is page five.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Page Section</td>\r
+ <td class="tabledata">Website One</td>\r
+ <td class="tabledata">Website One</td>\r
+ <td class="tabledata">Website One</td>\r
+ <td class="tabledata">Website One</td>\r
+ <td class="tabledata">Website One</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Page Template</td>\r
+ <td class="tabledata">The First Template (firsttemplate.html)</td>\r
+ <td class="tabledata">The First Template (firsttemplate.html)</td>\r
+ <td class="tabledata">The First Template (firsttemplate.html)</td>\r
+ <td class="tabledata">The First Template (firsttemplate.html)</td>\r
+ <td class="tabledata">The First Template (firsttemplate.html)</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Page Filename</td>\r
+ <td class="tabledata">page1.html</td>\r
+ <td class="tabledata">page2.html</td>\r
+ <td class="tabledata">page3.html</td>\r
+ <td class="tabledata">page4.html</td>\r
+ <td class="tabledata">page5.html</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Page Content</td>\r
+ <td class="tabledata">This is the first page of the first website.</td>\r
+ <td class="tabledata">This is the second page of the first website.</td>\r
+ <td class="tabledata">This is the third page of the first website.</td>\r
+ <td class="tabledata">This is the fourth page of the first website.</td>\r
+ <td class="tabledata">This is the fifth page of the first website.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Page Settings</td>\r
+ <td class="tabledata">Use page name and section name.</td>\r
+ <td class="tabledata">Use page name and section name.</td>\r
+ <td class="tabledata">Use page name and section name.</td>\r
+ <td class="tabledata">Use page name and section name.</td>\r
+ <td class="tabledata">Use page name and section name.</td>\r
+ </tr>\r
+</table>\r
+\r
+<br>\r
+\r
+<table class="infotable">\r
+ <tr>\r
+ <td class="tableheading">Setting</td>\r
+ <td class="tableheading">page6.html</td>\r
+ <td class="tableheading">page7.html</td>\r
+ <td class="tableheading">page8.html</td>\r
+ <td class="tableheading">page9.html</td>\r
+ <td class="tableheading">page10.html</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Page Name</td>\r
+ <td class="tabledata">Page Six</td>\r
+ <td class="tabledata">Page Seven</td>\r
+ <td class="tabledata">Page Eight</td>\r
+ <td class="tabledata">Page Nine</td>\r
+ <td class="tabledata">Page Ten</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Page Description</td>\r
+ <td class="tabledata">This is page six.</td>\r
+ <td class="tabledata">This is page seven.</td>\r
+ <td class="tabledata">This is page eight.</td>\r
+ <td class="tabledata">This is page nine.</td>\r
+ <td class="tabledata">This is page ten.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Page Section</td>\r
+ <td class="tabledata">Website Two</td>\r
+ <td class="tabledata">Website Two</td>\r
+ <td class="tabledata">Website Two</td>\r
+ <td class="tabledata">Website Two</td>\r
+ <td class="tabledata">Website Two</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Page Template</td>\r
+ <td class="tabledata">The Second Template (secondtemplate.html)</td>\r
+ <td class="tabledata">The Second Template (secondtemplate.html)</td>\r
+ <td class="tabledata">The Second Template (secondtemplate.html)</td>\r
+ <td class="tabledata">The Second Template (secondtemplate.html)</td>\r
+ <td class="tabledata">The Second Template (secondtemplate.html)</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Page Filename</td>\r
+ <td class="tabledata">page6.html</td>\r
+ <td class="tabledata">page7.html</td>\r
+ <td class="tabledata">page8.html</td>\r
+ <td class="tabledata">page9.html</td>\r
+ <td class="tabledata">page10.html</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Page Content</td>\r
+ <td class="tabledata">This is the first page of the second website.</td>\r
+ <td class="tabledata">This is the second page of the second website.</td>\r
+ <td class="tabledata">This is the third page of the second website.</td>\r
+ <td class="tabledata">This is the fourth page of the second website.</td>\r
+ <td class="tabledata">This is the fifth page of the second website.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Page Settings</td>\r
+ <td class="tabledata">Use page name and section name.</td>\r
+ <td class="tabledata">Use page name and section name.</td>\r
+ <td class="tabledata">Use page name and section name.</td>\r
+ <td class="tabledata">Use page name and section name.</td>\r
+ <td class="tabledata">Use page name and section name.</td>\r
+ </tr>\r
+</table>\r
+\r
+<br>\r
+\r
+After the pages have been entered into the 'Tutorial 3' database. Compile the 'Tutorial 3' (as shown how to in tutorial 1) database and go in the Output Directory and check that pages 1-5 (page1.html, page2.html, page3.html, page4.html, page5.html) have First Website in the page title and pages 6-10 (page6.html, page7.html, page8.html, page9.html, page10.html) have Second Website in the page title and that the background of the page is black while using white text.\r
+ </div>\r
+ </body>\r
+</html>\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 - Tutorial Documentation</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">Tutorial Documentation</span><br>\r
+\r
+The Tutorial Documentation provides tutorials on how to use some of the most common functions in Kiriwrite.\r
+\r
+<br><br>\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
+ </div>\r
+ </body>\r
+</html>\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 - 1.3: Kiriwrite Installer Script</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">1.3 Kiriwrite Installer Script</span><br><br>\r
+After pointing your browser to the installer script, a page appears which guides you through configuring the settings for Kiriwrite.<br><br>\r
+At the top of the page a drop down box is available to change the language of the installer script to another language which is more easier to understand, simply select the language from the drop down box and click on the Switch button, the script will then switch to the selected language.<br><br>\r
+The installer script will preform three tests, the first being to check if all the needed modules are there, the second test is to check if the modules needed for the database modules are there and finally a test to check if the directories have their correct permissions set.<br><br>\r
+Before the settings can be configured, checks are made to make sure that all of the needed modules are installed properly. If any of the needed modules are missing an error message will appear saying that one or more of the required Perl modules is missing and will need to be installed which can be done from the CPAN interface.<br><br>\r
+The installer script then checks to see if at least of the Perl modules for the database modules are installed. If none of the Perl modules needed for the database modules are found then an error message will appear saying that none of the Perl modules needed for the database modules are installed and will need to be installed which can be done from the CPAN interface.<br><br>\r
+Finally, the installer script then checks to see if the directories have the minimum correct permissions set. If one or more of the directories has an error, then a message appears saying to make sure that the correct permissions are set.<br><br>\r
+\r
+<div class="messagebox">\r
+ <div class="message hint">\r
+ <b>Hint</b><br>\r
+ More information on solving problems that occur while installing Kiriwrite can be found in Chapter 5: Troubleshooting.\r
+ </div>\r
+</div>\r
+\r
+<br>\r
+\r
+When the installer finds that everything is fine in regards to Perl modules and file permissions, a form appears allowing to configure the Kiriwrite installation to specific needs. Some default values are given which will work with the file-based database modules.<br><br>\r
+The configuration settings in detail:<br><br>\r
+<table class="infotable">\r
+ <tr>\r
+ <td class="tableheading">Setting</td>\r
+ <td class="tableheading">Description</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Database Directory</td>\r
+ <td class="tabledata">Specifies the database directory to use for storing databases that are created by the file-based database modules. This option is ignored by the server-based modules.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Output Directory</td>\r
+ <td class="tabledata">Specifies the output directory to use to store the compiled pages.</td>\r
+ </tr>\r
+ <tr>\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">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
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Language</td>\r
+ <td class="tabledata">Specifies the system language to use in Kiriwrite. If the language used in the installer script is available as language to use in Kiriwrite then that language will be selected by default.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Presentation Module</td>\r
+ <td class="tabledata">Specifies the presentation module to use in Kiriwrite.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Database Module</td>\r
+ <td class="tabledata">Specifies the database module to use in Kiriwrite. SQLite is a file-based database module which uses the database directory and the SQLite Perl module while MySQL5 is a server-based database module which uses a MySQL 5.x server from the MySQL Perl module.</td>\r
+ </tr>\r
+</table>\r
+\r
+<br>\r
+\r
+The following options are used only by the server-based database modules:<br><br>\r
+\r
+<table class="infotable">\r
+ <tr>\r
+ <td class="tableheading">Setting</td>\r
+ <td class="tableheading">Description</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Database Server</td>\r
+ <td class="tabledata">Specifies the database server to use.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Database Port</td>\r
+ <td class="tabledata">Specifies the database port to use.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Database Protocol</td>\r
+ <td class="tabledata">Specifies the database protocol to use.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Database Name</td>\r
+ <td class="tabledata">Specifies the database name to use.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Database Username</td>\r
+ <td class="tabledata">Specifies the database username to use.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Database Password</td>\r
+ <td class="tabledata">Specifies the database password to use.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Database Table Prefix</td>\r
+ <td class="tabledata">Specifies the table prefix to use. Multiple Kiriwrite installations can use the same server database so long as the table prefix is different.</td>\r
+ </tr>\r
+</table>\r
+\r
+<br>\r
+\r
+There is an option that is enabled by default to attempt to delete the installation script after the configuration file has been written since the installation script would no longer be needed after that. Unchecking the box for this option disables this.<br><br>\r
+Click on the Save Settings button to write the configuration file or the Reset Settings button to restore the settings to their default values.<br><br>\r
+After clicking on the Save Settings button, some checks are made to make sure that data passed is correct, the configuration file is written (and the installer script deleted if requested) and a message appears saying that Kiriwrite can now be used by clicking on the link at the bottom of the page.\r
+\r
+ </div>\r
+ </body>\r
+</html>\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 - 1.2: Installing 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">1.2.1 Copying files</span><br><br>\r
+Before Kiriwrite can be used, the files need to be copied to the correct place. After extracting the archive, the structure of the extracted archive should be like this:<br><br>\r
+<b>Documentation</b> – Documentation that is available in several languages.<br>\r
+<b>cgi-files</b> – The main Kiriwrite script, associated modules, installer script and language files.<br>\r
+ <b>Modules</b> – Modules for Kiriwrite are stored here.<br>\r
+ <b>Database</b> – Database modules are stored here.<br>\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>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
+The files in the cgi-files folder should be copied to the cgi-bin<sup>1</sup> folder<sup>2</sup> and the files in the non-cgi-files folder should be copied to a folder which can be accessed from the web server.<br><br>\r
+<span class="heading">1.2.2 Setting Permissions</span><br><br>\r
+The following permissions should be set for the files that have been copied to the cgi-files directory (the following file list should apply to those running *nix/BSD systems):<br><br>\r
+\r
+<table class="infotable">\r
+ <tr>\r
+ <td class="tableheading">Filename</td>\r
+ <td class="tableheading">Owner</td>\r
+ <td class="tableheading">Group</td>\r
+ <td class="tableheading">Others</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata"><i>(Top Directory)</i></td>\r
+ <td class="tabledata">RWX</td>\r
+ <td class="tabledata">RX</td>\r
+ <td class="tabledata"><i>None</i></td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata"><b>Modules</b></td>\r
+ <td class="tabledata">RX</td>\r
+ <td class="tabledata">RX</td>\r
+ <td class="tabledata"><i>None</i></td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata"><b>Modules/Database</b></td>\r
+ <td class="tabledata">RX</td>\r
+ <td class="tabledata">RX</td>\r
+ <td class="tabledata"><i>None</i></td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Modules/Database/MySQL.pm</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">Modules/Database/SQLite.pm</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>Modules/Presentation</b></td>\r
+ <td class="tabledata">RX</td>\r
+ <td class="tabledata">RX</td>\r
+ <td class="tabledata"><i>None</i></td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Modules/Presentation/HTML4S.pm</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>db</b></td>\r
+ <td class="tabledata">RWX</td>\r
+ <td class="tabledata">RX</td>\r
+ <td class="tabledata"><i>None</i></td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata"><b>output</b></td>\r
+ <td class="tabledata">RWX</td>\r
+ <td class="tabledata">RX</td>\r
+ <td class="tabledata"><i>None</i></td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata"><b>lang</b></td>\r
+ <td class="tabledata">RX</td>\r
+ <td class="tabledata">RX</td>\r
+ <td class="tabledata"><i>None</i></td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">lang/*.xml</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">kiriwrite.cgi</td>\r
+ <td class="tabledata">RWX</td>\r
+ <td class="tabledata">R</td>\r
+ <td class="tabledata"><i>None</i></td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">install.cgi</td>\r
+ <td class="tabledata">RWX</td>\r
+ <td class="tabledata">R</td>\r
+ <td class="tabledata"><i>None</i></td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">page.html</td>\r
+ <td class="tabledata">R</td>\r
+ <td class="tabledata">R</td>\r
+ <td class="tabledata"><i>None</i></td>\r
+ </tr>\r
+</table>\r
+\r
+<br><br>\r
+\r
+R = Read, W = Write, X = Execute/Allow directory listing<br><br>\r
+For the non-cgi files folder, read only permissions should be set on all files (and read and allow directory listings for directories) as no writing should be needed.<br><br>\r
+Once this is done, the installer script can be run by browsing to URI location of where the files in the cgi-files directory were in place and adding install.cgi to the end of it.<br><br>\r
+<div class="footnote"></div>\r
+<sup>1</sup>The cgi-bin folder is used for storing scripts that use the Common Gateway Interface (CGI). CGI scripts are typically associated with Perl scripts but can also be C++, C, Python, shell script and many others.<br>\r
+<sup>2</sup>Some servers are configured so that CGI scripts can run from any directory so in this case Kiriwrite doesn't have to be placed in the cgi-bin directory.\r
+ </div>\r
+ </body>\r
+</html>\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 - 1.1: Obtaining 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">1.1 Obtaining Kiriwrite</span><br><br>\r
+Kiriwrite can be obtained either through the Subversion repository or extracted from a source archive that is available on Kiriwrite homepage.<br><br>\r
+<span class="heading">1.1.1: Archive Extraction</span><br><br>\r
+The contents of the Kiriwrite archive can be extracted using gzip if it's a Gzip archive, bzip2 if it's a Bzip2'ed archive, 7za if it's a 7-Zip archive and unzip if it's a ZIP archive.<br><br>\r
+Bear in mind the following is done from a command console. GUI interfaces can also do the same as preformed here and mainly involves opening the archive and clicking on the Extract/Extract All button or simply dragging the folder containing from out of the archive (usually making a copy of the contents in the archive).<br><br>\r
+\r
+<div class="messagebox">\r
+ <div class="message note">\r
+ <b>Note</b><br>\r
+ The naming convention of the Kiriwrite archives go as the following:<br><br>\r
+ <div class="code">\r
+ kiriwrite-x.y.z(-e).arc\r
+ </div>\r
+ <br>\r
+ Where x is the major version, y is the minor version and z is the revision with (-e) meaning a very tiny modification that had to be done that did not merit an increment to the revision number.\r
+ </div>\r
+</div>\r
+\r
+<br>\r
+\r
+When downloading an archive, the archive can be checked (by downloading the file with the same name but with .sha256 added to the end of it) using shasum<sup>1</sup> by doing the following to ensure it is downloaded correctly:<br><br>\r
+\r
+<div class="code">\r
+ shasum -a 256 kiriwrite-x.y.z(-e).arc\r
+</div>\r
+\r
+<br>\r
+\r
+shasum should then generate the SHA-256 that should match the one that appears in the file with the .sha256 added to it. If it does not match (and the file containing the sha256 hash is the correct version) then the archive should be downloaded again and repeat the same process.<br><br>\r
+To extract the gzip archive, the following command should be preformed when switched to the correct directory to extract from.<br><br>\r
+\r
+<div class="code">\r
+ gzip -d -c <i>(path)</i>/kiriwrite-0.1.0.tar.gz | tar -xv\r
+</div>\r
+\r
+<br>\r
+\r
+A list of files that have been extracted will then appear with the contents of the archive appearing in the directory that the archive was extracted to.<br><br>\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
+</div>\r
+\r
+<br>\r
+\r
+A list of files that have been extracted will then appear with the contents of the archive appearing in the directory that the archive was extracted to.<br><br>\r
+To extract the ZIP archive, the following command should be preformed when switched to the correct directory to extract from.<br><br>\r
+\r
+<div class="code">\r
+ unzip <i>(path)</i>/kiriwrite-0.1.0.zip\r
+</div>\r
+\r
+<br>\r
+\r
+A list of files that have been extracted will then appear with the contents of the archive appearing in the directory that the archive was extracted to.<br><br>\r
+To extract the 7Zip archive, the following command should be preformed when switched to the correct directory to extract from.<br><br>\r
+\r
+<div class="code">\r
+ 7za e <i>(path)</i>/kiriwrite-0.1.0.7z\r
+</div>\r
+\r
+<br>\r
+\r
+A list of files that have been extracted will then appear with the contents of the archive appearing in the directory that the archive was extracted to.<br><br>\r
+\r
+<span class="heading">1.1.2: Subversion Access</span><br><br>\r
+Kiriwrite can also be obtained through checking out the code from the Subversion repository.<br><br>\r
+\r
+<div class="messagebox">\r
+ <div class="message note">\r
+ <b>Note</b><br>\r
+ Bear in mind that the code that is in the Kiriwrite Subversion repository is normally unstable and could very well cause unexpected problems (such as warnings that appear in the web server error log that can be easily fixed and alterations to the database structure which requires an upgrade script which hasn't been written yet for that particular version yet).\r
+ </div>\r
+</div>\r
+\r
+<br>\r
+\r
+Kiriwrite can be obtained from the Subversion repository by doing the following in a command console after selecting the correct directory to put it in:<br><br>\r
+\r
+<div class="code">\r
+ svn checkout svn://svn.berlios.de/kiriwrite/trunk\r
+</div>\r
+\r
+<br>\r
+\r
+A list of files then appear as they are received from the Subversion repository and placed in the directory the command console is currently in. To update the code stored locally with code that is in the Kiriwrite Subversion repository this command should be done after changing to the directory where the local copy of the Kiriwrite Subversion code is:<br><br>\r
+\r
+<div class="code">\r
+ svn update\r
+</div>\r
+\r
+<br>\r
+\r
+A list of files will then appear showing which file has been updated.\r
+ </div>\r
+ </body>\r
+</html>\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 1: Installation</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 1: Installation</span><br><br>\r
+Before Kiriwrite can be used, Kiriwrite needs to be installed properly and this involves obtaining the code from a source package or from a Subversion<sup>1</sup> repository, copying the needed files into the correct place, setting the correct permissions on the files and running the installation script.<br><br>\r
+\r
+<div class="warningbox">\r
+ <div class="message warning">\r
+ <span class="warningtext">\r
+ <b>Warning</b><br>\r
+ Please be aware (for this version), that Kiriwrite <b>is intended to be used on a private web server and not on a public web server unless it is properly secured down</b> because by default anyone can run Kiriwrite and manipulate the data already there. Suggested methods of securing down your Kiriwrite installation are available in Chapter 4: Usage Tips.\r
+ </span>\r
+ </div>\r
+</div>\r
+\r
+<br>\r
+\r
+This chapter is split into two parts with the first part explaining on how to obtain Kiriwrite and the second part explaining on how to install Kiriwrite.<br><br>\r
+\r
+<div class="footnote"></div>\r
+<sup>1</sup> Subversion is a version control system which tracks changes to data stored in the repositories and allows easy updating of source code after the source code is checked out.\r
+ </div>\r
+ </body>\r
+</html>\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 - 2.5: Compiling</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">2.5 Compiling</span><br><br>\r
+\r
+Compiling combines the page data with the template layout and the filters that are in the filter database to create pages as if they were created manually.<br><br>\r
+\r
+To compile the pages from their databases, click on the 'Compile Pages' menu link. A list of databases will then appear which can be compiled. If no databases are available then a message will appear saying that no databases are available.<br><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
+\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
+\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
+\r
+<span class="heading">2.5.4 Cleaning the output directory</span><br><br>\r
+\r
+Cleaning the output directory removes all of the contents that is in the output directory. To clean the output directory click on the 'Clean Output Directory' link which will display a message asking to confirm that the output directory should be cleaned. Clicking on the 'Yes, clean output directory' will display a confirmation message saying that the output directory was cleaned. Clicking on the 'Return to the compile database list.' link will return to the list of databases to compile.\r
+ </div>\r
+ </body>\r
+</html>\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 - 2.1: Databases</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">2.1 Databases</span><br><br>\r
+Databases are used for storing the pages that are created in Kiriwrite. Before pages can be stored in a database, a database has to be created.<br><br>\r
+The default view when you run the Kiriwrite script is to show the list of databases. If there are no databases available, then a message appears saying that there are no databases than can be used.<br><br>\r
+<span class="heading">2.1.1 Add a database</span><br><br>\r
+To add a database, from the View Databases sub-menu click on the 'Add Database' link, a form then appears allowing to enter the information about the new database.<br><br>\r
+\r
+<table class="infotable">\r
+ <tr>\r
+ <td class="tableheading">Settings</td>\r
+ <td class="tableheading">Description</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Database Name</td>\r
+ <td class="tabledata">Specifies the database name of the new Kiriwrite database.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Database Description</td>\r
+ <td class="tabledata">Specifies the description of the new Kiriwrite database.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Database Categories</td>\r
+ <td class="tabledata">Specifies the categories the database should belong to.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Database Notes</td>\r
+ <td class="tabledata">The notes that gives information about the database.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Database Filename</td>\r
+ <td class="tabledata">Specifies the database filename to use. If nothing is entered for the filename than an attempt to automatically generate a filename will be done.</td>\r
+ </tr>\r
+</table>\r
+\r
+<br>\r
+\r
+To add the database with the settings given, click on the 'Add Database' button and a confirmation message should then appear saying that the database has been added and offering a link back to the list of databases. To clear the settings, click on the 'Clear values' button.<br><br>\r
+\r
+<span class="heading">2.2 Edit a database</span><br><br>\r
+To edit a database, click on the 'Edit' link opposite the name and description of the database you want to edit. A form then appears similar to the form for adding a database.<br><br>\r
+\r
+<table class="infotable">\r
+ <tr>\r
+ <td class="tableheading">Settings</td>\r
+ <td class="tableheading">Description</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Database Name</td>\r
+ <td class="tabledata">Specifies the new database name of the Kiriwrite database.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Database Description</td>\r
+ <td class="tabledata">Specifies the new description of the Kiriwrite database.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Database Categories</td>\r
+ <td class="tabledata">Specifies the new categories the database should belong to.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Database Notes</td>\r
+ <td class="tabledata">The notes that gives information about the database.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Database Filename</td>\r
+ <td class="tabledata">Specifies the database filename to use.</td>\r
+ </tr>\r
+</table>\r
+\r
+<br>\r
+\r
+To edit a database with the new settings given click on the 'Edit Database' button and a confirmation message should appear saying that the database has been edited and offering a link back to the database list. Clicking on the 'Restore current settings' button will undo any changes and revert to the currently used settings.<br><br>\r
+\r
+<span class="heading">2.3 Delete a database</span><br><br>\r
+To delete a database, click on the 'Delete' link opposite. A message then appears asking if the selected database should be deleted. Clicking on the 'Yes, delete the database' button will delete the database and display a confirmation message saying that the selected database has been deleted offering a link to return to the database list. Clicking on 'No, return to the database list.' link will make it return to the database list.<br><br>\r
+\r
+<div class="warningbox">\r
+ <div class="message warning">\r
+ <span class="warningtext">\r
+ <b>Warning</b><br>\r
+ When a database is deleted, the pages in the database are deleted as well.\r
+ </span>\r
+ </div>\r
+</div>\r
+ </div>\r
+ </body>\r
+</html>\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 - 2.3: Filters</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">2.3 Filters</span><br><br>\r
+\r
+Filters allows text to be easily replaced by looking for certain words, tag or phrase and then replacing it with another set of words, tag or phrase.<br><br>\r
+\r
+The list of filters can be viewed by clicking on the 'View Filters' link. If the filter database doesn't exist than a message will appear saying that the filter database doesn't exist and will be created when a filter is added or if the filter database does exist but there are no filters then a message appears saying that there is no filters in the filter database.<br><br>\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
+<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
+\r
+<table class="infotable">\r
+ <tr>\r
+ <td class="tableheading">Setting</td>\r
+ <td class="tableheading">Description</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Find...</td>\r
+ <td class="tabledata">Specifies the find setting to search text for.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Replace With...</td>\r
+ <td class="tabledata">Specifies the replace setting to replace the text with if the search text is found.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Priority</td>\r
+ <td class="tabledata">Specifies the priority of the filter.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Notes</td>\r
+ <td class="tabledata">Specifies the notes for this filter.</td>\r
+ </tr>\r
+</table>\r
+\r
+<br>\r
+\r
+After entering the needed filter information, the filter can be added by clicking on the 'Add Filter' button which displays a confirmation message saying that the filter has been added to the filter database and offering a link back to the list of filters in the filter database. Clicking on the 'Clear values' button will clear any of the filter settings that have been entered and clicking on the 'Return to the filter list.' link will return to the list of filters in the filter database.<br><br>\r
+\r
+<span class="heading">2.3.2 Edit a filter</span><br><br>\r
+To edit a filter click on the 'Edit' link opposite the filter you want to edit. A form then appears that is similar to adding a filter.<br><br>\r
+\r
+<table class="infotable">\r
+ <tr>\r
+ <td class="tableheading">Setting</td>\r
+ <td class="tableheading">Description</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Find...</td>\r
+ <td class="tabledata">Specifies the new find setting to search text for.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Replace With...</td>\r
+ <td class="tabledata">Specifies the new replace setting to replace the text with if the search text is found.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Priority</td>\r
+ <td class="tabledata">Specifies the new priority of the filter.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Notes</td>\r
+ <td class="tabledata">Specifies the new notes for this filter.</td>\r
+ </tr>\r
+</table>\r
+\r
+<br>\r
+\r
+To update the information about the filter, click on the 'Edit Filter' button and a confirmation message should appear saying that the selected filter was edited offering a link back to the list of filters in the filter database. Clicking on the 'Restore current settings' will undo any changes made and will revert the currently used filter settings and clicking on the 'Return to the filter list.' link will return to the list of filters in the filter database.<br><br>\r
+\r
+<span class="heading">2.3.3 Delete a filter</span><br><br>\r
+\r
+To delete a filter click on the 'Delete' link opposite the filter you want to delete. A form then appears asking to confirm the deletion of the selected filter. Clicking on the 'Yes, delete the selected filter' button will display a confirmation message saying that the selected filter was deleted. Clicking on the 'No, return to the filter list.' link will return to the list of filters in the filter database.\r
+ </div>\r
+ </body>\r
+</html>\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 - 2.2: Pages</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="">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
+<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
+<table class="infotable">\r
+ <tr>\r
+ <td class="tableheading">Setting</td>\r
+ <td class="tableheading">Description</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Database</td>\r
+ <td class="tabledata">Specifies the database that the page is being added to.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Page Name</td>\r
+ <td class="tabledata">Specifies the name of the new page.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Page Description</td>\r
+ <td class="tabledata">Specifies the description of the new page.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Page Section</td>\r
+ <td class="tabledata">Specifies the section name of the new page.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Page Template</td>\r
+ <td class="tabledata">Specifies the page template to use.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Page Filename</td>\r
+ <td class="tabledata">Specifies the page filename to use.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Page Content</td>\r
+ <td class="tabledata">Specifies the content of the page.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Page Settings</td>\r
+ <td class="tabledata">Specifies if the page name and section should be used for the title.</td>\r
+ </tr>\r
+</table>\r
+\r
+<br>\r
+\r
+The following Kiriwrite tags can be used with the page content to automatically place information such as page name, description and section:<br><br>\r
+\r
+<table class="infotable">\r
+ <tr>\r
+ <td class="tableheading">Tag</td>\r
+ <td class="tableheading">Description</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata"><kiriwrite:pagetitle></td>\r
+ <td class="tabledata">Places the page title here. The format of the page title can be changed using the Page Settings value.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata"><kiriwrite:pagename></td>\r
+ <td class="tabledata">Places the page name here.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata"><kiriwrite:pagedescription></td>\r
+ <td class="tabledata">Places the page description here.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata"><kiriwrite:pagesection></td>\r
+ <td class="tabledata">Places the page section here.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata"><kiriwrite:autosection></td>\r
+ <td class="tabledata">Places the automatic page section here.<br><br>\r
+ <div class="messagebox">\r
+ <div class="message note">\r
+ <b>Note</b><br>\r
+ If there is a page section then the page section will appear bracketed. If Information was the page section then the automatic page section name would be '(Information)' and if the page section name is blank then no brackets will appear and will be blank.\r
+ </div>\r
+ </div> \r
+ </td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata"><kiriwrite:autotitle></td>\r
+ <td class="tabledata">Places the automatic page title here. This combines the section name and page name with brackets around them and a dash separating them with '(Section Name – Page Name)' being the example. The format can be changed by changing the Page Settings value.</td>\r
+ </tr>\r
+\r
+</table>\r
+\r
+<br>\r
+\r
+After entering the needed page information, the page can be added to the selected database by clicking on the 'Add Page' button and then a confirmation message would appear saying that the selected page has been added and offering a link to return to the page list for the selected database. The new page settings can be cleared by clicking on the 'Reset Settings' button.<br><br>\r
+\r
+<span class="heading">2.2.2: Editing a page</span><br><br>\r
+\r
+To edit a page, click on the 'Edit' link opposite the page filename you want to edit. A form then appears that is similar for adding a page.<br><br>\r
+\r
+<table class="infotable">\r
+ <tr>\r
+ <td class="tableheading">Setting</td>\r
+ <td class="tableheading">Description</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Database</td>\r
+ <td class="tabledata">Specifies the database that the page is being edited from.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Page Name</td>\r
+ <td class="tabledata">Specifies the new name of the page.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Page Description</td>\r
+ <td class="tabledata">Specifies the new description of the page.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Page Section</td>\r
+ <td class="tabledata">Specifies the new section name of the page.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Page Template</td>\r
+ <td class="tabledata">Specifies the new page template to use.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Page Filename</td>\r
+ <td class="tabledata">Specifies the new page filename.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Page Content</td>\r
+ <td class="tabledata">Specifies the new content of the page.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Page Settings</td>\r
+ <td class="tabledata">Specifies if there should be a new page name and section setting.</td>\r
+ </tr>\r
+</table>\r
+\r
+<br>\r
+\r
+The following Kiriwrite tags are used for when adding a page can also be used when editing a page:<br><br>\r
+\r
+<table class="infotable">\r
+ <tr>\r
+ <td class="tableheading">Tag</td>\r
+ <td class="tableheading">Description</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata"><kiriwrite:pagetitle></td>\r
+ <td class="tabledata">Places the page title here. The format of the page title can be changed using the Page Settings value.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata"><kiriwrite:pagename></td>\r
+ <td class="tabledata">Places the page name here.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata"><kiriwrite:pagedescription></td>\r
+ <td class="tabledata">Places the page description here.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata"><kiriwrite:pagesection></td>\r
+ <td class="tabledata">Places the page section here.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata"><kiriwrite:autosection></td>\r
+ <td class="tabledata">Places the automatic page section here.<br><br>\r
+ <div class="messagebox">\r
+ <div class="message note">\r
+ <b>Note</b><br>\r
+ If there is a page section then the page section will appear bracketed. If Information was the page section then the automatic page section name would be '(Information)' and if the page section name is blank then no brackets will appear and will be blank.\r
+ </div>\r
+ </div>\r
+\r
+ </td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata"><kiriwrite:autotitle></td>\r
+ <td class="tabledata">Places the automatic page title here. This combines the section name and page name with brackets around them and a dash separating them with '(Section Name – Page Name)' being the example. The format can be changed by changing the Page Settings value.</td>\r
+ </tr>\r
+</table>\r
+\r
+<br>\r
+\r
+After entering the new information, the page can be edited by clicking on the 'Edit Page' button and a confirmation message appears saying that the page has been edited and offering a link back to the list of pages for the currently selected database. Clicking on the 'Restore current settings' button will undo any changes and revert to the current page settings.<br><br>\r
+\r
+<span class="heading">2.2.3: Deleting a page</span><br><br>\r
+\r
+To delete a page, click on the 'Delete' link opposite the page filename you want to delete, a message then appears asking to confirm that page will be deleted. Clicking on the 'Yes, delete the page' button will delete the page and offer a link back to the list of pages for the selected database. Clicking on the 'No, return to the page list for the (database name) database.' link will return to the list of pages for the selected database.<br><br>\r
+\r
+<span class="heading">2.2.4: Delete multiple pages</span><br><br>\r
+\r
+To delete multiple pages from the selected database click on the check-box that is to the left of the page filenames you want to delete and then click on the 'Delete Selected' button at the top of the page, a form will then appear asking to confirm if the selected pages listed should be deleted.<br><br>\r
+\r
+Clicking on the 'Yes, delete the selected pages' button will display a confirmation message saying that the selected pages were deleted offering a link back to the list of pages for the selected database. Clicking on the 'No, return to the page list for the (database name) database.' will return to the list of pages for the selected database.<br><br>\r
+\r
+<span class="heading">2.2.5: Move multiple pages</span><br><br>\r
+\r
+To move multiple pages from the selected database click on the check-box that is to the left of the page filenames you want to delete and then click on the 'Move Selected' button at the top of the page, a form will then appear asking to select which database the selected pages should go to and confirm that those pages are being moved to the new database.<br><br>\r
+\r
+Clicking on the 'Move selected pages' button will display a confirmation message saying that the selected pages were moved to the new database selected offering a link back to the selected database that the pages were moved from and a link to the selected database where the pages have moved to. Clicking on the 'Return to the page list for the (database name) database' will return to the list of pages in the selected database.<br><br>\r
+\r
+<span class="heading">2.2.6: Copy multiple pages</span><br><br>\r
+\r
+To copy multiple pages from the selected database click on the check-box that is to the left of the page filenames you want to copy and then click on the 'Copy Selected' button at the top of the page, a form will then appear asking to select which database the selected pages should be copied to and confirm that those pages are being copied to the new database.<br><br>\r
+\r
+Clicking on the 'Copy selected pages' button will display a confirmation message saying that the selected pages were copied to the new database selected offering a link back to the selected pages that the pages were copied from and a link to the selected database where the pages have been copied to. Clicking on the 'Return to the page list for the (database name) database.' will return to the list of pages in the selected database.<br><br>\r
+\r
+<span class="heading">2.2.7: Edit multiple pages</span><br><br>\r
+\r
+To edit multiple pages from the selected database click on the check-box that is to the left of the page filenames you want to edit and then click on the 'Edit Selected' button at the top of the page, a form will then appear that allows certain settings of each page to be edited as shown in the table below:<br><br>\r
+\r
+<table class="infotable">\r
+ <tr>\r
+ <td class="tableheading">Setting</td>\r
+ <td class="tableheading">Description</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Page Section</td>\r
+ <td class="tabledata">Specifies the new page section to be used on the selected pages.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Page Template</td>\r
+ <td class="tabledata">Specifies the new page template to be used on the selected pages.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Page Settings</td>\r
+ <td class="tabledata">Specifies the new page settings to be used on the selected pages.</td>\r
+ </tr>\r
+</table>\r
+\r
+<br>\r
+\r
+Each setting that needs to be changed needs to have the check-box on the left of the name needs to be checked otherwise the change will not take effect. This is done to make sure that only the selected page settings are changed.<br><br>\r
+Clicking on the 'Edit selected pages' button will display a confirmation message saying that the selected pages were edited offering a link back to the list of pages in the selected database, clicking on the 'Clear values' button will clear the currently selected values and clicking on the 'Return to the page list for the '(database name)' database.' link will return to the page list for selected database.\r
+ </div>\r
+ </body>\r
+</html>\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 - 2.4: Templates</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">2.4 Templates</span><br><br>\r
+\r
+Templates allows pages to use a common layout which is used to keep a consistent layout on a website or keep the format of documentation pages the same. Templates also allow small tweaks to the page layout to be made without needing to edit each page so the change is reflected in all of the pages by simply changing the template layout and then recompile the pages.<br><br>\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
+<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
+\r
+<table class="infotable">\r
+ <tr>\r
+ <td class="tableheading">Setting</td>\r
+ <td class="tableheading">Description</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Template Name</td>\r
+ <td class="tabledata">Specifies the template name to be used.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Template Description</td>\r
+ <td class="tabledata">Specifies the template description to be used.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Template Filename</td>\r
+ <td class="tabledata">Specifies the template filename to use.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Template Layout</td>\r
+ <td class="tabledata">Specifies the content of the template layout.</td>\r
+ </tr>\r
+</table>\r
+\r
+<br>\r
+\r
+The following Kiriwrite tags can be used with the template layout to automatically place information such as page content, name, description and section:\r
+\r
+<br><br>\r
+\r
+<table class="infotable">\r
+ <tr>\r
+ <td class="tableheading">Tag</td>\r
+ <td class="tableheading">Description</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata"><kiriwrite:pagecontent></td>\r
+ <td class="tabledata">Places the page content here.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata"><kiriwrite:pagetitle></td>\r
+ <td class="tabledata">Places the page title here. The format of the page title can be changed using the Page Settings value.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata"><kiriwrite:pagename></td>\r
+ <td class="tabledata">Places the page name here.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata"><kiriwrite:pagedescription></td>\r
+ <td class="tabledata">Places the page description here.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata"><kiriwrite:pagesection></td>\r
+ <td class="tabledata">Places the page section here.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata"><kiriwrite:autosection></td>\r
+ <td class="tabledata">Places the automatic page section here.<br><br>\r
+ <div class="messagebox">\r
+ <div class="message note">\r
+ <b>Note</b><br>\r
+ If there is a page section then the page section will appear bracketed. If Information was the page section then the automatic page section name would be '(Information)' and if the page section name is blank then no brackets will appear and will be blank.\r
+ </div>\r
+ </div> \r
+ </td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata"><kiriwrite:autotitle></td>\r
+ <td class="tabledata">Places the automatic page title here. This combines the section name and page name with brackets around them and a dash separating them with '(Section Name – Page Name)' being the example. The format can be changed by changing the Page Settings value.</td>\r
+ </tr>\r
+</table>\r
+\r
+<br>\r
+\r
+After entering the needed template information, click on the 'Add Template' button to display a confirmation message saying that add the template to the list of templates in the template database and offering a link back to the list of templates in the template database. Clicking on the 'Clear values' button will clear all of the template settings entered. Clicking on the 'Return to the template list.' link will return to the list of templates in the template database.<br><br>\r
+\r
+<span class="heading">2.4.2 Edit a template</span><br><br>\r
+To edit a template click on the 'Edit' link opposite the template name you want to edit, a form then appears that is similar to adding a template.<br><br>\r
+\r
+<table class="infotable">\r
+ <tr>\r
+ <td class="tableheading">Setting</td>\r
+ <td class="tableheading">Description</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Template Name</td>\r
+ <td class="tabledata">Specifies the new template name to be used.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Template Description</td>\r
+ <td class="tabledata">Specifies the new template description to be used.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Template Filename</td>\r
+ <td class="tabledata">Specifies the new template filename to use.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Template Layout</td>\r
+ <td class="tabledata">Specifies the new content of the template layout.</td>\r
+ </tr>\r
+</table>\r
+\r
+<br>\r
+\r
+The Kiriwrite tags used when adding a template can also be used when editing a template.\r
+\r
+<br><br>\r
+\r
+<table class="infotable">\r
+ <tr>\r
+ <td class="tableheading">Tag</td>\r
+ <td class="tableheading">Description</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata"><kiriwrite:pagecontent></td>\r
+ <td class="tabledata">Places the page content here.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata"><kiriwrite:pagetitle></td>\r
+ <td class="tabledata">Places the page title here. The format of the page title can be changed using the Page Settings value.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata"><kiriwrite:pagename></td>\r
+ <td class="tabledata">Places the page name here.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata"><kiriwrite:pagedescription></td>\r
+ <td class="tabledata">Places the page description here.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata"><kiriwrite:pagesection></td>\r
+ <td class="tabledata">Places the page section here.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata"><kiriwrite:autosection></td>\r
+ <td class="tabledata">Places the automatic page section here.<br><br>\r
+ <div class="messagebox">\r
+ <div class="message note">\r
+ <b>Note</b><br>\r
+ If there is a page section then the page section will appear bracketed. If Information was the page section then the automatic page section name would be '(Information)' and if the page section name is blank then no brackets will appear and will be blank.\r
+ </div>\r
+ </div> \r
+ </td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata"><kiriwrite:autotitle></td>\r
+ <td class="tabledata">Places the automatic page title here. This combines the section name and page name with brackets around them and a dash separating them with '(Section Name – Page Name)' being the example. The format can be changed by changing the Page Settings value.</td>\r
+ </tr>\r
+</table>\r
+\r
+<br>\r
+\r
+After editing the information about the template, the template can be edited by clicking on the 'Edit Template' button which will display a confirmation message saying that the template information was edited offering a link back to the list of templates in the template database. Clicking on the 'Restore current settings' button will undo any changes and revert to the currently used settings. Clicking on the 'Return to the template list.' will return to the list of templates in the template database.<br><br>\r
+\r
+<span class="heading">2.4.3 Delete a template</span><br><br>\r
+\r
+To delete a template click on the 'Delete' link opposite the template name you want to delete, a message then appears asking to confirm the deletion of the selected template. Clicking on the 'Yes, delete the template' button will display a confirmation message saying that the selected template has been deleted offering a link back to the list of templates in the template database. Clicking on the 'No, return to the template list.' link will return to the list of templates in the template database.\r
+ </div>\r
+ </body>\r
+</html>\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 2: Operation</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 2: Operation</span><br><br>\r
+Now that Kiriwrite is installed and working, this chapter is about operating Kiriwrite. This chapter is split into five parts:<br>\r
+\r
+<ul>\r
+<li>Databases, how to add a database, edit a database and delete a database.</li>\r
+<li>Pages, Selecting a database, creating, editing and deleting pages, deleting, moving, copying and editing multiple pages.</li>\r
+<li>Filters, adding a filter, editing a filter and deleting a filter.</li>\r
+<li>Templates, adding a template, editing a template and deleting a template.</li>\r
+<li>Compiling, compiling one, selected or all databases and cleaning the output directory.</li>\r
+</ul>\r
+ </div>\r
+ </body>\r
+</html>\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 3: Kiriwrite Settings</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 3: Kiriwrite Settings</span><br><br>\r
+\r
+The settings that are used in Kiriwrite can be viewed by clicking on the 'View Settings' link in the menu which will display a list of settings that are currently in use.<br><br>\r
+\r
+<span class="heading">3.1 Editing the settings</span><br><br>\r
+\r
+To edit the settings, click on the 'Edit Settings' link in the View Settings sub-menu, a form then appears allowing the settings in Kiriwrite to be edited.<br><br>\r
+\r
+<table class="infotable">\r
+ <tr>\r
+ <td class="tableheading">Setting</td>\r
+ <td class="tableheading">Description</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Database Directory</td>\r
+ <td class="tabledata">Specifies the database directory to use for storing databases that are created by the file-based database modules. This option is ignored by the server-based modules.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Output Directory</td>\r
+ <td class="tabledata">Specifies the output directory to use to store the compiled pages.</td>\r
+ </tr>\r
+ <tr>\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">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
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Language</td>\r
+ <td class="tabledata">Specifies the system language to use in Kiriwrite. If the language used in the installer script is available as language to use in Kiriwrite then that language will be selected by default.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Presentation Module</td>\r
+ <td class="tabledata">Specifies the presentation module to use in Kiriwrite.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Database Module</td>\r
+ <td class="tabledata">Specifies the database module to use in Kiriwrite. SQLite is a file-based database module which uses the database directory and the SQLite Perl module while MySQL5 is a server-based database module which uses a MySQL 5.x server from the MySQL Perl module.</td>\r
+ </tr>\r
+</table>\r
+\r
+<br>\r
+\r
+The following options are used only by the server-based database modules:<br><br>\r
+\r
+<table class="infotable">\r
+ <tr>\r
+ <td class="tableheading">Setting</td>\r
+ <td class="tableheading">Description</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Database Server</td>\r
+ <td class="tabledata">Specifies the database server to use.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Database Port</td>\r
+ <td class="tabledata">Specifies the database port to use.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Database Protocol</td>\r
+ <td class="tabledata">Specifies the database protocol to use.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Database Name</td>\r
+ <td class="tabledata">Specifies the database name to use.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Database Username</td>\r
+ <td class="tabledata">Specifies the database username to use.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Database Password</td>\r
+ <td class="tabledata">Specifies the database password to use.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">Database Table Prefix</td>\r
+ <td class="tabledata">Specifies the table prefix to use. Multiple Kiriwrite installations can use the same server database so long as the table prefix is different.</td>\r
+ </tr>\r
+</table>\r
+\r
+<br>\r
+\r
+To save the new settings, click on the 'Change Settings' button which will display a confirmation message saying that the settings were changed and will take effect on the next page load of Kiriwrite offering a link back to the updated list of settings. Clicking on the 'Restore current settings' button will undo any changes made and will restore the current settings. Clicking on the 'Return to the list of settings.' link will return to the list of currently used settings.\r
+ </div>\r
+ </body>\r
+</html>\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 - 4.3: Removing unneeded modules and language files</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">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
+\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
+ </body>\r
+</html>\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 - 4.2: Renaming the main Kiriwrite script (kiriwrite.cgi)</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">4.2 Renaming the main Kiriwrite script (kiriwrite.cgi)</span><br><br>\r
+\r
+While the Kiriwrite script can be used as kiriwrite.cgi, the script has been designed so that it can work if it's renamed to something else such as docmake.cgi, private.cgi or even flyingrhinos.cgi. This can simply be done by renaming the script to whatever name is needed.<br><br>\r
+\r
+<div class="warningbox">\r
+ <div class="message warning">\r
+ <span class="warningtext">\r
+ <b>Warning</b><br>\r
+ Bear in mind that no matter what the script filename is called, it will always look for configuration file as kiriwrite.xml, the modules in the Modules directory and the language files in the lang directory.\r
+ </span>\r
+ </div>\r
+</div>\r
+\r
+ </div>\r
+ </body>\r
+</html>\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 - 4.1: Securing your Kiriwrite installation</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">4.1 Securing your Kiriwrite installation</span><br><br>\r
+\r
+This section is about securing your Kiriwrite installation.<br><br>\r
+\r
+<span class="heading">4.1.1 HTTP Authentication</span><br><br>\r
+\r
+HTTP Authentication allows users who only know the correct username and password to access pages that are not available to the public. HTTP Authentication is done by the following if you're using Apache 1.3.x/2.x from a command console:<br><br>\r
+\r
+<div class="code">\r
+ htpasswd -c .htpasswd username\r
+</div>\r
+\r
+<br>\r
+\r
+The -c switch specifies that a password file should be created called .htpasswd (although can be called something else), while username is the username of the login (which can be something else other than username), after pressing enter a password prompt then appears asking for a password to be entered the same twice.<br><br>\r
+\r
+After the .htpasswd file is created, the file should be copied to a location that cannot be accessed from a URI resource (such as outside the htdocs/web documents directory) and then create a .htaccess file (if it doesn't exist) pointing to the password file with the following directives as an example.<br><br>\r
+\r
+<div class="code">\r
+ AuthUserFile /home/www/website/private/.htpasswd<br>\r
+ AuthType Digest<br>\r
+ AuthName “Private Area”\r
+</div>\r
+\r
+<br>\r
+\r
+The AuthUserFile directive should point to the htpasswd file that was created earlier on. The AuthType directive specifies the authentication type to use and AuthName specifies the name of the area to appear when entering the username and password.<br><br>\r
+\r
+<span class="heading">4.1.2 IP Address Filtering</span><br><br>\r
+\r
+IP Address filtering allows certain IP addresses or hosts to be blocked from access and allowing everyone else access or blocking everyone from access and allowing certain IP addresses or hosts in. Typically when using Kiriwrite, the best method would be the white list method where everyone is blocked from access and only certain IP addresses or hosts can be allowed access.<br><br>\r
+\r
+To setup a white list, open the .htaccess file and insert the following (if it already exists) if you're using Apache 1.3/2.x:<br><br>\r
+\r
+<div class="code">\r
+ Order Deny, Allow<br>\r
+ Deny from all<br>\r
+ Allow from 127.0.0.1\r
+</div>\r
+\r
+<br>\r
+\r
+This example denies everyone and then only allows 127.0.0.1 (which is the computer the web server is running from which tends to be the machine you're using on a personal installation). Multiple Allow commands can be entered which allows multiple hosts.<br><br>\r
+\r
+More information on using Allow and Deny can be found in the Apache 1.3/2.x Documentation.\r
+ </div>\r
+ </body>\r
+</html>\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 4: Usage Tips</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 4: Usage Tips</span><br><br>\r
+This chapter mainly contains usage tips in securing your Kiriwrite installation and small features which may be useful for some users.<br><br>\r
+\r
+<div class="specific apache132x">\r
+ In this chapter, directory specific settings used in Apache is .htaccess. Typically, if the web server software is configured to check a file other than .htaccess then a different filename would be used (and would be blocked from being accessed from the web server).\r
+</div>\r
+\r
+ </div>\r
+ </body>\r
+</html>\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 5: Troubleshooting</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 5: Troubleshooting</span><br><br>\r
+<span class="heading">5.1 Common Problems</span><br><br>\r
+\r
+<table class="infotable">\r
+ <tr>\r
+ <td class="tableheading">Problem</td>\r
+ <td class="tableheading">Symptom</td>\r
+ <td class="tableheading">Solution</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">When installing, some of the needed Perl modules have the word 'Error' next to them.</td>\r
+ <td class="tabledata">The needed Perl modules are more than likely not installed.</td>\r
+ <td class="tabledata">Install the needed Perl modules from the CPAN archive using the CPAN command interface.<sup>1</sup></td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">When installing, an error message appears saying that none of the needed Perl modules for the database modules are installed.</td>\r
+ <td class="tabledata">The needed Perl module(s) (or the Perl module needed specifically for that certain database module) are more than likely not installed.</td>\r
+ <td class="tabledata">Install the needed Perl modules from the CPAN archive using the CPAN command interface.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">When installing, an error message appears saying that some of the directories and files have invalid permissions set.</td>\r
+ <td class="tabledata">The directories and/or files have invalid permissions set.</td>\r
+ <td class="tabledata">Change the permissions on the directories and/or files so that are the correct permissions needed.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">When installing, no database or presentation modules appear in the list of available database or presentation modules.</td>\r
+ <td class="tabledata">The modules weren't copied or were copied to the wrong directories.</td>\r
+ <td class="tabledata">Copy or move the database modules to the correct directory.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">When installing, no languages appears in the languages selection list.</td>\r
+ <td class="tabledata">The language files weren't copied or were copied to the wrong location.</td>\r
+ <td class="tabledata">Copy or move the language files to the correct directory.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">When starting Kiriwrite, a critical error message appears saying that the configuration file does not exist.</td>\r
+ <td class="tabledata">The configuration file has been deleted or the installation script wasn't run.</td>\r
+ <td class="tabledata">Run the installer script (again).</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">When starting Kiriwrite, a critical error message appears saying that the configuration file has invalid permissions set.</td>\r
+ <td class="tabledata">The configuration file has invalid permissions set.</td>\r
+ <td class="tabledata">Change the permissions on the configuration file so that it can be read.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">When starting Kiriwrite, a critical error message appears saying that the database module does not exist.</td>\r
+ <td class="tabledata">The database module has been deleted or renamed.</td>\r
+ <td class="tabledata">Run the installer script (again).<br>\r
+ Check if the Modules and Modules/Database directory have the correct permissions set so that they can be read.\r
+ </td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">When starting Kiriwrite, a critical error message appears saying that the database module has invalid permissions set.</td>\r
+ <td class="tabledata">The database module has invalid permissions set.</td>\r
+ <td class="tabledata">Change the permissions on the database module so that they can be read (execute permissions not usually needed).</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">When starting Kiriwrite, a critical error message appears saying that the presentation module does not exist.</td>\r
+ <td class="tabledata">The presentation module has been deleted or renamed.</td>\r
+ <td class="tabledata">Run the installer script (again).<br>\r
+ Check if the Modules and Modules/Presentation directory have the correct permissions set so that they can be read.\r
+ </td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">When starting Kiriwrite, a critical error message appears saying that the presentation module has invalid permissions set.</td>\r
+ <td class="tabledata">The presentation module has invalid permissions set.</td>\r
+ <td class="tabledata">Change the permissions on the presentation module so that they can be read (execute permissions not usually needed).</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">When starting Kiriwrite, a critical error message appears saying that the language file does not exist.</td>\r
+ <td class="tabledata">The language file does not exist.</td>\r
+ <td class="tabledata">Run the installer script (again).<br>\r
+ Check if the lang directory has the correct permissions set so that they can be read.\r
+ </td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">When starting Kiriwrite, a critical error message appears saying that the language file has invalid permissions set.</td>\r
+ <td class="tabledata">The language file has invalid permissions set.</td>\r
+ <td class="tabledata">Change the permissions on the language file so that they can be read.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">When viewing the list of databases, an error message appears saying that the permissions of the database directory is invalid.</td>\r
+ <td class="tabledata">The database directory has incorrect permissions set.</td>\r
+ <td class="tabledata">Set the correct permissions (read and write) on the database directory.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">When viewing the template database, an error message appears saying the permissions of the template database is invalid.</td>\r
+ <td class="tabledata">The template database has invalid permissions set.</td>\r
+ <td class="tabledata">Set the correct permissions (read and write) on the template database.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">When viewing the filter database, an error message appears saying that the permissions of the filter database is invalid.</td>\r
+ <td class="tabledata">The filter database has invalid permissions set.</td>\r
+ <td class="tabledata">Set the correct permissions (read and write) on the filter database.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">When compiling the pages, an error message appears saying that the output directory has invalid permissions set.</td>\r
+ <td class="tabledata">The output directory has invalid permissions set.</td>\r
+ <td class="tabledata">Set the correct permissions (read and write) on the output directory.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">When compiling the pages, certain pages do not change when the pages are edited.</td>\r
+ <td class="tabledata">The pages have invalid permissions set.</td>\r
+ <td class="tabledata">Set the correct permissions (read and write) on those pages which have invalid permissions set.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">When compiling the pages, the template database has invalid permissions set.</td>\r
+ <td class="tabledata">The template database has invalid permissions set.</td>\r
+ <td class="tabledata">Set the correct permissions (read) on the template database.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">When compiling the pages, the filter database has invalid permissions set.</td>\r
+ <td class="tabledata">The filter database has invalid permissions set.</td>\r
+ <td class="tabledata">Set the correct permissions (read) on the template database.</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="tabledata">When saving the new settings, an error message appears saying that the configuration file has invalid permissions set.</td>\r
+ <td class="tabledata">The configuration file has invalid permissions set.</td>\r
+ <td class="tabledata">Set the correct permissions (read and write) on the configuration file and then change the permissions back to read-only after saving the new settings.</td>\r
+ </tr>\r
+</table>\r
+\r
+<br>\r
+\r
+<div class="footnote"></div>\r
+\r
+<sup>1</sup>The CPAN (Comprehensive Perl Archive Network) command interface is normally included with Perl installations and will normally require superuser (root) permissions.\r
+ </div>\r
+ </body>\r
+</html>\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 - Introduction</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">Introduction</span><br><br>\r
+Kiriwrite is a web-based (browser-based) interface for creating pages for websites, intended for those who know how to create pages by hand and want to accelerate the process of (re)designing a static-only website.<br><br>\r
+The documentation is split into three parts, the user documentation (which is this part), the developer documentation (for writing new modules or language files) and the tutorial documentation (the basics and how to use Kiriwrite).<br><br>\r
+Although Kiriwrite isn't limited for creating pages for websites (as in you can create other types of text-based formats), Kiriwrite is primarily intended for creating pages for websites.<br><br>\r
+ </div>\r
+ </body>\r
+</html>\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 - Preface</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">Preface</span><br><br>\r
+Kiriwrite originally came into existence in 2003 when I was designing a new layout for my personal website (Kirinji's Pad) and found that I had so many pages to edit, I had to find an easier way of editing the website layout as I needed to and apply those changes to all of the pages on the website very quickly.<br><br>\r
+As I was designing my website using an advanced free ware text-editor (at it's time) which allowed me to create a template and create pages as I needed which was great, until I wanted to redesign the website. At that point I had around 50 pages which had to be changed and became somewhat time consuming.<br><br>\r
+That was when I wrote the original Kiriwrite script which was coded pretty much to my own needs and wasn't really well organised and was coded in Perl (although not that brilliantly as strict and warnings weren't used since I was learning Perl at the time) and by the time I finished coding it, I was able to do what I needed to do with Kiriwrite.<br><br>\r
+Around the end of 2005 (and after a two-year spell at St. Austell College which is now Cornwall College St. Austell) I decided to rewrite the Kiriwrite code because the original Kiriwrite did not do any input validation and so little of the code was commented which meant I forgot what everything did and I wanted to add some new features which would become useful in the future.<br><br>\r
+The rewritten Kiriwrite version was pretty much done in October 2006, following a suggestion from a good friend I decided to replace the flat-file based system which I used since the original Kiriwrite with a file-based database system called SQLite. Once that was done pretty much around the end of January 2007, I then separated the database code, presentation code and language strings into separate modules and files which meant that a MySQL 5.x server-based database could be used instead of file-based SQLite. The presentation code used to render internal output from Kiriwrite was separated and placed in the HTML4S (HTML 4.01 Strict) presentation module. The language strings that was hard-coded were separated and placed in the English (British) language file.<br><br>\r
+After some minor tweaks, the rewritten Kiriwrite code was pretty much ready and once the documentation was written Kiriwrite was ready for release. What I would like to see in the future for Kiriwrite is to make it work with mod_perl and add some extra customisable features as some settings are currently hard-coded when they could very well not be hard-coded.<br><br>\r
+I leave you with some advice, if you are going to design a website which uses a white background don't assume everyone will use a white background by default if no colour is specified and actually declare it as white background in the Cascading Style Sheet markup. You'd be amazed at how many commercial websites and some personal websites (that expect you to have) assume you have a white background when really you have a teal coloured background.\r
+ </div>\r
+ </body>\r
+</html>\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</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">User Documentation</span><br>\r
+\r
+The User Documentation contains information on how to install Kiriwrite, operate Kiriwrite, solutions to common problems that occur while using Kiriwrite and tips on using Kiriwrite.\r
+\r
+<br><br>\r
+\r
+<span class="heading">Contents</span><br>\r
+\r
+<a href="user-preface.html">Preface</a><br>\r
+<a href="user-introduction.html">Introduction</a><br>\r
+<a href="user-chapter1.html">Chapter 1: Installation</a><br>\r
+ <a href="user-chapter1-obtainingkiriwrite.html">1.1: Obtaining Kiriwrite</a><br>\r
+ <a href="user-chapter1-installingkiriwrite.html">1.2: Installing Kiriwrite</a><br>\r
+ <a href="user-chapter1-installerscript.html">1.3: Kiriwrite Installer Script</a><br>\r
+<a href="user-chapter2.html">Chapter 2: Operation</a><br>\r
+ <a href="user-chapter2-databases.html">2.1: Databases</a><br>\r
+ <a href="user-chapter2-pages.html">2.2: Pages</a><br>\r
+ <a href="user-chapter2-filters.html">2.3: Filters</a><br>\r
+ <a href="user-chapter2-templates.html">2.4: Templates</a><br>\r
+ <a href="user-chapter2-compiling.html">2.5: Compiling</a><br>\r
+<a href="user-chapter3.html">Chapter 3: Kiriwrite Settings</a><br>\r
+<a href="user-chapter4.html">Chapter 4: Usage Tips</a><br>\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
+\r
+ </div>\r
+ </body>\r
+</html>\r
Home |
News |
Projects |
Releases
Bugs |
RFE |
Repositories |
Help
/images/apache132x.png;h=78e031d8c22b524049bbdfafa1d8d4cc0693d668;hb=a110948e819f1beb388f504ddd758617fd6a6c1e){kind=link}
/images/background.png;h=fb0922f105a92063d3670f4032e8df6f91fec641;hb=a110948e819f1beb388f504ddd758617fd6a6c1e){kind=link}
/images/hint.png;h=9c4b7b082e18613099719a2f0bc0ee1dfed57cec;hb=a110948e819f1beb388f504ddd758617fd6a6c1e){kind=link}
/images/menutop.png;h=4feb4ad9fd8c4a0787bbbcccccf9da57acdc8eee;hb=a110948e819f1beb388f504ddd758617fd6a6c1e){kind=link}
/images/messageback.png;h=cf5689174d02ac291cc9205bf4499176e9c07735;hb=a110948e819f1beb388f504ddd758617fd6a6c1e){kind=link}
/images/note.png;h=cc02c96938d3bac93f9e1b94950b5416699414c9;hb=a110948e819f1beb388f504ddd758617fd6a6c1e){kind=link}
/images/warning.png;h=8600bf5fd8cec8bda148e5dcf2dc8f77d7e53b65;hb=a110948e819f1beb388f504ddd758617fd6a6c1e){kind=link}
/images/warningback.png;h=79228570a4ff1880ef66c078baecf5f7afc1d9aa;hb=a110948e819f1beb388f504ddd758617fd6a6c1e){kind=link}