UserPreferences

HelpOnMacros

/Include   /MailTo  
  1. Macros
    1. Search macros
    2. Navigation
    3. System information
    4. Others
  2. Example Display

1. Macros

Macros allow the insertion of system features into normal wiki pages; the only thing that makes those pages special is that they contain macros. If you edit pages like RecentChanges or SystemInfo, you'll see what that means.

For more information on the possible markup, see HelpOnEditing.

1.1. Search macros

Macro Description Example
[[TitleSearch]] search the page titles See the FindPage
[[FullSearch]] search the page contents See the FindPage
[[FullSearch()]] search for the current title in all pages (like clicking on the page title) See the CategoryCategory page
[[FullSearch('text')]] search for "text" in all pages Search for FullSearch:
  1. HelpOnMacros . . . . 6 matches
  2. HelpOnActions . . . . 3 matches
  3. CategoryCategory . . . . 1 match
  4. FindPage . . . . 1 match
  5. SiteNavigation . . . . 1 match
[[GoTo]] directly go to the page you enter See the FindPage
[[PageList(regex)]] list of pages whose title matches the regex See the HelpIndex

1.2. Navigation

Macro Description Example
[[RecentChanges]] a list of recently edited pages See RecentChanges
[[TitleIndex]] an index of all page titles See TitleIndex
[[WordIndex]] an index of all words in page titles See WordIndex
[[WantedPages]] list links to non-existent pages See WantedPages
[[OrphanedPages]] list pages no other page links to See OrphanedPages
[[AbandonedPages]] list pages that were not edited for the longest time See AbandonedPages
[[RandomPage]] a link to a random page InterWiki
[[RandomPage(#)]] links to a number of random pages Two random pages:
[[TableOfContents([maxdepth])]] display a local table of contents, possibly limited to a maximal depth See above
[[Anchor(anchorname)]] macro to insert anchors into a page #here
[[Navigation(children[,maxdepth])]] macro to list all of a pages' children See start of this page
[[Navigation(siblings[,maxdepth])]] quick navigation to siblings of a page See /MailTo
[[Navigation(slideshow)]] creates a link to toggle between slide show and wiki mode, and a link to start the slide show See HelpOnSlideShows
[[Navigation(slides)]] displays first/prev/next/last links See HelpOnSlideShows

1.3. System information

Macro Description Example
[[InterWiki]] a list of all known InterWiki names InterWiki
[[SystemInfo]] info on the wiki, the python interpreter and the host system SystemInfo
[[PageCount]] current page count 149 pages
[[PageSize]] list the sizes of all pages See PageSize
[[StatsChart(type)]] shows statistical charts (currently defined types: hitcounts, pagesize, useragents) See EventStats and subpages
[[SystemAdmin]] Web interface to wiki administration (not completed yet as of version 1.0) See SystemInfo

1.4. Others

Macro Description Example
[[Icon(image)]] display system icons See HelpOnNavigation
[[UserPreferences]] display a user preferences dialog See UserPreferences
[[BR]] insert a line break 1st line
2nd line
[[RandomQuote(pagename)]] Select a random quote from the given page, or from FortuneCookies if ommitted
"A reader who chanced to be ignorant of the Glass Bead Game might imagine such a Game pattern as rather similar to the pattern of a chess game, except that the significance of the pieces and the potentialities of their relationships to one another and their effect upon one another multiplied manyfold and an actual content must be ascribed to each piece, each constellation, each chess move, of which this move, configuration, and so on is the symbol." --Hermann Hesse
[[Include(HelloWorld[,"heading"[,level]])]] include contents of another page for details see /Include
[[FootNote(text)]] Add a footnote (the text cannot contain any wiki markup), or explicitely display collected footnotes when no args are given See HelpOnPageCreation for an example
[[Date(timestamp)]] display a timestamp according to system settings 2008-12-05
[[DateTime(timestamp)]] display a timestamp1 according to user settings 2008-12-05 12:37:16
[[GetText(text)]] loads I18N texts (mainly intended for use on Help pages) "EditText" is translated to "EditText"
[[TeudView]] useful for intranet developer wikis, a means to view pydoc documentation, formatted via a XSLT stylesheet, for details see [EfnetPythonWiki]TeudProject See [EfnetPythonWiki]TeudViewer?module=MoinMoin.macro.TeudView
[[MailTo(email)]] protect your email address from spam bots for details see /MailTo

2. Example Display

We don't show examples for all macros here, because that would make this page quite long. Here is is the replacement text for the [[SystemInfo]] macro: