PmWiki | PmWiki / PageDirectives browse

PmWiki uses a number of directives to specify page titles, descriptions, page keywords, and control the display of various components.

(:attachlist:)

Shows a list of attachments of the current group or page, depending on whether attachments are organised per group or per page. The attachlist is displayed at the foot of the uploads page form.

Options: (:attachlist NAME:) shows a list of attachments of the group or page NAME. (:attachlist ext=xxx:) specifies an extension for filtering by type of file.

(:description text:): Descriptive text associated with the page. (Generates a <meta name='description' content='...' /> element in the page output.)

(:keywords word1, word2, ...:): Identifies keywords associated with the page. These are not displayed anywhere, but are useful to help search engines locate the page. (Essentially, this generates a <meta name='keywords' content='...' /> element in the output.)

(:linebreaks:), (:nolinebreaks:): Honors any newlines in the markup; i.e., text entered on separate lines in the markup will appear as separate lines in the output. Use (:nolinebreaks:) to cause text lines to automatically join again.

(:linkwikiwords:), (:nolinkwikiwords:): Enables/disables WikiWord links in text.

(:markup:) ... (:markupend:): Can be used for markup examples, showing first the markup and then the result of the markup.

Options: (:markupend:) is not required when using (:markup:) [=...=].

Arguments: (:markup class=horiz:) and (:markup caption='...':)

(:nogroupheader:)
(:nogroupfooter:): Turns off any groupheader or groupfooter for the page. (See GroupHeaders.)

(:noheader:), (:nofooter:)
(:noleft:), (:noright:), (:notitle:): If supported by the skin, each of these turns off the corresponding portion of the page.

(:redirect PageName:)
(:redirect PageName status=301 from=name:): Redirects the browser to another page, along with a redirect message. For security reasons this only redirects to other pages within the wiki and does not redirect to external urls. The status= option can be used to return a different HTTP status code as part of the redirect. The from= option limits redirects to occuring only on pages matching the wildcarded name (helpful when (:redirect:) is in another page).

(:spacewikiwords:), (:nospacewikiwords:)

Enables/disables automatic spacing of WikiWords in text.

(:title text:): Sets a page's title to be something other than the page's name. The title text can contain apostrophes and other special characters. If there are multiple titles in a page, the last one encountered wins.

<< WikiStyle examples | Documentation Index | Include other pages >>

Can I get (:redirect:) to return a "moved permanently" (HTTP 301) status code?

Use (:redirect PageName status=301:).

Is there any way to prevent the "redirected from" message from showing at the top of the target page when I use (:redirect:)?

If you want to suppress the message...

in all cases, add add $PageRedirectFmt = ''; in your local/config.php
based on the destination/target of the redirect, add $PageRedirectFmt = ''; to a local/group.page.php or local/group.php file (see PmWiki.PerGroupCustomizations).
based on the origin/source of the redirect, add the following to your local/config.php

   if (@$_GET['from']) {
     $group = PageVar($_GET['from'], '$Group');
     if ($group == 'SomeGroup') $PageRedirectFmt = '';
   }

Example application: Replace 'SomeGroup' with 'Profiles'

This page may have a more recent version on pmwiki.org: PmWiki:PageDirectives, and a talk page: PmWiki:PageDirectives-Talk.

Page last modified on July 28, 2006, at 05:27 PM