From cca3c34faa9c1d5fc56e88e42f1c8054b4c4eaac Mon Sep 17 00:00:00 2001 From: Dries Buytaert Date: Sat, 9 Oct 2004 06:29:16 +0000 Subject: - Patch #11401 by Goba: documentation updates: + Made error strings in blog.module consistent. + Explained a bit better what the RSD setting is for in the blog module. + Removed the notes about PHP content from block module and book module, since everything is handled via the input formats now. --- modules/block.module | 2 +- modules/block/block.module | 2 +- modules/blogapi.module | 14 +++++++------- modules/blogapi/blogapi.module | 14 +++++++------- modules/book.module | 4 ++-- modules/book/book.module | 4 ++-- 6 files changed, 20 insertions(+), 20 deletions(-) (limited to 'modules') diff --git a/modules/block.module b/modules/block.module index 605de85ab..3b604f13a 100644 --- a/modules/block.module +++ b/modules/block.module @@ -27,7 +27,7 @@ function block_help($section) { case 'admin/block': return t("Blocks are the boxes in the left- and right- side bars of the web site, depending on the chosen theme. They are made available active modules or created manually. The \"enabled\" checkbox sets the default status of the block. Only enabled blocks are shown. When the \"custom\" checkbox is checked, your users can show or hide the block using their account settings. In that case, the 'enabled' checkbox signifies the block's default status. You can assign the block's placement by giving it a region and a weight. The region specifies which side of the page the block is on, and the weight sorts blocks within a region. Lighter (smaller weight value) blocks \"float up\" towards the top of the page. The path setting lets you define which pages you want a block to be shown on. Blocks can automatically be temporarily disabled to reduce server load when your site becomes extremely busy by checking throttle. The auto-throttle functionality must be enabled on the throttle configuration page after having enabled the throttle module.", array('%throttle' => url('admin/settings/throttle'))); case 'admin/block/add': - return t("Here you can create a new block. Once you have created this block you must make it active and give it a place on the page using blocks. The title is used when displaying the block. The description is used in the \"block\" column on the blocks page. If you are going to place PHP code in the block, and you have the create php content permission (see the permissions page), you must change the type to PHP to make your code active.", array('%overview' => url('admin/block'), '%permission' => url('admin/user/configure/permission'))); + return t("Here you can create a new block. Once you have created this block you must make it active and give it a place on the page using blocks. The title is used when displaying the block. The description is used in the \"block\" column on the blocks page.", array('%overview' => url('admin/block'))); } } diff --git a/modules/block/block.module b/modules/block/block.module index 605de85ab..3b604f13a 100644 --- a/modules/block/block.module +++ b/modules/block/block.module @@ -27,7 +27,7 @@ function block_help($section) { case 'admin/block': return t("Blocks are the boxes in the left- and right- side bars of the web site, depending on the chosen theme. They are made available active modules or created manually. The \"enabled\" checkbox sets the default status of the block. Only enabled blocks are shown. When the \"custom\" checkbox is checked, your users can show or hide the block using their account settings. In that case, the 'enabled' checkbox signifies the block's default status. You can assign the block's placement by giving it a region and a weight. The region specifies which side of the page the block is on, and the weight sorts blocks within a region. Lighter (smaller weight value) blocks \"float up\" towards the top of the page. The path setting lets you define which pages you want a block to be shown on. Blocks can automatically be temporarily disabled to reduce server load when your site becomes extremely busy by checking throttle. The auto-throttle functionality must be enabled on the throttle configuration page after having enabled the throttle module.", array('%throttle' => url('admin/settings/throttle'))); case 'admin/block/add': - return t("Here you can create a new block. Once you have created this block you must make it active and give it a place on the page using blocks. The title is used when displaying the block. The description is used in the \"block\" column on the blocks page. If you are going to place PHP code in the block, and you have the create php content permission (see the permissions page), you must change the type to PHP to make your code active.", array('%overview' => url('admin/block'), '%permission' => url('admin/user/configure/permission'))); + return t("Here you can create a new block. Once you have created this block you must make it active and give it a place on the page using blocks. The title is used when displaying the block. The description is used in the \"block\" column on the blocks page.", array('%overview' => url('admin/block'))); } } diff --git a/modules/blogapi.module b/modules/blogapi.module index f952c18da..ad2b4a568 100644 --- a/modules/blogapi.module +++ b/modules/blogapi.module @@ -153,7 +153,7 @@ function blogapi_new_post($req_params) { return new xmlrpcresp(new xmlrpcval($nid, 'string')); } - return blogapi_error(t('error storing post')); + return blogapi_error(t('Error storing post.')); } /** @@ -213,7 +213,7 @@ function blogapi_edit_post($req_params) { return new xmlrpcresp(new xmlrpcval(true, 'boolean')); } - return blogapi_error(t('error storing node')); + return blogapi_error(t('Error storing post.')); } /** @@ -263,11 +263,11 @@ function blogapi_new_media_object($req_params) { $data = $params[3]['bits']; if (!$data) { - return blogapi_error(t('No file sent')); + return blogapi_error(t('No file sent.')); } if (!$file = file_save_data($data, $name)) { - return blogapi_error(t('Error storing file')); + return blogapi_error(t('Error storing file.')); } // Return the successful result. @@ -412,7 +412,7 @@ function blogapi_supported_text_filters($req_params) { * trackback module. */ function blogapi_get_trackback_pings($req_params) { - return blogapi_error(t('not implemented')); + return blogapi_error(t('Not implemented.')); } /** @@ -424,7 +424,7 @@ function blogapi_publish_post($req_params) { $user = blogapi_validate_user($params[1], $params[2]); $node = node_load(array('nid' => $params[0])); if (!$node) { - return blogapi_error(t('invalid node')); + return blogapi_error(t('Invalid post.')); } $node->status = 1; @@ -504,7 +504,7 @@ function blogapi_blogger_title(&$contents) { } function blogapi_settings() { - $output = form_select(t('XML-RPC Engine'), 'blogapi_engine', variable_get('blogapi_engine', 0), array(0 => 'Blogger', 1 => 'MetaWeblog', 2 => 'Movabletype'), t('RSD or Really-Simple-Discovery is a mechanism which allows external blogger tools to discover the APIs they can use to interact with Drupal. The common XML-RPC engines are Blogger, MetaWeblog and Movabletype. If you are not sure which is the correct setting, choose Blogger.')); + $output = form_select(t('XML-RPC Engine'), 'blogapi_engine', variable_get('blogapi_engine', 0), array(0 => 'Blogger', 1 => 'MetaWeblog', 2 => 'Movabletype'), t('RSD or Really-Simple-Discovery is a mechanism which allows external blogger tools to discover the APIs they can use to interact with Drupal. Here you can set the preferred method for blogger tools to interact with your site. The common XML-RPC engines are Blogger, MetaWeblog and Movabletype. If you are not sure which is the correct setting, choose Blogger.')); return $output; } diff --git a/modules/blogapi/blogapi.module b/modules/blogapi/blogapi.module index f952c18da..ad2b4a568 100644 --- a/modules/blogapi/blogapi.module +++ b/modules/blogapi/blogapi.module @@ -153,7 +153,7 @@ function blogapi_new_post($req_params) { return new xmlrpcresp(new xmlrpcval($nid, 'string')); } - return blogapi_error(t('error storing post')); + return blogapi_error(t('Error storing post.')); } /** @@ -213,7 +213,7 @@ function blogapi_edit_post($req_params) { return new xmlrpcresp(new xmlrpcval(true, 'boolean')); } - return blogapi_error(t('error storing node')); + return blogapi_error(t('Error storing post.')); } /** @@ -263,11 +263,11 @@ function blogapi_new_media_object($req_params) { $data = $params[3]['bits']; if (!$data) { - return blogapi_error(t('No file sent')); + return blogapi_error(t('No file sent.')); } if (!$file = file_save_data($data, $name)) { - return blogapi_error(t('Error storing file')); + return blogapi_error(t('Error storing file.')); } // Return the successful result. @@ -412,7 +412,7 @@ function blogapi_supported_text_filters($req_params) { * trackback module. */ function blogapi_get_trackback_pings($req_params) { - return blogapi_error(t('not implemented')); + return blogapi_error(t('Not implemented.')); } /** @@ -424,7 +424,7 @@ function blogapi_publish_post($req_params) { $user = blogapi_validate_user($params[1], $params[2]); $node = node_load(array('nid' => $params[0])); if (!$node) { - return blogapi_error(t('invalid node')); + return blogapi_error(t('Invalid post.')); } $node->status = 1; @@ -504,7 +504,7 @@ function blogapi_blogger_title(&$contents) { } function blogapi_settings() { - $output = form_select(t('XML-RPC Engine'), 'blogapi_engine', variable_get('blogapi_engine', 0), array(0 => 'Blogger', 1 => 'MetaWeblog', 2 => 'Movabletype'), t('RSD or Really-Simple-Discovery is a mechanism which allows external blogger tools to discover the APIs they can use to interact with Drupal. The common XML-RPC engines are Blogger, MetaWeblog and Movabletype. If you are not sure which is the correct setting, choose Blogger.')); + $output = form_select(t('XML-RPC Engine'), 'blogapi_engine', variable_get('blogapi_engine', 0), array(0 => 'Blogger', 1 => 'MetaWeblog', 2 => 'Movabletype'), t('RSD or Really-Simple-Discovery is a mechanism which allows external blogger tools to discover the APIs they can use to interact with Drupal. Here you can set the preferred method for blogger tools to interact with your site. The common XML-RPC engines are Blogger, MetaWeblog and Movabletype. If you are not sure which is the correct setting, choose Blogger.')); return $output; } diff --git a/modules/book.module b/modules/book.module index 9184262f5..0e9fc11a4 100644 --- a/modules/book.module +++ b/modules/book.module @@ -792,14 +792,14 @@ function book_help($section) { return t("

The book organises content into a nested hierarchical structure. It is particularly good for manuals, Frequently Asked Questions (FAQs) and the like, allowing you to have chapters, sections, etc.

A book is simply a collection of nodes that have been linked together. These nodes are usually of type book page, but you can insert nodes of any type into a book outline. Every node in the book has a parent node which \"contains\" it. This is how book.module establishes its hierarchy. At any given level in the hierarchy, a book can contain many nodes. All these sibling nodes are sorted according to the weight that you give them.

-

A book page is a special node type that allows you to embed PHP within the body of the page. This capability is only offered to administrators, since malicious users could abuse this power. In addition, book pages contain a log message field which helps your users understand the motivation behind an edit of a book page. Each edited version of a book page is stored as a new revision of a node. This capability makes it easy to revert to an old version of a page, should that be desirable.

+

Book pages contain a log message field which helps your users understand the motivation behind an edit of a book page. Each edited version of a book page is stored as a new revision of a node. This capability makes it easy to revert to an old version of a page, should that be desirable.

Like other node types, book submissions and edits may be subject to moderation, depending on your configuration. Similarly, books use permissions to determine who may read and write to them. Only administrators are allowed to create new books, which are really just nodes whose parent is <top-level>. To include an existing node in your book, click on the \"outline\"-tab on the node's page. This enables you to place the node wherever you'd like within the book hierarchy. To add a new node into your book, use the create content » book page link.

Administrators may review the hierarchy of their books by clicking on the collaborative book link in the adminstration pages. There, nodes may be edited, reorganized, removed from book, and deleted. This behavior may change in the future. When a parent node is deleted, it may leave behind child nodes. These nodes are now orphans. Administrators should periodically review their books for orphans and reaffiliate those pages as desired. Finally, administrators may also export their books to a single, flat HTML page which is suitable for printing.

Maintaining a FAQ using a collaborative book

Collaborative books let you easily set up a Frequently Asked Questions (FAQ) section on your web site. The main benefit is that you don't have to write all the questions/answers by yourself - let the community do it for you!

In order to set up the FAQ, you have to create a new book which will hold all your content. To do so, click on the create content » book page link. Give it a thoughtful title, and body. A title like \"Estonia Travel - FAQ\" is nice. You may always edit these fields later. You will probably want to designate <top-level> as the parent of this page. Leave the log message and type fields blank for now. After you have submitted this book page, you are ready to begin filling up your book with questions that are frequently asked.

Whenever you come across a post which you want to include in your FAQ, click on the administer link. Then click on the edit book outline button at the bottom of the page. Then place the relevant post wherever is most appropriate in your book by selecting a parent. Books are quite flexible. They can have sections like Flying to Estonia, Eating in Estonia and so on. As you get more experienced with the book module, you can reorganize posts in your book so that it stays organized.

-

Notes:

", array('%permissions' => url('admin/user/configure/permission'), "%create" => url('node/add/book'), '%collaborative-book' => url('admin/node/book'), '%orphans-book' => url('admin/node/book/orphan'), '%export-book' => url('book/print'))); +

Notes:

", array('%permissions' => url('admin/user/configure/permission'), "%create" => url('node/add/book'), '%collaborative-book' => url('admin/node/book'), '%orphans-book' => url('admin/node/book/orphan'), '%export-book' => url('book/print'))); case 'admin/modules#description': return t('Allows users to collaboratively author a book.'); case 'admin/node/book': diff --git a/modules/book/book.module b/modules/book/book.module index 9184262f5..0e9fc11a4 100644 --- a/modules/book/book.module +++ b/modules/book/book.module @@ -792,14 +792,14 @@ function book_help($section) { return t("

The book organises content into a nested hierarchical structure. It is particularly good for manuals, Frequently Asked Questions (FAQs) and the like, allowing you to have chapters, sections, etc.

A book is simply a collection of nodes that have been linked together. These nodes are usually of type book page, but you can insert nodes of any type into a book outline. Every node in the book has a parent node which \"contains\" it. This is how book.module establishes its hierarchy. At any given level in the hierarchy, a book can contain many nodes. All these sibling nodes are sorted according to the weight that you give them.

-

A book page is a special node type that allows you to embed PHP within the body of the page. This capability is only offered to administrators, since malicious users could abuse this power. In addition, book pages contain a log message field which helps your users understand the motivation behind an edit of a book page. Each edited version of a book page is stored as a new revision of a node. This capability makes it easy to revert to an old version of a page, should that be desirable.

+

Book pages contain a log message field which helps your users understand the motivation behind an edit of a book page. Each edited version of a book page is stored as a new revision of a node. This capability makes it easy to revert to an old version of a page, should that be desirable.

Like other node types, book submissions and edits may be subject to moderation, depending on your configuration. Similarly, books use permissions to determine who may read and write to them. Only administrators are allowed to create new books, which are really just nodes whose parent is <top-level>. To include an existing node in your book, click on the \"outline\"-tab on the node's page. This enables you to place the node wherever you'd like within the book hierarchy. To add a new node into your book, use the create content » book page link.

Administrators may review the hierarchy of their books by clicking on the collaborative book link in the adminstration pages. There, nodes may be edited, reorganized, removed from book, and deleted. This behavior may change in the future. When a parent node is deleted, it may leave behind child nodes. These nodes are now orphans. Administrators should periodically review their books for orphans and reaffiliate those pages as desired. Finally, administrators may also export their books to a single, flat HTML page which is suitable for printing.

Maintaining a FAQ using a collaborative book

Collaborative books let you easily set up a Frequently Asked Questions (FAQ) section on your web site. The main benefit is that you don't have to write all the questions/answers by yourself - let the community do it for you!

In order to set up the FAQ, you have to create a new book which will hold all your content. To do so, click on the create content » book page link. Give it a thoughtful title, and body. A title like \"Estonia Travel - FAQ\" is nice. You may always edit these fields later. You will probably want to designate <top-level> as the parent of this page. Leave the log message and type fields blank for now. After you have submitted this book page, you are ready to begin filling up your book with questions that are frequently asked.

Whenever you come across a post which you want to include in your FAQ, click on the administer link. Then click on the edit book outline button at the bottom of the page. Then place the relevant post wherever is most appropriate in your book by selecting a parent. Books are quite flexible. They can have sections like Flying to Estonia, Eating in Estonia and so on. As you get more experienced with the book module, you can reorganize posts in your book so that it stays organized.

-

Notes:

", array('%permissions' => url('admin/user/configure/permission'), "%create" => url('node/add/book'), '%collaborative-book' => url('admin/node/book'), '%orphans-book' => url('admin/node/book/orphan'), '%export-book' => url('book/print'))); +

Notes:

", array('%permissions' => url('admin/user/configure/permission'), "%create" => url('node/add/book'), '%collaborative-book' => url('admin/node/book'), '%orphans-book' => url('admin/node/book/orphan'), '%export-book' => url('book/print'))); case 'admin/modules#description': return t('Allows users to collaboratively author a book.'); case 'admin/node/book': -- cgit v1.2.3