Commit e2f098af authored by Dries's avatar Dries
Browse files

- Block module documentation improvement.  Patch by Gerhard.
parent 6cf836a1
...@@ -12,7 +12,7 @@ function block_help($section = "admin/block/help") { ...@@ -12,7 +12,7 @@ function block_help($section = "admin/block/help") {
$output .= "<p>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!</p>"; $output .= "<p>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!</p>";
$output .= strtr("<p>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</p>", array("%pcre" => l(t("Perl-Compatible Regular Expressions (PCRE)"), "php.net/pcre", array("location" => "global")))); $output .= strtr("<p>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</p>", array("%pcre" => l(t("Perl-Compatible Regular Expressions (PCRE)"), "php.net/pcre", array("location" => "global"))));
$output .= "<p>However, for basic tasks it is sufficient to look at the following examples:</p>"; $output .= "<p>However, for basic tasks it is sufficient to look at the following examples:</p>";
$output .= "<p>If the block should only show up on blog pages, use &lt;/blog&gt;. To display on all node views use &lt;/node/view&gt;. The angular brackets are used as delimiters of the regular expression. To show up on either forum or book pages use &lt;(/forum|/book)&gt;. 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 &lt;/node/add/(story|blog|image)&gt;. Blocks which have their paths set to this expression will show up on story, block, or image composition pages.</p>"; $output .= "<p>If the block should only show up on blog pages, use &lt;/blog&gt;. To display on all node views use &lt;/node/view&gt;. The angular brackets are used as delimiters of the regular expression. To show up on either forum or book pages use &lt;(/forum|/book)&gt;. 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 &lt;/node/add/(story|blog|image)&gt;. 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 &lt;(^/$|[^(search)$/]+)&gt;</p>";
$output .= "<h3>Custom Blocks</h3>"; $output .= "<h3>Custom Blocks</h3>";
$output .= "<p>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.</p>"; $output .= "<p>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.</p>";
$output .= "<h4>PHP in custom blocks</h4>"; $output .= "<h4>PHP in custom blocks</h4>";
......
...@@ -12,7 +12,7 @@ function block_help($section = "admin/block/help") { ...@@ -12,7 +12,7 @@ function block_help($section = "admin/block/help") {
$output .= "<p>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!</p>"; $output .= "<p>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!</p>";
$output .= strtr("<p>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</p>", array("%pcre" => l(t("Perl-Compatible Regular Expressions (PCRE)"), "php.net/pcre", array("location" => "global")))); $output .= strtr("<p>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</p>", array("%pcre" => l(t("Perl-Compatible Regular Expressions (PCRE)"), "php.net/pcre", array("location" => "global"))));
$output .= "<p>However, for basic tasks it is sufficient to look at the following examples:</p>"; $output .= "<p>However, for basic tasks it is sufficient to look at the following examples:</p>";
$output .= "<p>If the block should only show up on blog pages, use &lt;/blog&gt;. To display on all node views use &lt;/node/view&gt;. The angular brackets are used as delimiters of the regular expression. To show up on either forum or book pages use &lt;(/forum|/book)&gt;. 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 &lt;/node/add/(story|blog|image)&gt;. Blocks which have their paths set to this expression will show up on story, block, or image composition pages.</p>"; $output .= "<p>If the block should only show up on blog pages, use &lt;/blog&gt;. To display on all node views use &lt;/node/view&gt;. The angular brackets are used as delimiters of the regular expression. To show up on either forum or book pages use &lt;(/forum|/book)&gt;. 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 &lt;/node/add/(story|blog|image)&gt;. 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 &lt;(^/$|[^(search)$/]+)&gt;</p>";
$output .= "<h3>Custom Blocks</h3>"; $output .= "<h3>Custom Blocks</h3>";
$output .= "<p>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.</p>"; $output .= "<p>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.</p>";
$output .= "<h4>PHP in custom blocks</h4>"; $output .= "<h4>PHP in custom blocks</h4>";
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment