PmWiki uses a number of directives to specify page titles, descriptions, page keywords, and control the display of various components. Directive keywords are not case sensitive, e.g. Description, description, and DESCRIPTION are equivalent.
(: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.
(:attachlist *:)shows the uploads directory and permits browsing of all uploaded files by directory (will not work if
$EnableDirectDownloadis set to 0).
- 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.)
- 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.
- Enables/disables WikiWord links in text. Note, this setting requires WikiWords to be enabled, see
$EnableWikiWords. See also
(:markup:) ... (:markupend:)or
- Can be used for markup examples, showing first the markup and then the result of the markup.
(:markup class=horiz:)will show the markup side by side instead of one upon the other.
(:markup caption='...':)adds a caption to the markup example.
(:markupend:)is not required when using
[=...=]option then the opening
[=MUST occur on the same line as the
(:markup:). If you are using the full
(:markup:) ... (:markupend:)form then your markup code must appear AFTER a newline after the initial
- Displays messages from PmWiki or recipes, for instance from editing pages.
- Turns off the section of the skin marked by <!—PageActionFmt?--> thru <!--/PageActionFmt?-->. In the pmwiki skin, this turns off the display of the actions at the top-right of the page (other skins may locate the actions in other locations). The actions at the bottom of the page are still available.
- Turns off any groupheader or groupfooter for the page. (See GroupHeaders.)
(:noleft:), (:noright:), (:notitle:)
- If supported by the skin, each of these turns off the corresponding portion of the page.
- Redirects to another wiki page.
- Redirects to an anchor within a page
(:redirect PageName status=301 from=name quiet=1:)
- 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). The
quiet=1option allows the target page not to display a link back to the original page (
$EnableRedirectQuietvariable should be set to 1).
- 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 (see also
$EnablePageTitlePriorityabout how to change it).
Can I get
(:redirect:) to return a "moved permanently" (HTTP 301) status code?
(: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
From version 2.2.1 on, set in config.php
and in the page
(:redirect OtherPage quiet=1:) for a quiet redirect.
How can a wiki enable linebreaks by default, i.e. without having the directive
(:linebreaks:) in a page or in a GroupHeader?
Add to config.php such a line:
$HTMLPNewline = '<br/>';