home *** CD-ROM | disk | FTP | other *** search
/ PC World 2005 April / PCWorld_2005-04_cd.bin / akce / web / phpnuke / PHP-Nuke-7.5.exe / html / blocks / readme.txt < prev   
Text File  |  2004-01-29  |  4KB  |  111 lines
  1. PHP-Nuke Blocks System
  2. ======================
  3.  
  4.  
  5. Since PHP-Nuke 5.1 you can add new blocks by simply copying the blocks
  6. files into its directory /blocks/.
  7.  
  8. Please read this doc carefully and remember that this system, as the whole
  9. PHP-Nuke comes without any warranty and all you do from here is under
  10. your own responsability and risk. Always remember to backup your
  11. database and all your files before doing anything.
  12.  
  13.  
  14. ====================================
  15. 1.- Introduction to Use Block Files
  16. ====================================
  17.  
  18. We start on the "blocks" directory where you can add or delete all the
  19. blocks' files you want.
  20.  
  21. The filenames under /blocks/ dir have two rules to work properly:
  22.  
  23. a) All spaces are filled with "_", so if you have a block called for example
  24.    Quote of the Day, your filename need to be: block-Quote_of_the_Day.php
  25.    Note the "block-" at the begining of the filename and the ".php" extension,
  26.    both are needed in order to properly add a block from the administration.
  27.    
  28. b) All blocks needs to return a variable with the content called $content,
  29.    you can see the Sample Block included.
  30.    
  31. All files in this directory that start with "block-" and have the .php extension
  32. will be included in the selection form in the administration interfase, otherwise
  33. you will not see anything.
  34.  
  35. To add the new block, go to administration interfase and select your new block
  36. from the "Filename" field in the Blocks section.
  37.  
  38. If you don't write a Title for your block, by default the system will get the
  39. title from the filename stripping the "_" characters and converting it into spaces.
  40.  
  41. If you created a block and then you delete the file, the system automaticaly will
  42. show an error message on your block, also if there isn't any content in the $content
  43. variable from your file.
  44.  
  45. When install a new block please be sure that the blank spaces on the filename
  46. are replaced with "_", for Example: The_Weather. The filename is case sensitive,
  47. this mean that isn't the same the_weather and The_Weather. The "_" character is
  48. replaced automaticaly by a blank space when the block appears in your site. So
  49. "The_Weather" block filename name will be changed to "Web Links". All this is
  50. valid only if you don't set a title for your block when you add it.
  51.  
  52. Also, please read the block instructions that will be included by the block author
  53. for installation purpouses.
  54.  
  55.  
  56. =====================================
  57. 2.- Information for Blocks Developers
  58. =====================================
  59.  
  60.  
  61. Making a new block with this system is very easy. Developer just need to know
  62. a few rules:
  63.  
  64. a) On each addon file please remember to add the following code as the first
  65.    lines:
  66.    
  67.     if (eregi("block-Sample_Block.php",$PHP_SELF)) {
  68.     Header("Location: index.php");
  69.     die();
  70.     }
  71.  
  72.    This is to avoid direct access to the block file, so users only see it in a
  73.    block on your site.
  74.     
  75. b) You can make whatever you want into a block like database queries, include
  76.    another file from the block, use HTML code, Forms, PHP code, Java, Javascript,
  77.    Perl, Flash, etc.
  78.  
  79. c) You have limited width space to show the block content. This limit is set by
  80.    the blocks width defined in your site's theme, note that if you include a big
  81.    image your site will look like something horrible :-P
  82.  
  83. d) On the Blocks filename do not use blank spaces, instead use the character
  84.    "_". For example if you want to create a block called "The Web Ring", the
  85.    filename will be "The_Web_Ring".
  86.    
  87. e) Anything you do in the block you need to return a value. This value will be
  88.    stored in a variable named: $content
  89.    You can see the Sample Block to have the idea.
  90.    
  91.  
  92. Hope that you enjoy this new feature of PHP-Nuke.
  93.  
  94. =============================================================================
  95.  
  96. NOTE: To stay under HTML 4.01 Transitional standard is very important that
  97. you substitute all "&" characters in the URLs with "&" tag. So, for
  98. example, the URL:
  99.  
  100.     <a href="modules.php?op=modload&name=FAQ&file=index">
  101.  
  102. need to be written:
  103.  
  104.     <a href="modules.php?op=modload&name=FAQ&file=index">
  105.  
  106. and do not use FONT or LI tags (for example) let the CSS do this for you,
  107. without this, your pages will not validate as HTML 4.01 compatible.
  108.  
  109. =============================================================================
  110.  
  111. Have fun now!