Help On Processing Instructions

Help on: Editing | Formatting | Emoticons | Headers | Linking | Macros | Processing Instructions | Tables
[goto Help Menu]

Processing instructions control how a page is processed. Processing instructions must be entered at the first line, start with a hash (#) character followed by a keyword in capital letters and optionally followed by a space and an argument. Below are the processing instructions recognized by Open Wiki.

  • #REDIRECT
  • #RANDOMPAGE
  • #DEPRECATED
  • #MINOREDIT
  • #INCLUDE_AS_TEMPLATE
  • #REDIRECT

    The syntax for this processing instruction is:
        #REDIRECT <PageName>
    
    If this processing instruction appears on the first line of a page the contents of the page will not be shown, instead you will be redirected to the page <PageName>. This is useful because it allows similar pagenames to share the same page content. Redirections are not recursive, only the first redirection will be used.

    Example: if you go to Wiki Sand Box you will be redirected to Sand Box.

    Editing a redirected page is easy. In the above example, after you've been redirected, simply click on the title Wiki Sand Box and you're in the edit mode of that page. Click on the "Preview" button if you then want to see the page as it would look like if it wasn't redirected.

    #RANDOMPAGE

    This is a special case of the #REDIRECT processing instruction. If the #RANDOMPAGE processing instruction appears on the first line of a page you will be redirected to a random page.

    #DEPRECATED

    The #DEPRECATED processing instruction is used to mark a page as being deprecated. A deprecated page will be deleted after a certain number of days (determined by the administrator of this website).

    When you deprecate a page you should remove and/or change all references to the page. You can find all the references to the deprecated page by clicking on its title at the top.

    You can see which pages are deprecated and about to be destroyed permanently by entering the string ^#DEPRECATED in the Find box below a page and hitting the search button. Or see Deprecated Pages.

    #MINOREDIT

    If present on a page then when you go into edit mode for that page then the checkbox "Include page in RecentChanges list" is unchecked. In essence, you'd use this processing instruction on pages you're normally not interested in to see in the Recent Changes list if it gets modified.

    #INCLUDE_AS_TEMPLATE

    When you use the macro <Include>, then subpages on an included page are taken to be relative to the included page. When this processing instruction is defined in the included page, then the subpages on the included page are taken to be relative to the including page.