|
PmWiki /
FAQ<< Backup and Restore | Documentation Index | FAQ Candidate >> This attempts to summarize some of the more commonly asked questions. The answers are on the corresponding pages (see link). If you have a question that isn't answered here, you can leave your question on the Questions page or search for documentation using the search facility. More documentation can be found on the documentation index page. IntroductionWhat is PmWiki? PmWiki is a wiki-based system for collaborative creation and maintenance of websites. What can I do with it? PmWiki pages look and act like normal web pages, except they have an "Edit" link that makes it easy to modify existing pages and add new pages into the website, using basic editing rules. You do not need to know or use any HTML or CSS. Page editing can be left open to the public or restricted to small groups of authors. Feel free to experiment with the Text Formatting Rules in the "Wiki sandbox". The website you're currently viewing is built and maintained with PmWiki. What are the requirements? See the PmWiki requirements page. Where can I find documentation? See the documentation index page. How can I download PmWiki? See the download page. How do I install PmWiki? Instructions for installation are on the installation page. Basic PmWiki editing rulesI'm new to PmWiki, where can I find some basic help for getting started? The Basic Editing page is a good start. From there, you can just follow the navigational links at the bottom of the page (they are called Wiki Trails) to the next pages, or to the Documentation Index page, which provides an outline style index of essential documentation pages, organized from basic to advanced. How do I include special characters on my wiki pages? Use character codes to insert special characters, such as Copyright (©) and Trademark (® or ™) symbols, that don't appear on your keyboard. Why are separate lines of text in the markup combined into a single line on output? PmWiki normally treats consecutive lines of text as being a paragraph, and merges and wraps lines together on output. This is consistent with most other wiki packages. However, an author can use the Can I just enter HTML directly? By default (and by design), PmWiki does not support the use of HTML elements in the editable markup for wiki pages. There are a number of reasons for this described in the PmWiki Philosophy and PmWiki:Audiences. Basically, Pm feels that enabling HTML markup within wiki pages in a collaborative environment has the effect of excluding some potential authors from being able to edit pages, as well as posing a number of display and security issues. However, a site administrator can use the Cookbook:EnableHTML recipe to enable the use of HTML markup directly in pages. Where can I find more documentation? See the documentation index page.+' Creating New Pages
How do I create a new page? Typing my new page? will create a link to the new page?. Also, on sites that have WikiWords enabled as link-creating syntax, typing MyNewPage will create a link to the new page. WikiWords are CapitalizedWordsSmashedTogether, and, on such sites, don't need double brackets to become links. Note that some sites have turned off WikiWord links -- including this one! There's a lot you can do with double bracket links. Why do some new pages have a title with spaces like "Creating New Pages" and others end up with a WikiWord-like title like "CreatingNewPages"? The default page title is simply the name of page, which is normally stored as "CreatingNewPages." However, you can override a page's title by using the LinksHow do I create a link that will open as a new window? Use the
How do I create a link that will open a new window, and configure that new window? This requires javascript. See Cookbook:PopupWindow. How do I place a mailing address in a page? Use the
See also Cookbook:EProtect or Cookbook:ProtectEmail for information on protecting email addresses from spammers. How can I enable links to other protocols, such as nntp:, ssh:, xmpp:, etc? See Cookbook:Add Url schemes How to get PmWiki to recognize additional URL schemes such as How do I make a WikiWord link to an external page instead of a WikiPage? Use link markup. There are two formats: [[http://example.com/ | WikiWord]] [[WikiWord -> http://example.com/]] How do I find all of the pages that link to another page (i.e., backlinks)? Use the (:pagelist link=SomePage list=all:) -- show all links to SomePage
(:pagelist link={$FullName} list=all:) -- show all links to the current page
What link schemes does PmWiki support? See Link schemes Link schemes supported by PmWiki How do I open external links in a new window or mark them with an icon? See Cookbook:External links Configure external links to open in a new window, have a "tooltip title", or use other CSS classes ImagesIs it possible to link an image on PmWiki without using a fully qualified URL? Yes. For images that are attachments, the general format is Why doesn't the
Can I attach a client image file on PmWiki? Yes, see Uploads How can I include a page from another group that contains an attached image? Include the page in the normal way, ie Why, if I put an image with rframe or rfloat and immediatly after that I open a new page section with ! the section title row is below the image instead of on the left side? Because the CSS for headings such as ! contains an element clear:both which forces this behaviour. Redefine the CSS locally if you want to stop this happening, but I think the bottom border (that underlines the heading) would need further re-definition. I just use bolding for the title, and 4 dashes below ---- to separate a new section, and it saves the effort of fiddling with the core definitions. Unlike the lframe and rframe directives, cframe does not fully honour the width setting. While the frame itself resizes to match the request, the enclosed image does not, and retains its original width. Effect is the same in IE and Fx. I've added an example beneath the standard example above. How can I put a table of captioned images within a numbered list? I cannot use a simple table, because images cannot (apparently) have captions within a simple table (Example 1). I cannot seem to use the table directives, because I cannot get them to work within a list without ending the list and causing subsequent numbering to restart (Example 2). Table directives must start in column 1 Example 1
Note caption (signified by bar) is not recognised, and an erroneous bar is displayed
Example 2
Use styles for indentation, you will have to resume the numbering, see Wiki styles
Not good enough
Is it possible to disallow all images? I already disabled uploads but I also want to disallow external images from being shown on my wiki pages. - X ? How can I make it so that when I place an image in a page, the block of text it is in is a <p> (paragraph) rather than a <div> (division)? If you just want it to happen for a single image (instead of all), then
try putting [==] http://www.pmwiki.org/pub/pmwiki/pmwiki-32.gif
Having Is there any way to use relative paths for images? See Cookbook:RelativeLinks . Is there a way to attach a BMP and have it display rather than link? Is there a way to have a table to the left or right of an image? UploadsWhen I upload a file, how do I make the link look like "file.doc" instead of "Attach:file.doc"? Use parentheses, as in Why can't I upload files of size more than 50kB to my newly installed PmWiki? Out of the box PmWiki limits the size of files to be uploaded to 50kB. Add to your config.php to increase limit to 1MB (for example). See UploadsAdmin for how to further customize limits. Note that both PHP and webservers also place their own limits on the size of uploaded files.
Why does my upload exit unexpectedly with "Incomplete file received"? You may be running out of space in a 'scratch' area, used either by PmWiki or by PHP. On *nix, check that you have sufficient free space in /tmp and /var/tmp. How do I make it so that the upload link still allows one to make another upload (if someone wants to replace the old version of a file with a newer version, for example). Currently you only get the upload link when there is no file in the upload directory. Use the Attach page action, and click on the delta symbol (Δ) shown against each of files listed. If you can't see the attach action either uploads are not enabled, you are not not authorised to upload, or the attach action has been commented out or is missing. See also available actions, and look at Test?action=upload. How do I prevent files being uploaded with no extension?
Ho do I hide the "Attach:" for all attachments How to avoid problems with non-ASCII characters in attachment names (i.e. "Zażółć geślą jaźń.doc")? See How can I link a file that have a 4-letter file extension such like 'abc.pptx'? If I try to download it, its file extension changes automatically like 'abc.zip' ? What is problem do you think ? How can I prevent others from using the url's of my images on their site See Cookbook:Prevent Hotlinking Prevent hotlinking of uploaded files TablesHow do I create a basic table? Tables are created via use of the double pipe character:
How do I create cell headers? Header cells can be created by placing ! as the first character of a cell. Note that these are table headers, not headings, so it doesn't extend to !!, !!!, etc.
How do I create an advanced table? See table directives My tables are by default centered. When I try to use '||align=left' they don't align left as expected. You're probably using Firefox. Use ||style="margin-left:0px;" instead. How can I specify the width of columns? At present there isn't a way to do this using the basic markup. You need to use Table Directives. How can I display a double pipe "||" in cell text using basic table markup? Use || to display || as a special characters. Table DirectivesCan I define table headers using the table directive markup? No, but you can with Cookbook:AdvancedTableDirectives. See Pm's reply to pending PITS:00535 Is it possible to do nested tables? Yes, if you nest simple tables inside advanced tables. See also Cookbook:AdvancedTableDirectives. Is it possible to add background images to tables and table cells? Yes, see Cookbook:BackgroundImages. Is it possible to have a collapsible table, that you can set by default to be deployed (as with the (:toc:) display) or retracted? WikiStyles Some of my colors aren't working! For example, Be sure to use lowercase letters for rgb hex colors, otherwise PmWiki may mistake the color value for a WikiWord. why is a color word not a class class, eg
why does this not work?
Because, confusingly, rframe is not a class.
Is a wiki style a class
It would be helpful to provide more consistency.
What happened to test 3? PageDirectives Can I get Use Is there any way to prevent the "redirected from" message from showing at the top of the target page when I use There are several possibilities. If you want to suppress the message in all cases
If you want to suppress the message based on the destination/target of the redirect
If you want to suppress the message based on the origin/source of the redirect
if (@$_GET['from']) {
$group = PageVar($_GET['from'], '$Group');
if ($group == 'SomeGroup') $PageRedirectFmt = '';
}
(In the above code example, you might replace SomeGroup with Profiles.)
An alternative is the include the other page rather than redirect. There are two cookbook recipes that may assist Is there any method for redirecting to the equivalent page in a different group, i.e. from BadGroup/thispage => GoodGroup/thispage using similar markup to (:redirect Goodgroup.{Name}:)? (:redirect Goodgroup.{$Name}:) works if you want to put it in one page.
If you want it to work for the entire group, put (:redirect Goodgroup.{*$Name}:) into Badgroup.GroupHeader - however, that only works with pages that really exist in Goodgroup; if you visit a page in Badgroup without a corresponding page of the same name in Goodgroup, instead of being redirected to a nonexistant page, you get the redirect Directive at the top of the page.
With (:if exists Goodgroup.{*$Name}:)(:redirect Goodgroup.{*$Name}:)(:ifend:) in Badgroup.GroupHeader you get redirected to Goodgroup.Name if it exists, otherwise you get Badgroup.Name without the bit of code displayed.
IncludeOtherPages What's the maximum number of includes that can exist in a page? My site seems to stop including after 48 includes. ( By default, PmWiki places a limit of 50 include directives for any given page, to prevent runaway infinite loops and other situations that might eat up server resources. The limit can be modified by the wiki administrator via the Page specific variablesIs there a variable like $LastModified, but which shows me the creation time? No, but you can create one in config.php. For instance: # add page variable {$PageCreationDate} in format yyyy-mm-dd
$FmtPV['$PageCreationDate'] = 'strftime("%Y-%m-%d", $page["ctime"])';
if you like the same format that you define in config.php with $FmtPV['$Created'] = "strftime(\$GLOBALS['TimeFmt'], \$page['ctime'])"; WikiGroupHow can I get rid of the 'Main' group in urls for pages pointing to Main? How can I limit the creation of new groups? See Cookbook:Limit Wiki Groups. Why doesn't [[St. Giles and St. James]] work as a link? (It doesn't display anything.) Because it contains periods, and destroys PmWiki's file structure, which saves pages as Group.PageName. Adding those periods disrupts this format. Links may only contain words. If you need a link precisely as shown, the page must be named eg StGilesAndStJames then you can use the (:title:) directive to have the page's title appear with periods (:title St. Giles and St. James:). (Although modern US and UK grammar now tend to drop the period to simplify style). How can I delete a wiki group? Normally you can't, as this requires an admin with server-side access to delete the file that makes up the group's RecentChanges page. But there is an option method of making it possible to delete RecentChanges pages from within the wiki if the admin enables the code found on Cookbook:RecentChanges Deletion. How can I delete a wiki group's Group.RecentChanges page? Normally you can't, as this requires an admin with server-side access to delete a file. But there is an optional method of making it possible to delete RecentChanges pages from within the wiki if the admin enables the code found on Cookbook:RecentChanges Deletion. GroupHeadersHow do I set one header for all pages/groups? The header for each page is controlled by the
$GroupHeaderFmt = '(:include {$SiteGroup}.SiteHeader
basepage={*$FullName}:)(:nl:)' . $GroupHeaderFmt;
Note that single quotes must be used so that Any form of markup is valid in $GroupHeaderFmt .= "Global markup text here.";
Would this then work for site footers?
$GroupFooterFmt = '(:include {$SiteGroup}.SiteFooter
basepage={*$FullName}:)(:nl:)' . $GroupFooterFmt;
Yes, I am using this in my config.php file for my footers and it works perfectly Ian MacGregor PageHistoryIs there a way to remove page history from page files? 1. Administrators can clean page histories using the Cookbook:ExpireDiff recipe. 2. Administrators with FTP file access can download individual pages from the wiki.d directory, open them in a text editor, manually remove history, and re-upload the files to wiki.d/ directory. Care must be exercised, when manually editing a page file, to preserve the minimum required elements of the page and avoid corrupting its contents. See PageFileFormat#creating. 3. Edit the page. Select all the contents of the edit text area and cut them to the clipboard. Enter How can I restrict viewing the page history In the local/config.php file, set $HandleAuth['diff'] = 'edit';
PasswordsHow can I password protect all the pages and groups on my site? Do I really have to set passwords page by page, or group by group? Administrators can set passwords for the entire site by editing the config.php file; they don't have to set passwords for each page or group. For example, to set the entire site to be editable only by those who know an "edit" password, an administrator can add a line like the following to local/config.php: For more information about the password options that are available only to administrators, see PasswordsAdmin. I get http error 500 "Internal Server Error" when I try to log in. What's wrong? This can happen if the encrypted passwords are not created on the web server that hosts the PmWiki. Solution: Create the passwords on the system with the oldest PHP version and use them on all other systems. How can I create private groups for users, so that each user can edit pages in their group, but no one else (other than the admin) can? Administrators can use the AuthUser recipe and add the following few lines to their local/config.php file to set this up: $group = FmtPageName('$Group', $pagename); This automatically gives edit rights to a group to every user who has the same user name as the group name. How come when I switch to another wiki within a farm, I keep my same authorization? PmWiki uses PHP sessions to keep track of authentication/authorization information, and by default PHP sets things up such that all interactions with the same server are considered part of the same session. An easy way to fix this is to make sure each wiki is using a different cookie name for its session identifier. Near the top of one of the wiki's local/config.php files, before calling authuser or any other recipes, add a line like: session_name('XYZSESSID');
You can pick any alphanumeric name for XYZSESSID; for example, for the cs559-1 wiki you might choose session_name('CS559SESSID');
This will keep the two wikis' sessions independent of each other. PageListsHow can I configure my site to always exclude wiki-related pages from searches? Try the following in your local/config.php file. See also Cookbook:SearchPatterns. ## Exclude Certain pages / groups from search results. $SearchPatterns['default'][] = '!\\.(All)?Recent(Changes|Uploads|Comments)$!'; $SearchPatterns['default'][] = '!\\.Group(Print)?(Header|Footer|Attributes)$!'; $SearchPatterns['default'][] = '!\\.(Left|Right|Side)(Bar|Menu|Note)$!'; $SearchPatterns['default'][] = '!^Site\\.!'; $SearchPatterns['default'][] = '!^PmWiki\\.!'; If you add How do I turn on wiki word spacing in page lists? Try the following in your Site.LocalTemplates ----
!!!fmt=#simplelist
Simple list of page names, without the Group name.
[@
[[#simplelist]]
[[({=$Group}/){=$Name}|{=$Titlespaced}]],
[[#simplelistend]]
@] Can I customise the text in the button generated by the The searchbox directive does not appear to support a parameter to change the label of the associated submit button. How to list only pages that have their title (*not* name) starting with A, B, C,... (:pagelist $Title=A*,B*,C* :) How do I search for pages changed by an particular author? It would be useful to provide Author= (similar to name= or group=). Try using the AuthorContribution recipe. This recipe provides a way to automatically keep a list of the pages each author has edited by producing an "Author Contributions" page with a name of Profiles.<author's name>-Contrib for each author that has a page in the Profiles group. Contributions by authors without profile pages are placed in a single Profiles.Other-Contrib page. How do I search for pages changed after a particular date? ... How to exclude deleted pages from Use (:pagelist trail=Site.AllRecentChanges if="exists {=$FullName}" ...:) --Petko (This needs the new beta version in order to work, the latest stable will ignore the if= condition.) Using pagelist with the link-parameter causes on Strato an "Internal Server Error:" "The server encountered an internal error or misconfiguration and was unable to complete your request. Please contact the server administrator, service@webmailer.de and inform them of the time the error occurred, and anything you might have done that may have caused the error. More information about this error may be available in the server error log." The same thing happens when trying to search something or when trying to load the PmWikiDe/DocumentationIndex page. Are there ideas for a workaround? I had a similar error on Free.fr due to a local misconfiguration of PHP4. Switching the website to PHP5 solved the issue. As Strato supports different versions of PHP4 and 5, you should try all and tell us if/when it works. (Read the FAQs: you need to rename your index.php to index.php5, or add in your /.htaccess the code: " order=ctime displays the pages in the order they were created. Is there a way to reverse this (so that the newest page appears first)? Yes. Use A pagelist excludes the current page from the generated list if "list=normal", how can the current page be included while retaining all the other benefits of using "list=normal"? Set in config.php this: Then use Is it possible to return a list of all pages that are not protected by the sitepassword? Experimenting with the "passwd="-attribute didn't get me very far... How do I capture the output from "fmt=count" into a page text variable. I want to test if the pagelist returns any items, or to separate the pagelist into two columns.
Category: Searching
PageDirectives Can I get Use Is there any way to prevent the "redirected from" message from showing at the top of the target page when I use There are several possibilities. If you want to suppress the message in all cases
If you want to suppress the message based on the destination/target of the redirect
If you want to suppress the message based on the origin/source of the redirect
if (@$_GET['from']) {
$group = PageVar($_GET['from'], '$Group');
if ($group == 'SomeGroup') $PageRedirectFmt = '';
}
(In the above code example, you might replace SomeGroup with Profiles.)
An alternative is the include the other page rather than redirect. There are two cookbook recipes that may assist Is there any method for redirecting to the equivalent page in a different group, i.e. from BadGroup/thispage => GoodGroup/thispage using similar markup to (:redirect Goodgroup.{Name}:)? (:redirect Goodgroup.{$Name}:) works if you want to put it in one page.
If you want it to work for the entire group, put (:redirect Goodgroup.{*$Name}:) into Badgroup.GroupHeader - however, that only works with pages that really exist in Goodgroup; if you visit a page in Badgroup without a corresponding page of the same name in Goodgroup, instead of being redirected to a nonexistant page, you get the redirect Directive at the top of the page.
With (:if exists Goodgroup.{*$Name}:)(:redirect Goodgroup.{*$Name}:)(:ifend:) in Badgroup.GroupHeader you get redirected to Goodgroup.Name if it exists, otherwise you get Badgroup.Name without the bit of code displayed.
DeletingPagesDeleting Groups & Categories: Once I create a Group or Category, how can I get rid of that group or category? An admin can just remove the unwanted pages from wiki.d/ . Normally, doing it via the wiki doesn't resolve the problem, since it counts as an "update" which causes the RecentChanges page to be re-created, but it is possible to modify the site's configuration to allow deletion of the group's RecentChanges page -- see Cookbook:RecentChangesDeletion. PmWiki InstallationShould I rename pmwiki.php to index.php? Renaming pmwiki.php is not recommended. Instead, create an index.php file that contains this single line <?php include_once('pmwiki.php');
How do I make pmwiki.php the default page for a website? Create an index.php file that runs PmWiki from a subdirectory (pmwiki/ for example) and place it in the site's web document root (the main directory for the website). <?php chdir('pmwiki'); include_once('pmwiki.php');
Note: You will also need to explicitly set the How do I enable "Clean URLs" that are shorter and look like paths to my wiki pages? Why does pmwiki.org appear to have a directory structure rather than "?n=pagename" in URLs? See Cookbook:CleanUrls. Is it possible to move wiki.d to /tmp/persistent/foo/wiki.d (a new sourceforge rule)? Sourceforge suggests moving everything to /tmp/persistent/new-folder-of-your-choice/ and creating a symbolic link to the new folder on /tmp . It works -- see Cookbook:SourceForgeServers. How can I run PmWiki on a standalone (offline, portable) machine ? UpgradesHow can I determine what version of PmWiki I'm running now? See version - Determining and displaying the current version of PmWiki (pmwiki-2.2.0-beta66). How can I test a new version of PmWiki on my wiki without changing the prior version used by visitors? The easy way to do this is to install the new version in a separate directory, and for the new version set (in local/config.php):
$WikiLibDirs = array(&$WikiDir,
new PageStore('/path/to/existing/wiki.d/{$FullName}'),
new PageStore('wikilib.d/{$FullName}'));
This lets you test the new version using existing page content without impacting the existing site or risking modification of the pages. (Of course, any recipes or local customizations have to be installed in the new version as well.) Then, once you're comfortable that the new version seems to work as well as the old, it's safe to upgrade the old version (and one knows of any configuration or page changes that need to be made). Uploads AdministrationHow do I disable uploading of a certain type of file? Here's an example of what to add to your local/config.php file to disable uploading of .zip files: $UploadExtSize['zip'] = 0; # Disallow uploading .zip files.
How do I attach uploads to individual pages or the entire site, instead of organizing them by wiki group? Use the $UploadPrefixFmt = '/$FullName'; # per-page
$UploadPrefixFmt = ''; # site-wide
For Units are in bytes. 100K: $UploadDirQuota = 102400; 1MB: $UploadDirQuota = 1048576; 1GB: $UploadDirQuota = 1073741824; 1TB: $UploadDirQuota = 1099511627776;pm Is it possible to eliminate the "Name attachment as:" box so the uploaded file uses the same filename and the selected file? jb Yes. Put the following code into you config.php file:
$PageUploadFmt = array("
<div id='wikiupload'>
<h2 class='wikiaction'>$[Attachments for] {\$FullName}</h2>
<h3>\$UploadResult</h3>
<form enctype='multipart/form-data' action='{\$PageUrl}'
method='post'>
<input type='hidden' name='n' value='{\$FullName}' />
<input type='hidden' name='action' value='postupload' />
<table border='0'>
<tr><td align='right'>$[File to upload:]</td><td><input
name='uploadfile' type='file' /><input type='submit'
value='Upload' /></td></tr></table></form></div>",
'wiki:$[{$SiteGroup}/UploadQuickReference]');
Is there a way to allow file names with Unicode or addtiional characters? Yes, see Where is the list of attachments stored? JanBrejcha It is generated on the fly by the (:attachlist:) markup. In my lan-only pmwiki, how can I authorize ANY upload, without any size nor type checking? At the moment, I force my lan-only fully-trusted users to use a container such as .tar... Mhhh... Not that nice.
How can I find orphaned or missing attachments See Cookbook:Attachlist enhanced How to list missing or orphaned attachments. How can I prevent hotlinking of my uploaded images See Cookbook:Prevent Hotlinking Prevent hotlinking of uploaded files SecurityHow do I report a possible security vulnerability of PmWiki? Pm wrote about this in a post to pmwiki-users from September 2006. In a nutshell he differentiates two cases:
See his post mentioned above for details and rationals. What about the botnet security advisory at http://isc.sans.org/diary.php?storyid=1672? Sites that are running with PHP's register_globals setting set to "On" and versions of PmWiki prior to 2.1.21 may be vulnerable to a botnet exploit that is taking advantage of a bug in PHP. The vulnerability can be closed by turning register_globals off, upgrading to PmWiki 2.1.21 or later, or upgrading to PHP versions 4.4.3 or 5.1.4. Wiki Vandalism
how do I stop pages being deleted, eg password protect a page from deletion? use Cookbook:DeleteAction and password protect the page deletion action? by adding or how do I stop pages being replaced with an empty (all spaces) page? Add how do I stop pages being completely replaced by an inane comment such as excellent site, great information, where the content cannot be blocked? Try using the newer automatic blocklists that pool information and IP addresses about known wiki defacers. or Try using Cookbook:Captchas Uses captchas to protect certain actions from spambots or Cookbook:Captcha Use captchas to prevent automated systems from modifying pages, (note these are different} or Set an edit password, but make it publicly available on the Site.AuthForm template. how do I password protect all common pages in all groups such as recent changes, search, group header, group footer, and so on? insert the following lines into your local/config.php file. Editing these pages then requires the admin password.
## Require admin password to edit RecentChanges (etc.) pages.
if ($action=='edit'
&& preg_match('/\\.(Search|Group(Header|Footer)|(All)?RecentChanges)$/', $pagename))
{ $DefaultPasswords['edit'] = crypt('secret phrase'); }
Note that all GroupAttributes pages are protected by the attr password. Alternative:
I think because of my clean URLs setup I had to shorten the regular expression a little to make it work. furthermore I set the edit password for these pages to the admin password set in
## Require admin password to edit RecentChanges (etc.) pages.
if ($action=='edit'
&& preg_match('(Search|Group(Header|Footer)|(All)?RecentChanges)', $pagename))
{ $HandleAuth['edit'] = 'admin'; }
As far as I could see in my tests this seems to work for me as expected. --Rico, 2007-02-02 how do I password protect the creation of new groups? see Cookbook:Limit Wiki Groups How to limit the names or number of groups in your wiki how do I password protect the creation of new pages? see Cookbook:Limit new pages in Wiki Groups How to limit the creation of new pages in your wiki group how do I take a whitelist approach where users from known or trusted IP addresses can edit, and others require a password? Put these lines to local/config.php:
## Allow passwordless editing from own turf, pass for others.
if ($action=='edit'
&& !preg_match("^90.68.", $_SERVER['REMOTE_ADDR']) )
{ $DefaultPasswords['edit'] = crypt('foobar'); }
Replace 90.68. with the preferred network prefix and foobar with the default password for others. how do I, in ? how do I password protect page actions? see Passwords for setting in config.php or How do I only allow authors to post if they have a Profile? Add this to your local/config.php below if(!PageExists('Profiles.'.$Author)&&$action=='edit')
This is a possible solution, but be warned: author can't edit their wiki page in Profiles? group too.
Add How to make a rule that allows only authors to edit their own wiki page in Profiles? group? Add this to your local/config.php $name = PageVar($pagename, '$Name');
if($group=='Profiles')
how do I moderate all postings? Enable PmWiki.Drafts
Custom InterMapAre InterMap names case sensitive? Yes, thus How can I achieve a localmap.txt mapping with the effect of Use the following: Pics: /somepathto/pics/
Is there any chance to get the InterMap part of the class selector of the resulting Link? Means Wikipedia:Example gets <a href="..." class="wikipedia"> - automatically without writing a special LinkIMap entry for every InterMap entry? CustomMarkupHow can I embed JavaScript into a page's output? There are several ways to do this. The Cookbook:JavaScript recipe describes a simple means for embedding static JavaScript into web pages using custom markup. For editing JavaScript directly in wiki pages (which can pose various security risks), see the JavaScript-Editable recipe. For JavaScript that is to appear in headers or footers of pages, the skin template can be modified directly, or <script> statements can be inserted using the How would I create a markup ((:nodiscussion:)) that will set a page variable ({$HideDiscussion}) which can be used by (:if enabled HideDiscussion:) in .PageActions? ejersau? May 07, 2007, at 06:27 PM Add the following section of code to your config.php
SDV($HideDiscussion, 0); #define var name
Markup('hideDiscussion', '<{$var}', '/\\(:nodiscussion:\\)/e', 'setHideDiscussion(true)');
function setHideDiscussion($val) {
global $HideDiscussion;
$HideDiscussion = $val;
}
This will enable the PmWiki only supports tool tips for external links, can I use custom markup to add tool tips to internal links? Yes, add the following custom markup to your config.php: Use the markup with internal links such as: (jtankers) August 22, 2007 I'm trying to create a markup that takes arbitrary text and stores it in a custom page variable so that variable can be accessed later through the page variable markup (I'm using version 2.1.27). Thus far, I have this line in my config file: Markup('authors', '_begin', "/\\(:authors\\s+(.+?):\\)/ei", "PZZ(\$GLOBALS['FmtPV']['\$Authors'] = '$1')"). It works reasonably well except that it doesn't match text with spaces in it. For example, I can access the variable correctly if use (:authors Tyrel:) but not with (:authors Tyrel Newton:). Where am I going wrong? tyrel Oct 25, 2007 It appears that (.*?) does not match newlines in these functions, making the above example inoperable if the text to be wrappen in <em> contains new lines. If you include the "s" modifier on the regular expression then the dot (.) will match newlines. Thus your regular expression will be "/STUFF(.*?)/s". That s at the very end is what you are looking for. If you start getting into multi-line regexes you may be forced to look at the m option as well - let's anchors (^ and $) match not begin/end of strings but also begin/end of lines (i.e., right before/after a newline). See also Cookbook:LinkTitles How do I get started writing recipes and creating my own custom markup? InternationalizationsIf my wiki is internationalized by config.php, how do I revert a specific group to English? Use If my wiki is in English and I want just one page, or group, in Spanish do I say Yes, that is usually the best method. If you were doing this with many scattered pages, or with several languages, you might find it easier to maintain if you load the translations all in config.php like this: XLPage('es','PmWikiEs.XLPage');
XLPage('fr','PmWikiFr.XLPage');
XLPage('ru','PmWikiRu.XLPage');
Then in each group or page configuration file, you'd just use What does the first parameter of this function stand for? How can it be used? The XLPage mechanism allows multiple sets of translations to be loaded, and the first parameter is used to distinguish them. For example, suppose I want to have translations for both normal French and "Canadian" French. Rather than maintain two entirely separate sets of pages, I could do: XLPage('fr', 'PmWikiFr.XLPage');
XLPage('fr-ca', 'PmWikiFrCa.XLPage');
PmWikiFr.XLPage would contain all of the standard French translations, while PmWikiFrCA.XLPage would only need to contain "Canada-specific" translations -- i.e., those that are different from the ones in the French page. The first parameter distinguishes the two sets of translations.
In addition, a config.php script can use the and PmWiki will use only the 'fr' and 'en' translations (in that order), no matter how many translations have been loaded with XLPage(). Tools for PmWiki LocalizationYou can help to localize PmWiki in your language in the original site: Translation Portal I think it may be of some use to have a central page devoted to translation (aimed to translators) - the present page is for i18n by users. the translation portal is a central hub for translators as starting point jdd Unfortunately, an anonymous contributor have deleted on march,16 the link to the localization page, so it have disappeared in space. It was intended to be the resource you are searching for. I think these two pages shall be merged somewhat. The same contributor also have made an energic cleaning of the Internationalization page and the pertinence of all that erasing shall be carefully checked.PRZ feel free to restore it!
The creation of a "localization" group is a very good idea (I'm too new here to take such decision :-), but I think keeping at least one page aimed to translators in the PmWiki group is a good idea, must simpler to find, I guess. the other translator pages should be moved to the new group. jdd Multilingual pmWiki-based website, is it possible? Would it be possible to set pmwiki in a way that allows to maintain a multilingual website? I realize when you discuss i10n and l18n you refer to the wiki system itself, but on the content level it may be more than desirable, especially if the user may select his/her desired language for the content. VirtualFlavius?
LocalCustomizations Can I change the default page something other than Main.HomePage ( Yes, just set the $DefaultPage = 'ABC.StartPage';
How do I get the group / page name in a local configuration file (e.g. local/config.php)? Use the following markup in pmwiki-2.1.beta21 or newer: ## Get the group and page name $pagename = ResolvePageName($pagename); $page = PageVar($pagename, '$FullName'); $group = PageVar($pagename, '$Group'); $name = PageVar($pagename, '$Name'); Can I remove items from the wikilib.d folder on my site? Yes, the files in wikilib.d/ can be safely removed. They'll reappear again when you upgrade, however. How do I customize my own 404 error page for non-existent pages? To change the text of the message, try editing the Site.PageNotFound page. PerGroupCustomizationsHow can I apply CSS styles to a particular group or page? Simply create a pub/css/Group.css or pub/css/Group.Page.css file containing the custom CSS styles for that group or page. Why shouldn't passwords be set in group (or page) customization files? The reason for this advice is that per-group customization files are only loaded for the current page. So, if
and because the GroupA.php file wasn't loaded (we're looking at Main.WikiSandbox --> local/Main.php), there's no read password set. The same is true for page customization files. Isn't that processing order strange? Why not load per page configuration last (that is after global configuration an per group configuration)? Many times what we want to do is to enable a certain capability for a group of pages, but disable it on a specific page, as if it was never enabled. If the per-group config file is processed first, then it becomes very difficult/tedious for the per-page one to "undo" the effects of the per-group page. So, we load the per-page file before the per-group. If a per-page customization wants the per-group customizations to be performed first, it can use the techniques given in PmWiki.PerGroupCustomizations (using include_once() or setting SkinsHow do I change the Wiki's default name in the upper left corner of the Main Page? Put the following config.php $WikiTitle = 'My Wiki Site';
The docs/sample-config.php file has an example of changing the title. How can I embed PmWiki pages inside a web page? Source them through a PHP page, or place them in a frame. How do I change the font or background color of the hints block on the Edit Page? Add a CSS style to pub/css/local.css: WebFeedsHow do I include text from the page (whole page, or first X characters) in the feed body? (note: markup NOT digested) function MarkupExcerpt($pagename) {
$page = RetrieveAuthPage($pagename, 'read', false);
return substr(@$page['text'], 0, 200);
}
Q:Does this mean if I want to include the time in the rss title and "summary" to rss body I call $FeedFmt['rss']['item']['description'] = '$LastSummary';
$FeedFmt['rss']['item']['title'] = '{$Group} / {$Title} @ $ItemISOTime';
What if I want the text included to be marked up to HTML? From mailing list June 26, 2007, by Roman:
$FeedFmt['rss']['item']['description'] = 'FeedText';
function FeedText($pagename, &$page, $tag) {
$p = ReadPage($pagename);
$content = MarkupToHTML($pagename, $p['text']);
return "<$tag><![CDATA[$content]]></$tag>";
}
How do I include the last change (the last diff section) in the feed body ? I would like to see directly what has been modified. How can I use the RSS <enclosure> tag for podcasting? For podcasting of mp3 files, simply attach an mp3 file to the page with the same name as the page (i.e., for a page named Podcast.Episode4, one would attach to that page a file named "Episode4.mp3"). The file is automatically picked up by ?action=rss and used as an enclosure. The set of potential enclosures is given by the $RSSEnclosureFmt array, thus $RSSEnclosureFmt = array('{$Name}.mp3', '{$Name}.wma', '{$Name}.ogg');
allows podcasting in mp3, wma, and ogg formats. How to add "summary" to the title in a rss feed (ie. with Add this line in you $FeedFmt['rss']['item']['title'] = '{$Group} / {$Title} : $LastModifiedSummary';
How to add "description" to the title in an rss feed, and summary to the body? Add these lines to your $FeedFmt['rss']['item']['title'] = '{$Group} / {$Title} : {$Description}';
$FeedFmt['rss']['item']['description'] = '$LastModifiedSummary';
-OtherMichael, based on the "summary" example, above
NOTES:
Some of my password-protected pages aren't appearing in the feed... how do I work around this? From a similar question on the newsgroup, Pm's reply: The last time I checked, RSS and other syndication protocols didn't really have a well-established interface or mechanism for performing access control (i.e., authentication). As far as I know this is still the case. PmWiki's WebFeeds capability is built on top of pagelists, so it
could simply be that the The "downside" to setting You could also set if ($action == 'rss')
This limits the ability to see the protected pages to RSS feeds; normal pagelists and searches wouldn't see them. Lastly, it's also possible to configure the webfeeds to obtain the authentication information from the url directly, as in: .../Site/AllRecentChanges?action=rss&authpw=secret The big downside to this is that the cleartext password will end up travelling across the net with every RSS request, and may end up being recorded in Apache's access logs. How to add feed image? Add the following to local/config.php (this example is for $FeedFmt['rss']['feed']['image'] = "<title>Logo title</title> <link>http://example.com/</link> <url>http://example.com/images/logo.gif</url> <width>120</width> <height>60</height>"; How do I insert RSS news feeds into PmWiki pages? How can I specify default feed options in a configuration file instead of always placing them in the url? For example, if you want
if ($action == 'rss')
SDVA($_REQUEST, array(
'group' => 'News',
'order' => '-time',
'count' => 10));
FAQTroubleshootingWhy am I seeing strange errors after upgrading? Make sure all of the files were updated, in particular pmwiki.php. This question sometimes arises when an administrator hasn't followed the advice, which used to be less prominent, on the installation and initial setup tasks pages and has renamed pmwiki.php instead of creating an index.php wrapper script. If you have renamed pmwiki.php to index.php, then the upgrade procedure won't have updated your index.php file. Delete the old version and create a wrapper script so it won't happen again. Sometimes an FTP or other copy program will fail to transfer all of the files properly. One way to check for this is by comparing file sizes. Be sure all of the files in the wikilib.d/ directory were also upgraded. Sometimes it's a good idea to simply delete the wikilib.d/ directory before upgrading. (Local copies of pages are stored in wiki.d/ and not wikilib.d/.) I'm suddenly getting messages like " Something (or someone) has changed the permissions on the wiki.d/.flock file or the wiki.d/ directory such that the webserver is no longer able to write the lockfile. The normal solution is to simply delete the .flock file from the wiki.d/ directory -- PmWiki will then create a new one. Also be sure to check the permissions on the wiki.d/ directory itself. (One can easily check and modify permissions of the wiki.d/ directory in FileZilla (open-source FTP app) by right-clicking on the file > File attributes) One other possibility is that you have recently moved the wiki and you were previously using EnableIMSCaching. Disable EnableIMSCaching in your local/config.php file and that could fix the problem RussFink (this information subject to review) My links in the sidebar seem to be pointing to non-existent pages, even though I know I created the pages. Where are the pages? Links in the sidebar normally need to be qualified by a WikiGroup in order to work properly. Otherwise they will point to whatever group you happen to be viewing the sidebar in. Why am I seeing " If this is the first or only error message you're seeing, it's usually an indication that there are blank lines or spaces before the If the warning is appearing after some other warning or error message, then resolve the other error and this warning may go away. How do I make a PHP Warning about If you are seeing an error similar to this Warning: session_write_close() [function.session-write-close]: open(/some/filesystem/path/to/a/directory/sess_[...]) failed: No such file or directory (2) in /your/filesystem/path/to/pmwiki.php on line NNN PmWiki sometimes does session-tracking using PHP's session-handling functions. For session-tracking to work, some information needs to be written in a directory on the server. That directory needs to exist and be writable by the webserver software. For this example, the webserver software is configured to write sessions in this directory /some/filesystem/path/to/a/directory/
but the directory doesn't exist. The solution is to do at least one of these:
session_save_path('/home/someuser/tmp/sessions');
Why is PmWiki prompting me multiple times for a password I've already entered? Usually this is an indication that the browser isn't accepting cookies, or that PHP's session handling functions on the server aren't properly configured. If the browser is accepting cookies, then try setting I edited config.php, but when I look at my wiki pages, all I see is " You've made a mistake in writing the PHP that goes into the config.php file. The most common mistake that causes the T_VARIABLE error is forgetting the semi-colon (;) at the end of a line that you added. The line number and file named are where you should look for the mistake. Searches and pagelists stopped working after I upgraded -- no errors are reported, but links to other pages do not appear (or do not appear as they should) -- what gives? Be sure all of the files in the wikilib.d/ directory were also upgraded. In particular, it sounds as if the Site.PageListTemplates page is either missing (if no links are displayed) or is an old version (if the links do not appear as they should). Allso make sure that read-permissions (attr) are set for the pages Site.PageListTemplates and Site.Search. Some of my posts are coming back with "403 Forbidden" errors, "Not Acceptable", or "Internal Server Error". This happens with some posts but not others. Your webserver probably has mod_security enabled. The mod_security "feature" scans all incoming posts for forbidden words or phrases that might indicate someone is trying to hack the system, and if any of them are present then Apache returns the 403 Forbidden error. Common phrases that tend to trigger mod_security include "curl ", "wget", "file(", and "system(", although there are many others. Since mod_security intercepts the requests and sends the "forbidden"
message before PmWiki ever gets a chance to run, it's not a bug in PmWiki, and
there's little that PmWiki can do about it. Instead, one has to alter the
webserver configuration to disable mod_security or reconfigure it to allow
whatever word it is forbidding. Some sites may be able to disable mod_security
by placing I get the following message when attempting to upload an image, what do I do?
Your server is configured with PHP Safe Mode enabled. Configure your wiki to use a site-wide uploads prefix, then create the uploads/ directory manually and set 777 permissions on it (rather than letting PmWiki create the directory). I'm starting to see "Division by zero error in pmwiki.php..." on my site. What's wrong? It's a bug in PmWiki that occurs only with the tables markup and only for versions of PHP >= 4.4.6 or >= 5.2.0. Often it seems to occur "out of nowhere" because the server administrator has upgraded PHP. Try upgrading to a later version of PmWiki to remove the error, or try setting the following in local/config.php: AuthUserI get http error 500 "Internal Server Error" when I try to log in. What's wrong? This can happen if the encrypted passwords are not created on the web server that hosts the PmWiki. The crypt function changed during the PHP development, e.g. a password encrypted with PHP 5.2 can not be decrypted in PHP 5.1, but PHP 5.2 can decrypt passwords created by PHP 5.1. This situation normally happens if you prepare everything on your local machine with the latest PHP version and you upload the passwords to a webserver which is running an older version. The same error occurs when you add encrypted passwords to local/config.php. Solution: Create the passwords on the system with the oldest PHP version and use them on all other systems. Can I specify authorization group memberships from with local/config.php? Yes -- put the group definition into the $AuthUser array: $AuthUser['@editors'] = array('alice', 'carol', 'bob');
I'm running multiple wikis under the same domain name, and logins from one wiki are appearing on other wikis. Shouldn't they be independent? This is caused by the way that PHP treats sessions. See PmWiki.AuthUser#sessions for more details. How can I access the authorization groups that the current user belongs to in order to test using that as a condition of an if statement? Is there any way to have groups inherit other groups (e.g. @fruits: @apples, @oranges, jack)? Is it possible to list more than one .htpasswd and .htgroup file to be used? e.g. if I am running a wikifarm and some users are common across various fields, it would be nice if they only needed to update their password once. Sure I could merge all the passwd & group files, but then I wouldn't be able to support identical user or group names on each independent wikifield.. Is there any way to record the time of the last login for each user when using AuthUser? I need a way to look for stale accounts. I wrote a recipe to do something like this. It records the last action for each user (not necessarily just login actions). See Cookbook:UserLastAction for more info. --Lordmundi March 23, 2007 I want to allow anyone to edit my wiki, but don't want anyone else to use my name as the author. Is there a way to "reserve" and password protect certain usernames? Or basically just require a password when attempting to edit a page with a registered user's name in the author field? Though every settings seem correct, authentication against LDAP is not working, and there is nothing in ldap log. What's wrong ? Be sure ldap php module is installed ( on debian apt-get install php(4|5)-ldap ; apache(2)ctl graceful ) ! -- July 18, 2007 I'm facing a problem with authentication using MySQL database. New user registration works but login always fails asking for correct user name and password even though proper values are entered. Where could be the problem? The login form asks for username and password, but only password matters. Username can be left blank and it still signs in under the account. Is this intentional and if so, can I change it so that the username and password must both be entered? - X 1/18/07 Nevermind I think this has something to do with using the admin password. I created a test account and it's working ok. Is there any way to hide IP addresses once someone has logged in so that registered users can keep their IP addresses invisible to everyone except administrators? - X 1/18/07 (:comment:)
I have been trying to set site-wide authorizations and getting really frustrated. I have the following lines in my config.php:
What gives? biocwiki.physics.indiana.edu/~abalter/pmwiki/pmwiki.php PasswordsAdminThere seems to be a default password. What is it? There isn't any valid password until you set one. Passwords admin describes how to set one. PmWiki comes "out of the box" with How do I use passwd-formatted files (like .htpasswd) for authentication? See AuthUser or Cookbook:UserAuth Is there anything I can enter in a GroupAttributes field to say 'same as the admin password'? If not, is there anything I can put into the config.php file to have the same effect? For the sitewide edit password (in config.php), use '@_site_edit'. I haven't tested this, but I think one can also use '@_site_admin', '@_site_read', '@_site_attr', etc. for the other site-wide passwords set in config.php. '@admin' is used to specify the site admin password. How do I edit protect, say, all RecentChanges pages? How can I read password protect all pages in a group except the HomePage using configuration files? As described in PmWiki.PerGroupCustomizations per-group or per-page configuration files should not be used for defining passwords. The reason is that per-group (or per-page) customization files are only loaded for the current page. So, if
and because the GroupA.php file wasn't loaded (we're looking at Main.WikiSandbox --> local/Main.php), there's no read password set. How can I password protect the creation of new pages? One solution is described in Cookbook.Limit Wiki Groups, are there any others? How do I change the password prompt screen? If your question is about how to make changes to that page... edit Site.AuthForm. If your question is about how to change which page you are sent to when prompted for a password, you might check out the |
| Figure 1