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>Xestia Scanner Server 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">Xestia Scanner Server</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>\r
  19 <br><br>\r
  20 When creating a new presentation module to be used in Xestia Scanner Server, the following is required.\r
  21 <br><br>\r
  22 When creating a new presentation module, at the top of the script the following should be inserted:\r
  23 <br><br>\r
  24 <div class="code">\r
  25 package Module::Presentation::(modulename);<br>\r
  26 <br>\r
  27 use strict;<br>\r
  28 use warnings;<br>\r
  29 <br>\r
  30 our $VERSION = “(version)”;<br>\r
  31 my $pagedata = “”;\r
  32 </div>\r
  33 <br><br>\r
  34 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).\r
  35 <br><br>\r
  36 ‘use strict’ and ‘use warnings’ isn’t required but it is generally accepted that Perl scripts and modules should at least have ‘use strict’ and ‘use warnings’ lines written.\r
  37 <br><br>\r
  38 Replace (version) with the internal version number of the module.\r
  39 <br><br>\r
  40 ‘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 by the grab subroutine. 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