|
==== dokuwiki.getPagelist ====
^Name|''dokuwiki.getPagelist'' |
^Parameters|(string) namespace, (array) options|
^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]]. |
==== dokuwiki.search ====
^Name |''dokuwiki.search'' |
^Parameters |(string) a query string as described on [[doku>search|search]]|
^Description|Performs a fulltext search based on the raw string|
==== dokuwiki.getTitle ====
^Name |''dokuwiki.getTitle'' |
^Parameters |-|
^Description|Returns the title of the wiki.|
==== dokuwiki.appendPage ====
^Name |''dokuwiki.appendPage '' |
^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.|
^Description|Appends text to a Wiki Page.|
==== wiki.aclCheck ====
^Name |''wiki.aclCheck'' |
^Parameters |(string) [[doku>:pagename]]|
^Description|Returns the permission of the given wikipage.|
==== wiki.getPage ====
^Name |''wiki.getPage'' |
^Parameters |(string) [[doku>:pagename]]|
^Description|Returns the raw Wiki text for a page.|
==== plugin.xcom.pageVersions ====
^Name |''plugin.xcom.pageVersions'' |
^Parameters |(string) [[doku>:pagename]] , (int) offset|
^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.|
==== plugin.xcom.getPageInfo ====
^Name |''plugin.xcom.getPageInfo'' |
^Parameters |(string) [[doku>:pagename]]|
^Description|Returns information about a Wiki page.|
==== wiki.getPageHTML ====
^Name |''wiki.getPageHTML'' |
^Parameters |(string) [[doku>:pagename]]|
^Description|Returns the rendered XHTML body of a Wiki page.|
==== wiki.putPage ====
^Name |''wiki.putPage'' |
^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]]|
^Description|Saves a Wiki Page to the remote wiki.|
==== wiki.listLinks ====
^Name |''wiki.listLinks'' |
^Parameters |(string) [[doku>:pagename|pagename]]|
^Description|Returns a list of all links contained in a Wiki page.|
==== wiki.getAllPages ====
^Name |''wiki.getAllPages'' |
^Description|Returns a list of all Wiki pages in the remote Wiki.|
==== wiki.getBackLinks ====
^Name |''wiki.getBackLinks'' |
^Parameters |(string) [[doku>:pagename]]|
^Description|Returns a list of [[doku>:backlinks]] of a Wiki page.|
==== wiki.getRecentChanges ====
^Name |''wiki.getRecentChanges'' |
^Parameters |(int) timestamp (See below: [[#timestamp|timestamp]])|
^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.|
==== wiki.getRecentMediaChanges ====
^Name |''wiki.getRecentMediaChanges'' |
^Parameters |(int) timestamp (See below: [[#timestamp|timestamp]])|
^Description|Returns a list of recent changed media since given timestamp.|
==== wiki.getAttachments ====
^Name|''wiki.getAttachments'' |
^Parameters|(String) namespace, (array) options|
^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. |
==== wiki.getAttachment ====
^Name |''wiki.getAttachment'' |
^Parameters |(String) id|
^Description|Returns the binary data of a media file|
==== wiki.getAttachmentInfo ====
^Name |''wiki.getAttachmentInfo'' |
^Parameters |(String) id|
^Description|Returns information about a media file|
==== wiki.deleteAttachment ====
^Name |''wiki.deleteAttachment'' |
^Parameters |(String) id|
^Description|Deletes a file. Fails if the file is still referenced from any page in the wiki.|
==== plugin.acl.addAcl ====
^Name |''plugin.acl.addAcl'' |
^Parameters |(String) scope, (String) username, (int) permission|
^Description|Add an ACL rule. Use ''@groupname'' instead of ''user'' to add an ACL rule for a group|
==== plugin.acl.delAcl ====
^Name |''plugin.acl.delAcl'' |
^Parameters |(String) scope, (String) username|
^Description|Delete any ACL rule matching the given scope and user. Use ''@groupname'' instead of ''user'' to delete the ACL rules for the group|
==== plugin.xcom.getMedia ====
^Name |''plugin.xcom.getMedia'' |
^Parameters |(String) id|
^Description|List the media files in a page (id)|
==== plugin.xcom.listNamespaces ====
^Name|''plugin.xcom.listNamespaces'' |
^Parameters|(String) namespace id, (Array) exclusions|
^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 |
==== plugin.xcom.GetMetaData ====
^Name|''plugin.xcom.GetMetaData'' |
^Parameters|(String) namespace or page id|
^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.|
==== Timestamp ====
Enter a date formatted all in numerals as follows: YYYY-MM-DD, e.g. // 2011-3-19 //. The timestamp will be created for you.
|
DokuWiki markup allowed
|
| ===== Purpose =====
With this app users can conveniently communicate with Dokuwiki's xmlrpc library. It can be on any Dokuwiki, including the one which you are currently logged into. The user can then communicate and exchange data between the local wiki and a remote wiki.
===== Basics =====
At its simplest you enter the URL of the remote wiki into the ''Remote URL'' text box, you select a query form the ''Select query'' drop-down menu, and you click ''Send query''. So, for instance, if you select ''getAllPages'', the result will be a list of all the pages on the remote wiki. Often, however, queries require an id. For these, you enter the id in the ''ID'' textbox. If you enter a paged id, then select listLinks, a list of all the links for that page, and their types, will be returned.
===== Dashboard Layout =====
* Top Row: Buttons for controlling what appears on the screen and the ''Send Query'' button for submitting the query.
* Second and third rows: inputs for constructing the query
* Third row:
- A drop-down menu for selecting pre-defined remote sites and their credentials
- A button for saving remote data to the local wiki and the credentials of the local wiki
* A status bar with action links to clear the various views and to display the current query
* Above the status bar is the output window where the results of the query are displayed. They open automatically when the query is completed.
==== Instructions for creating the query ====
- Enter the URL to the remote site. If your remote site is at ''<nowiki>http://www.example.com</nowiki>'' and the name of the wiki is ''my_wiki'', then you would enter ''<nowiki>http://www.example.com/my_wiki</nowiki>''. \\ As explained above the 'remote site' simply refers to the site which holds the xmlrpc interface with which you are communicating and could therefore be the site that you are currently logged into.
- Enter the remote user name and password for the remote site. In your configuration settings you must enable the "Remote API system" and identify the remote user(s) or group(s).
- Select your query type from the drop-down ''Select query'' menu.
- If your query requires an id, enter that in the ''ID'' text box. The id must be the complete id that identifies the page on the remote server, in other words, including the namespace.
- Some queries may require additional options. Clicking the ''Query types'' button will bring up a listing of query types and their options. Enter these options, in the order listed, separated by commas, in the ''Options'' text box. ** Do not ** re-enter the ''id'' in this additional list of options.
- Options which expect arrays are enclosed in parentheses: ''(option)''. See the ''Query types'' listing for details on how to handle array options for specific queries.
- There are more query types found on Dokuwiki's [[https://dokuwiki.org/devel:xmlrpc|xmlrpc page]] than are listed in the ''Select query'' menu. If you want to use one of those, then enter the complete listing, including the function name into the ''Options'' box. The function name must come first and then, in order listed, the options. They must all be separated by commas, including the function name. For instance: \\ ''wiki.function,parameter_1, parameter_2''
- ''Timestamps'': Some queries require a timestamp as a parameter. Xcom will create the timestamp for you. Enter the date in the ''Options'' box in this format: yyyy-mm-dd, for instance 2014-05-29.
==== Views ====
There are three display views: HTML, Edit, and Code. These are all contained within an "Output" window. When the result of a query is displayed, this window opens and the contents of your query will appear in one of these three views, depending upon the output. More than one view can be open at any one time, so that, for instance, you can be looking at the markup for a page while also viewing it as HTML. You can close and re-open these views using the buttons at the top right of the screen. And you can close the Output window entirely.
- ''Edit'' view enables you to make changes to the markup and save it back to the remote wiki which, as nted above, could be the wiki you are currently logged into. It also enables you to add material to a page by appending.
- ''HTML view'' is used to display wiki pages and to display query results that can be conveniently formatted as HTML.
- The ''Code view'' is preformatted text. It's used for simple plain text responses and complex arrays which may in later versions of xcom be re-formatted as tables.
==== Status Bar ====
In the status bar at the bottom of the screen there are command links which enable you to ''Clear'' the contents from each of the three view windows. The status bar also contains a ''Query'' field where the current query is displayed. At the far right is a link which enables you to submit the query.
==== Local Save ====
The ''Local save'' button makes it possible to move pages and media from the remote wiki to the local wiki. Enter the id of a remote page or media file into the ''ID'' field and click the ''Local save'' button. If you select a page id, the page and all of its referenced media will be copied to the local server. All will be copied to the correct namespaces, including the page itself. If, instead of a page id,you enter a media id, the media file will also be copied to the correct namespace.
To use the feature you must fill in the local user's xmlrpc user name and password in the text boxes. The local url will be automtically retrieved from the system.
There is an alternate way of importing pages and media from the remote to the local wiki. There are several query types which return lists of pages and/or media with the ids in the first column. These are:
* dokuwiki.getPagelist
* wiki.getAllPages
* wiki.getAttachments (media files)
* dokuwiki.search
**''dokuwiki.getPagelist''** will take a namespace in the ''ID'' field and return all the pages in that namespace. **''wiki.getAllPages''** will return all the pages on the remote wiki. Finally, **''wiki_getAttachments''** returns media files and behaves exactly as **''dokuwiki.getPagelist''**. The latter takes a namespace in the ID field and requires a regular expression in the Options field. The regular expression must be placed between hashes and passed in as an array. For instance, if you want to get all PNG images in a namespace, you would enter the following expression in the options field: ''(#\.png#)''. **''dokuwiki.search''** takes a query string as described in [[doku>search]] and returns a page of snippets from pages with the matching texts; clicking on the page id's for these snippets opens the full page with all matching texts highlighted.
The results of these queries are formatted as tables in which the first column is an action link. If you click that link, the item will be imported into the local wiki from the remote wiki. If this is a page, all of its media will also be imported.
Action links can also work with queries selected from the drop-down query menu. For more information about this, see the [[doku>plugin:xcom#action_links|xcom plugin page]].
==== Remote Sites Menu ====
There is an initialization file named ''xcom.ini'' which is found in the scripts directory. Use of this file is not required but it can be convenient. The file structure is based on the php,ini format:
<code>
[title]
url=http://www.example.com/mywiki/
user=rpcuser
pwd=rpcpwd
</code>
For each remote wiki that you work with, enter another data block. Only the title is required. The titles of these remote sites will appear in the drop-down menu, and when you select a menu item, the fields with entries will be entered into the remote wiki's text boxes. **Note:** the title entry must be set flush against the left-hand margin.
=== Security ===
The fact that the fields are optional means that you don't have to enter passwords (or even user names). But as another security feature, you can move xcom.ini out of the web server's access. For this, there is a configuration option (''inidir'') for setting an alternate directory for this file, and this can be anywhere on your server. But the file and its directory must be readable.
|
DokuWiki markup allowed
|
| xcom XMLRPC Dashboard
|
|
| For a complete listing with full details see
|
|
| But the xcom listing may differ from that at dokuwiki.org in particulars that apply to the xcom application.
|
|
| close
|
|
| Query types
|
|
| Select query
|
|
| Send query
|
|
| Remote URL
|
|
| User name
|
|
| Password
|
|
| invalid input detected!
|
|
| ID
|
|
| Page, media, or namespace
|
|
| Options
|
|
| Options/User-created query
|
|
| Instructions
|
|
| Show views
|
|
| Edit
|
|
| Code view
|
|
| HTML view
|
|
| Action view
|
|
| Open/close output window
|
|
| Clear
|
|
| Query
|
|
| No connection. Have you set the remote API config options?
|
|
| Query returned no result
|
|
| Hide views
|
|
| View password
|
|
| Hide password
|
|
| Local password
|
|
| Local user
|
|
| Local Save
|
|
| Save remote selection to local server
|
|
| Remote sites
|
|
| Unable to log into local server
|
|
| Unable to log into remote server
|
|
| Please check your authorization credentials or try again later
|
|
| success: logged in.
|
|
| No page name given
|
|
| Not found on the remote server:
|
|
| No media found for
|
|
| Requesting remote media
|
|
| Create permission needed for
|
|
| Unable to import
|
|
| Imported:
|
|
| Upload permission needed for
|
|
| Logging off
|
|
| Logoff function not available
|
|
| Local Dokuwiki version =
|
|
| Remote Dokuwiki version =
|
|
| Saved to local wiki:
|
|
| file size:
|
|
| is a media file:
|
|
| Click OK to save file to the local wiki:
|
|
| Debug:
|
|
| Action Link Results
|
|
| Wrong parameter count:
|
|
| does not take options
|
|
| Bad DokuWiki ID
|
|
| Date format error. Use yyyy-mm-dd
|
|
| requires both a namespace and either a depth or hash entry
|
|
| Required search string missing
|
|
| No Query selected
|
|
| Alternate directory for xcom.ini
|
|
| Size of Remote URL text box. Size is number of characters wide; this does not affect the number of characters that can be entered into the box. You may need this to adjust for browser layout width.
|
|
| Local IP address, e.g. http://192.168.0.5/dokuwiki. Needed only for local saves where the the dokuwiki is accessed by a local alias instead of its IP address.
|
|