From e2f098af854861033d863c2dc304e62f90c0896d Mon Sep 17 00:00:00 2001 From: Dries Buytaert Date: Thu, 7 Aug 2003 16:53:36 +0000 Subject: - Block module documentation improvement. Patch by Gerhard. --- modules/block.module | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'modules/block.module') diff --git a/modules/block.module b/modules/block.module index 1d752f13c..94e84c3e4 100644 --- a/modules/block.module +++ b/modules/block.module @@ -12,7 +12,7 @@ function block_help($section = "admin/block/help") { $output .= "

The path setting lets you define the pages on which a specific block is visable. If you leave the path blank it will appear on all pages. The path uses a regular expression syntax so remember to escape special characters!

"; $output .= strtr("

In case you do not know what a regular expression is, you should read about them in the PHP manual. The chapter to look at is the one on %pcre

", array("%pcre" => l(t("Perl-Compatible Regular Expressions (PCRE)"), "php.net/pcre", array("location" => "global")))); $output .= "

However, for basic tasks it is sufficient to look at the following examples:

"; - $output .= "

If the block should only show up on blog pages, use </blog>. To display on all node views use </node/view>. The angular brackets are used as delimiters of the regular expression. To show up on either forum or book pages use <(/forum|/book)>. The round brackets form a group of expressions, divided by the | character. It matches if any of the expressions in it match. A more complicated example is </node/add/(story|blog|image)>. Blocks which have their paths set to this expression will show up on story, block, or image composition pages.

"; + $output .= "

If the block should only show up on blog pages, use </blog>. To display on all node views use </node/view>. The angular brackets are used as delimiters of the regular expression. To show up on either forum or book pages use <(/forum|/book)>. The round brackets form a group of expressions, divided by the | character. It matches if any of the expressions in it match. A more complicated example is </node/add/(story|blog|image)>. Blocks which have their paths set to this expression will show up on story, block, or image composition pages. If you want to show a block an all pages, but not the search page, use <(^/$|[^(search)$/]+)>

"; $output .= "

Custom Blocks

"; $output .= "

A custom block contains admin-supplied HTML, text or PHP content (as opposed to being generated automatically by a module). Each custom block consists of a title, a description, and a body containing text, HTML, or PHP code which can be as long as you wish. The Drupal engine will 'render' the content of the custom block.

"; $output .= "

PHP in custom blocks

"; -- cgit v1.2.3