<?xml version="1.0" encoding="utf-8"?>
<s1 title="HelpOnMacros"><p><table class="navigation"><tr><td><a href="/wiki/HelpOnMacros/EmbedObject">/EmbedObject</a> &nbsp; <a href="/wiki/HelpOnMacros/Include">/Include</a> &nbsp; <a href="/wiki/HelpOnMacros/MailTo">/MailTo</a> &nbsp; <a href="/wiki/HelpOnMacros/MonthCalendar">/MonthCalendar</a> &nbsp; </td></tr></table> </p>
<s2 id="Macros" title="Macros">
<p><p>Contents</p>
<ol><li>
<link anchor="M">Macros</link><ol><li>
<link anchor="S">Search macros</link></li>
<li>
<link anchor="N">Navigation macros</link></li>
<li>
<link anchor="S-1">System Information macros</link></li>
<li>
<link anchor="O">Others</link></li>
</ol>
</li>
</ol>
<p> </p>
<p>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 <jump href="/wiki/RecentChanges">RecentChanges</jump> or <jump href="/wiki/SystemInfo" class="nonexistent">SystemInfo</jump>, you&apos;ll see what that means. </p>
<p>For more information on the possible markup, see <jump href="/wiki/HelpOnEditing">HelpOnEditing</jump> and <jump href="/wiki/HelpOnMoinWikiSyntax">HelpOnMoinWikiSyntax</jump>. </p>
<p></p>
<s3 id="Search macros" title="Search macros">
<p><jump href="/wiki/MoinMoin">MoinMoin</jump> now uses a new search engine, that lets your make sophisticated searches using both the interactive search box or any of the search macros. For more help, see <jump href="/wiki/HelpOnSearching">HelpOnSearching</jump>. </p>
<table><strong class="highlight"><![CDATA[]]></strong><tr><td><strong class="highlight"><![CDATA[]]></strong><p> <strong>Macro</strong> </p>
</td><td><p> <strong>Description</strong>  </p>
</td></tr><tr><td><p><code>&lt;&lt;AdvancedSearch&gt;&gt;</code></p>
</td><td><strong class="highlight"><![CDATA[]]></strong><p> create an advanced search dialogue on the page. See <jump href="/wiki/FindPage">FindPage</jump>. </p>
</td></tr><tr><td><p><code>&lt;&lt;TitleSearch&gt;&gt;</code></p>
</td><td><p> create a search box on the page, which search the page titles. See <jump href="/wiki/FindPage">FindPage</jump>. </p>
</td></tr><tr><td><p><code>&lt;&lt;FullSearch&gt;&gt;</code></p>
</td><td><p> create a search box on the page, which search the page contents.See <jump href="/wiki/FindPage">FindPage</jump>. </p>
</td></tr><tr><td><p><code>&lt;&lt;FullSearch()&gt;&gt;</code></p>
</td><td><p> print a list of pages whose content matches the current page title (like clicking on the page title). See <jump href="/wiki/CategoryCategory">CategoryCategory</jump> for example </p>
</td></tr><tr><td><p><code>&lt;&lt;FullSearch(text)&gt;&gt;</code></p>
</td><td><p> print a list of pages whose content matches the search term. </p>
</td></tr><tr><td><p><code>&lt;&lt;FullSearchCached(text)&gt;&gt;</code></p>
</td><td><p> Works like the <code>FullSearch</code> macro but caches the results statically. Use it if you prefer speed over an up-to-date result. </p>
</td></tr><tr><td><p><code>&lt;&lt;GoTo&gt;&gt;</code></p>
</td><td><p> directly go to the page you enter. See <jump href="/wiki/FindPage">FindPage</jump>.  </p>
</td></tr><tr><td><p><code>&lt;&lt;PageList(Help)&gt;&gt;</code></p>
</td><td><p> print a list of pages whose title matches the search term. See <jump href="/wiki/HelpIndex">HelpIndex</jump>. </p>
</td></tr></table><p></p>
</s3>
<s3 id="Navigation macros" title="Navigation macros">
<table><strong class="highlight"><![CDATA[]]></strong><tr><td><strong class="highlight"><![CDATA[]]></strong><p> <strong>Macro</strong> </p>
</td><td><p> <strong>Description</strong>  </p>
</td></tr><tr><td><p> <code>&lt;&lt;RecentChanges&gt;&gt;</code> </p>
</td><td><p> a list of recently edited pages. See <jump href="/wiki/RecentChanges">RecentChanges</jump> </p>
</td></tr><tr><td><p> <code>&lt;&lt;TitleIndex&gt;&gt;</code> </p>
</td><td><p> an index of all page titles. See <jump href="/wiki/TitleIndex">TitleIndex</jump> </p>
</td></tr><tr><td><p> <code>&lt;&lt;WordIndex&gt;&gt;</code> </p>
</td><td><p> an index of all words in page titles. See <jump href="/wiki/WordIndex">WordIndex</jump> </p>
</td></tr><tr><td><p> <code>&lt;&lt;WantedPages&gt;&gt;</code> </p>
</td><td><p> list links to non-existent pages. See <jump href="/wiki/WantedPages" class="nonexistent">WantedPages</jump> </p>
</td></tr><tr><td><p> <code>&lt;&lt;OrphanedPages&gt;&gt;</code> </p>
</td><td><p> list pages no other page links to. See <jump href="/wiki/OrphanedPages" class="nonexistent">OrphanedPages</jump> </p>
</td></tr><tr><td><p> <code>&lt;&lt;AbandonedPages&gt;&gt;</code> </p>
</td><td><p> list pages that were not edited for the longest time. See <jump href="/wiki/AbandonedPages" class="nonexistent">AbandonedPages</jump> </p>
</td></tr><tr><td><p> <code>&lt;&lt;RandomPage&gt;&gt;</code> </p>
</td><td><p> inserts a link to a random page. </p>
</td></tr><tr><td><p> <code>&lt;&lt;RandomPage(#)&gt;&gt;</code> </p>
</td><td><p> links to a number of random pages. </p>
</td></tr><tr><td><p> <code>&lt;&lt;TableOfContents([maxdepth])&gt;&gt;</code> </p>
</td><td><p> display a local table of contents, possibly limited to a maximal depth. </p>
</td></tr><tr><td><p> <code>&lt;&lt;Anchor(anchorname)&gt;&gt;</code> </p>
</td><td><p> macro to insert anchors into a page. </p>
</td></tr><tr><td><p> <code>&lt;&lt;Navigation(children[,maxdepth])&gt;&gt;</code> </p>
</td><td><p> macro to list all of a pages&apos; children. See start of this page for sample. </p>
</td></tr><tr><td><p> <code>&lt;&lt;Navigation(siblings[,maxdepth])&gt;&gt;</code> </p>
</td><td><p> quick navigation to siblings of a page. See <jump href="/wiki/HelpOnMacros/MailTo">/MailTo</jump> for sample. </p>
</td></tr><tr><td><p> <code>&lt;&lt;Navigation(slideshow)&gt;&gt;</code> </p>
</td><td><p> creates a link to toggle between slide show and wiki mode, and a link to start the slide show. See <jump href="/wiki/HelpOnSlideShows">HelpOnSlideShows</jump> </p>
</td></tr><tr><td><p> <code>&lt;&lt;Navigation(slides)&gt;&gt;</code> </p>
</td><td><p> displays first/prev/next/last links. See <jump href="/wiki/HelpOnSlideShows">HelpOnSlideShows</jump> </p>
</td></tr><tr><td><p> <code>&lt;&lt;AttachInfo&gt;&gt;</code> </p>
</td><td><p>displays number of attachments for current page. See <jump href="/wiki/HelpOnActions/AttachFile">HelpOnActions/AttachFile</jump> </p>
</td></tr><tr><td><p> <code>&lt;&lt;AttachInfo(page)&gt;&gt;</code> </p>
</td><td><p> displays number of attachments for page. See <jump href="/wiki/HelpOnActions/AttachFile">HelpOnActions/AttachFile</jump> </p>
</td></tr><tr><td><p> <code>&lt;&lt;AttachList(pagename,mimetype)&gt;&gt;</code> </p>
</td><td><p> displays list of attachments. See <jump href="/wiki/HelpOnActions/AttachFile">HelpOnActions/AttachFile</jump> </p>
</td></tr></table><p></p>
</s3>
<s3 id="System Information macros" title="System Information macros">
<table><strong class="highlight"><![CDATA[]]></strong><tr><td><strong class="highlight"><![CDATA[]]></strong><p> <strong>Macro</strong> </p>
</td><td><p> <strong>Description</strong>  </p>
</td></tr><tr><td><p><code>&lt;&lt;Hits&gt;&gt;</code></p>
</td><td><p> a counter for page hits <code>&lt;&lt;Hits([all=(False,True)][,event_type=(VIEWPAGE,SAVEPAGE)]&gt;&gt;</code> </p>
</td></tr><tr><td><p><code>&lt;&lt;InterWiki&gt;&gt;</code></p>
</td><td><p> a list of all known <jump href="/wiki/InterWiki" class="nonexistent">InterWiki</jump> names.</p>
</td></tr><tr><td><p><code>&lt;&lt;SystemInfo&gt;&gt;</code></p>
</td><td><p> info on the wiki, the python interpreter and the host system. </p>
</td></tr><tr><td><p><code>&lt;&lt;PageCount(exists)&gt;&gt;</code></p>
</td><td><p>current page count. If <code>exists</code> is supplied as an argument, only existing pages will be shown.  </p>
</td></tr><tr><td><p><code>&lt;&lt;PageSize&gt;&gt;</code></p>
</td><td><p> list the sizes of all pages. See <jump href="/wiki/PageSize" class="nonexistent">PageSize</jump> </p>
</td></tr><tr><td><p><code>&lt;&lt;StatsChart(type)&gt;&gt;</code></p>
</td><td><p> shows statistical charts (currently defined types: hitcounts, pagesize, useragents, languages). See <jump href="/wiki/EventStats" class="nonexistent">EventStats</jump> and subpages </p>
</td></tr><tr><td><p><code>&lt;&lt;SystemAdmin&gt;&gt;</code></p>
</td><td><p> Information for system administrators, see <jump href="/wiki/SystemAdmin" class="nonexistent">SystemAdmin</jump>. <em>You need to be superuser to use this macro.</em> </p>
</td></tr><tr><td><p><code>&lt;&lt;EditedSystemPages&gt;&gt;</code></p>
</td><td><p> A list of system pages that were modified. </p>
</td></tr><tr><td><p><code>&lt;&lt;WikiConfig&gt;&gt;</code></p>
</td><td><p> Shows wiki configuration settings which are either non-default or unknown. <em>You need to be superuser to use this macro.</em> </p>
</td></tr><tr><td><p><code>&lt;&lt;WikiConfigHelp&gt;&gt;</code></p>
</td><td><p> Shows all wiki configuration settings with descriptions. </p>
</td></tr><tr><td><p><code>&lt;&lt;HighlighterList&gt;&gt;</code></p>
</td><td><p> List available Pygments lexers. See <interwiki wiki="MoinMoin" pagename="MacroMarket/HighlighterList">MacroMarket/HighlighterList</interwiki> for additional information. </p>
</td></tr></table><p></p>
</s3>
<s3 id="Others" title="Others">
<table><strong class="highlight"><![CDATA[]]></strong><tr><td><strong class="highlight"><![CDATA[]]></strong><p> <strong>Macro</strong></p>
</td><td><p><strong>Description</strong> </p>
</td></tr><tr><td><p><code>&lt;&lt;Action(action [,text])&gt;&gt;</code></p>
</td><td><p>links to page with valid action, optional text could be used as alias. (action names are case sensitive). Example: <code>&lt;&lt;Action(print, Print this page)&gt;&gt;</code> will generate <jump href="/wiki/HelpOnMacros?action=print" class="action">Print this page</jump></p>
</td></tr><tr><td><p><code>&lt;&lt;Icon(image)&gt;&gt;</code></p>
</td><td><p>display system icons.  See <jump href="/wiki/HelpOnNavigation">HelpOnNavigation</jump> </p>
</td></tr><tr><td><p><code>&lt;&lt;BR&gt;&gt;</code></p>
</td><td><p> insert a line break. </p>
</td></tr><tr><td><p><code>&lt;&lt;RandomQuote(pagename)&gt;&gt;</code> </p>
</td><td><p> Select a random quote from the given page, or from <code>FortuneCookies</code> if omitted. </p>
</td></tr><tr><td><p><code>&lt;&lt;Include(HelloWorld[,&quot;heading&quot;[,level]])&gt;&gt;</code> </p>
</td><td><p> include contents of another page. See <jump href="/wiki/HelpOnMacros/Include">/Include</jump> </p>
</td></tr><tr><td><p><code>&lt;&lt;FootNote(text)&gt;&gt;</code></p>
</td><td><p> Add a footnote<sup><link anchor="fnref-20f25675be2608a0416555faab22516d2d9a84d2" id="fndef-20f25675be2608a0416555faab22516d2d9a84d2-0">1</link></sup>, or explicitly display collected footnotes when no args are given.  </p>
</td></tr><tr><td><p><code>&lt;&lt;Date(timestamp)&gt;&gt;</code></p>
</td><td><p> display a timestamp according to system settings, in the style of 2026-04-26 </p>
</td></tr><tr><td><p><code>&lt;&lt;DateTime(timestamp)&gt;&gt;</code></p>
</td><td><p> display a timestamp<sup><link anchor="fnref-4e2be9fcccab96fc091ee101f59fc48f969086bb" id="fndef-4e2be9fcccab96fc091ee101f59fc48f969086bb-1">2</link></sup> according to user settings, in the style of 2026-04-26 10:57:23 </p>
</td></tr><tr><td><p><code>&lt;&lt;GetText(text)&gt;&gt;</code></p>
</td><td><p> <small>(mainly intended for use on Help pages)</small> Loads I18N texts. Example: &quot;Edit<code></code>Text&quot; is translated to &quot;EditText&quot; </p>
</td></tr><tr><td><p><code>&lt;&lt;GetText2(,message,argument1,argument2,...)&gt;&gt;</code></p>
</td><td><p> <small>(mainly intended for use on Help pages or in generated output on wiki pages)</small> loads I18N texts and replaces <code>%s</code> in the message by the arguments. The first character of the argument is used as the separator (in this example: a comma). You can escape the separator by using a backslash. Example: &quot;<code>&lt;&lt;GetText2(,[You may not read %s],FooBar)&gt;&gt;</code>&quot; yields &quot;[You may not read FooBar]&quot;. For named placeholders, use &quot;key=value&quot; argument syntax, for example, &quot;<code>&lt;&lt;GetText2(,Upload new attachment \&quot;%(filename)s\&quot;,filename=file.txt)&gt;&gt;</code>&quot; yields &quot;Upload new attachment &quot;file.txt&quot;&quot;. </p>
</td></tr><tr><td><p><code>&lt;&lt;TeudView&gt;&gt;</code></p>
</td><td><p> useful for intranet developer wikis, a means to view pydoc documentation, formatted via a XSLT stylesheet. See <jump href="http://twistedmatrix.com/wiki/python/TeudProject" class="http">http://twistedmatrix.com/wiki/python/TeudProject</jump> </p>
</td></tr><tr><td><p><code>&lt;&lt;MailTo(email)&gt;&gt;</code></p>
</td><td><p> protect your email address from spam bots. See <jump href="/wiki/HelpOnMacros/MailTo">/MailTo</jump> </p>
</td></tr><tr><td><p><code>&lt;&lt;NewPage(PageTemplate,ButtonLabel,[ParentPage,@ME,@SELF] [,NameTemplate])&gt;&gt;</code></p>
</td><td><p> Allow the user to create (sub-)pages easily, using the page <code>PageTemplate</code> as the template for the new page and the string <code>NameTemplate</code> as a template for the name.<sup><link anchor="fnref-381bfa3b6ca655a70a38ce8bea2d77e8ab6ca15c" id="fndef-381bfa3b6ca655a70a38ce8bea2d77e8ab6ca15c-2">3</link></sup> <code>@ME</code> is used if you want the  page created below the users homepage. <code>@SELF</code> is used to create a subpage below the page where it is called from. </p>
</td></tr><tr><td><p><code>&lt;&lt;GetVal(NeatSnippets,regards)&gt;&gt;</code></p>
</td><td><p> Retrieve dictionary entries from dict pages. Example: If you have a page called <jump href="/wiki/GermanDict" class="nonexistent">GermanDict</jump> which contains the entry <em>Test</em>, you should see the translation here:  </p>
</td></tr><tr><td><p><code>&lt;&lt;MonthCalendar(,,12)&gt;&gt;</code></p>
</td><td><p> Displays a Calendar and creates link for entries to each day on subpages. See <jump href="/wiki/HelpOnMacros/MonthCalendar">/MonthCalendar</jump> </p>
</td></tr></table><p></p>
<ol><li><p><link anchor="None" id="fnref-20f25675be2608a0416555faab22516d2d9a84d2"></link>the text cannot contain any wiki markup </p>
 (<link anchor="fndef-20f25675be2608a0416555faab22516d2d9a84d2-0">1</link>)</p>
</li>
<li><p><link anchor="None" id="fnref-4e2be9fcccab96fc091ee101f59fc48f969086bb"></link>&quot;timestamp&quot; can be empty (current time), a number of seconds since 1970 (unix timestamp), or a W3C time specification (&quot;2002-01-23T12:34:56&quot;). See RFC822, sect. 5.  </p>
 (<link anchor="fndef-4e2be9fcccab96fc091ee101f59fc48f969086bb-1">2</link>)</p>
</li>
<li><p><link anchor="None" id="fnref-381bfa3b6ca655a70a38ce8bea2d77e8ab6ca15c"></link><code>NameTemplate</code> is formatted with <code>time.strftime()</code>, with the exception of <code>%s</code> which is replaced by the input into the edit box (which is only shown if necessary). If <code>NameTemplate</code> is not specified or empty, it defaults to <code>%s</code>. </p>
 (<link anchor="fndef-381bfa3b6ca655a70a38ce8bea2d77e8ab6ca15c-2">3</link>)</p>
</li>
</ol>
<p> </p>
</s3></s2></s1>