<extension><title>MindTouch Core Service</title><copyright>Copyright (c) 2006-2010 MindTouch Inc.</copyright><uri.help>http://developer.mindtouch.com/en/ref/MindTouch_API</uri.help><function><name>wiki.page</name><uri>https://wiki.comfsm.fm/@api/deki/wiki.page</uri><description>Include an entire or part of another wiki page.</description><param name="path" type="str">wiki page path</param><param name="section" type="str" optional="true">section to include on wiki page (default: full page)</param><param name="revision" type="num" optional="true">page revision to use: 0 is the head revision, &gt; 0 stands for a specific revision (e.g. 1 is the first revision), &lt; 0 is revision relative to head revision (e.g. -1 is the previous revision) (default: head revision)</param><param name="show" type="bool" optional="true">show page/section title of included page (default: no)</param><param name="heading" type="num" optional="true">set page/section title heading and adjust all sub-headings accordingly; the adjustment is applied even when the page/section heading is not shown (range: 0-5, where 0 is 'Title' style, 1 is 'Heading 1', and so forth; default: keep original headings)</param><param name="nilIfMissing" type="bool" optional="true">return nil if page/section is not found (default: return link to missing page/section)</param><return type="xml" /></function><function><name>wiki.text</name><uri>https://wiki.comfsm.fm/@api/deki/wiki.text</uri><description>Retrieve the text contents for an entire or part of another wiki page.</description><param name="path" type="str">wiki page path</param><param name="section" type="str" optional="true">section to include on wiki page (default: nil)</param><param name="revision" type="num" optional="true">page revision to use: 0 is the head revision, &gt; 0 stands for a specific revision (e.g. 1 is the first revision), &lt; 0 is revision relative to head revision (e.g. -1 is the previous revision) (default: head revision)</param><param name="nilIfMissing" type="bool" optional="true">return nil if page/section is not found (default: return name of missing page/section)</param><return type="str" /></function><function><name>wiki.anypage</name><uri>https://wiki.comfsm.fm/@api/deki/wiki.anypage</uri><description>Include or link to a random page from a list of pages.</description><param name="query" type="str">page query</param><param name="seconds" type="num" optional="true">interval in seconds for selecing another page (default: 3600)</param><param name="max" type="num" optional="true">max query results (default: 100)</param><param name="linkonly" type="bool" optional="true">link to the page (default: false)</param><param name="titlestyle" type="str" optional="true">style for page title (default: "display: none;")</param><return type="xml" /></function><function><name>wiki.toc</name><uri>https://wiki.comfsm.fm/@api/deki/wiki.toc</uri><description>Show the table of contents of a wiki page.</description><param name="path" type="str" optional="true">wiki page path</param><param name="depth" type="num" optional="true">heading depth for table of contents (default: all)</param><return type="xml" /></function><function><name>wiki.tree</name><uri>https://wiki.comfsm.fm/@api/deki/wiki.tree</uri><description>Show hierarchy of pages starting at a wiki page.</description><param name="path" type="str" optional="true">wiki page path</param><param name="depth" type="num" optional="true">nesting depth for retrieving child pages (default: all)</param><param name="reverse" type="bool" optional="true">reverse order of child pages</param><return type="xml" /></function><function><name>wiki.popular</name><uri>https://wiki.comfsm.fm/@api/deki/wiki.popular</uri><description>Show list of popular pages</description><param name="max" type="num" optional="true">max number of pages (default: 10)</param><return type="xml" /></function><function><name>wiki.search</name><uri>https://wiki.comfsm.fm/@api/deki/wiki.search</uri><description>Find wiki pages and files.</description><param name="query" type="str">search query</param><param name="max" type="num" optional="true">max results (default: 10)</param><param name="sortBy" type="str" optional="true">sort field (one of "score", "title", "date", "size", "wordcount", "rating.score", "rating.count"; use "-title" for reverse order; default: "score")</param><param name="constraint" type="str" optional="true">additional search constraint (default: "")</param><param name="offset" type="num" optional="true">number of results to skip (default: 0)</param><return type="xml" /></function><function><name>wiki.uri</name><uri>https://wiki.comfsm.fm/@api/deki/wiki.uri</uri><description>Retrieve the full uri of a given wiki page.</description><param name="path" type="str">wiki page path</param><param name="query" type="str" optional="true">query</param><return type="str" /></function><function><name>wiki.directory</name><uri>https://wiki.comfsm.fm/@api/deki/wiki.directory</uri><description>Show directory of wiki pages matching the search query.</description><param name="query" type="str" optional="true">search query (default: all pages in main namespace)</param><return type="xml" /></function><function><name>wiki.template</name><uri>https://wiki.comfsm.fm/@api/deki/wiki.template</uri><description>Invoke a template page.</description><param name="path" type="str">template path</param><param name="args" type="any" optional="true">template arguments (default: nil)</param><param name="target" type="str" optional="true">alternative body target (default: nil)</param><param name="conflict" type="str" optional="true">conflict resolution if target already exists (one of "ignore", "replace", or "append"; default: "ignore")</param><return type="xml" /></function><function><name>template</name><uri>https://wiki.comfsm.fm/@api/deki/template</uri><description>Invoke a template page.</description><param name="path" type="str">template path</param><param name="args" type="any" optional="true">template arguments (default: nil)</param><param name="target" type="str" optional="true">alternative body target (default: nil)</param><param name="conflict" type="str" optional="true">conflict resolution if target already exists (one of "ignore", "replace", or "append"; default: "ignore")</param><return type="xml" /></function><function><name>wiki.contributors</name><uri>https://wiki.comfsm.fm/@api/deki/wiki.contributors</uri><description>Show most active contributors for the site or a page.</description><param name="path" type="str" optional="true">wiki page path (default: nil)</param><param name="max" type="num" optional="true">max results (default: 10)</param><param name="recent" type="bool" optional="true">order by most recent (default: false)</param><param name="exclude" type="str" optional="true">exclude banned or inactive users (one of: none, banned, inactive, all; default: none)</param><return type="xml" /></function><function><name>wiki.localize</name><uri>https://wiki.comfsm.fm/@api/deki/wiki.localize</uri><description>Retrieve a localized resource string.</description><param name="resourceName" type="str">wiki resource name</param><param name="resourceParameters" type="list" optional="true">wiki resource parameters (default: nil)</param><return type="xml" /></function><function><name>wiki.languages</name><uri>https://wiki.comfsm.fm/@api/deki/wiki.languages</uri><description>Displays a page's versions written in other languages.</description><param name="languages" type="map">Language to title map of all page versions written in other languages</param><return type="xml" /></function><function><name>wiki.pageexists</name><uri>https://wiki.comfsm.fm/@api/deki/wiki.pageexists</uri><description>Check if the given wiki page exists.</description><param name="path" type="str">wiki page path</param><return type="bool" /></function><function><name>wiki.pagepermissions</name><uri>https://wiki.comfsm.fm/@api/deki/wiki.pagepermissions</uri><description>Get the effective permissions for a user and page.</description><param name="page" type="any" optional="true">wiki page path or id (default: current page)</param><param name="user" type="any" optional="true">user name or id (default: current user)</param><return type="map" /></function><function><name>wiki.appendpath</name><uri>https://wiki.comfsm.fm/@api/deki/wiki.appendpath</uri><description>Append a title to a page path.</description><param name="path" type="str">wiki page path</param><param name="title" type="any">single page title or list of titles to append</param><return type="str" /></function><function><name>wiki.comments</name><uri>https://wiki.comfsm.fm/@api/deki/wiki.comments</uri><description>Get most recent comments for a page path.</description><param name="path" type="str" optional="true">wiki page path (default: current page)</param><param name="recurse" type="bool" optional="true">retrieve comments from descendant pages as well (default: false)</param><param name="user" type="any" optional="true">filter by poster user id or name (default: all)</param><param name="max" type="num" optional="true">maximum number of comments to return (default: 100)</param><param name="offset" type="num" optional="true">number of comments to skip (default: 0)</param><return type="list" /></function><function><name>wiki.create</name><uri>https://wiki.comfsm.fm/@api/deki/wiki.create</uri><description>Insert a link or button to create a new page.</description><param name="label" type="str" optional="true">label for edit link or button (default: "New page")</param><param name="path" type="str" optional="true">path to parent page for new page (default: current page)</param><param name="template" type="str" optional="true">template to use to populate new page (default: system default)</param><param name="button" type="bool" optional="true">show as button (default: true)</param><param name="title" type="str" optional="true">new title for page (default: "Page Title")</param><param name="args" type="map" optional="true">request arguments to pass to new page (default: nil)</param><return type="xml" /></function><function><name>wiki.edit</name><uri>https://wiki.comfsm.fm/@api/deki/wiki.edit</uri><description>Insert a link or button to open the editor.</description><param name="label" type="str" optional="true">label for edit link or button (default: "Edit page")</param><param name="path" type="str" optional="true">path of page to edit (default: current page)</param><param name="section" type="str" optional="true">name of section to edit (default: edit entire page)</param><param name="button" type="bool" optional="true">show as button (default: true)</param><param name="template" type="str" optional="true">template to use to populate new page (default: system default)</param><param name="args" type="map" optional="true">request arguments to pass to page (default: nil)</param><return type="xml" /></function><function><name>wiki.getpage</name><uri>https://wiki.comfsm.fm/@api/deki/wiki.getpage</uri><description>Get page object at wiki page path or id.</description><param name="page" type="any">wiki page path or id</param><param name="redirect" type="bool" optional="true">follow redirects (default: true)</param><return type="map" /></function><function><name>wiki.getfile</name><uri>https://wiki.comfsm.fm/@api/deki/wiki.getfile</uri><description>Get file object for a given file id.</description><param name="fileid" type="num">file id</param><return type="map" /></function><function><name>wiki.getuser</name><uri>https://wiki.comfsm.fm/@api/deki/wiki.getuser</uri><description>Get user object by user name or id.</description><param name="user" type="any">user name or id</param><return type="map" /></function><function><name>wiki.getsearch</name><uri>https://wiki.comfsm.fm/@api/deki/wiki.getsearch</uri><description>Get list of found page and file objects.</description><param name="query" type="str">search query</param><param name="max" type="num" optional="true">max results (default: 10)</param><param name="sortBy" type="str" optional="true">sort field (one of "score", "title", "date", "size", "wordcount", "rating.score", "rating.count"; use "-title" for reverse order; default: "score")</param><param name="constraint" type="str" optional="true">additional search constraint (default: "")</param><param name="offset" type="num" optional="true">number of results to skip (default: 0)</param><return type="list" /></function><function><name>wiki.gettag</name><uri>https://wiki.comfsm.fm/@api/deki/wiki.gettag</uri><description>Get specified tag.</description><param name="tag" type="str">tag name</param><return type="map" /></function><function><name>wiki.inclusions</name><uri>https://wiki.comfsm.fm/@api/deki/wiki.inclusions</uri><description>Get list of pages that form the current inclusion chain.  The first item is the outermost page that is being loaded.  The last item is the current page, unless the current page is a template and templates are excluded (see parameters below).</description><param name="templates" type="bool" optional="true">list template pages as well (default: true)</param><return type="list" /></function><function usage="property"><name>wiki.version</name><uri>https://wiki.comfsm.fm/@api/deki/$wiki.version</uri><description>Get the current version number.</description><return type="map" /></function><function><name>wiki.api</name><uri>https://wiki.comfsm.fm/@api/deki/wiki.api</uri><description>Get an XML document from the API using the current user's credentials.</description><param name="source" type="uri">XML source uri</param><param name="nilOnError" type="bool" optional="true">return nil when an error occurs</param><return type="xml" /></function><function><name>wiki.language</name><uri>https://wiki.comfsm.fm/@api/deki/wiki.language</uri><description>Get the effective language for a page given the page language, user language, and site language.</description><param name="path" type="str" optional="true">wiki page path</param><return type="str" /></function><function><name>wiki.link</name><uri>https://wiki.comfsm.fm/@api/deki/wiki.link</uri><description>Insert a hyperlink to a page.</description><param name="page" type="any">wiki page path or id</param><param name="text" type="any" optional="true">link contents; can be text, an image, or another document (default: page title)</param><param name="title" type="str" optional="true">link hover title (default: none)</param><param name="target" type="str" optional="true">link target (default: none)</param><param name="redirect" type="bool" optional="true">follow redirects (default: true)</param><return type="xml" /></function><function><name>wiki.recentchangestimestamp</name><uri>https://wiki.comfsm.fm/@api/deki/wiki.recentchangestimestamp</uri><description>Compute a timestamp based on recent changes in a page hierarchy.</description><param name="path" type="str" optional="true">wiki page path</param><param name="pages" type="bool" optional="true">include page changes (default: true)</param><param name="tags" type="bool" optional="true">include tag changes (default: true)</param><param name="comments" type="bool" optional="true">include comment changes (default: true)</param><param name="files" type="bool" optional="true">include file changes (default: true)</param><return type="str" /></function><function><name>meta.description</name><uri>https://wiki.comfsm.fm/@api/deki/meta.description</uri><description>Add a plain language description to the page.</description><param name="content" type="str">description text</param><return type="xml" /></function><function><name>meta.keywords</name><uri>https://wiki.comfsm.fm/@api/deki/meta.keywords</uri><description>Add keywords for search engines to the page.</description><param name="content" type="str">comma separated keywords</param><return type="xml" /></function><function><name>meta.author</name><uri>https://wiki.comfsm.fm/@api/deki/meta.author</uri><description>Add the author's name to the page.</description><param name="content" type="str">author name</param><return type="xml" /></function><function><name>meta.robots</name><uri>https://wiki.comfsm.fm/@api/deki/meta.robots</uri><description>Add control statements for search engines to the page.</description><param name="content" type="str">search engine control statements</param><return type="xml" /></function><function><name>meta.copyright</name><uri>https://wiki.comfsm.fm/@api/deki/meta.copyright</uri><description>Add a copyright statement to the page.</description><param name="content" type="str">copyright text</param><return type="xml" /></function><function><name>meta.rating</name><uri>https://wiki.comfsm.fm/@api/deki/meta.rating</uri><description>Add simple content rating to the page.</description><param name="content" type="str">content rating</param><return type="xml" /></function><function><name>meta.googlebot</name><uri>https://wiki.comfsm.fm/@api/deki/meta.googlebot</uri><description>Add control statements for Google's search engine to the page.</description><param name="content" type="str">google search engine control statements</param><return type="xml" /></function><function><name>meta.custom</name><uri>https://wiki.comfsm.fm/@api/deki/meta.custom</uri><description>Add a custom meta tag to the page.</description><param name="name" type="str">meta property name</param><param name="content" type="str">meta property value</param><return type="xml" /></function><function><name>meta.refresh</name><uri>https://wiki.comfsm.fm/@api/deki/meta.refresh</uri><description>Add an automatice reload/redirect to the page.</description><param name="delay" type="num">delay in seconds</param><param name="redirect" type="uri" optional="true">redirect URI (default: current page)</param><return type="xml" /></function></extension>