Changes made in preperation for Kiriwrite 0.4.0

[kiriwrite/.git] / Documentation / English (British) / developer-chapter1-kiriwriteinitalise.html
diff --git a/Documentation/English (British)/developer-chapter1-begin.html b/Documentation/English (British)/developer-chapter1-kiriwriteinitalise.html

similarity index 58%

rename from Documentation/English (British)/developer-chapter1-begin.html

rename to Documentation/English (British)/developer-chapter1-kiriwriteinitalise.html

index bf647d6..d262258 100644 (file)
--- a/Documentation/English (British)/developer-chapter1-begin.html
+++ b/Documentation/English (British)/developer-chapter1-kiriwriteinitalise.html
@@ -3,7 +3,7 @@
         <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
+               <title>Kiriwrite Documentation - Developer Documentation - 1.1: kiriwrite_initalise</title>\r
         </head>\r
         <body>\r
                 <div class="menubarback">\r
@@ -15,9 +15,19 @@ Documentation</a> | <a href="tutorial.html">Tutorial Documentation</a> |
                         </div>\r
                 </div>\r
                 <div class="pageinformation">\r
-                       <span class="pagetitle">1.1 BEGIN</span><br><br>\r
+                       <span class="pagetitle">1.1 kiriwrite_initalise</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
+kiriwrite_initalise loads some variables before they are used throughout Kiriwrite (such as the script filename). This subroutine does not need to be called anywhere else.<br><br>\r
+\r
+<span class="heading">Parameters:</span><br><br>\r
+<div class="code">\r
+  kiriwrite_initalise();\r
+</div><br><br>\r
+\r
+<span class="heading">Usage:</span><br><br>\r
+<div class="code">\r
+  kiriwrite_initalise();\r
+</div>\r
                 </div>\r
         </body>\r
  </html>\r