Documentation/English (British)/developer-chapter2-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 - 2.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">2.1 Guidance</span><br><br>\r
  19 \r
  20 When creating a new presentation module to be used in Kiriwrite, the following is required.<br><br>\r
  21 \r
  22 When creating a new presentation module, at the top of the page the following should be inserted:<br><br>\r
  23 \r
  24 <div class="code">\r
  25     package Kiriwrite::Presentation::(modulename);<br><br>\r
  26 \r
  27     use strict;<br>\r
  28     use warnings;<br><br>\r
  29 \r
  30     our $VERSION = &quot;(version)&quot;;<br>\r
  31     my $pagedata = &quot;&quot;;\r
  32 </div>\r
  33 \r
  34 <br>\r
  35 \r
  36 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
  37 '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
  38 Replace (version) with the internal version number of the module.<br><br>\r
  39 '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
  40 Presentation modules are stored in the Modules/Presentation directory. For an example of a written presentation module look at the HTML4S.pm file.\r
  41                 </div>\r
  42         </body>\r
  43 </html>\r