• Immutable Page
  • Info
  • Attachments

帮助-宏

  1. 宏命令
    1. 用于查找的宏
    2. 用于浏览的宏
    3. 系统信息宏
    4. 其他宏
  2. 示例显示
  3. Macros
    1. Search macros
    2. Navigation
    3. System information
    4. Others
    5. Writing your own macro

宏命令

通过宏命令您可以在普通 wiki 页面中插入系统功能;使这种页面与众不同的唯一原因就是它们含有宏。如果你曾经编辑过类似 RecentChangesSystemInfo 的页面,你就会看到宏是什么。

关于更多可能出现的 wiki 标记,请参见 HelpOnEditingZh

用于查找的宏

宏名

描述

示例

[[TitleSearch]]

查找页标题

参见 FindPage

[[FullSearch]]

查找页内容

参见 FindPage

[[FullSearch()]]

在所有的页面中查找当前页面的标题(就象点击页面标题的效果一样)

参见页面 CategoryCategory

[[FullSearch('text')]]

在所有页面里查找字符串 "text"

查找 powered

[[GoTo]]

直接跳转到您输入的页面

参见 FindPage

[[PageList(regex)]]

标题可以匹配正则表达式 regxp 的页面的列表

参见 HelpIndex

用于浏览的宏

宏名

描述

示例

[[RecentChanges]]

最近被编辑的页面的列表

参见 RecentChanges

[[TitleIndex]]

所有页标题的索引

参见 TitleIndex

[[WordIndex]]

所有页标题中使用过的单词的索引

参见 WordIndex

[[WantedPages]]

所有在 Wiki 系统中被引用的但实际并不存在的页面的列表

参见 WantedPages

[[OrphanedPages]]

所有不被其他页面引用的页的列表

参见 OrphanedPages

[[AbandonedPages]]

列出保持不被改动状态最长的页面

参见 AbandonedPages

[[RandomPage]]

指向随机一个页面的链接

帮助-访问权限控制表

[[RandomPage(#)]]

指向 "#" 个随机页面的链接

两个随机链接:

[[TableOfContents([maxdepth])]]

显示一个当前页面的目录,可以控制其最大深度

参见本页开头

[[Anchor(anchorname)]]

在页面中插入定位标记(锚链)

#这里

[[Navigation(children[,maxdepth])]]

列出一个页面的所有子页面

参见本页的开头

[[Navigation(siblings[,maxdepth])]]

列出所有兄弟页

参见 /MailToZh

[[Navigation(slideshow)]]

FuzzTransZh 创建一个切换幻灯模式和wiki模式的链接,和一个开始幻灯模式的链接

参见 HelpOnSlideShows

[[Navigation(slides)]]

显示 第一个/前一个/下一个/最后 链接

参见 HelpOnSlideShows

系统信息宏

宏名

描述

示例

[[InterWiki]]

所有已知的 InterWiki 名的列表

InterWiki

[[SystemInfo]]

关于当前 wiki 的信息,python 解释器和系统

SystemInfo

[[PageCount]]

当前页面总数

共 4189 页

[[PageSize]]

所有页面的总大小

参见 PageSize

[[StatsChart(type)]]

显示统计图表(当前已定义类型:hitcounts(浏览次数), pagesize(页面大小), useragents(客户端类型))

参见 EventStats 及其子页面

[[SystemAdmin]]

wiki 管理员的 Web 管理界面(在 1.0 版本中还未实现)

参见 SystemInfo

其他宏

宏名

描述

示例

[[Icon(image)]]

显示系统中所支持的小图标

参见 HelpOnNavigation

[[UserPreferences]]

显示用户首选项对话框

参见 UserPreferences

[[BR]]

插入一个断行符

第一行
第二行

[[RandomQuote(pagename)]]

从指定的页面随机引用一句话,如果省略 pagename 将从 FortuneCookies 中引用

Tip: set your pages language with #language en processing instruction. See also HelpOnLanguages.

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

包含另一页的目录

详细使用方法参见 /IncludeZh

[[FootNote(text)]]

增加一个脚注(脚注中不能包含任何 wiki 标记),当省略参数 text 时,将在插入点显示所有已收集的脚注

示例参见 HelpOnPageCreationZh

[[Date(timestamp)]]

根据系统设置显示一个时间戳

2014-12-22

[[DateTime(timestamp)]]

根据用户设置显示一个时间戳1

2014-12-22 18:26:05

[[GetText(text)]]

载入 I18N 文字 (主要用于帮助页面)

"EditText" 将被转换为 "EditText"

[[TeudView]]

适用于内部网开发者 wiki ,可以察看通过 XSLT 样式表格式化的后的 pydoc 文档,详细用法参见 EfnetPythonWiki:TeudProject

参见 EfnetPythonWiki:TeudViewer?module=MoinMoin.macro.TeudView

[[MailTo(email)]]

防止你的邮件地址被垃圾邮件机器人搜集到

详细用法参见 /MailToZh

  • 1

    "timestamp" 可以为空(代表当前时间),或者一个从1970年开始计算的秒数( unix 时间),或者一个符合 W3C 时间表示规范的字符串("2002-01-23T12:34:56")。

示例显示

抱歉,因为篇幅关系,我们不能在这里提供所有宏命令的示例。下面是 [[SystemInfo]] 宏显示的信息:

  • Python Version
    2.4.3 (#1, Oct 23 2012, 22:02:41) [GCC 4.1.2 20080704 (Red Hat 4.1.2-54)]
    MoinMoin Version
    Release 1.5.0beta3 [Revision release]
    Number of pages
    975
    Number of system pages
    19
    Accumulated page sizes
    3142124
    Entries in edit log
    7208 (1024852 bytes)
    Event log
    20110033 bytes
    Global extension macros
    AbandonedPages, Action, AttachInfo, AttachList, BR, EditTemplates, EditedSystemPages, FootNote, Form, FullSearch, GetText, Include, LikePages, MonthCalendar, Navigation, NewPage, OrphanedPages, PageHits, PageSize, RandomPage, RandomQuote, RecentChanges, ShowSmileys, StatsChart, SystemAdmin, TableOfContents, TeudView, Verbatim, WantedPages
    Local extension macros
    NONE
    Global extension actions
    AttachFile, DeletePage, Despam, LikePages, LocalSiteMap, MyPages, PackagePages, RenamePage, RenderAsDocbook, SpellCheck, SubscribeUser, backup, fckdialog, fullsearch, links, newpage, rss_rc, titleindex
    Local extension actions
    NONE
    Global parsers
    CSV, cplusplus, docbook, irc, java, pascal, plain, python, wiki, xslt
    Local extension parsers
    NONE
    Installed processors (DEPRECATED -- use Parsers instead)
    NONE
    Lupy search
    Disabled
    Active threads
    1

  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:

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

AideD'Installation/CréerUneInstance

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

4189 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

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

Tip: 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 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

2014-12-22

[[DateTime(timestamp)]]


display a timestamp1 according to user settings

2014-12-22 18:26:07

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

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

  • 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"). See RFC822, sect. 5.

  • 2

    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.

  • macro is an instance of class Macro, and also evaluates to a string of the macroname.

  • arguments is an arbitrary argument string you can pass in with parameters to your macro.

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:

Dependencies = []

def execute(macro, args):
    return macro.formatter.text("I got these args from a macro %s: %s" %
    (str(macro), args))
  • /!\ Add an entry into Dependencies if the output from your macro should not be cached. This is important if the macro output could change from one moment to another, for example if your macro searches in wiki pages which may be being edited by other users, or loads information from an external database whose contents may change. Currently the value of any entry does not matter and may be considered a short description for 'why results from this macro should not be cached', but please look at the entries used in other macros for values which may be suitable.

Tell others about this page:

last modified 2005-11-13 13:36:05