From 6842d59732859beeb291e04bc433618bd586ce5b Mon Sep 17 00:00:00 2001 From: Dries Buytaert Date: Wed, 13 Aug 2003 18:40:26 +0000 Subject: - Documentation fixes by Michael F. --- modules/bloggerapi.module | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) (limited to 'modules/bloggerapi.module') diff --git a/modules/bloggerapi.module b/modules/bloggerapi.module index 0535fa21f..c159194a7 100644 --- a/modules/bloggerapi.module +++ b/modules/bloggerapi.module @@ -379,21 +379,21 @@ function bloggerapi_help($section) { case 'admin/bloggerapi/help': case 'admin/help': $output = "

Introduction

"; - $output .= strtr("

%blogger-com, the well-known public weblog service, provides an application programing interface (API) to allow remote procedure calls (RPC) to the Blogger service. Drupal supports this %blogger-api, which means that many remote clients (e.g. %client-radio, %client-blogbuddy, %client-w_bloggar, and %client-textrouter) may post to Drupal. These clients provide a bevy of interesting capabilities like offline composing, spellcheck, and WYSIWYG editing; many folks prefer to blog with a client application over typical web forms. By supporting the Blogger API, Drupal grows grander than a web site engine, it's a content accepting machine™.

", array("%blogger-com" => l(t("Blogger"), "www.blogger.com", array("location" => "global")), "%blogger-api" => l(t("Blogger API"), "www.blogger.com/developers/api/1_docs/", array("location" => "global")), "%client-radio" => l(t("Radio"), "radio.userland.com", array("location" => "global")), "%client-blogbuddy" => l(t("BlogBuddy"), "blogbuddy.sourceforge.net", array("location" => "global")), "%client-w_bloggar" => l(t("w.bloggar"), "www.wbloggar.com", array("location" => "global")), "%client-textrouter" => l(t("TextRouter"), "projects.kittle.info/tr", array("location" => "global")) )); - $output .= strtr("

The %blogger-api uses the %xml-rpc protocol for communicating with the outside world. %xml-rpc, originally developed by Dave Winer of %userland-software, is a simple XML-based RPC specification ideally suited to the web. Drupal also uses %xml-rpc for several other tasks (e.g. notifiying %weblogs-com of blog updates and making/accepting %dist-auth requests)

",array("%blogger-api" => l(t("Blogger API"), "www.blogger.com/developers/api/1_docs", array("location" => "global")), "%xml-rpc" => l(t("XML-RPC"), "www.xmlrpc.com", array("location" => "global")), "%userland-software" => l(t("UserLand Software"), "www.userland.com", array("location" => "global")), "%weblogs-com" => l(t("weblogs.com"), "www.weblogs.com", array("location" => "global")), "%dist-auth" => l(t("distributed authentication"), "user/help") )) ; + $output .= strtr("

%blogger-com, the well-known public weblog service, provides an application programing interface (API) to allow remote procedure calls (RPC) to the Blogger service. Drupal supports this %blogger-api, which means that many remote clients (e.g. %client-radio, %client-blogbuddy, %client-w_bloggar, and %client-textrouter) may post to Drupal. These clients provide a bevy of interesting capabilities like offline composing, spellcheck, and WYSIWYG editing; many folks prefer to blog with a client application over typical web forms. By supporting the Blogger API, Drupal grows grander than a web site engine, it's a content accepting machine™.

", array("%blogger-com" => "". t("Blogger") ."", "%blogger-api" => "". t("Blogger API") ."", "%client-radio" => "". t("Radio") ."", "%client-blogbuddy" => "". t("BlogBuddy") ."", "%client-w_bloggar" => "". t("w.bloggar") ."", "%client-textrouter" => "". t("TextRouter") ."" )); + $output .= strtr("

The %blogger-api uses the %xml-rpc protocol for communicating with the outside world. %xml-rpc, originally developed by Dave Winer of %userland-software, is a simple XML-based RPC specification ideally suited to the web. Drupal also uses %xml-rpc for several other tasks (e.g. notifiying %weblogs-com of blog updates and making/accepting %dist-auth requests)

",array("%blogger-api" => "". t("Blogger API") ."", "%xml-rpc" => "". t("XML-RPC") ."", "%userland-software" => "". t("UserLand Software") ."", "%weblogs-com" => "". t("weblogs.com") ."", "%dist-auth" => l(t("distributed authentication"), "user/help") )) ; $output .= "

Blogger API implementation

"; - $output .= strtr("

A word of warning on the Blogger API: it is unofficial. It exists because Blogger is one of the most popular and the first service to implement an XML-RPC interface. It may not be the best implementation of a distributed weblog API. For a promising candidate, see the %echo-proj.

", array("%echo-proj" => l(t("Echo project"), "www.intertwingly.net/wiki/pie/RoadMap", array("location" => "global")) )); + $output .= strtr("

A word of warning on the Blogger API: it is unofficial. It exists because Blogger is one of the most popular and the first service to implement an XML-RPC interface. It may not be the best implementation of a distributed weblog API. For a promising candidate, see the %echo-proj.

", array("%echo-proj" => "". t("Echo project") ."" )); $output .= "

Drupal's support for the Blogger API is quite complete. Each method with an asterisk below has been implemented in Drupal.

"; - $output .= strtr("

%bloggerapi-newpost
%bloggerapi-editpost
%bloggerapi-getuserblogs
%bloggerapi-getuserinfo
%bloggerapi-gettemplate
%bloggerapi-settemplate

", array("%bloggerapi-newpost" => l(t("blogger.newPost()*"), "%blogger-api/xmlrpc_newPost.html", array("location" => "global")), "%bloggerapi-editpost" => l(t("blogger.editPost()*"), "%blogger-api/xmlrpc_editPost.html", array("location" => "global")), "%bloggerapi-getuserblogs" => l(t("blogger.getUsersBlogs()*"), "%blogger-api/xmlrpc_getUserBlogs.html", array("location" => "global")), "%bloggerapi-getuserinfo" => l(t("blogger.getUserInfo()*"), "%blogger-api/xmlrpc_getUserInfo.html", array("location" => "global")), "%bloggerapi-gettemplate" => l(t("blogger.getTemplate()*"), "%blogger-api/xmlrpc_getTemplate.html", array("location" => "global")), "%bloggerapi-settemplate" => l(t("blogger.setTemplate()*"), "%blogger-api/xmlrpc_setTemplate.html", array("location" => "global")) )); - $output = strtr($output, array("%blogger-api" => "www.blogger.com/developers/api/1_docs")); + $output .= strtr("

%bloggerapi-newpost
%bloggerapi-editpost
%bloggerapi-getuserblogs
%bloggerapi-getuserinfo
%bloggerapi-gettemplate
%bloggerapi-settemplate

", array("%bloggerapi-newpost" => "%blogger-api/xmlrpc_newPost.html\">". t("blogger.newPost()*") ."", "%bloggerapi-editpost" => "%blogger-api/xmlrpc_editPost.html\">". t("blogger.editPost()*") ."", "%bloggerapi-getuserblogs" => "%blogger-api/xmlrpc_getUserBlogs.html\">". t("blogger.getUsersBlogs()*") ."", "%bloggerapi-getuserinfo" => "%blogger-api/xmlrpc_getUserInfo.html\">". t("blogger.getUserInfo()*") ."", "%bloggerapi-gettemplate" => "%blogger-api/xmlrpc_getTemplate.html\">". t("blogger.getTemplate()*") ."", "%bloggerapi-settemplate" => "blogger-api/xmlrpc_setTemplate.html\">". t("blogger.setTemplate()*") ."" )); + $output = strtr($output, array("%blogger-api" => "%mess-296
%mess-225
%mess-147

", array("%mess-296" => l(t("blogger.getPost()*"), "%blogger-dev/296", array("location" => "global")), "%mess-225" => l(t("blogger.getRecentPosts()*"), "%blogger-dev/225", array("location" => "global")), "%mess-147" => l(t("blogger.deletePost()*"), "%blogger-dev/147", array("location" => "global")) )); - $output = strtr($output, array("%blogger-dev" => "groups.yahoo.com/group/bloggerDev/message")); + $output .= strtr("

%mess-296
%mess-225
%mess-147

", array("%mess-296" => "%blogger-dev/296\">". t("blogger.getPost()*") ."", "%mess-225" => "%blogger-dev/225\">". t("blogger.getRecentPosts()*") ."", "%mess-147" => "%blogger-dev/147\">". t("blogger.deletePost()*") ."" )); + $output = strtr($output, array("%blogger-dev" => "To install the Blogger API module, enable the module on the %mod-config. Also make sure you have your permissions set correctly for accessing the Blogger API, the relevant settings can be found under the %user-management section in the administration pages. Check the checkbox behind the line \"access Blogger API\" for the roles that are allowed to use the Blogger API.

", array("%mod-config" => l(t("modules configuration page"), "admin/systems/modules"), "%user-management" => l(t("user management"), "admin/user/permission") )); $output .= "

Once the API is enabled you can download one of the above mentioned Blogger API clients and get blogging.

"; $output .= "

Setup of the client

"; - $output .= strtr("

The Drupal page you need to call in order to connect using the Blogger API is http://server/xmlrpc.php where server is the URL of the site you want to post to. As an example when posting to drupal.org, the account settings for %client-wbloggar would be: host: www.drupal.org (default = plant.blogger.com) and page: xmlrpc.php (default = /api/RPC2).

", array("%client-wbloggar" => l(t("w.bloggar"), "www.wbloggar.com", array("location" => "global")) )); + $output .= strtr("

The Drupal page you need to call in order to connect using the Blogger API is http://server/xmlrpc.php where server is the URL of the site you want to post to. As an example when posting to drupal.org, the account settings for %client-wbloggar would be: host: www.drupal.org (default = plant.blogger.com) and page: xmlrpc.php (default = /api/RPC2).

", array("%client-wbloggar" => "". t("w.bloggar") ."" )); $output .= "

You can't use remote authentication when posting using a Blogger API enabled client, even when you could use that to authenticate on the site itself. You will have to use the site's local username, enter a password for that account, and then use that combination to post using the Blogger API client.

"; $output .= "

Notes and limitations

"; $output .= ""; -- cgit v1.2.3