• View
• Edit
• History
• Attach
• Print
• Backlinks

IncludeSection

Description

Include a section from the first available among a list of pages.

The PmWiki (:include Page1 Page2 Page3 #from#to:) directive does not work as advertized. If Page1 exists, but does not contain a section #from#to, it returns nothing without checking the other pages.

I have a list of pages that "may" contain a specific section. I need to include this section if it exists in the first page, if not: from the second page and so on. This recipe adds a new markup that does exactly this:

   (:includesection #from#to Page1 Page2 Page3:) 
   (:includesection #section Page1 Page2 Page3:) 

Note that the section anchors are the first parameter, unlike with the (:include:) markup.

Installation

Place the following code in local/config.php :

Markup('includesection', '>if',
  '/\\(:includesection\\s+(\\S.*?):\\)/ei',
  "PRR(IncludeSection(\$pagename, PSS('$1')))");
$SaveAttrPatterns['/\\(:includesection\\s.*?:\\)/i'] = ' ';

function IncludeSection($pagename, $inclspec)
{
  $args = ParseArgs($inclspec);
  $anc = array_shift($args['']);
  if($anc>'' && $anc{0}!="#") return '';
  foreach($args[''] as $v)
  {
    $x = IncludeText($pagename, "$v$anc");
    if($x>'') return $x;
  }
}

To set additional parameters such as lines= or basepage=, use such a markup (note the quotes):

   (:includesection "#from#to lines=3 self=1" Page1 Page2 Page3:) 

To specify different section names with each page, use this (note the quotes) :

   (:includesection "" Page1#sec1 Page2#sec2 Page3#sec3:) 

Notes

Release Notes

• 20090228 : added $SaveAttrPatterns skip definition (suggested by Tontyna)
• 20090112a : added way to specify different section names with each page
• 20090112 : first release

See Also

Contributors

• Petko

Comments

Thanx for this recipe.
But don't forget to add the (:includesection:) markup to the $SaveAttrPatterns.
Otherwise the included pages/sections might add their links to the targets of the page where you inserted the (:includesection:) markup. That's probaly not what you want.
To avoid that place the following additional line in local/config.php

SDV($SaveAttrPatterns['/\\(:includesection\\s+(\\S.*?):\\)/i'], ' ');

Tontyna February 28, 2009, at 10:05 AM

Thanks, added. --Petko February 28, 2009, at 01:58 PM