2 rcs_id('$Id: IncludePage.php,v 1.26 2004-09-25 16:35:09 rurban Exp $');
4 Copyright 1999, 2000, 2001, 2002 $ThePhpWikiProgrammingTeam
6 This file is part of PhpWiki.
8 PhpWiki is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or
11 (at your option) any later version.
13 PhpWiki is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with PhpWiki; if not, write to the Free Software
20 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25 * IncludePage: include text from another wiki page in this one
26 * usage: <?plugin IncludePage page=OtherPage rev=6 quiet=1 words=50 lines=6?>
27 * author: Joe Edelman <joe@orbis-tertius.net>
30 class WikiPlugin_IncludePage
34 return _("IncludePage");
37 function getDescription() {
38 return _("Include text from another wiki page.");
41 function getVersion() {
42 return preg_replace("/[Revision: $]/", '',
43 "\$Revision: 1.26 $");
46 function getDefaultArguments() {
47 return array( 'page' => false, // the page to include
48 'rev' => false, // the revision (defaults to most recent)
49 'quiet' => false, // if set, inclusion appears as normal content
50 'words' => false, // maximum number of words to include
51 'lines' => false, // maximum number of lines to include
52 'section' => false, // include a named section
53 'sectionhead' => false // when including a named section show the heading
57 function getWikiPageLinks($argstr, $basepage) {
58 extract($this->getArgs($argstr));
61 // Expand relative page names.
62 $page = new WikiPageName($page, $basepage);
64 if (!$page or !$page->name)
66 return array($page->name);
69 function run($dbi, $argstr, &$request, $basepage) {
70 extract($this->getArgs($argstr, $request));
72 // Expand relative page names.
73 $page = new WikiPageName($page, $basepage);
77 return $this->error(_("no page specified"));
80 // A page can include itself once (this is needed, e.g., when editing
81 // TextFormattingRules).
82 static $included_pages = array();
83 if (in_array($page, $included_pages)) {
84 return $this->error(sprintf(_("recursive inclusion of page %s"),
88 $p = $dbi->getPage($page);
91 $r = $p->getRevision($rev);
93 return $this->error(sprintf(_("%s(%d): no such revision"),
97 $r = $p->getCurrentRevision();
99 $c = $r->getContent();
102 $c = extractSection($section, $c, $page, $quiet, $sectionhead);
104 $c = array_slice($c, 0, $lines);
106 $c = firstNWordsOfContent($words, $c);
108 array_push($included_pages, $page);
110 include_once('lib/BlockParser.php');
111 $content = TransformText(implode("\n", $c), $r->get('markup'), $page);
113 array_pop($included_pages);
118 return HTML(HTML::p(array('class' => 'transclusion-title'),
119 fmt("Included from %s", WikiLink($page))),
121 HTML::div(array('class' => 'transclusion'),
126 // This is an excerpt from the css file I use:
128 // .transclusion-title {
129 // font-style: oblique;
130 // font-size: 0.75em;
131 // text-decoration: underline;
132 // text-align: right;
135 // DIV.transclusion {
136 // background: lightgreen;
138 // border-style: solid;
139 // padding-left: 0.8em;
140 // padding-right: 0.8em;
142 // padding-bottom: 0px;
143 // margin: 0.5ex 0px;
147 // - line & word limit doesn't work if the included page itself
151 // $Log: not supported by cvs2svn $
152 // Revision 1.25 2004/07/08 20:30:07 rurban
153 // plugin->run consistency: request as reference, added basepage.
154 // encountered strange bug in AllPages (and the test) which destroys ->_dbi
156 // Revision 1.24 2004/02/17 12:11:36 rurban
157 // added missing 4th basepage arg at plugin->run() to almost all plugins. This caused no harm so far, because it was silently dropped on normal usage. However on plugin internal ->run invocations it failed. (InterWikiSearch, IncludeSiteMap, ...)
159 // Revision 1.23 2003/03/25 21:01:52 dairiki
160 // Remove debugging cruft.
162 // Revision 1.22 2003/03/13 18:57:56 dairiki
163 // Hack so that (when using the IncludePage plugin) the including page shows
164 // up in the BackLinks of the included page.
166 // Revision 1.21 2003/02/21 04:12:06 dairiki
167 // Minor fixes for new cached markup.
169 // Revision 1.20 2003/01/18 21:41:02 carstenklapp
171 // Reformatting & tabs to spaces;
172 // Added copyleft, getVersion, getDescription, rcs_id.
180 // c-hanging-comment-ender-p: nil
181 // indent-tabs-mode: nil