Help On Macros - Wiki Linux-Québec

Macros
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 Recent Changes or System Info, you'll see what that means.

For more information on the possible markup, see Help On Editing.

Search macros

Macro	Description	Example
`[[TitleSearch]]`	search the page titles	See the Find Page
`[[FullSearch]]`	search the page contents	See the Find Page
`[[FullSearch()]]`	search for the current title in all pages (like clicking on the page title)	See the Category Category page
`[[FullSearch('text')]]`	search for "text" in all pages	Search for `FullSearch`: AiutoSuMacro . . . . 6 matches HelpOnMacros . . . . 6 matches HilfeZuMakros . . . . 6 matches HjälpMedMakron . . . . 6 matches AideActions . . . . 3 matches AiutoSuAzioni . . . . 3 matches HelpOnActions . . . . 3 matches HilfeZuAktionen . . . . 3 matches HjälpMedÅtgärder . . . . 3 matches CategoryCategory . . . . 1 match CercaPagina . . . . 1 match FindPage . . . . 1 match FindSide . . . . 1 match KategoriKategori . . . . 1 match KategorieHomepage . . . . 1 match KategorieKategorie . . . . 1 match NavigaIlSito . . . . 1 match NavigationSite . . . . 1 match PlatsNavigering . . . . 1 match SeiteFinden . . . . 1 match SiteNavigation . . . . 1 match SiteNavigering . . . . 1 match SökSida . . . . 1 match TrouvePage . . . . 1 match WegWeiser . . . . 1 match
`[[GoTo]]`	directly go to the page you enter	See the Find Page
`[[PageList(regex)]]`	list of pages whose title matches the regex	See the Help Index

Navigation

Macro	Description	Example
`[[RecentChanges]]`	a list of recently edited pages	See Recent Changes
`[[TitleIndex]]`	an index of all page titles	See Title Index
`[[WordIndex]]`	an index of all words in page titles	See Word Index
`[[WantedPages]]`	list links to non-existent pages	See Wanted Pages
`[[OrphanedPages]]`	list pages no other page links to	See Orphaned Pages
`[[AbandonedPages]]`	list pages that were not edited for the longest time	See Abandoned Pages
`[[RandomPage]]`	a link to a random page	Recent Changes
`[[RandomPage(#)]]`	links to a number of random pages	Two random pages: Slide Show Template Wiki Schulung/ Basis Einführung/ 150 Tabellen
`[[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 Help On Slide Shows
`[[Navigation(slides)]]`	displays first/prev/next/last links	See Help On Slide Shows

System information

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

Others

Macro	Description	Example
`[[Icon(image)]]`	display system icons	See Help On Navigation
`[[UserPreferences]]`	display a user preferences dialog	See User Preferences
`[[BR]]`	insert a line break	1st line 2nd line
`[[RandomQuote(pagename)]]`	Select a random quote from the given page, or from `FortuneCookies` if ommitted	Edit the FortuneCookies page to display randomly selected wisdom here.
`[[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 Help On Page Creation for an example
`[[Date(timestamp)]]`	display a timestamp according to system settings	2004-09-13
`[[DateTime(timestamp)]]`	display a timestamp¹ according to user settings	2004-09-13 02:41:32
`[[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 TeudProject	See TeudViewer?module=MoinMoin.macro.TeudView
`[[MailTo(email)]]`	protect your email address from spam bots	for details see /MailTo

1 "timestamp" can be empty (current time), a number of seconds since 1970 (unix timestamp), or a W3C time specification ("2002-01-23T12:34:56").

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:

Python Version: 2.3.3 (#2, May 1 2004, 06:12:12) [GCC 3.3.3 (Debian 20040401)]
MoinMoin Version: Release 1.2.1 [Revision 1.184]
Number of pages: 376
Number of system pages: 318
Number of backup versions: 77
Accumulated page sizes: 687308
Entries in edit log: 121 (11292 bytes)
Event log: 2066940 bytes
Global extension macros: AbandonedPages, BR, FootNote, Form, FullSearch, GetText, Include, Navigation, OrphanedPages, PageSize, RandomPage, RandomQuote, RecentChanges, ShowSmileys, StatsChart, SystemAdmin, TableOfContents, TeudView, WantedPages
Local extension macros: NONE
Global extension actions: AttachFile, DeletePage, LikePages, LocalSiteMap, SpellCheck, links, rss_rc, titleindex
Local extension actions: NONE
Installed processors: CSV, Colorize