Documentation/English (British)/developer-chapter4-guidance.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">\r
   2 <html>\r
   3         <head>\r
   4                 <link href="style.css" REL="stylesheet" TYPE="text/css" MEDIA="screen">\r
   5                 <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">\r
   6                 <title>Kiriwrite Documentation - Developer Documentation - 4.1: Guidance</title>\r
   7         </head>\r
   8         <body>\r
   9                 <div class="menubarback">\r
  10                         <div class="menubar">\r
  11                                 <span class="apptitle">Kiriwrite</span>\r
  12                                 <a href="index.html">Index</a> | <a href="user.html">User \r
  13 Documentation</a> | <a href="tutorial.html">Tutorial Documentation</a> | \r
  14 <a href="developer.html">Developer Documentation</a>\r
  15                         </div>\r
  16                 </div>\r
  17                 <div class="pageinformation">\r
  18                         <span class="pagetitle">4.1 Guidance</span><br><br>\r
  19 \r
  20 When creating a new output module to be used in Kiriwrite, the following below is required.<br><br>\r
  21 When creating a new output module, at the top of the page the following should be inserted at the very minimum using the Normal module as an example:<br><br>\r
  22 \r
  23 <div class="code">\r
  24 package Modules::Output::Normal;<br><br>\r
  25 use strict;<br>\r
  26 use warnings;<br>\r
  27 use Encode qw(decode_utf8);<br>\r
  28 use Tie::IxHash;<br><br>\r
  29 our $VERSION = "0.5.0";<br>\r
  30 my ($pages, %pages);<br>\r
  31 my $error_flag = 0;<br>\r
  32 my $error_message = "";<br>\r
  33 my $language_name = "";<br>\r
  34 my %optionshash = ();<br><br>\r
  35 tie(%pages, "Tie::IxHash");\r
  36 </div>\r
  37 <br><br>\r
  38 \r
  39 If a subroutine is not needed then create the subroutine which is not needed and insert the return command for that subroutine. \r
  40                 </div>\r
  41         </body>\r
  42 </html>\r