HelpOnMacros


Joi's Wiki has moved to [WWW]a new SocialText wiki
This Wiki is now disabled.

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

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.

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. CategoryEmergentDemocracy . . . . 1 match
  5. CategoryHomepage . . . . 1 match
  6. FindPage . . . . 1 match
  7. PhilWolff . . . . 1 match
  8. 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

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 GoingToJapan--
[[RandomPage(#)]] links to a number of random pages Two random pages:
[[TableOfContents]] display a local table of contents See below
[[Anchor(anchorname)]] macro to insert anchors into a page #here

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 483 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

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
[[Include(HelloWorld[,"heading"[,level]])]] include contents of another page
[[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 2004-10-20
[[DateTime(timestamp)]] display a timestamp1 according to user settings 2004-10-20 06:56:21 JST
[[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

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: