Roxen.git / server / modules / examples / fnord.pike

version» Context lines:

Roxen.git/server/modules/examples/fnord.pike:1:   // This is a roxen module. Copyright © 1996 - 2001, Roxen IS.      // This is a small sample module. It is intended to show a simple example   // of a container.      // This variable is shown in the configinterface as the version of the module. - constant cvs_version = "$Id: fnord.pike,v 1.16 2001/09/21 15:58:08 jhs Exp $"; + constant cvs_version = "$Id: fnord.pike,v 1.17 2002/06/14 10:21:57 nilsson Exp $";      // Tell Roxen that this module is threadsafe. That is there is no   // request specific data in global variables.   constant thread_safe=1;      // Include and inherit code that is needed in every module.   #include <module.h>   inherit "module";      // Some defines for the translation system   //   //<locale-token project="mod_fnord">LOCALE</locale-token> - #define LOCALE(X,Y) _DEF_LOCALE("mod_fnord",X,Y) + #define LOCALE(X,Y) _STR_LOCALE("mod_fnord",X,Y)   // end of the locale related stuff      // Documentation:      // The purpose of this module is to allow comments in the SPML source   // that are invisible to average viewers, but can be seen with the   // right magic incantation. Fnord! The special text is rendered in   // the "sample" font, if available, which makes it possible for   // someone looking at the mixed output to distinguish text that is for   // public consumption from that which is restricted.
Roxen.git/server/modules/examples/fnord.pike:72:   // of 'fnord'. If it is there, show the contents, otherwise, if there   // is an 'alt' text, display it, if not, simply return an empty string      string simpletag_fnord(string tag_name, mapping arguments, string contents,    RequestID id )   {    if (id->prestate->fnord)    return contents;    if (arguments->alt)    return arguments->alt; +  if (arguments["show-fnord"]) +  return LOCALE(5, "FNORD");    return "";   }         // Some constants that are needed to register the module in the RXML parser.   constant module_type = MODULE_TAG; - LocaleString module_name = LOCALE(1,"Fnord!"); - LocaleString module_doc = -  LOCALE(2,"Adds an extra container tag, &lt;fnord&gt; that's supposed " + constant module_name = "Fnord!"; + constant module_doc = +  ("Adds an extra container tag, &lt;fnord&gt; that's supposed "    "to make things invisible unless the \"fnord\" prestate is present."    "<p>This module is here as an example of how to write a "    "very simple RXML-parsing module.</p>" );         // Last, but not least, we want a documentation that can be integrated in the   // online manual. The mapping tagdoc maps from container names to it's description.      TAGDOCUMENTATION;   #ifdef manual   constant tagdoc=(["fnord":#"<desc type='cont'>The fnord container tag hides its "    "contents for the user, unless the fnord prestate is used.</desc>"    "<attr name=alt value=string>An alternate text that should be written "    "in place of the hidden text.</attr>"]);   #endif