From fb02a3c6cb60580a1dce80522a06168919460207 Mon Sep 17 00:00:00 2001 From: kirinji Date: Sat, 29 Dec 2007 05:47:13 +0000 Subject: [PATCH] Updated the documentation. --- ...er-chapter1-kiriwritecompilemakepages.html | 16 +++++--- ...eveloper-chapter1-kiriwritefilterlist.html | 8 +++- ...loper-chapter1-kiriwriteoutputconfig.html} | 18 ++++++--- .../developer-chapter1-kiriwritepagelist.html | 10 +++-- ...eloper-chapter1-kiriwritesettingsedit.html | 10 ++++- ...eloper-chapter1-kiriwritetemplatelist.html | 9 ++++- .../developer-chapter2-addcheckbox.html | 2 +- .../developer-chapter3-getfiltercount.html | 38 ++++++++++++++++++ .../developer-chapter3-getfilterinfo.html | 6 ++- .../developer-chapter3-getfilterlist.html | 21 +++++++++- .../developer-chapter3-getpagecount.html | 39 +++++++++++++++++++ .../developer-chapter3-getpageinfo.html | 2 +- .../developer-chapter3-getpagelist.html | 21 +++++++++- .../developer-chapter3-gettemplatecount.html | 38 ++++++++++++++++++ .../developer-chapter3-gettemplateinfo.html | 6 ++- .../developer-chapter3-gettemplatelist.html | 24 +++++++++++- .../English (British)/developer.html | 5 ++- .../tutorial-introduction.html | 4 +- Documentation/English (British)/tutorial.html | 6 +-- .../user-chapter1-installerscript.html | 8 ++++ .../user-chapter1-installingkiriwrite.html | 15 ++++++- .../user-chapter1-obtainingkiriwrite.html | 2 +- .../user-chapter2-compiling.html | 18 +++++++-- .../user-chapter2-filters.html | 2 + .../user-chapter2-pages.html | 4 +- .../user-chapter2-templates.html | 2 + .../English (British)/user-chapter3.html | 8 ++++ .../user-chapter4-removing.html | 2 +- .../English (British)/user-chapter6.html | 36 +++++++++++++++++ Documentation/English (British)/user.html | 4 +- cgi-files/kiriwrite.cgi | 2 +- 31 files changed, 341 insertions(+), 45 deletions(-) rename Documentation/English (British)/{developer-chapter1-kiriwriteoutputxml.html => developer-chapter1-kiriwriteoutputconfig.html} (74%) create mode 100644 Documentation/English (British)/developer-chapter3-getfiltercount.html create mode 100644 Documentation/English (British)/developer-chapter3-getpagecount.html create mode 100644 Documentation/English (British)/developer-chapter3-gettemplatecount.html create mode 100644 Documentation/English (British)/user-chapter6.html diff --git a/Documentation/English (British)/developer-chapter1-kiriwritecompilemakepages.html b/Documentation/English (British)/developer-chapter1-kiriwritecompilemakepages.html index ffc3518..81af67e 100644 --- a/Documentation/English (British)/developer-chapter1-kiriwritecompilemakepages.html +++ b/Documentation/English (British)/developer-chapter1-kiriwritecompilemakepages.html @@ -24,7 +24,7 @@ kiriwrite_compile_makepages will return data that is intended for kiriwrite_outp Parameters:

- kiriwrite_compile_makepages(type, confirm, selectedlist); + kiriwrite_compile_makepages(type, confirm, override, overridetemplate, selectedlist);

@@ -32,10 +32,10 @@ kiriwrite_compile_makepages will return data that is intended for kiriwrite_outp Usage:

- $pagedata = kiriwrite_compile_makepages(“single”, 0, ['database1']);
- $pagedata = kiriwrite_compile_makepages(“single”, 1, ['database1']);
- $pagedata = kiriwrite_compile_makepages(“multiple”, 0, ['database1','database2','database3','database4']);
- $pagedata = kiriwrite_compile_makepages(“multiple”, 1, ['database1','database2','database3','database4']); + $pagedata = kiriwrite_compile_makepages(“single”, 0, 0, "", ['database1']);
+ $pagedata = kiriwrite_compile_makepages(“single”, 1, 0, "", ['database1']);
+ $pagedata = kiriwrite_compile_makepages(“multiple”, 0, 1, "template.html", ['database1','database2','database3','database4']);
+ $pagedata = kiriwrite_compile_makepages(“multiple”, 1, 0, "", ['database1','database2','database3','database4']);

@@ -63,6 +63,12 @@ Specifies the type meaning if a single or multiple databases should be compiled. confirm
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.

+override
+Override the template being used with the overridetemplate value.

+ +overridetemplate
+Override the template using the filename given.

+ selectedlist
Specifies the list of databases to compile as an array. This is required every time the subroutine is called. diff --git a/Documentation/English (British)/developer-chapter1-kiriwritefilterlist.html b/Documentation/English (British)/developer-chapter1-kiriwritefilterlist.html index 599accd..9f65b67 100644 --- a/Documentation/English (British)/developer-chapter1-kiriwritefilterlist.html +++ b/Documentation/English (British)/developer-chapter1-kiriwritefilterlist.html @@ -24,7 +24,7 @@ kiriwrite_filter_list will return data that is intended for kiriwrite_output_pag Parameters:

- kiriwrite_filter_list(); + kiriwrite_filter_list(browsenumber);

@@ -32,9 +32,13 @@ kiriwrite_filter_list will return data that is intended for kiriwrite_output_pag Usage:

- $pagedata = kiriwrite_filter_list(); + $pagedata = kiriwrite_filter_list(1);
+
+ +browsenumber
+Specifies the number of which list of filters to view. diff --git a/Documentation/English (British)/developer-chapter1-kiriwriteoutputxml.html b/Documentation/English (British)/developer-chapter1-kiriwriteoutputconfig.html similarity index 74% rename from Documentation/English (British)/developer-chapter1-kiriwriteoutputxml.html rename to Documentation/English (British)/developer-chapter1-kiriwriteoutputconfig.html index 4d491ec..7c43b62 100644 --- a/Documentation/English (British)/developer-chapter1-kiriwriteoutputxml.html +++ b/Documentation/English (British)/developer-chapter1-kiriwriteoutputconfig.html @@ -3,7 +3,7 @@ - Kiriwrite Documentation - Developer Documentation - 1.40: kiriwrite_output_xml + Kiriwrite Documentation - Developer Documentation - 1.40: kiriwrite_output_config
- 1.40 kiriwrite_output_xml

+ 1.40 kiriwrite_output_config

-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.

+kiriwrite_output_config outputs a configuration file and is mainly used for writing an updated configuration file. All parameters in the subroutine are required.

Parameters:

- kiriwrite_output_xml(filename, type, options); + kiriwrite_output_config(options);

@@ -30,7 +30,7 @@ kiriwrite_output_xml outputs a file in the XML format and is mainly used for wri Usage:

- 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” }); + kiriwrite_output_config({ DatabaseDirectory => “db”, OutputDirectory => “output”, ImagesURIPath => “/images/kiriwrite”, DateTimeFormat => “DD/MM/YY (hh:mm:ss)”, SystemLanguage => “en-GB”, PresentationModule => “HTML4S”, TextAreaCols => 50, TextAreaRows => 10, DatabaseModule => “SQLite”, DatabaseServer => “localhost”, DatabasePort => “3306”, DatabaseProtocol => “tcp”, DatabaseSQLDatabase => “database”, DatabaseUsername => “username”, DatabasePassword => “password”, DatabaseTablePrefix => “tableprefix” });

@@ -73,6 +73,14 @@ Specifies the options to use as a hash.

PresentationModule Specifies the presentation module in Kiriwrite to use. + + TextAreaCols + Specifies the width of the text area. + + + TextAreaRows + Specifies the height of the text area. + DatabaseModule Specifies the database module in Kiriwrite to use. diff --git a/Documentation/English (British)/developer-chapter1-kiriwritepagelist.html b/Documentation/English (British)/developer-chapter1-kiriwritepagelist.html index 80a3992..ebde495 100644 --- a/Documentation/English (British)/developer-chapter1-kiriwritepagelist.html +++ b/Documentation/English (British)/developer-chapter1-kiriwritepagelist.html @@ -24,7 +24,7 @@ kiriwrite_page_list will return page data which is intended for kiriwrite_output Parameters:

- kiriwrite_page_list(database); + kiriwrite_page_list(database, browsenumber);

@@ -32,13 +32,15 @@ kiriwrite_page_list will return page data which is intended for kiriwrite_output Usage:

- $pagedata = kiriwrite_page_list(“database”); + $pagedata = kiriwrite_page_list(“database”, 1);

-database
-Specifies the database to get the list of pages from. +database
+Specifies the database to get the list of pages from.

+browsenumber
+Specifies the number of which list of pages to view.
diff --git a/Documentation/English (British)/developer-chapter1-kiriwritesettingsedit.html b/Documentation/English (British)/developer-chapter1-kiriwritesettingsedit.html index 76b1228..cb098db 100644 --- a/Documentation/English (British)/developer-chapter1-kiriwritesettingsedit.html +++ b/Documentation/English (British)/developer-chapter1-kiriwritesettingsedit.html @@ -32,7 +32,7 @@ kiriwrite_settings_edit will return data that is intended for kiriwrite_output_p Usage:

- $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” }); + $pagedata = kiriwrite_settings_edit({ DatabaseDirectory => “db”, OutputDirectory => “output”, ImagesURIPath => “/images/kiriwrite”, DateTimeFormat => “DD/MM/YY (hh:mm:ss)”, SystemLanguage => “en-GB”, PresentationModule => “HTML4S”, TextAreaCols => 50, TextAreaRows => 10, DatabaseModule => “SQLite”, DatabaseServer => “localhost”, DatabasePort => “3306”, DatabaseProtocol => “tcp”, DatabaseSQLDatabase => “database”, DatabaseUsername => “username”, DatabasePasswordKeep => 0, DatabasePassword => “password”, DatabaseTablePrefix = “kiridev” });

@@ -69,6 +69,14 @@ Specifies a hash listing the new settings. This is required when editing the set PresentationModule Specifies the presentation module in Kiriwrite to use. + + TextAreaCols + Specifies the width of the text area. + + + TextAreaRows + Specifies the height of the text area. + DatabaseModule Specifies the database module in Kiriwrite to use. diff --git a/Documentation/English (British)/developer-chapter1-kiriwritetemplatelist.html b/Documentation/English (British)/developer-chapter1-kiriwritetemplatelist.html index 9767112..54ad243 100644 --- a/Documentation/English (British)/developer-chapter1-kiriwritetemplatelist.html +++ b/Documentation/English (British)/developer-chapter1-kiriwritetemplatelist.html @@ -24,7 +24,7 @@ kiriwrite_template_list will return data that is intended for kiriwrite_output_p Parameters:

- kiriwrite_template_list(); + kiriwrite_template_list(browsenumber);

@@ -32,8 +32,13 @@ kiriwrite_template_list will return data that is intended for kiriwrite_output_p Usage:

- $pagedata = kiriwrite_template_list(); + $pagedata = kiriwrite_template_list(1);
+ +
+ +browsenumber
+Specifies the number of which list of templates to view. diff --git a/Documentation/English (British)/developer-chapter2-addcheckbox.html b/Documentation/English (British)/developer-chapter2-addcheckbox.html index 4ba9ea3..6ad7685 100644 --- a/Documentation/English (British)/developer-chapter2-addcheckbox.html +++ b/Documentation/English (British)/developer-chapter2-addcheckbox.html @@ -30,7 +30,7 @@ Adds a check box.

Usage:

- $kiriwrite_presmodule->addcheckbox(“checkbox”, { Description => “Check box”, Style => “checkboxstyle”, LineBreak => 1 } ); + $kiriwrite_presmodule->addcheckbox(“checkbox”, { OptionDescription => “Check box”, Style => “checkboxstyle”, LineBreak => 1 } );

diff --git a/Documentation/English (British)/developer-chapter3-getfiltercount.html b/Documentation/English (British)/developer-chapter3-getfiltercount.html new file mode 100644 index 0000000..ab59742 --- /dev/null +++ b/Documentation/English (British)/developer-chapter3-getfiltercount.html @@ -0,0 +1,38 @@ + + + + + + Kiriwrite Documentation - Developer Documentation - 3.42: getfiltercount + + + +
+
3.42 getfiltercount


+ +Get the count of how many filters are in the filter database.

+ +Parameters:

+ +
+ $kiriwrite_dbmodule->getfiltercount(); +
+ +
+ +Usage:

+ +
+ $kiriwrite_dbmodule->connectfilter();

+ $filter_count = $kiriwrite_dbmodule->getfiltercount(); +
+
+ + diff --git a/Documentation/English (British)/developer-chapter3-getfilterinfo.html b/Documentation/English (British)/developer-chapter3-getfilterinfo.html index b200f27..c7b12c4 100644 --- a/Documentation/English (British)/developer-chapter3-getfilterinfo.html +++ b/Documentation/English (British)/developer-chapter3-getfilterinfo.html @@ -31,7 +31,7 @@ Gets information about the filter. Returns the information about the filter as a
$kiriwrite_dbmodule->connectfilter(); - $kiriwrite_dbmodule->getfilterinfo({ FilterID => 1 }); + $kiriwrite_dbmodule->getfilterinfo({ FilterID => 1, Reduced => 1 });

@@ -48,6 +48,10 @@ Specifies the following options as a hash in any order.

FilterID Specifies the filter identification number to get the filter information from. + + Reduced + Gets a reduced version of the filter information (filter identification number, priority, filter find setting and filter replace setting). +
diff --git a/Documentation/English (British)/developer-chapter3-getfilterlist.html b/Documentation/English (British)/developer-chapter3-getfilterlist.html index 6e05257..2b43660 100644 --- a/Documentation/English (British)/developer-chapter3-getfilterlist.html +++ b/Documentation/English (British)/developer-chapter3-getfilterlist.html @@ -22,7 +22,7 @@ Gets the list of available filters. Returns the list of filters as an array.
Parameters:

- $kiriwrite_dbmodule->getfilterlist(); + $kiriwrite_dbmodule->getfilterlist(options);

@@ -31,9 +31,26 @@ Gets the list of available filters. Returns the list of filters as an array.
$kiriwrite_dbmodule->connectfilter();
- @filterlist = $kiriwrite_dbmodule->getfilterlist(); + @filterlist = $kiriwrite_dbmodule->getfilterlist({ StartFrom => 0, Limit => 50 });
+

+ + + + + + + + + + + + + + +
ValueDescription
StartFromSpecifies which filter entry to start from.
LimitSpecifies how many filters should be retrieved.
+
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. diff --git a/Documentation/English (British)/developer-chapter3-getpagecount.html b/Documentation/English (British)/developer-chapter3-getpagecount.html new file mode 100644 index 0000000..3c1362d --- /dev/null +++ b/Documentation/English (British)/developer-chapter3-getpagecount.html @@ -0,0 +1,39 @@ + + + + + + Kiriwrite Documentation - Developer Documentation - 3.40: getpagecount + + + +
+
3.40: getpagecount


+ +Get the count of how many pages are in the database.

+ +Parameters:

+ +
+ $kiriwrite_dbmodule->getpagecount(); +
+ +
+ +Usage:

+ +
+ $kiriwrite_dbmodule->selectdb(“database”);

+ $page_count = $kiriwrite_dbmodule->getpagecount(); +
+ +
+ + diff --git a/Documentation/English (British)/developer-chapter3-getpageinfo.html b/Documentation/English (British)/developer-chapter3-getpageinfo.html index 12d1899..e15d71b 100644 --- a/Documentation/English (British)/developer-chapter3-getpageinfo.html +++ b/Documentation/English (British)/developer-chapter3-getpageinfo.html @@ -31,7 +31,7 @@ Gets information about the page. The page information is returned as a hash.
$kiriwrite_dbmodule->selectdb(“database”);
- %pageinfo = $kiriwrite_dbmodule->getpageinfo({ PageFilename => “pagefilename.html” }); + %pageinfo = $kiriwrite_dbmodule->getpageinfo({ PageFilename => “pagefilename.html”, Reduced => 1 });

diff --git a/Documentation/English (British)/developer-chapter3-getpagelist.html b/Documentation/English (British)/developer-chapter3-getpagelist.html index 5766018..99b6d7d 100644 --- a/Documentation/English (British)/developer-chapter3-getpagelist.html +++ b/Documentation/English (British)/developer-chapter3-getpagelist.html @@ -22,7 +22,7 @@ Gets the page list from a database. The page list is returned as an array.
Parameters:

- $kiriwrite_dbmodule->getpagelist(); + $kiriwrite_dbmodule->getpagelist(options);

@@ -31,9 +31,26 @@ Gets the page list from a database. The page list is returned as an array.
$kiriwrite_dbmodule->selectdb(“database”);
- @pagelist = $kiriwrite_dbmodule->getpagelist(); + @pagelist = $kiriwrite_dbmodule->getpagelist({ StartFrom => 0, Limit => 50 }); +

+ + + + + + + + + + + + + + +
ValueDescription
StartFromSpecifies which page entry to start from.
LimitSpecifies how many pages that should be retrieved.
+
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. diff --git a/Documentation/English (British)/developer-chapter3-gettemplatecount.html b/Documentation/English (British)/developer-chapter3-gettemplatecount.html new file mode 100644 index 0000000..0fa3659 --- /dev/null +++ b/Documentation/English (British)/developer-chapter3-gettemplatecount.html @@ -0,0 +1,38 @@ + + + + + + Kiriwrite Documentation - Developer Documentation - 3.41: gettemplatecount + + + +
+
3.41: gettemplatecount


+ +Get the count of how many templates are in the template database.

+ +Parameters:

+ +
+ $kiriwrite_dbmodule->gettemplatecount(); +
+ +
+ +Usage:

+ +
+ $kiriwrite_dbmodule->connecttemplate();

+ $template_count = $kiriwrite_dbmodule->gettemplatecount(); +
+
+ + diff --git a/Documentation/English (British)/developer-chapter3-gettemplateinfo.html b/Documentation/English (British)/developer-chapter3-gettemplateinfo.html index 3e3bb39..818c5e8 100644 --- a/Documentation/English (British)/developer-chapter3-gettemplateinfo.html +++ b/Documentation/English (British)/developer-chapter3-gettemplateinfo.html @@ -30,7 +30,7 @@ Gets information about the template. The information is returned as a hash.
< Usage:

- $kiriwrite_dbmodule->gettemplateinfo({ TemplateFilename => “template.html” }); + $kiriwrite_dbmodule->gettemplateinfo({ TemplateFilename => “template.html”, Reduced => 1 });

@@ -47,6 +47,10 @@ Specifies the following options as a hash in any order.

TemplateFilename Specifies the template filename to get the information from. + + Reduced + Gets a reduced version of the template information (template filename, name, description and last modified date). +
diff --git a/Documentation/English (British)/developer-chapter3-gettemplatelist.html b/Documentation/English (British)/developer-chapter3-gettemplatelist.html index 181ad1a..8e86526 100644 --- a/Documentation/English (British)/developer-chapter3-gettemplatelist.html +++ b/Documentation/English (British)/developer-chapter3-gettemplatelist.html @@ -22,7 +22,7 @@ Gets the list of templates. The information is returned as an array.

Parameters:

- $kiriwrite_dbmodule->gettemplatelist(); + $kiriwrite_dbmodule->gettemplatelist(options);

@@ -30,11 +30,31 @@ Gets the list of templates. The information is returned as an array.

Usage:

- $kiriwrite_dbmodule->gettemplatelist(); + $kiriwrite_dbmodule->gettemplatelist({ StartFrom => 0, Limit => 50 });

+options
+Specifies the following options as a hash (in any order).

+ + + + + + + + + + + + + + +
ValueDescription
StartFromSpecifies which template entry to start from.
LimitSpecifies how many templates should be retrieved.
+ +
+ 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. diff --git a/Documentation/English (British)/developer.html b/Documentation/English (British)/developer.html index 33ee36b..df5eb27 100644 --- a/Documentation/English (British)/developer.html +++ b/Documentation/English (British)/developer.html @@ -62,7 +62,7 @@ The Developer Documentation contains information on how to create presentation m  1.37 kiriwrite_filepermissions
 1.38 kiriwrite_utf8convert
 1.39 kiriwrite_output_header
1.40 kiriwrite_output_xml
1.40 kiriwrite_output_config
 1.41 kiriwrite_output_page
Chapter 2: Presentation Module
 2.1 Guidance
@@ -145,6 +145,9 @@ The Developer Documentation contains information on how to create presentation m  3.37 addfilter
 3.38 editfilter
 3.39 deletefilter
3.40 getpagecount
3.41 gettemplatecount
3.42 getfiltercount
Chapter 4: Kiriwrite Page Format
Chapter 5: Languages
diff --git a/Documentation/English (British)/tutorial-introduction.html b/Documentation/English (British)/tutorial-introduction.html index 7323937..ef42078 100644 --- a/Documentation/English (British)/tutorial-introduction.html +++ b/Documentation/English (British)/tutorial-introduction.html @@ -15,11 +15,11 @@ Documentation | Tutorial Documentation |
-
Introduction

+ Introduction

This documentation provides a tutorial which allows the main functions of Kiriwrite to be learned.

-The tutorial consists of the following:

+The tutorial consists of the following:
diff --git a/Documentation/English (British)/user-chapter1-installerscript.html b/Documentation/English (British)/user-chapter1-installerscript.html index f4b82ed..3b1736b 100644 --- a/Documentation/English (British)/user-chapter1-installerscript.html +++ b/Documentation/English (British)/user-chapter1-installerscript.html @@ -51,6 +51,14 @@ The configuration settings in detail:

Images (URI path) Specifies the Images (URI path) to use for displaying images when using the page template with Kiriwrite. + + Text Area Columns + Specifies the width of the text area when editing notes, pages and templates. + + + Text Area Rows + Specifies the height of the text area when editing notes, pages and templates. + Date Format 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. diff --git a/Documentation/English (British)/user-chapter1-installingkiriwrite.html b/Documentation/English (British)/user-chapter1-installingkiriwrite.html index 9a722c8..22a4b65 100644 --- a/Documentation/English (British)/user-chapter1-installingkiriwrite.html +++ b/Documentation/English (British)/user-chapter1-installingkiriwrite.html @@ -24,6 +24,7 @@ Before Kiriwrite can be used, the files need to be copied to the correct place.   Presentation – Presentation modules are stored here.
 db – Default database directory (for file based Database modules).
 lang – The directory for language files in Kiriwrite.
lib - Library files that are used by Kiriwrite.
 output – The output directory when pages are compiled.
misc – Miscellaneous files (mainly for developers).
non-cgi-files – Non CGI files that need to be placed outside of the cgi-bin folder.

@@ -99,7 +100,19 @@ The following permissions should be set for the files that have been copied to t None - lang/*.xml + lang/*.lang + R + R + None + + + lib + R + R + None + + + lib\*.lib R R None diff --git a/Documentation/English (British)/user-chapter1-obtainingkiriwrite.html b/Documentation/English (British)/user-chapter1-obtainingkiriwrite.html index c44f19d..43d9211 100644 --- a/Documentation/English (British)/user-chapter1-obtainingkiriwrite.html +++ b/Documentation/English (British)/user-chapter1-obtainingkiriwrite.html @@ -57,7 +57,7 @@ A list of files that have been extracted will then appear with the contents of t To extract the bzip2 archive, the following command should be preformed when switched to the correct directory to extract from.

- bzip2 -d -c (path)/kiriwrite-0.1.0.tar.bzip2 | tar -xv + bzip2 -d -c (path)/kiriwrite-0.1.0.tar.bz2 | tar -xv

diff --git a/Documentation/English (British)/user-chapter2-compiling.html b/Documentation/English (British)/user-chapter2-compiling.html index f9f83cc..ca09dbb 100644 --- a/Documentation/English (British)/user-chapter2-compiling.html +++ b/Documentation/English (British)/user-chapter2-compiling.html @@ -23,15 +23,27 @@ To compile the pages from their databases, click on the 'Compile Pages' menu lin 2.5.1 Compiling a database

-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.

+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.

+ +When compiling a database, the template being used on the pages in the database selected can be overridden. To override the templates being used, click on the 'Override the template being used' box and select the template to override with.

+ +Clicking on the 'Return to the compile database list.' will return to the list of databases to compile.

2.5.2 Compiling multiple databases

-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.

+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.

+ +When compiling a database, the templates being used on the pages in the databases selected can be overridden. To override the templates being used, click on the 'Override the template being used' box and select the template to override with.

+ +Clicking on the 'Return to the compile database list.' will return to the list of databases to compile.

2.5.3 Compiling all databases

-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.

+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.

+ +When compiling a database, the templates being used on the pages in all of the databases can be overridden. To override the templates being used, click on the 'Override the template being used' box and select the template to override with.

+ +Clicking on the 'Return to the compile database list.' link will return to the list of databases to compile.

2.5.4 Cleaning the output directory

diff --git a/Documentation/English (British)/user-chapter2-filters.html b/Documentation/English (British)/user-chapter2-filters.html index 9f4f551..a68b8da 100644 --- a/Documentation/English (British)/user-chapter2-filters.html +++ b/Documentation/English (British)/user-chapter2-filters.html @@ -23,6 +23,8 @@ The list of filters can be viewed by clicking on the 'View Filters' link. If the 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.

+To view the next (or previous list) of filters, click on the relevant link at the top of the page and to view a specific list of filters, select the list page number in the drop down menu box at the top of the page and click on the Show button.

+ 2.3.1 Add a filter

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.

diff --git a/Documentation/English (British)/user-chapter2-pages.html b/Documentation/English (British)/user-chapter2-pages.html index 09feab8..cef5b94 100644 --- a/Documentation/English (British)/user-chapter2-pages.html +++ b/Documentation/English (British)/user-chapter2-pages.html @@ -15,12 +15,14 @@ Documentation | Tutorial Documentation |
- 2.2 Pages

+ 2.2 Pages

Pages are used for storing information that is relevant to that page.

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.

+To view the next (or previous list) of pages, click on the relevant link at the top of the page and to view a specific list of pages, select the list page number in the drop down menu box at the top of the page and click on the Show button.

+ 2.2.1: Creating a page

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.

diff --git a/Documentation/English (British)/user-chapter2-templates.html b/Documentation/English (British)/user-chapter2-templates.html index 29c8b9a..892f102 100644 --- a/Documentation/English (British)/user-chapter2-templates.html +++ b/Documentation/English (British)/user-chapter2-templates.html @@ -21,6 +21,8 @@ Templates allows pages to use a common layout which is used to keep a consistent 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.

+To view the next (or previous list) of templates, click on the relevant link at the top of the page and to view a specific list of templates, select the list page number in the drop down menu box at the top of the page and click on the Show button.

+ 2.4.1 Add a template

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.

diff --git a/Documentation/English (British)/user-chapter3.html b/Documentation/English (British)/user-chapter3.html index 732f489..f09761f 100644 --- a/Documentation/English (British)/user-chapter3.html +++ b/Documentation/English (British)/user-chapter3.html @@ -40,6 +40,14 @@ To edit the settings, click on the 'Edit Settings' link in the View Settings sub Images (URI path) Specifies the Images (URI path) to use for displaying images when using the page template with Kiriwrite. + + Text Area Columns + Specifies the width of the text area when editing notes, pages and templates. + + + Text Area Rows + Specifies the height of the text area when editing notes, pages and templates. + Date Format 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. diff --git a/Documentation/English (British)/user-chapter4-removing.html b/Documentation/English (British)/user-chapter4-removing.html index f036d7f..53e0205 100644 --- a/Documentation/English (British)/user-chapter4-removing.html +++ b/Documentation/English (British)/user-chapter4-removing.html @@ -17,7 +17,7 @@ Documentation | Tutorial Documentation |
4.3 Removing unneeded modules and language files

-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.

+As Kiriwrite uses a modular system for manipulating the databases, outputting the pages internally by Kiriwrite and language files for each language used, space can be recovered by removing unneeded modules from the Modules directory and language files from the lang directory.

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.
diff --git a/Documentation/English (British)/user-chapter6.html b/Documentation/English (British)/user-chapter6.html new file mode 100644 index 0000000..f3d7ecf --- /dev/null +++ b/Documentation/English (British)/user-chapter6.html @@ -0,0 +1,36 @@ + + + + + + Kiriwrite Documentation - User Documentation - Chapter 6: Contributing to Kiriwrite + + + +
+ Chapter 6: Contributing to Kiriwrite

+ +6.1: Contributing

+ +You can contribute to Kiriwrite in many different ways like the following examples: +
    +
  • Translate Kiriwrite (program or documentation) so that it can be used your own local language.
  • +
  • Add functionality to Kiriwrite.
  • +
  • Write a presentation or database module.
  • +
  • Report a bug or fault (either with Kiriwrite itself or the documentation).
  • +
    • + When reporting a bug, you should give the version number of Kiriwrite, what operating system you are using, what web server you are using and the version of it, the version of Perl you are using (and if possible the version of the Perl module that is causing the bug), what the error message of the bug is and how to recreate the bug (if possible). +
    +
+ +For more information on how to contribute to Kiriwrite visit http://xestia.co.uk/kiriwrite or visit the BerliOS project site at http://developer.berlios.de/projects/kiriwrite . A list of stuff that needs doing can be found in the TODO file in the Kiriwrite package (remember to check the latest Kiriwrite package's TODO file for the latest on what needs doing). +
+ + diff --git a/Documentation/English (British)/user.html b/Documentation/English (British)/user.html index 1516bd6..5ed2530 100644 --- a/Documentation/English (British)/user.html +++ b/Documentation/English (British)/user.html @@ -40,8 +40,8 @@ The User Documentation contains information on how to install Kiriwrite, operate  4.1: Securing your Kiriwrite installation
 4.2: Renaming the Kiriwrite script (kiriwrite.cgi)
 4.3: Removing unneeded modules and language files
-Chapter 5: Troubleshooting - +Chapter 5: Troubleshooting
+Chapter 6: Contributing to Kiriwrite
diff --git a/cgi-files/kiriwrite.cgi b/cgi-files/kiriwrite.cgi index 109751c..1eb2657 100755 --- a/cgi-files/kiriwrite.cgi +++ b/cgi-files/kiriwrite.cgi @@ -40,7 +40,7 @@ our ($kiriwrite_config, %kiriwrite_config, %kiriwrite_lang, $kiriwrite_lang, $ki %kiriwrite_version = ( "major" => 0, - "minor" => 1, + "minor" => 2, "revision" => 0 ); -- 2.39.5