DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:xcom

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
Both sides next revision
plugin:xcom [2021-05-11 02:50]
turnermm [Last 8 Commits]
plugin:xcom [2021-05-16 18:32]
turnermm [Views]
Line 6: Line 6:
 email      : turnermm02@shaw.ca email      : turnermm02@shaw.ca
 type       : admin,remote type       : admin,remote
-lastupdate :  2021-05-09+lastupdate :  2021-05-16
 compatible : "Binky", "Weatherwax","Ponder Stibbons","Hrun","detritus",'Frusterick Manners",Greebo,hogfather compatible : "Binky", "Weatherwax","Ponder Stibbons","Hrun","detritus",'Frusterick Manners",Greebo,hogfather
 depends    :  depends    : 
 conflicts  conflicts 
 similar    :  similar    : 
-tags       : xmlrpc,import+tags       : xmlrpc,import,metadata
  
 downloadurl: https://github.com/turnermm/xcom/archive/refs/heads/master.zip downloadurl: https://github.com/turnermm/xcom/archive/refs/heads/master.zip
Line 41: Line 41:
   * A status bar with action links to clear the various views and to display the current query   * 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.   * Above the status bar is the output window where the results of the query are displayed.  They open automatically when the query is completed.
 +  * The remote site can be the local wiki.  Some users might find this particularly useful in combination with the ''xcom.GetMetaData'' query, which makes it possible to check the metadata entries on the local wiki. 
  
 ==== Instructions for creating the query ==== ==== Instructions for creating the query ====
Line 46: Line 47:
   - 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>''. ((Note: the complete url and not for instance: "example.com/my_wiki")) \\ 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 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>''. ((Note: the complete url and not for instance: "example.com/my_wiki")) \\ 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).   - 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.+  - Select your query type from the drop-down ''Select query'' menu. **Important**: Query types that begin with ''plugin.xcom'' or ''xcom'' must have the [[plugin:xcom]] plugin installed on both the local and the remote server, preferably the same version
   - 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. For an optional way to enter an id, see the section on [[#action_link|action links]] below.   - 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. For an optional way to enter an id, see the section on [[#action_link|action links]] below.
   - 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.   - 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.   - 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 [[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: \\ <code>wiki.function,parameter_1, parameter_2</code>   - There are more query types found on DokuWiki's [[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: \\ <code>wiki.function,parameter_1, parameter_2</code>
 +  - The queries that start with ''xcom'' (or ''plugin.xcom'') were written specifically for the xcom plugin.
   - ''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.   - ''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.
  
Line 61: Line 63:
   - ''HTML view''  is used to display wiki pages and to display query results that can be conveniently formatted as HTML.   - ''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 is used for simple plain text responses, error codes, and arrays from queries not in xcom's list of ''Query types''.   - The ''Code view''  is preformatted text. It is used for simple plain text responses, error codes, and arrays from queries not in xcom's list of ''Query types''.
 +  - ''Action View'' holds the results obtained with action links 
  
 ==== Status Bar ==== ==== Status Bar ====
Line 119: Line 122:
  
 ===== Changes ===== ===== Changes =====
-==== Last Commits ====+==== Last 10 Commits ====
  
-{{rss>https://github.com/turnermm/xcom/commits/master.atom date count=8}}+{{rss>https://github.com/turnermm/xcom/commits/master.atom date count=10}}
 ==== 2016 ==== ==== 2016 ====
     *  Mon Oct 24  \\       fixed error return in xml.php \\       fixed copying error in xml.php \\     enabled depth param for dokuwiki.getPagelist()  \\      corrected xref url in funtions list     *  Mon Oct 24  \\       fixed error return in xml.php \\       fixed copying error in xml.php \\     enabled depth param for dokuwiki.getPagelist()  \\      corrected xref url in funtions list
plugin/xcom.txt ยท Last modified: 2021-05-16 18:32 by turnermm