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-04-26 02:18]
turnermm [Last 10 Commits]
plugin:xcom [2021-05-16 18:32] (current)
turnermm [Views]
Line 6: Line 6:
 email      : turnermm02@shaw.ca email      : turnermm02@shaw.ca
 type       : admin,remote type       : admin,remote
-lastupdate :  2020-04-25+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 ====
  
-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.+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. 
 ==== Local Save ==== ==== Local Save ====
  
Line 70: Line 73:
  
 To use this feature you must fill in the local user's xmlrpc user name and password in the text boxes.  The local url will be automatically retrieved from the system. To use this feature you must fill in the local user's xmlrpc user name and password in the text boxes.  The local url will be automatically retrieved from the system.
 +
 +
 +==== Query Types with First Column IDs ====
  
 There are several query types which return lists of pages and media with the ids in the first column. Among them are: There are several query types which return lists of pages and media with the ids in the first column. Among them are:
Line 76: Line 82:
   - wiki.getAllPages  \\  ''wiki.getAllPages'' will return all the pages on the remote wiki.     - wiki.getAllPages  \\  ''wiki.getAllPages'' will return all the pages on the remote wiki.  
   - wiki.getAttachments (media files) \\ ''wiki_getAttachments'' returns media files and behaves exactly as ''dokuwiki.getPagelist''. It 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#)''.   - wiki.getAttachments (media files) \\ ''wiki_getAttachments'' returns media files and behaves exactly as ''dokuwiki.getPagelist''. It 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 \\ ''dokuwiki.search'' behaves like DokuWiki's [[:search|Search]] mechanism. It returns snippets of text with some highlighted matches and links to the pages where the matches occur which. Clicking these links accesses the pages with all their matches highlighted.  The search text is entered as a string, e.g. ''@playground dokuwiki''+  - dokuwiki.search \\ ''dokuwiki.search'' behaves like DokuWiki's [[:search|Search]] mechanism. It returns snippets of text with some highlighted matches and links to the pages where the matches occur which. Clicking these links accesses the pages with all their matches highlighted.  The search text is entered as a string, e.g. '':playground dokuwiki''
    
  
Line 112: Line 118:
   - ''inidir'':  Alternate directory for xcom.ini   - ''inidir'':  Alternate directory for xcom.ini
   - ''textbox_size'': 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   - ''textbox_size'': 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_url'': 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+  - ''local_url'': Local IP address, e.g. %%http://192.168.0.5/dokuwiki%%.  May be needed in some cases for local saves where the the dokuwiki is accessed by a local alias instead of its IP address.  It may also be possible to use 127.0.0.1.
  
  
Line 118: Line 124:
 ==== Last 10 Commits ==== ==== Last 10 Commits ====
  
-{{rss>https://github.com/turnermm/xcom/commits/version_2.atom date count=12}} +{{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
 +
 +
 +
  
 ====   2015 ==== ====   2015 ====
plugin/xcom.1619396298.txt.gz · Last modified: 2021-04-26 02:18 by turnermm