The following 422 words could not be found in the dictionary of 615 words (including 615 LocalSpellingWords) and are highlighted below:

10px   Abandoned   above   according   Actions   Add   address   adjusted   Admin   admin   administrators   all   All   Allow   allow   alt   alttag   an   Anchor   anchorname   anchors   and   another   arbitrary   arg1   arg2   arg3   args   argument   arguments   at   Attach   attachment   attachments   be   being   below   between   both   bots   box   break   but   Button   by   C822   Cached   cached   caches   Calendar   called   can   cannot   cases   Category   category   Changes   Chart   charts   children   class   clicking   collected   considered   construct   contain   contains   contents   Contents   Cookies   Count   count   createonly   creates   creation   current   Currently   currently   database   date   Date   day   defaults   defined   Dependencies   depth   description   Description   details   developer   dialog   dict   Dict   dictionary   directly   display   displays   Displays   documentation   does   each   easily   edit   Edit   edited   either   empty   engine   Ensure   enter   entries   entry   evaluates   Event   example   Example   exception   execute   existent   existing   exists   explicitely   external   fail   features   File   file   Find   following   Foot   footnote   footnotes   For   for   form   format   formats   formatted   formatter   Fortune   from   Full   Get   given   go   Go   got   heading   height   Hello   help   Help   hitcounts   host   I18   Icon   icons   if   If   image   important   in   In   include   Include   Index   index   information   Information   input   insert   insertion   instance   instances   intended   interaction   interactive   interpreter   into   intranet   itself   known   Label   last   lets   level   like   limited   line   Link   link   links   list   List   ll   loads   local   located   longest   look   Macro   macro   macroname   Macros   macros   Mail   mainly   make   makes   margin   matches   matter   maxdepth   maximal   means   member   method   mode   moment   Month   more   most   name   Name   names   navigation   Navigation   Neat   necessary   Needs   new   New   next   no   non   normal   Note   now   number   Of   of   ommitted   On   on   one   only   Optionally   or   Orphaned   other   Others   output   over   own   page   Page   pagename   pages   Pages   pagesize   parameters   Parent   pass   plain   please   plugin   point   possible   possibly   powered   prefer   preferences   Preferences   prev   Project   protect   pydoc   python   quick   quote   Quote   random   Random   Recent   recently   regards   related   replaced   request   requested   result   results   Retrieve   return   returns   rights   search   Search   searches   Searching   seconds   sect   See   see   Select   settings   short   should   show   shown   Shows   shows   siblings   since   single   size   Size   sizes   Slide   slide   slides   slideshow   Snippets   so   sophisticated   special   specification   specified   speed   start   statically   statistical   Stats   str   strftime   string   style   stylesheet   sub   subpages   suitable   supplied   system   System   T12   Table   table   tablewidth   target   Template   template   term   Test   Teud   Text   text   texts   that   the   these   they   thing   this   This   those   through   Time   time   timestamp   Title   title   titles   to   To   toggle   translated   translation   twistedmatrix   Two   type   types   unix   up   use   Use   used   useful   user   User   useragents   users   uses   using   Val   valid   value   values   via   View   view   W3   Wanted   were   what   when   which   whose   why   width   will   with   Word   words   work   Works   World   write   writing   Writing   You   you   your  

Clear message

/ImageLink   /Include   /MailTo   /MonthCalendar  

Contents

  1. Macros
    1. Search macros
    2. Navigation
    3. System information
    4. Others
    5. Writing your own macro

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

MoinMoin 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 HelpOnSearching.

Macro

Description

Example

[[TitleSearch]]

create a search box on the page, which search the page titles

See FindPage

[[FullSearch]]

create a search box on the page, which search the page contents

See FindPage

[[FullSearch()]]

print a list of pages whose content matches the current page title (like clicking on the page title)

See the CategoryCategory page

[[FullSearch(text)]]

print a list of pages whose content matches the search term

Search for powered:

  1. FrontPage
  2. HelpOnMacros
  3. WhyWikiWorks

[[FullSearchCached(text)]]

Works like the FullSearch macro but caches the results statically. Use it if you prefer speed over an up-to-date result

Search for powered:

  1. FrontPage
  2. HelpOnMacros
  3. WhyWikiWorks

[[GoTo]]

directly go to the page you enter

See the FindPage

[[PageList(Help)]]

print a list of pages whose title matches the search term

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

EditedSystemPages

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

[[AttachInfo]]

displays number of attachments for current page

See HelpOnActions/AttachFile

[[AttachInfo(page)]]

displays number of attachments for page

See HelpOnActions/AttachFile

[[AttachList]]

displays list of attachments for current page

See HelpOnActions/AttachFile

[[AttachList(page)]]

displays list of attachments for page

See HelpOnActions/AttachFile

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(exists)]]

current page count. If exists is supplied as an argument, only existing pages will be shown.

290 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]]

Information for system administrators

Needs admin rights.

Others

Macro

Description

Example

[[ImageLink(image,target[,width=width[,height=height]][,alt=alttag])]]

This macro is used to make a link that displays an image (can be given as either attachment or URL) and links to either an URL or a wiki page. Optionally the size of the image can be adjusted. If no target is given the link will point to the image itself.

See /ImageLink

[[Icon(image)]]

display system icons

See HelpOnNavigation

[[UserPreferences]]

display a user preferences dialog

See UserPreferences

[[UserPreferences(createonly)]]

display user creation dialog

[[BR]]

insert a line break

1st line
2nd line

[[RandomQuote(pagename)]]

Select a random quote from the given page, or from FortuneCookies if ommitted

Hint: you can search for multiple words, just like Google. See also HelpOnSearching.

[[Include(HelloWorld[,"heading"[,level]])]]

include contents of another page

for details see /Include

[[FootNote(text)]]

Add a footnote1, or explicitely display collected footnotes when no args are given

See below for an example.

[[Date(timestamp)]]

display a timestamp according to system settings

2024-11-22

[[DateTime(timestamp)]]

display a timestamp2 according to user settings

2024-11-22 20:02:59

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

See http://twistedmatrix.com/wiki/python/TeudProject

[[MailTo(email)]]

protect your email address from spam bots

for details see /MailTo

[[NewPage(PageTemplate,ButtonLabel,ParentPage[,NameTemplate])]]

Allow the user to create (sub-) pages easily, using the page PageTemplateas the template for the new page and the string NameTemplate as a template for the name.3

[[GetVal(NeatSnippets,regards)]]

Retrieve dictionary entries from dict pages.

If you have a page called GermanDict which contains the entry Test, you should see the translation here:

 [[MonthCalendar(,,12)]]

Displays a Calendar and creates link for entries to each day on subpages

See /MonthCalendar

  • 1 the text cannot contain any wiki markup

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

  • 3 NameTemplate is formatted with time.strftime(), with the exception of %s which is replaced by the input into the edit box (which is only shown if necessary). If NameTemplate is not specified or empty, it defaults to %s.

Writing your own macro

Create a python file called MacroName.py located in your data/plugin/macro directory. Ensure it has a single method called execute(macro, arguments), which is the entry-point.

All Macro instances have a request member through which you can access the form parameters and other information related to user interaction.

execute() should use the formatter to construct valid markup for the current target format. In most cases this is HTML, so writing a macro which returns HTML will work in most cases but fail when formats like XML or text/plain are requested.

For example, your wiki page has the following line on it: 

[[MacroName(arg1,arg2,arg3)]]

You could write a MacroName.py file like this: 

   1 Dependencies = []
   2 
   3 def execute(macro, args):
   4     return macro.formatter.text("I got these args from a macro %s: %s" %
   5     (str(macro), args))

HelpOnMacros (last modified 2007-04-01 02:20:36)