1
2==== dokuwiki.getPagelist ====
3
4^Name|''dokuwiki.getPagelist''   |
5^Parameters|(string) namespace, (array) options|
6^Description|Lists all pages within a given namespace. Use a single colon '':'' for the root namespace. The namespace setting is required. The options are passed directly to [[https://xref.dokuwiki.org/reference/dokuwiki/nav.html?_functions/search_allpages.html|search_allpages()]]. The options array must have one of two items, either ''depth'' or ''hash'' enclosed in parentheses. If not set, it defaults to ''hash''. If ''hash'' is specified, the results will include a column containing a hash of the raw wiki contents of each page found. The ''depth'' option determines the level of recursion. A depth of 1, returns the results the top level of the specified directory, a depth of 2 includes the directories two level below, and so forth. This option is set as follows: (depth:<num>), where num is the number of levels to recurse. Its output is a table of [[https://www.dokuwiki.org/plugin:xcom#action_links|action links]]. |
7
8
9==== dokuwiki.search ====
10
11^Name  |''dokuwiki.search'' |
12^Parameters  |(string) a query string as described on [[doku>search|search]]|
13^Description|Performs a fulltext search based on the raw string|
14
15==== dokuwiki.getTitle ====
16
17^Name  |''dokuwiki.getTitle'' |
18^Parameters  |-|
19^Description|Returns the title of the wiki.|
20
21==== dokuwiki.appendPage ====
22
23^Name  |''dokuwiki.appendPage '' |
24^Parameters  |(string) [[doku>:pagename]], (string) raw Wiki text, (array) attrs \\  Where ''attrs'' can be one of the following: \\ 1. ''(sum;summary text)'' \\ 2. ''(minor;1)'' \\ The semi-colons after ''sum'' and ''minor'' are required. The summary text should not be enclosed in quotation marks.|
25^Description|Appends text to a Wiki Page.|
26
27==== wiki.aclCheck ====
28
29^Name  |''wiki.aclCheck'' |
30^Parameters  |(string) [[doku>:pagename]]|
31^Description|Returns the permission of the given wikipage.|
32
33==== wiki.getPage ====
34
35^Name  |''wiki.getPage'' |
36^Parameters  |(string) [[doku>:pagename]]|
37^Description|Returns the raw Wiki text for a page.|
38
39==== plugin.xcom.pageVersions ====
40
41^Name  |''plugin.xcom.pageVersions'' |
42^Parameters  |(string) [[doku>:pagename]] , (int) offset|
43^Description|Returns the available versions of a Wiki page. The number of pages in the result is controlled \\ via the [[doku>:config:recent]] configuration setting. The offset can be used to list earlier versions in the history.|
44
45
46==== plugin.xcom.getPageInfo ====
47
48^Name  |''plugin.xcom.getPageInfo'' |
49^Parameters  |(string) [[doku>:pagename]]|
50^Description|Returns information about a Wiki page.|
51
52==== wiki.getPageHTML ====
53
54^Name  |''wiki.getPageHTML'' |
55^Parameters  |(string) [[doku>:pagename]]|
56^Description|Returns the rendered XHTML body of a Wiki page.|
57
58==== wiki.putPage ====
59
60^Name  |''wiki.putPage'' |
61^Parameters  |(string) [[doku>:pagename]] , (string) raw Wiki text, (array) attrs \\  Where ''attrs'' is either ''minor'' or it is''sum'', which specifies change summary. The format is the same is in [[#dokuwikiappendpage|dokuwiki.appendPage]]|
62^Description|Saves a Wiki Page to the remote wiki.|
63
64==== wiki.listLinks ====
65
66^Name  |''wiki.listLinks'' |
67^Parameters  |(string) [[doku>:pagename|pagename]]|
68^Description|Returns a list of all links contained in a Wiki page.|
69
70==== wiki.getAllPages ====
71
72^Name  |''wiki.getAllPages'' |
73^Description|Returns a list of all Wiki pages in the remote Wiki.|
74
75==== wiki.getBackLinks ====
76
77^Name  |''wiki.getBackLinks'' |
78^Parameters  |(string) [[doku>:pagename]]|
79^Description|Returns a list of [[doku>:backlinks]] of a Wiki page.|
80
81==== wiki.getRecentChanges ====
82
83^Name  |''wiki.getRecentChanges'' |
84^Parameters  |(int) timestamp (See below: [[#timestamp|timestamp]])|
85^Description|Returns a list of recent changes since given timestamp. \\ As stated in [[doku>:recent_changes|:recent_changes]]: Only the most recent change for each page is listed, \\  regardless of how many times that page was changed.|
86
87==== wiki.getRecentMediaChanges ====
88
89^Name  |''wiki.getRecentMediaChanges'' |
90^Parameters  |(int) timestamp (See below: [[#timestamp|timestamp]])|
91^Description|Returns a list of recent changed media since given timestamp.|
92
93==== wiki.getAttachments ====
94
95^Name|''wiki.getAttachments''   |
96^Parameters|(String) namespace, (array) options|
97^Description|Returns a list of media files in a given namespace. The options array holds a regular expression in this format: ''(#pattern#)''. The hashes are regular expression pattern delimiters; everything between them will be matched against the media file names in ''namespace'' and only the matching files will be returned.  |
98
99==== wiki.getAttachment ====
100
101^Name  |''wiki.getAttachment'' |
102^Parameters  |(String) id|
103^Description|Returns the binary data of a media file|
104
105==== wiki.getAttachmentInfo ====
106
107^Name  |''wiki.getAttachmentInfo'' |
108^Parameters  |(String) id|
109^Description|Returns information about a media file|
110
111==== wiki.deleteAttachment ====
112
113^Name  |''wiki.deleteAttachment'' |
114^Parameters  |(String) id|
115^Description|Deletes a file. Fails if the file is still referenced from any page in the wiki.|
116
117==== plugin.acl.addAcl ====
118
119^Name  |''plugin.acl.addAcl'' |
120^Parameters  |(String) scope, (String) username, (int) permission|
121^Description|Add an ACL rule. Use ''@groupname'' instead of ''user'' to add an ACL rule for a group|
122
123==== plugin.acl.delAcl ====
124
125^Name  |''plugin.acl.delAcl'' |
126^Parameters  |(String) scope, (String) username|
127^Description|Delete any ACL rule matching the given scope and user. Use ''@groupname'' instead of ''user'' to delete the ACL rules for the group|
128
129==== plugin.xcom.getMedia ====
130
131^Name  |''plugin.xcom.getMedia'' |
132^Parameters  |(String) id|
133^Description|List the media files in a page (id)|
134
135==== plugin.xcom.listNamespaces ====
136
137^Name|''plugin.xcom.listNamespaces''   |
138^Parameters|(String) namespace id, (Array) exclusions|
139^Description|Returns a list of sub-namespaces under the specified namespace id. If the namespace id is left blank, the listing will start at the root namespace. To exclude sub-namespaces enter the exclusions array in the ''Options'': ''(id1;id2;id3)''. Note that the array is a series of ids separated by semi-colons and enclosed in parentheses |
140
141
142==== plugin.xcom.GetMetaData ====
143
144^Name|''plugin.xcom.GetMetaData''   |
145^Parameters|(String) namespace or page id|
146^Description|Returns either the metadata for a single page or the metadata for all the pages in a specified namespace and its subdirectories. When choosing a namespace, it must end with colon or a colon and asterisk, i.e.  '':*''. To start at the root directory, either a single colon or a colon followed by an asterisk.|
147
148
149==== Timestamp ====
150
151Enter a date formatted all in numerals as follows: YYYY-MM-DD, e.g. // 2011-3-19 //. The timestamp will be created for you.
152
153