From 59d2a75d99ef4e2ec3bc33bb5af0bf5c4167f6e1 Mon Sep 17 00:00:00 2001
From: defacer <defacer>
Date: Mon, 19 Apr 2004 07:39:43 +0000
Subject: [PATCH] Fixed/added some things so that the instructions are mostly
 correct.

---
 blocks/README.txt | 29 ++++++++++++++++++++---------
 1 file changed, 20 insertions(+), 9 deletions(-)

diff --git a/blocks/README.txt b/blocks/README.txt
index 4c6153233f..6a848082d1 100644
--- a/blocks/README.txt
+++ b/blocks/README.txt
@@ -1,13 +1,23 @@
+-------------------------------------------------------------------------------
 CREATING NEW BLOCKS
 -------------------------------------------------------------------------------
 
+-------------------------------------------------------------------------------
+WARNING - PRELIMINARY DOCUMENTATION
+This is designed to point new block developers in the right direction. At times
+it may NOT be fully up-to-date with the source, or it may even contain some
+tiny bit of misinformation that has slipped our notice. If you encounter such a
+case, please:
+    1. Use the existing block code as reference
+    2. Come to the moodle.org forums and tell the world! :) We 'll help you!
+-------------------------------------------------------------------------------
+
 You have to derive a class that extends MoodleBlock.
 
 The derived class MUST:
 
     * Implement a constructor that:
         1. Sets $this->content_type (BLOCK_TYPE_LIST or BLOCK_TYPE_TEXT)
-        2. Sets $this->header (BLOCK_SHOW_HEADER or BLOCK_HIDE_HEADER)
         3. Sets $this->title
         4. Sets $this->version
         5. Sets $this->course equal to its only argument
@@ -19,24 +29,25 @@ The derived class MAY:
 
         1. Define a method has_config() {return true;}
         2. Define a method print_config() that prints whatever
-          configuration interface you want to have.
+           configuration interface you want to have.
         3. Define a method handle_config($data) that does what
-          is needed. $data comes straight from data_submitted().
+           is needed. $data comes straight from data_submitted().
 
     * Limit the course formats it can be displayed in.
       To do so:
 
-        1. Define a method applicable_formats() which returns a
-          bitwise AND of one or more COURSE_FORMAT_XXX defined
-          constants.
+        1. Define a method applicable_formats() which returns a bitwise
+           OR of one or more COURSE_FORMAT_XXX defined constants. These
+           are defined in lib/blocklib.php.
 
     * Select a "preferred" width which the course format will try to honor.
       To do so:
 
-        1. Define a method preferred_width() which returns a number
-          measured in pixels.
+        1. Define a method preferred_width() which returns an integer.
+           This is the block's preferred width in pixels.
 
-    * Declare that the block is going to hide its header.
+    * Declare that the block is going to hide its header. This will result
+      in a more lightweight appearance. Ideal for announcements/notices.
       To do so:
 
         1. Define a method hide_header() {return true;}
-- 
2.39.5