===== Wikka Menulets ===== {{lastedit show="3"}} In the trac as [[Ticket:28]]. As part of my proposal for a general overhaul of the [[WikkaMenus menu management system]] in WikkaWiki, I suggest we replace the current system-generated items that occur in the main menu and footer menu with a series of **menulets**, i.e. mini-actions generating content for menu items. Any of these mini-actions can of course be used in the page body as well. Here's a list of potential menulets and their output, that I've uploaded to this server. Suggestions/modifications are welcome. ---- ==##""{{acls}}""##== Prints a link to ##""CurrentPage/acls""## if the user has access to the ACLs: {{acls}} %%(php) page){ if ($owner = $this->GetPageOwner()){ if ($owner == "(Public)"){ print $this->IsAdmin() ? "href("acls")."\">(Edit ACLs)\n" : ""; #i18n } elseif ($this->UserIsOwner()){ print "href("acls")."\">Edit ACLs\n"; #i18n } } else { print ($this->GetUser()) ? " (href("claim")."\">Take Ownership)\n" : ""; #i18n } } ?> %%--- ~&My version: %%(php)page) { switch (TRUE) { case ($this->UserIsOwner()): echo ''.ACLS_OWNER.''."\n"; break; case ('(Public)' == $this->page['owner']): if ($this->IsAdmin()) echo ''.ACLS_ADMIN.''."\n"; break; case ('' == $this->page['owner']): if ($this->GetUser()) echo ''.ACLS_NONE.''."\n"; break; default: // print nothing } } ?>%% --- A few notes about the differences: ~~-UI strings are grouped together at the top: easier maintainance; comments to give hints to translators; ~~-when $this->page is set, all data of the page is known; no need to use ""GetPageOwner()"" which would do another page load (or at least access the cache again); ~~-using a switch construct gives equal weight to the different cases, and makes it easily extensible for possible other types of ownership (groups? projects? aliens?); ~~-using single quotes wherever possible for speed (but always double quotes for strings to be internationalized); ~~-consistent spelling: the method is called Href() so we don't call it as href(). ~&**Code untested - Please test!**--- --JavaWoman ---- ==##""{{attachments}}""##== Prints a link to the FilesHandler differently depending if there are attached documents to the current page or not: {{attachments}}. %%(php) config['upload_path'].'/'.$this->GetPageTag(); $AttachmentClass = ""; if(is_dir($upload_path) ){ $handle = opendir($upload_path); while( (gettype( $name = readdir($handle)) != "boolean")){ $name_array[] = $name; } foreach($name_array as $temp) $folder_content .= $temp; closedir($handle); if($folder_content == "...") { $AttachmentClass ="emptyfolder"; // the upload path is empty } else { $AttachmentClass = "fullfolder"; // the upload path contains attachments } } else $AttachmentClass = "inexistingfolder"; // the upload path does not exist echo "href("files")."\" title=\"Click to manage attachments\" class=\"".$AttachmentClass."\">Attachments\n"; #i18n ?> %% Add something like this to the .css file: %%(css) .fullfolder { font-weight: bold; border: 1px solid red; } .emptyfolder { } .inexistingfolder { } %% ---- ==##""{{contact}}""##== Prints a ##mailto:## link to the Wikka administrator's address: {{contact}} __Note__: plain mailto links are a common source of spam. %%(php) GetConfigValue("admin_email"); // print spam-safe mailto link $patterns = array("'@'", "'\.'"); $replace = array("[at]", "[dot]"); echo "Contact"; #i18n // print plain mailto link //echo "Contact"; #i18n // print contact link only to registered users // echo ($this->GetUser()) ? "Contact" : ""; #i18n ?> %% ---- ==##""{{countcomments}}""##== Prints the total number of comments: {{countcomments}} %%(php) LoadSingle("SELECT count(*) as num FROM ".$this->config["table_prefix"]."comments"); echo $commentsdata["num"]; ?> %% Compact version using the ##[[WikkaCountingRecords getCount()]]## method: %%(php) getCount('comments'); ?> %% ---- ==##""{{countowned}}""##== Prints the number of pages owned by the current user: {{countowned}} %%(php) config["table_prefix"].'pages WHERE `owner` '; $str .= "= '" . $this->GetUserName() . "' AND `latest` = 'Y'"; $countquery = $this->Query($str); $count = mysql_result($countquery, 0); echo $this->Link('MyPages', '', $count,'','','Display a list of the pages you currently own'); ?> %% Compact version using the ##[[WikkaCountingRecords getCount()]]## method: %%(php) GetUserName()."' AND `latest` = 'Y'"; $count = $this->getCount('pages', $where); echo $this->Link('MyPages', '', $count,'','','Display a list of the pages you currently own'); ?> %% ---- ==##""{{countpages}}""##== Prints the total number of pages: {{countpages}} %%(php) LoadSingle("SELECT count(*) as num FROM ".$this->config["table_prefix"]."pages WHERE latest = 'Y'"); echo $this->Link('PageIndex', '', $pagedata['num'],'','','Display an alphabetical page index'); ?> %% Compact version using the ##[[WikkaCountingRecords getCount()]]## method: %%(php) getCount('pages', $where); echo $this->Link('PageIndex', '', $count,'','','Display an alphabetical page index'); ?> %% ---- ==##""{{countreferrers}}""##== Prints the total number of referrers to the wiki: {{countreferrers}} Compact version using the ##[[WikkaCountingRecords getCount()]]## method: %%(php) getCount('referrers'); ?> %% ---- ==##""{{countusers}}""##== Prints the number of registered users: {{countusers}} %%(php) LoadSingle("SELECT count(*) as num FROM ".$this->config["table_prefix"]."users "); echo $userdata["num"]; ?> %% Compact version using the ##[[WikkaCountingRecords getCount()]]## method: %%(php) getCount('users'); ?> %% ---- ==##""{{delete}}""##== Prints a link to ##""CurrentPage/delete""## if the user has delete privileges: {{delete}} %%(php) IsAdmin())? "href("delete")."\" title=\"Click to delete this page\">Delete this page\n" : ""; #i18n ?> %% ---- ==##""{{edit}}""##== Prints a link to ##""CurrentPage/edit""##: {{edit}} %%(php) HasAccess("write")) { echo "href("edit")."\" title=\"Click to edit this page\">Edit this page\n"; #i18n } else { echo "href("showcode")."\" title=\"Click to display the page source\">Show code\n"; #i18n } ?> %% ---- ==##""{{history}}""##== Prints a link to ##""CurrentPage/history""##: {{history}} %%(php) href("history")."\" title=\"Click to view recent edits to this page\">Page History\n"; #i18n ?> %% ---- ==##""{{homepage}}""##== Prints a link to the wiki homepage specified in the config file: {{homepage}} %%(php) Link($this->config['root_page']); ?> %% ---- ==##""{{lasteditauthor}}""##== Prints the author of the last page version: {{lasteditauthor}} %%(php) LoadSingle("SELECT * FROM ".$this->config['table_prefix']."pages WHERE tag='".$this->GetPageTag()."' AND latest = 'Y'"); $user = ($this->LoadUser($page["user"]))? $this->Link($page["user"]) : "anonymous"; echo $user; ?> %% ---- ==##""{{linkcount}}""##== Count (and display) the number of Wikka-formatted links (##""[[http:...]]""##) in a page. Needs some optimization work. **actions/linkcount.php** %%(php) * @name LinkcountAction * @package Actions * @license http://www.gnu.org/copyleft/gpl.html * @since Wikka 1.1.7 * @uses /actions/linkcount.php * @version $Id: linkcount.php,v 1.1.1.1 2006/10/07 16:30:42 brian Exp brian $ * */ // Necessary to prevent "already defined" errors when the Wikka parser // comes across a "start" or "stop" action tag include_once("actions/linkcount.inc.php"); if(isset($vars['start']) || isset($vars['stop'])) { return; } $preformatted = $vars['preformatted']; $pretext = $vars['pretext']; $posttext = $vars['posttext']; if( isset($pretext) || isset($posttext)) { $pretext ? 1 : $pretext = ''; $posttext ? 1 : $posttext = ''; } else if(isset($preformatted)) { $pretext = "+++Link count: "; $posttext = " link(s)+++"; } $body = explode("\n", $this->page['body']); parse($body); ?> %% **actions/linkcount.inc.php** %%(php) * @name LinkcountAction * @package Actions * @license http://www.gnu.org/copyleft/gpl.html * @since Wikka 1.1.7 * @uses /actions/linkcount.inc.php * @version $Id: linkcount.inc.php,v 1.1.1.1 2006/10/07 16:32:17 brian Exp brian $ * */ function parse(&$body) { $linkcount = 0; if(!$body) { return; } $state = null; #null, start foreach($body as $line) { switch($state) { case null: if(preg_match('/\{\{linkcount[\s]+start.*\}\}/', $line)) { $state = 'start'; } break; case 'start': if (preg_match('/\{\{linkcount[\s]+stop.*\}\}/', $line)) { $state = null; } elseif (preg_match('/\[\[http:.*\]\]/', $line)) { $linkcount++; } break; } } echo $pretext.$linkcount.$posttext; } ?> %% ---- ==##""{{lasteditnotes}}""##== Prints the last edit notes: {{lasteditnotes}} %%(php) LoadSingle("SELECT * FROM ".$this->config['table_prefix']."pages WHERE tag='".$this->GetPageTag()."' AND latest = 'Y'"); echo ($page["note"])? $this->Format("//".$page["note"]."//") : ""; ?> %% ---- ==##""{{logo}}""##== Displays a wikka logo set by admins (in the future the path should be set in the config file): {{logo}} %%(php) Format('{{image alt="logo" title="'.$this->config['wakka_name'].'" url="images/wizard.gif" link="'.$this->config['root_page'].'"}}'); ?> %% My version (which needs the config entry: "wiki_logo => "yourlogo.jpg" [must be on the same server]): %%(php) config['wiki_logo'] && file_exists($this->config['wiki_logo'])) echo $this->Format('{{image alt="LOGO_ALT_TEXT" title="'.$this->config['wakka_name'].'" url="'.$this->config['wiki_logo'].'" link="'.$this->config['root_page'].'"}}'); else echo $this->Format('{{image alt="LOGO_ALT_TEXT" title="'.$this->config['wakka_name'].'" url="images/wizard.gif" link="'.$this->config['root_page'].'"}}'); ?> %% --NilsLindenberg ---- ==##""{{mysqlversion}}""##== Displays the current MySQL version: {{mysqlversion}} %%(php) %% ---- ==##""{{owner}}""##== Displays page ownership infos: {{owner}} %%(php) page) { if ($owner = $this->GetPageOwner()){ if ($owner == "(Public)"){ print "Public page"; #i18n } elseif ($this->UserIsOwner()) { if ($this->IsAdmin()) { print "Owner: ".$this->Link($owner, "", "", 0)."\n"; #i18n } else { print"You own this page.\n"; #i18n } } else { print "Owner: ".$this->Link($owner, "", "", 0)."\n"; #i18n } } else { print "Nobody\n"; #i18n } } ?> %%--- ~&My version: %%(php)page) { switch (TRUE) { case ($this->UserIsOwner() && !$this->IsAdmin()): echo OWNER_CURRENT."\n"; break; case ('(Public)' == $this->page['owner']): echo OWNER_PUBLIC."\n"; break; case ('' == $this->page['owner']): echo OWNER_NONE."\n"; break; case ($this->IsAdmin()): case ('' != $this->page['owner']): echo sprintf(OWNER_OTHER, $this->Link($owner, '', '', 0))."\n"; break; default: // just in case } } ?>%% --- Note: this has a similar approach and structure to my version of ##""{{acls}}""## above; see my notes there. The order of the cases is important! ~&**Code untested - Please test!**--- --JavaWoman ---- ==##""{{phpversion}}""##== Displays the current php version: {{phpversion}} %%(php) %% ---- ==##""{{recentchangesrss}}""##== Prints a link (RSS feed for recent changes) to ##""CurrentPage/recentchanges.xml""##: {{recentchangesrss}} %%(php) href("recentchanges.xml")."\" title=\"Click to view recent changes in XML format.\">\"XML\""; #i18n ?> %% ---- ==##""{{referrers}}""##== Prints a link to ##""CurrentPage/referrers""##: {{referrers}} %%(php) GetUser()) { echo "Referrers\n"; #i18n } ?> %% ---- ==##""{{revisions}}""##== Prints a link to ##""CurrentPage/revisions""##: {{revisions}} %%(php) GetPageTime()) { echo "href("revisions")."\" title=\"Click to view recent revisions list for this page\">".$this->GetPageTime()."\n"; #i18n } ?> %% ---- ==##""{{revisionsrss}}""##== Prints a link (RSS feed for page revisions) to ##""CurrentPage/revisions.xml""##: {{revisionsrss}} %%(php) GetPageTime()) { echo "href("revisions.xml")."\" title=\"Click to view recent page revisions in XML format.\">\"XML\""; #i18n } ?> %% ---- ==##""{{search}}""##== Prints a searchbox: {{search}} %%(php) FormOpen("", "TextSearch", "get"); echo 'Search: '; #i18n echo $this->FormClose(); ?> %% ---- ==##""{{skin}}""##== ~& Needs to be updated for new ##templates/## directory structure Displays a clickable link to the current skin: ""{{skin}}"" %%(php) GetCookie("wikiskin"))? $this->GetCookie("wikiskin") : $this->GetConfigValue("stylesheet"); $defaultskin = $this->config['stylesheet']; $skin = (!$this->GetCookie('wikiskin')) ? $defaultskin : $this->GetCookie('wikiskin'); # JW 2005-07-08 FIX possibly undefined cookie echo ''.$skin.''; ?> %%--- ~&Updated version - see comments on MySkin --JavaWoman ---- ==##""{{time}}""##== Prints the current time: {{time}} %%(php) %% ~& I created a similar action, but with an offset. It can be found on the TimeWithOffset page. --JasonHuebel ---- ==##""{{title}}""##== Prints the title of the current page: {{title}} %%(php) PageTitle(); ?> %% ---- ==##""{{today}}""##== Prints the current date: {{today}} %%(php) %% ---- ==##""{{url}}""##== Prints the complete URL of the current page: {{url}} %%(php) href("", $this->GetPageTag()); //clickable link //echo $this->Link($this->href("", $this->GetPageTag())); ?> %% ---- ==##""{{who}}""##== Prints the name of the current user: {{who}} %%(php) GetUser()) { echo "You are ".$this->Format($this->GetUserName()); #i18n } ?> %% ~&Here's my take (untested!): %%(php)GetUser()) { $who = $this->Format($this->GetUserName()); } else { if (isset($_SERVER['REMOTE_HOST'])) { $who = $_SERVER['REMOTE_HOST']; } else { $who = $_SERVER['REMOTE_ADDR']; } } // display output echo str_replace(' ',' ',sprintf(WHO_OUT, $who)); ?>%% --- By putting the whole **phrase** in a define, we are taking care of differences in word order in different languages; at the output stage we replace spaces by no-breaking spaces to keep the whole string together. This also takes care of usage of ##""{{who}}""## in the main_menu (displaying address instead of user name). --JavaWoman ~~&Nice way of doing it JavaWoman.%%(php)GetUser()) ? $this->Format($this->GetUserName()) : ( (isset($_SERVER['remote_host'])) ? $_SERVER['remote_host'] : $_SERVER['remote_addr'] ) ; // display output echo str_replace( ' ', ' ', sprintf(WHO_OUT, $who)); ?>%%---Here is a smaller take on the same code... -- GeorgePetsagourakis ~~~&Ya, it's smaller - but not faster. In fact, it's exactly the same thing, just harder to read. I just happen to like readable code. I wrote it like that for a reason: it's faster to maintain. ;-) --JavaWoman ~~~~&It is probably cause I never had the chance to use the (condition)? smth : oth_th ; syntax and I am so excited about it .. :D --GeorgePetsagourakis ~~~~~&It is indeed a very handy syntax and I do use it - but IMO usage beyond a //single// if-then-else level should be avoided: that's where it gets hard to parse for humans although PHP has no problem with it. ;-) --JavaWoman ---- ==##""{{wikkaname}}""##== Prints the name of the current Wikka: {{wikkaname}} %%(php) config['wakka_name']; ?> %% ---- ==##""{{wikkaversion}}""##== Prints the current wikka version: {{wikkaversion}} %%(php) VERSION; ?> %% ... ~&DarTar, can you post your code for these actions here? The way some of the menu items are formatted now should be improved - but if this little project moves ahead (I hope) we might as well do it in the "menulets" action code instead of the current code. And new code should be ready for i18n as well (I don't know if yours is...) --JavaWoman ---- ==##""{{system}}""##== Prints system information about the system Wikka is running on: ""{{system show="os"}}"" - prints the operating system information ""{{system show="machine"}}"" - prints information about the machine ""{{system show="host"}}"" - prints information about the host ""{{system}}"" - prints all of the above %%(php) $value) { switch ($param) { case 'show': if (in_array($value, $valid_show)) $show = strtolower($value); break; } } } // get data $host = php_uname('n'); $os = php_uname('s'); $release = php_uname('r'); $version = php_uname('v'); $machine = php_uname('m'); // build output $out = ''; switch ($show) { case '': if (isset($os)) $out .= $os.' '; if (isset($release)) $out .= $release.' '; if (isset($version)) $out .= $version.' '; if (isset($machine)) $out .= $machine.' '; if (isset($host)) $out .= '('.$host.')'; break; case 'os': if (isset($os)) $out .= $os.' '; if (isset($release)) $out .= $release.' '; if (isset($version)) $out .= $version.' '; break; case 'machine': if (isset($machine)) $out .= $machine.' '; break; case 'host': if (isset($host)) $out .= $host.' '; break; } // show result echo trim($out); ?> %% Installed as a beta feature on this site. --JavaWoman ---- ==##""{{randompage}}""##==//like the "Random Article" on wikipedia...// ~ ##""{{randompage}}""## ~~ Prints a link to a random page on this wiki. e.g. [[HomePage RandomPage]] ~ ##""{{randompage title="Random"}}""## ~~ Change the title, use ##""{{randompage title=""}}""## to display the real pagename. ~ ##""{{randompage pos="ActionInfo, HandlerInfo, FunctionInfo"}}""## ~~ Make a positive list to choose from, don't use all pages. (note the default neg list) ~ ##""{{randompage neg="HomePage, PageIndex"}}""## ~~ Use all pages exept the ones used in this negative list / override the default neg list in $neg_list_default ~ ##""{{randompage title="Random Link" pos="ActionInfo, HandlerInfo, FunctionInfo" neg=""}}""## ~~ Clear the default negative list, use only pages from the pos list and use "Random Link" as title. ~ ##""{{randompage pos="HomePage|DonateNow|DonateNow|DonateNow"}}""## ~~ You can influence the random ratio... (+other way of defining the list) ~& **Original idea** ~& %%(php)LoadAll("select distinct tag from ".$this->config["table_prefix"]."pages"); print $this->Link( $all[array_rand($all)]['tag'], '', 'RandomPage', FALSE, TRUE, 'A random page on this site' ); ?> %% %%(php)config["root_page"]; $neg_list_default = array("HomePage","UserSettings","TextSearch","TextSearchExpanded","PageIndex"); $title = isset($vars['title']) ? $this->htmlspecialchars_ent($vars['title']) : "RandomPage"; //i18n foreach( $this->LoadAll("select distinct tag from ".$this->config["table_prefix"]."pages") as $key => $val ){ $all[]=$val['tag']; } $pos_list = isset($vars['pos']) ? split('[|,]', ereg_replace( "[\ ]", '', $vars['pos'] ) ) : $all ; $neg_list = isset($vars['neg']) ? split('[|,]', ereg_replace( "[\ ]", '', $vars['neg'] ) ) : $neg_list_default ; $try = 0; while ( $try < 5 ) { $try++; $page = $pos_list[array_rand($pos_list)]; if( !in_array($page, $all) ) continue; if( in_array($page, $neg_list) ) continue; break; } if( $try > 4 ) $page = $errorpage; if( $title=='' ) $title = $page; print $this->Link( $page, '', $title, FALSE, TRUE, "$page, a random page on this site" ); //i18n ?>%% -- OnegWR ---- ==##""{{contributors}}""##== ~ Prints a space separated list of all users that have edited the current page, the most active user first. ~ A bit like ##""{{lasteditauthor}}""##, but with all editing authors... %%config["table_prefix"].'pages '. 'WHERE `tag`="'.$this->tag.'" GROUP BY user ORDER BY cnt DESC;'; $all = $this->LoadAll( $q ); foreach($all as $key=>$val) { print $this->Link($val['user'],'',$val['user'], FALSE, TRUE, '('.$val['cnt'].')') ." \n"; } ?>%% -- OnegWR ---- ==##""{{wordcount}}""##== Inserts a wordcount (my format, your format, or no format) into a document. Needed something quick and dirty, so there's some refinement yet to be done. ##""+++Word count: 9999 word(s)+++""## ==actions/wordcount.php== %%(php) * * Replace instances of {{wordcount}} with the number of words in the * text * * Optionally: {{wordcount preformatted="1" * pretext="Some pretext" * posttext="Some posttext"}} * * where preformatted = "1" produces "+++Word count: 9999 word(s)+++" * pretext is the text to precede the word count (overrides preformatted) * posttest is the text to follow the word count (overrides preformatted) * * @package Actions * @subpackage Menulets * @name Contributors * @author {@link http://wikkawiki.org/BrianKoontz Brian Koontz} * @copyright Copyright � 2006, Brian Koontz * @license http://www.gnu.org/copyleft/lesser.html GNU Lesser General Public License * @since Wikka 1.1.6.2 * * TODO: Probably counts a lot of things it should, and a lot of * things it shouldn't. Probably shouldn't count actions or other * special items. */ $preformatted = $vars['preformatted']; $pretext = $vars['pretext']; $posttext = $vars['posttext']; if( $pretext || $posttext) { $pretext ? 1 : $pretext = ''; $posttext ? 1 : $posttext = ''; } else if($preformatted) { $pretext = "+++Word count: "; $posttext = " word(s)+++"; } $wc = str_word_count($this->page['body']); echo $pretext.$wc.$posttext; ?> %% ---- CategoryDevelopmentActions CategoryDevelopmentTest