welcome: please sign in
Page Locked

HelpOnProcessingInstructions

HelpForUsers > HelpOnEditing > HelpOnProcessingInstructions

MoinMoin processing instructions have the same semantics as in XML: they control the paths taken when processing a page. Processing Instructions (PIs) are lines that start with a "#" character followed by a keyword and optionally some arguments; the keyword is always handled case-insensitive. Two consecutive hash marks at the start of a line are a comment that won't appear in the processed page.

All PIs must appear at the very start of a page. An exception are comment PIs, those may appear anywhere within a page using "wiki" format, but not in pages using other formats.

For more information on the possible markup, see HelpOnEditing.

Processing instructions MoinMoin knows of:

1. ## comment

## a comment, any text here is ignored

2. #format

Defines the input format for this page.

#FORMAT format-specifier optional-arguments

format-specifier can be:

Some parsers can accept optional arguments. Check the documentation of the parser for the possible options.

3. #redirect

Redirect to a different page (see PageRedirect)

#REDIRECT pagename

4. #refresh

Redirect to a different page (or an external URL or just refresh the same page, if left out)

#REFRESH delay target

target can be either a page name, or a fully qualified url. Here are two examples:

#refresh 0 FrontPage
#refresh 5 http://example.com/

5. #pragma

Sets processing modes for this page:

#PRAGMA mode arguments

Mode names are not case-sensitive.

MoinMoin knows few pragmas, and you may add more and use them for your own themes or macros. Here are the known pragmas:

5.1. section-numbers

Switches automatic numbering of section headers.

#pragma section-numbers off

off or 0 disable numbering, on or 1 enables numbering. The default mode is set by the show_section_numbers config option.

When enabling numbering, its possible to use specific heading level:

#pragma section-numbers 2

Only displays section numbers for headings of level 2 and up (similarly for 3 to 6).

5.2. keywords

adds a <meta> tag with keywords which tells search engines what you can find on the particular page.

#pragma keywords Cars, Vehicles, Foo

5.3. description

adds a <meta> tag which contains the description of the particular page.

#pragma description This page is about cars.

5.4. supplementation

is used to enable or disable a supplementation for the current page e.g. a discussion page

#pragma supplementation-page on

off disables the supplementation for the current page. See also HelpOnConfiguration/SupplementationPage for more.

6. #deprecated

Mark this page as deprecated.

#DEPRECATED

Further changes to the page will create no backup versions and using it will cause the current revision to show along with the revision previous to the deprecation. This allows you to remove all of the page's content, insert #deprecated, and then write a short message explaining the reason behind this action. By doing this you are effectively freezing the last version of the page, making it unavailable for searches (no hits on stale content), but you are keeping the content available for viewing.

7. #language

Set page language and direction.

#language language-name

Set page language and direction. Language name is the iso-639-1 code. MoinMoin ignore languages that does not have a translation file in MoinMoin/i18n/. See also HelpOnLanguages.