Documentation/English (British)/developer-chapter4-loadsettings.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.4: loadsettings</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.3 loadsettings</span><br><br>\r
  19 \r
  20 Loads the settings for the output module and processes the options from the hash. Input validation of the options received from the hash should be done in this subroutine.<br><br>\r
  21 \r
  22 <div class="warningbox">\r
  23     <div class="message warning">\r
  24 <b>Warning</b><br><br>\r
  25 Any values passed to this subroutine should be input validated before they are used.\r
  26     </div>\r
  27 </div>\r
  28 \r
  29 <span class="heading">Parameters:</span><br><br>\r
  30 \r
  31 <div class="code">\r
  32     $kiriwrite_outputmodule->loadsettings(language, options);\r
  33 </div>\r
  34 \r
  35 <span class="heading">Usage:</span><br><br>\r
  36 \r
  37 <div class="code">\r
  38     $kiriwrite_outputmodule->loadsettings(&quot;en-GB&quot;, %options);\r
  39 </div>\r
  40 language<br>\r
  41 Specifies the language strings to be used.<br><br>\r
  42 options<br>\r
  43 Specifies the options for the output module as a hash.\r
  44                 </div>\r
  45         </body>\r
  46 </html>\r