Thousands of web sites, especially news sites and weblogs, syndicate their most recent site content for others to display. The syndicated content always includes titles, also known as headlines, for the newest published stories. Each headline acts as a direct link to the stories on the remote site. Along with the headline, most sites typically provide either the first few paragraphs of the story or a short summary. Many individuals use client-based news aggregators on their personal computer to aggregate content, such as %amphetadesk
"; + $output = "Thousands of web sites, especially news sites and weblogs, syndicate their most recent site content for others to display. The syndicated content always includes titles, also known as headlines, for the newest published stories. Each headline acts as a direct link to the stories on the remote site. Along with the headline, most sites typically provide either the first few paragraphs of the story or a short summary. Many individuals use client-based news aggregators on their personal computer to aggregate content, such as Amphetadesk.
"; $output .= "Drupal also has a news aggregator built in as a standard feature. With it, you can subscribe to feeds from other sites and display their content for your site users. Simply enable the aggregator module in site administration and enter the feeds that you choose.
"; $output .= "The standard method of syndication is using the XML-based %rss (RSS). To syndicate a site's content, obtain the full URL of the RSS page providing syndication. Common file tags for RSS pages are .rss, .xml and .rdf. Example: %slashdot-rss.
"; + $output .= "The standard method of syndication is using the XML-based Rich Site Summary (RSS). To syndicate a site's content, obtain the full URL of the RSS page providing syndication. Common file tags for RSS pages are .rss, .xml and .rdf. Example: Slashdot RSS.
"; $output .= "Most weblog sites that offer syndication will have an obvious link on the main page. Often you need only look for an XML syndication button, such as the one Drupal uses for site syndication.
"; - $output .= "But some sites do not make their RSS feeds as easy to find. Or maybe you want to find a number of feeds on a given topic, without extensively searching the web. In that case, try an RSS syndication directory such as %syndic8.
"; - $output .= "To learn much more about RSS, read Mark Pilgrim's %rss-what and WebReference.com's %rss-evolution.
"; + $output .= "But some sites do not make their RSS feeds as easy to find. Or maybe you want to find a number of feeds on a given topic, without extensively searching the web. In that case, try an RSS syndication directory such as Syndic8.
"; + $output .= "To learn much more about RSS, read Mark Pilgrim's What is RSS and WebReference.com's The Evolution of RSS.
"; $output .= "NOTE: Enable your site's XML syndication button by turning on the Syndicate block in block management.
"; $output .= "To subscribe to an RSS feed on another site, use the %admin-news shortcut at the top of the news aggregation page. The link leads directly to the news aggregation configuration section of Drupal site administration.
"; - $output .= "Once there, select %new-feed from the left hand menu. Drupal will then ask for the following:
"; + $output .= "To subscribe to an RSS feed on another site, use the RSS/RDF shortcut at the top of the news aggregation page. The link leads directly to the news aggregation configuration section of Drupal site administration.
"; + $output .= "Once there, select new feed from the left hand menu. Drupal will then ask for the following:
"; $output .= "Once you submit your new feed, check to see if it is working properly. Select %update-items on the %admin-news page. If you do not see any items listed for that feed, edit the feed and make sure that the URL was entered correctly.
"; + $output .= "Once you submit your new feed, check to see if it is working properly. Select update items on the RSS/RDF page. If you do not see any items listed for that feed, edit the feed and make sure that the URL was entered correctly.
"; $output .= "You may want to follow some feeds more closely than others. Or perhaps you'd like to display a select list of the titles for some feeds as a block for users. Bundles are a way of grouping your feeds into categories. Bundles look for feeds that contain at least one of the keywords, or attributes, associated with the bundle and display those feeds together.
"; $output .= "When adding a bundle, Drupal will ask for:
"; diff --git a/modules/aggregator/aggregator.module b/modules/aggregator/aggregator.module index 005027f2065..e7c807961db 100644 --- a/modules/aggregator/aggregator.module +++ b/modules/aggregator/aggregator.module @@ -4,24 +4,24 @@ function aggregator_help($section) { switch ($section) { case 'admin/help#aggregator': - $output = "Thousands of web sites, especially news sites and weblogs, syndicate their most recent site content for others to display. The syndicated content always includes titles, also known as headlines, for the newest published stories. Each headline acts as a direct link to the stories on the remote site. Along with the headline, most sites typically provide either the first few paragraphs of the story or a short summary. Many individuals use client-based news aggregators on their personal computer to aggregate content, such as %amphetadesk
"; + $output = "Thousands of web sites, especially news sites and weblogs, syndicate their most recent site content for others to display. The syndicated content always includes titles, also known as headlines, for the newest published stories. Each headline acts as a direct link to the stories on the remote site. Along with the headline, most sites typically provide either the first few paragraphs of the story or a short summary. Many individuals use client-based news aggregators on their personal computer to aggregate content, such as Amphetadesk.
"; $output .= "Drupal also has a news aggregator built in as a standard feature. With it, you can subscribe to feeds from other sites and display their content for your site users. Simply enable the aggregator module in site administration and enter the feeds that you choose.
"; $output .= "The standard method of syndication is using the XML-based %rss (RSS). To syndicate a site's content, obtain the full URL of the RSS page providing syndication. Common file tags for RSS pages are .rss, .xml and .rdf. Example: %slashdot-rss.
"; + $output .= "The standard method of syndication is using the XML-based Rich Site Summary (RSS). To syndicate a site's content, obtain the full URL of the RSS page providing syndication. Common file tags for RSS pages are .rss, .xml and .rdf. Example: Slashdot RSS.
"; $output .= "Most weblog sites that offer syndication will have an obvious link on the main page. Often you need only look for an XML syndication button, such as the one Drupal uses for site syndication.
"; - $output .= "But some sites do not make their RSS feeds as easy to find. Or maybe you want to find a number of feeds on a given topic, without extensively searching the web. In that case, try an RSS syndication directory such as %syndic8.
"; - $output .= "To learn much more about RSS, read Mark Pilgrim's %rss-what and WebReference.com's %rss-evolution.
"; + $output .= "But some sites do not make their RSS feeds as easy to find. Or maybe you want to find a number of feeds on a given topic, without extensively searching the web. In that case, try an RSS syndication directory such as Syndic8.
"; + $output .= "To learn much more about RSS, read Mark Pilgrim's What is RSS and WebReference.com's The Evolution of RSS.
"; $output .= "NOTE: Enable your site's XML syndication button by turning on the Syndicate block in block management.
"; $output .= "To subscribe to an RSS feed on another site, use the %admin-news shortcut at the top of the news aggregation page. The link leads directly to the news aggregation configuration section of Drupal site administration.
"; - $output .= "Once there, select %new-feed from the left hand menu. Drupal will then ask for the following:
"; + $output .= "To subscribe to an RSS feed on another site, use the RSS/RDF shortcut at the top of the news aggregation page. The link leads directly to the news aggregation configuration section of Drupal site administration.
"; + $output .= "Once there, select new feed from the left hand menu. Drupal will then ask for the following:
"; $output .= "Once you submit your new feed, check to see if it is working properly. Select %update-items on the %admin-news page. If you do not see any items listed for that feed, edit the feed and make sure that the URL was entered correctly.
"; + $output .= "Once you submit your new feed, check to see if it is working properly. Select update items on the RSS/RDF page. If you do not see any items listed for that feed, edit the feed and make sure that the URL was entered correctly.
"; $output .= "You may want to follow some feeds more closely than others. Or perhaps you'd like to display a select list of the titles for some feeds as a block for users. Bundles are a way of grouping your feeds into categories. Bundles look for feeds that contain at least one of the keywords, or attributes, associated with the bundle and display those feeds together.
"; $output .= "When adding a bundle, Drupal will ask for:
"; diff --git a/modules/block.module b/modules/block.module index d2eb05e8f4a..4743ba507f3 100644 --- a/modules/block.module +++ b/modules/block.module @@ -10,7 +10,7 @@ function block_help($section = "admin/help#block") { $output .= "The sidebar each block appears in depends on both which theme you're using (some are left-only, some right, some both), and on the settings in block management.
Whether a block is visible in the first place depends on three things:
The block management screen also lets you specify the vertical sort-order of the blocks within a sidebar. You do this by assigning a weight to each block. Lighter blocks (smaller weight) \"float up\" towards the top of the sidebar. Heavier ones \"sink down\" towards the bottom of it. Once you've positioned things just so, you can preview what the layout will look like in different types of themes by clicking the preview placement link in the menu to the left.
"; $output .= "The path setting lets you define the pages on which a specific block is visable. If you leave the path blank it will appear on all pages. The path uses a regular expression syntax so remember to escape special characters!
"; - $output .= "In case you do not know what a regular expression is, you should read about them in the PHP manual. The chapter to look at is the one on %pcre.
"; + $output .= "In case you do not know what a regular expression is, you should read about them in the PHP manual. The chapter to look at is the one on Perl-Compatible Regular Expressions (PCRE).
"; $output .= "However, for basic tasks it is sufficient to look at the following examples:
"; $output .= "If the block should only show up on blog pages, use </blog>. To display on all node views use </node/view>. The angular brackets are used as delimiters of the regular expression. To show up on either forum or book pages use <(/forum|/book)>. The round brackets form a group of expressions, divided by the | character. It matches if any of the expressions in it match. A more complicated example is </node/add/(story|blog|image)>. Blocks which have their paths set to this expression will show up on story, block, or image composition pages. If you want to show a block an all pages, but not the search page, use <(^/$|[^(search)$/]+)>
"; $output .= "For more in-depth examples, we recommend that you check the existing boxes and use them as a starting point.
"; - $output = t($output, array("%pcre" => "". t("Perl-Compatible Regular Expressions (PCRE)") ."")); + $output = t($output, array("%pcre" => "http://php.net/pcre/")); break; case 'admin/system/modules#description': $output = t("Controls the boxes that are displayed around the main content."); break; case 'admin/system/block': - $output = t("Blocks are the boxes in the left- and right- side bars of the web site, depending on the choosen theme. They are created by active Drupal modules. In order to view a block it must be enabled. 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. The custom checkbox lets your users hide the block using their account setting. You can also create your own blocks, where you specify the content of the block rather than its being generated by a module (you can even use PHP in these). You can create one of these by clicking the %createblock link in the menu to the left. Edit and delete links will become active below for these customized blocks. 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 after having enabled the throttle module.", array("%createblock" => l(t("new block"), "admin/system/block/add"), "%throttle" => l(t("throttle configuration page"), "admin/system/modules/throttle"))); + $output = t("Blocks are the boxes in the left- and right- side bars of the web site, depending on the choosen theme. They are created by active Drupal modules. In order to view a block it must be enabled. 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. The custom checkbox lets your users hide the block using their account setting. You can also create your own blocks, where you specify the content of the block rather than its being generated by a module (you can even use PHP in these). You can create one of these by clicking the new block link in the menu to the left. Edit and delete links will become active below for these customized blocks. 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("%createblock" => url("admin/system/block/add"), "%throttle" => url("admin/system/modules/throttle"))); break; case 'admin/system/block/add': - $output = t("Here you can create a custom content block. Once you have created this block you must make it active, and give it a place on the page using %overview. The title is used when displaying the block. The description is used in the \"block\" column on the %overview page. If you are going to place PHP code in the block, and you have create php content permission (see the %permission page) you must change the type to PHP to make your code active.", array("%overview" => l(t("blocks"), "admin/system/block"), "%permission" => l(t("permissions"), "admin/user/permission"))); + $output = t("Here you can create a custom content 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 create php content permission (see the permissions page) you must change the type to PHP to make your code active.", array("%overview" => url("admin/system/block"), "%permission" => url("admin/user/permission"))); break; case 'admin/system/block/preview': $output = t("This page show you the placement of your blocks in different themes types. The numbers are the weight of each block, which is used to sort them within the sidebars."); diff --git a/modules/block/block.module b/modules/block/block.module index d2eb05e8f4a..4743ba507f3 100644 --- a/modules/block/block.module +++ b/modules/block/block.module @@ -10,7 +10,7 @@ function block_help($section = "admin/help#block") { $output .= "The sidebar each block appears in depends on both which theme you're using (some are left-only, some right, some both), and on the settings in block management.
Whether a block is visible in the first place depends on three things:
The block management screen also lets you specify the vertical sort-order of the blocks within a sidebar. You do this by assigning a weight to each block. Lighter blocks (smaller weight) \"float up\" towards the top of the sidebar. Heavier ones \"sink down\" towards the bottom of it. Once you've positioned things just so, you can preview what the layout will look like in different types of themes by clicking the preview placement link in the menu to the left.
"; $output .= "The path setting lets you define the pages on which a specific block is visable. If you leave the path blank it will appear on all pages. The path uses a regular expression syntax so remember to escape special characters!
"; - $output .= "In case you do not know what a regular expression is, you should read about them in the PHP manual. The chapter to look at is the one on %pcre.
"; + $output .= "In case you do not know what a regular expression is, you should read about them in the PHP manual. The chapter to look at is the one on Perl-Compatible Regular Expressions (PCRE).
"; $output .= "However, for basic tasks it is sufficient to look at the following examples:
"; $output .= "If the block should only show up on blog pages, use </blog>. To display on all node views use </node/view>. The angular brackets are used as delimiters of the regular expression. To show up on either forum or book pages use <(/forum|/book)>. The round brackets form a group of expressions, divided by the | character. It matches if any of the expressions in it match. A more complicated example is </node/add/(story|blog|image)>. Blocks which have their paths set to this expression will show up on story, block, or image composition pages. If you want to show a block an all pages, but not the search page, use <(^/$|[^(search)$/]+)>
"; $output .= "For more in-depth examples, we recommend that you check the existing boxes and use them as a starting point.
"; - $output = t($output, array("%pcre" => "". t("Perl-Compatible Regular Expressions (PCRE)") ."")); + $output = t($output, array("%pcre" => "http://php.net/pcre/")); break; case 'admin/system/modules#description': $output = t("Controls the boxes that are displayed around the main content."); break; case 'admin/system/block': - $output = t("Blocks are the boxes in the left- and right- side bars of the web site, depending on the choosen theme. They are created by active Drupal modules. In order to view a block it must be enabled. 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. The custom checkbox lets your users hide the block using their account setting. You can also create your own blocks, where you specify the content of the block rather than its being generated by a module (you can even use PHP in these). You can create one of these by clicking the %createblock link in the menu to the left. Edit and delete links will become active below for these customized blocks. 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 after having enabled the throttle module.", array("%createblock" => l(t("new block"), "admin/system/block/add"), "%throttle" => l(t("throttle configuration page"), "admin/system/modules/throttle"))); + $output = t("Blocks are the boxes in the left- and right- side bars of the web site, depending on the choosen theme. They are created by active Drupal modules. In order to view a block it must be enabled. 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. The custom checkbox lets your users hide the block using their account setting. You can also create your own blocks, where you specify the content of the block rather than its being generated by a module (you can even use PHP in these). You can create one of these by clicking the new block link in the menu to the left. Edit and delete links will become active below for these customized blocks. 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("%createblock" => url("admin/system/block/add"), "%throttle" => url("admin/system/modules/throttle"))); break; case 'admin/system/block/add': - $output = t("Here you can create a custom content block. Once you have created this block you must make it active, and give it a place on the page using %overview. The title is used when displaying the block. The description is used in the \"block\" column on the %overview page. If you are going to place PHP code in the block, and you have create php content permission (see the %permission page) you must change the type to PHP to make your code active.", array("%overview" => l(t("blocks"), "admin/system/block"), "%permission" => l(t("permissions"), "admin/user/permission"))); + $output = t("Here you can create a custom content 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 create php content permission (see the permissions page) you must change the type to PHP to make your code active.", array("%overview" => url("admin/system/block"), "%permission" => url("admin/user/permission"))); break; case 'admin/system/block/preview': $output = t("This page show you the placement of your blocks in different themes types. The numbers are the weight of each block, which is used to sort them within the sidebars."); diff --git a/modules/book.module b/modules/book.module index a1e13fef977..9c17917dcb0 100644 --- a/modules/book.module +++ b/modules/book.module @@ -854,14 +854,14 @@ function book_help($section = "admin/help#book") { $output .= "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.
"; $output .= "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.
"; $output .= "A book page is a special node type that allows you to embed PHP within the body of the page. This capability is only offerred to administrators, since malicious users could abuse this power. In addiiton, 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.
"; - $output .= "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 <root>. To include an existing node in your book, click on the \"administer\"-link in that node. At the bottom of this administration page, click on the edit book outline button. 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 link.
"; - $output .= "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 %orphans-book and reaffiliate those pages as desired. Finally, administrators may also %export-book to a single, flat HTML page which is suitable for printing.
"; + $output .= "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 <root>. To include an existing node in your book, click on the \"administer\"-link in that node. At the bottom of this administration page, click on the edit book outline button. 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 submit content » book page link.
"; + $output .= "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.
"; $output .= "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!
"; - $output .= "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 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 <root> 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.
"; + $output .= "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 submit 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 <root> 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.
"; $output .= "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.
"; - $output .= "Notes:
Notes:
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.
"; $output .= "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.
"; $output .= "A book page is a special node type that allows you to embed PHP within the body of the page. This capability is only offerred to administrators, since malicious users could abuse this power. In addiiton, 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.
"; - $output .= "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 <root>. To include an existing node in your book, click on the \"administer\"-link in that node. At the bottom of this administration page, click on the edit book outline button. 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 link.
"; - $output .= "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 %orphans-book and reaffiliate those pages as desired. Finally, administrators may also %export-book to a single, flat HTML page which is suitable for printing.
"; + $output .= "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 <root>. To include an existing node in your book, click on the \"administer\"-link in that node. At the bottom of this administration page, click on the edit book outline button. 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 submit content » book page link.
"; + $output .= "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.
"; $output .= "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!
"; - $output .= "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 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 <root> 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.
"; + $output .= "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 submit 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 <root> 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.
"; $output .= "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.
"; - $output .= "Notes:
Notes:
When a user chooses save settings, the comments are then redisplayed using the user's new choices. Administrators can set the default settings for the comment control panel, along with other comment defaults, in %comment-config.
"; + $output .= "When a user chooses save settings, the comments are then redisplayed using the user's new choices. Administrators can set the default settings for the comment control panel, along with other comment defaults, in administer » configuration » modules » comment.
"; $output .= "NOTE: When comment moderation is enabled, users will have another control panel option to control thresholds (see below).
"; $output .= "Comments behave like other user submissions in Drupal. Filters, smileys and HTML that work in nodes will also work with content. To prevent a single user from spamming the web site with too many comments, administrators can set a comment throttle in %site-config under Submission settings.
"; - $output .= "Administrators can control access to various comment module functions through %user-permissions. Know that in a new Drupal installation, all comment permissions are disabled by default. The choice of which permissions to grant to which roles (groups of users) is left up to the site administrator.
"; + $output .= "Comments behave like other user submissions in Drupal. Filters, smileys and HTML that work in nodes will also work with content. To prevent a single user from spamming the web site with too many comments, administrators can set a comment throttle in administer » configuration under Submission settings.
"; + $output .= "Administrators can control access to various comment module functions through administer » accounts » permissions. Know that in a new Drupal installation, all comment permissions are disabled by default. The choice of which permissions to grant to which roles (groups of users) is left up to the site administrator.
"; $output .= "The following permissions can be enabled for anonymous users, authenticated users, or any other user roles that the administrator chooses to define:
"; $output .= "Drupal provides specific features to inform site members when new comments have been posted:
"; $output .= "On sites with active commenting from users, the administrator can turn over comment moderation to the community.
"; $output .= "With comment moderation, each comment is automatically assigned an initial rating. As users read comments, they can apply a vote which affects the comment rating. At the same time, users have an additional option in the control panel which allows them to set a threshold for the comments they wish to view. Those comments with ratings lower than the set threshold will not be shown.
"; - $output .= "To enable moderation, the administrator must grant %permission permissions. Then, a number of options in %comment-moderation must be configured.
"; + $output .= "To enable moderation, the administrator must grant moderate comments permissions. Then, a number of options in administer » comments » moderation must be configured.
"; $output .= "The first step is to create moderation labels which allow users to rate a comment. Go to %comment-votes. In the vote field, enter the textual labels which users will see when casting their votes. Some examples are
"; + $output .= "The first step is to create moderation labels which allow users to rate a comment. Go to administer » comments » moderation » votes. In the vote field, enter the textual labels which users will see when casting their votes. Some examples are
"; $output .= "Next go to %comment-matrix. Enter the values for the vote labels for each permission role in the vote matrix. The values entered here will be used to create the rating for each comment.
"; + $output .= "Next go to administer » comments » moderation » matrix. Enter the values for the vote labels for each permission role in the vote matrix. The values entered here will be used to create the rating for each comment.
"; $output .= "NOTE: Comment ratings are calculated by averaging user votes with the initial rating.
"; $output .= "In %comment-thresholds, you'll have to create some comment thresholds to make the comment rating system useful. When comment moderation is enabled and the thresholds are created, users will find another comment control panel option for selecting their thresholds. They'll use the thresholds you enter here to filter out comments with low ratings. Consequently, you'll probably want to create more than one threshold to give users some flexibility in filtering comments.
"; + $output .= "In administer » comments » moderation » thresholds, you'll have to create some comment thresholds to make the comment rating system useful. When comment moderation is enabled and the thresholds are created, users will find another comment control panel option for selecting their thresholds. They'll use the thresholds you enter here to filter out comments with low ratings. Consequently, you'll probably want to create more than one threshold to give users some flexibility in filtering comments.
"; $output .= "When creating the thresholds, note that the Minimum score is asking you for the lowest rating that a comment can have in order to be displayed.
"; - $output .= "To see a common example of how thresholds work, you might visit %slashdot and view one of their comment boards associated with a story. You can reset the thresholds in their comment control panel.
"; + $output .= "To see a common example of how thresholds work, you might visit Slashdot and view one of their comment boards associated with a story. You can reset the thresholds in their comment control panel.
"; $output .= "Finally, you may want to enter some initial comment scores. In %comment-inital you can assign a beginning rating for all comments posted by a particular permission role. If you do not assign any initial scores, Drupal will assign a rating of 0 as the default.
"; - $output = t($output, array("%comment-config" => l(t("administer") ." » ". t("configuration") ." » ". t("modules") ." » ". t("comment"), "admin/system/modules/comment"), "%site-config" => l(t("administer") ." » ". t("configuration"), "admin/system"), "%user-permissions" => l(t("administer") ." » ". t("accounts") ." » ". t("permissions"), "admin/user/permission"), "%tracker" => l(t("recent posts"), "tracker"), "%download-notify" => "". t("download") ."", "%permission" => l(t("moderate comments"), "admin/user/permissions"), "%comment-moderation" => l(t("administer") ." » ". t("comments") ." » ". t("moderation"), "admin/comment/moderation"), "%comment-votes" => l(t("administer") ." » ". t("comments") ." » ". t("moderation") ." » ". t("votes"), "admin/comment/moderation/votes"), "%comment-matrix" => l(t("administer") ." » ". t("comments") ." » ". t("moderation") ." » ". t("matrix"), "admin/comment/moderation/matrix"), "%comment-thresholds" => l(t("administer") ." » ". t("comments") ." » ". t("moderation") ." » ". t("thresholds"), "admin/comment/moderation/thresholds"), "%slashdot" => "Slashdot", "%comment-inital" => l(t("administer") ." » ". t("comments") ." » ". t("initial comment scores"), "admin/comments/moderation/roles"))); + $output .= "Finally, you may want to enter some initial comment scores. In administer » comments » initial comment scores you can assign a beginning rating for all comments posted by a particular permission role. If you do not assign any initial scores, Drupal will assign a rating of 0 as the default.
"; + $output = t($output, array("%comment-config" => url("admin/system/modules/comment"), "%site-config" => url("admin/system"), "%user-permissions" => url("admin/user/permission"), "%tracker" => url("tracker"), "%download-notify" => "http://drupal.org/project/releases", "%permission" => url("admin/user/permissions"), "%comment-moderation" => url("admin/comment/moderation"), "%comment-votes" => url("admin/comment/moderation/votes"), "%comment-matrix" => url("admin/comment/moderation/matrix"), "%comment-thresholds" => url("admin/comment/moderation/thresholds"), "%slashdot" => " http://slashdot.org", "%comment-initial" => url("admin/comments/moderation/roles"))); break; case 'admin/system/modules#description': $output = t("Enables user to comment on content (nodes)."); break; case 'admin/system/modules/comment': - $output = t("Comments can be attached to any node. Below are the settings for comments. The display comes in two types, a \"flat list\" where everything is flush to the left side, and comments come in cronological order, and a \"threaded list\" where comments to other comments are placed immediately below and slightly indented forming an outline. They also come in two styles: \"expanded\", where you see both the title and the contents, and \"collapsed\" where you only see the title. To set the default threshold you first have to set up thresholds in the %threshold area. Preview comment forces a user to look at their comment by clicking on a \"Preview\" button before they can actually add the comment. If \"New comment form\" is enabled then at the bottom of every comment page there will be a form too add a new comment.", array("%threshold" => l(t("administer") ." » ". t("comments") ." » ". t("moderation") ." » ". t("thresholds"), "admin/comment/moderation/filters"))); + $output = t("Comments can be attached to any node. Below are the settings for comments. The display comes in two types, a \"flat list\" where everything is flush to the left side, and comments come in cronological order, and a \"threaded list\" where comments to other comments are placed immediately below and slightly indented forming an outline. They also come in two styles: \"expanded\", where you see both the title and the contents, and \"collapsed\" where you only see the title. To set the default threshold you first have to set up thresholds in the administer » comments » moderation » thresholds area. Preview comment forces a user to look at their comment by clicking on a \"Preview\" button before they can actually add the comment. If \"New comment form\" is enabled then at the bottom of every comment page there will be a form too add a new comment.", array("%threshold" => url("admin/comment/moderation/filters"))); break; case 'admin/comment': $output = t("Comments let users give feedback to content authors. Here you may review/approve/deny recent comments, and configure moderation if desired."); break; case 'admin/comment/comments': - $output = t("Click on %nup to see your latest comments, or %queue to approve new comments.", array("%nup" => l(t("new or updated comments"), "admin/comment/0"), "%queue" => l(t("comment approval queue"), "admin/comment/1"))); + $output = t("Click on new or updated comments to see your latest comments, or comment approval queue to approve new comments.", array("%nup" => url("admin/comment/0"), "%queue" => url("admin/comment/1"))); break; case 'admin/comment/comments/0': $output = t("Below is a list of the latest comments posted your site. Click on a subject to see the comment, the author's name to edit the author's user information , \"edit comment\" to edit the comment, and \"delete comment\" to remove the comment."); @@ -88,7 +88,7 @@ function comment_help($section = "admin/help#comment") { $output = t("Below is a list of the comments posted to your site that need approval. To approve a comment click on \"edit comment\" and then change it's moderation status to Approved.When a user chooses save settings, the comments are then redisplayed using the user's new choices. Administrators can set the default settings for the comment control panel, along with other comment defaults, in %comment-config.
"; + $output .= "When a user chooses save settings, the comments are then redisplayed using the user's new choices. Administrators can set the default settings for the comment control panel, along with other comment defaults, in administer » configuration » modules » comment.
"; $output .= "NOTE: When comment moderation is enabled, users will have another control panel option to control thresholds (see below).
"; $output .= "Comments behave like other user submissions in Drupal. Filters, smileys and HTML that work in nodes will also work with content. To prevent a single user from spamming the web site with too many comments, administrators can set a comment throttle in %site-config under Submission settings.
"; - $output .= "Administrators can control access to various comment module functions through %user-permissions. Know that in a new Drupal installation, all comment permissions are disabled by default. The choice of which permissions to grant to which roles (groups of users) is left up to the site administrator.
"; + $output .= "Comments behave like other user submissions in Drupal. Filters, smileys and HTML that work in nodes will also work with content. To prevent a single user from spamming the web site with too many comments, administrators can set a comment throttle in administer » configuration under Submission settings.
"; + $output .= "Administrators can control access to various comment module functions through administer » accounts » permissions. Know that in a new Drupal installation, all comment permissions are disabled by default. The choice of which permissions to grant to which roles (groups of users) is left up to the site administrator.
"; $output .= "The following permissions can be enabled for anonymous users, authenticated users, or any other user roles that the administrator chooses to define:
"; $output .= "Drupal provides specific features to inform site members when new comments have been posted:
"; $output .= "On sites with active commenting from users, the administrator can turn over comment moderation to the community.
"; $output .= "With comment moderation, each comment is automatically assigned an initial rating. As users read comments, they can apply a vote which affects the comment rating. At the same time, users have an additional option in the control panel which allows them to set a threshold for the comments they wish to view. Those comments with ratings lower than the set threshold will not be shown.
"; - $output .= "To enable moderation, the administrator must grant %permission permissions. Then, a number of options in %comment-moderation must be configured.
"; + $output .= "To enable moderation, the administrator must grant moderate comments permissions. Then, a number of options in administer » comments » moderation must be configured.
"; $output .= "The first step is to create moderation labels which allow users to rate a comment. Go to %comment-votes. In the vote field, enter the textual labels which users will see when casting their votes. Some examples are
"; + $output .= "The first step is to create moderation labels which allow users to rate a comment. Go to administer » comments » moderation » votes. In the vote field, enter the textual labels which users will see when casting their votes. Some examples are
"; $output .= "Next go to %comment-matrix. Enter the values for the vote labels for each permission role in the vote matrix. The values entered here will be used to create the rating for each comment.
"; + $output .= "Next go to administer » comments » moderation » matrix. Enter the values for the vote labels for each permission role in the vote matrix. The values entered here will be used to create the rating for each comment.
"; $output .= "NOTE: Comment ratings are calculated by averaging user votes with the initial rating.
"; $output .= "In %comment-thresholds, you'll have to create some comment thresholds to make the comment rating system useful. When comment moderation is enabled and the thresholds are created, users will find another comment control panel option for selecting their thresholds. They'll use the thresholds you enter here to filter out comments with low ratings. Consequently, you'll probably want to create more than one threshold to give users some flexibility in filtering comments.
"; + $output .= "In administer » comments » moderation » thresholds, you'll have to create some comment thresholds to make the comment rating system useful. When comment moderation is enabled and the thresholds are created, users will find another comment control panel option for selecting their thresholds. They'll use the thresholds you enter here to filter out comments with low ratings. Consequently, you'll probably want to create more than one threshold to give users some flexibility in filtering comments.
"; $output .= "When creating the thresholds, note that the Minimum score is asking you for the lowest rating that a comment can have in order to be displayed.
"; - $output .= "To see a common example of how thresholds work, you might visit %slashdot and view one of their comment boards associated with a story. You can reset the thresholds in their comment control panel.
"; + $output .= "To see a common example of how thresholds work, you might visit Slashdot and view one of their comment boards associated with a story. You can reset the thresholds in their comment control panel.
"; $output .= "Finally, you may want to enter some initial comment scores. In %comment-inital you can assign a beginning rating for all comments posted by a particular permission role. If you do not assign any initial scores, Drupal will assign a rating of 0 as the default.
"; - $output = t($output, array("%comment-config" => l(t("administer") ." » ". t("configuration") ." » ". t("modules") ." » ". t("comment"), "admin/system/modules/comment"), "%site-config" => l(t("administer") ." » ". t("configuration"), "admin/system"), "%user-permissions" => l(t("administer") ." » ". t("accounts") ." » ". t("permissions"), "admin/user/permission"), "%tracker" => l(t("recent posts"), "tracker"), "%download-notify" => "". t("download") ."", "%permission" => l(t("moderate comments"), "admin/user/permissions"), "%comment-moderation" => l(t("administer") ." » ". t("comments") ." » ". t("moderation"), "admin/comment/moderation"), "%comment-votes" => l(t("administer") ." » ". t("comments") ." » ". t("moderation") ." » ". t("votes"), "admin/comment/moderation/votes"), "%comment-matrix" => l(t("administer") ." » ". t("comments") ." » ". t("moderation") ." » ". t("matrix"), "admin/comment/moderation/matrix"), "%comment-thresholds" => l(t("administer") ." » ". t("comments") ." » ". t("moderation") ." » ". t("thresholds"), "admin/comment/moderation/thresholds"), "%slashdot" => "Slashdot", "%comment-inital" => l(t("administer") ." » ". t("comments") ." » ". t("initial comment scores"), "admin/comments/moderation/roles"))); + $output .= "Finally, you may want to enter some initial comment scores. In administer » comments » initial comment scores you can assign a beginning rating for all comments posted by a particular permission role. If you do not assign any initial scores, Drupal will assign a rating of 0 as the default.
"; + $output = t($output, array("%comment-config" => url("admin/system/modules/comment"), "%site-config" => url("admin/system"), "%user-permissions" => url("admin/user/permission"), "%tracker" => url("tracker"), "%download-notify" => "http://drupal.org/project/releases", "%permission" => url("admin/user/permissions"), "%comment-moderation" => url("admin/comment/moderation"), "%comment-votes" => url("admin/comment/moderation/votes"), "%comment-matrix" => url("admin/comment/moderation/matrix"), "%comment-thresholds" => url("admin/comment/moderation/thresholds"), "%slashdot" => " http://slashdot.org", "%comment-initial" => url("admin/comments/moderation/roles"))); break; case 'admin/system/modules#description': $output = t("Enables user to comment on content (nodes)."); break; case 'admin/system/modules/comment': - $output = t("Comments can be attached to any node. Below are the settings for comments. The display comes in two types, a \"flat list\" where everything is flush to the left side, and comments come in cronological order, and a \"threaded list\" where comments to other comments are placed immediately below and slightly indented forming an outline. They also come in two styles: \"expanded\", where you see both the title and the contents, and \"collapsed\" where you only see the title. To set the default threshold you first have to set up thresholds in the %threshold area. Preview comment forces a user to look at their comment by clicking on a \"Preview\" button before they can actually add the comment. If \"New comment form\" is enabled then at the bottom of every comment page there will be a form too add a new comment.", array("%threshold" => l(t("administer") ." » ". t("comments") ." » ". t("moderation") ." » ". t("thresholds"), "admin/comment/moderation/filters"))); + $output = t("Comments can be attached to any node. Below are the settings for comments. The display comes in two types, a \"flat list\" where everything is flush to the left side, and comments come in cronological order, and a \"threaded list\" where comments to other comments are placed immediately below and slightly indented forming an outline. They also come in two styles: \"expanded\", where you see both the title and the contents, and \"collapsed\" where you only see the title. To set the default threshold you first have to set up thresholds in the administer » comments » moderation » thresholds area. Preview comment forces a user to look at their comment by clicking on a \"Preview\" button before they can actually add the comment. If \"New comment form\" is enabled then at the bottom of every comment page there will be a form too add a new comment.", array("%threshold" => url("admin/comment/moderation/filters"))); break; case 'admin/comment': $output = t("Comments let users give feedback to content authors. Here you may review/approve/deny recent comments, and configure moderation if desired."); break; case 'admin/comment/comments': - $output = t("Click on %nup to see your latest comments, or %queue to approve new comments.", array("%nup" => l(t("new or updated comments"), "admin/comment/0"), "%queue" => l(t("comment approval queue"), "admin/comment/1"))); + $output = t("Click on new or updated comments to see your latest comments, or comment approval queue to approve new comments.", array("%nup" => url("admin/comment/0"), "%queue" => url("admin/comment/1"))); break; case 'admin/comment/comments/0': $output = t("Below is a list of the latest comments posted your site. Click on a subject to see the comment, the author's name to edit the author's user information , \"edit comment\" to edit the comment, and \"delete comment\" to remove the comment."); @@ -88,7 +88,7 @@ function comment_help($section = "admin/help#comment") { $output = t("Below is a list of the comments posted to your site that need approval. To approve a comment click on \"edit comment\" and then change it's moderation status to Approved.The \"Drupal\" module features a capability whereby other drupal sites may call home to report their existence. In turn, this enables a pod of Drupal sites to find, cooperate and advertise each other.
-Currently, the main application of this feature is the %drupal-sites page. By default, fresh Drupal installations can use %Drupal as their directory server and report their existence. This reporting occurs via scheduled %xml-rpc pings.
-Drupal administrators should simply enable this feature to get listed on the %drupal-sites page. Just set your site's name, e-mail address, slogan and mission statement on the %site-admin page. Then make sure that the field called %xml-rpc-server on the %drupal-settings page is set to %drupal-xml-rpc, and enable this feature using the dropdown directly below.
-The listing of your site will occur shortly after your site's next %cron-run. Note that cron.php should be called using the domain name which you want to have listed at %Drupal. For example, don't kick off cron by requesting http://127.0.0.1/cron.php. Instead, use a publicly accessible domain name such as http://www.example.com/cron.php.
-Also note that your installation need not use drupal.org as its directory server. For example, this feature is perfectly capable of aggregating pings from all of your departmental drupal installations sites within an enterprise.
", array("%drupal-sites" => "".t("Drupal sites")."", "%Drupal" => "drupal.org", "%xml-rpc" => "XLM-RPC", "%site-admin" => l(t("site administration"), "admin/system"), "%xml-rpc-server" => t("Drupal XML-RPC server"), "%drupal-settings" => l(t("administer") ." » ". t("configuration") ." » ". t("modules") ." » ". t("drupal"), "admin/system/modules/drupal"), "%drupal-xml-rpc" => "http://www.drupal.org/xmlrpc.php", "%cron" => l(t("cron run"), "admin/system/help#cron"))); +Currently, the main application of this feature is the Drupal sites page. By default, fresh Drupal installations can use drupal.org as their directory server and report their existence. This reporting occurs via scheduled XML-RPC pings.
+Drupal administrators should simply enable this feature to get listed on the Drupal sites page. Just set your site's name, e-mail address, slogan and mission statement on the site administration page. Then make sure that the field called Drupal XML-RPC server on the administer » configuration » modules » drupal page is set to %drupal-xml-rpc, and enable this feature using the dropdown directly below.
+The listing of your site will occur shortly after your site's next cron run. Note that cron.php should be called using the domain name which you want to have listed at drupal.org. For example, don't kick off cron by requesting http://127.0.0.1/cron.php. Instead, use a publicly accessible domain name such as http://www.example.com/cron.php.
+Also note that your installation need not use drupal.org as its directory server. For example, this feature is perfectly capable of aggregating pings from all of your departmental drupal installations sites within an enterprise.
", array("%drupal-sites" => "http://www.drupal.org/sites", "%Drupal" => "http://www.drupal.org", "%drupal-xml-rpc" => "http://www.drupal.org/xmlrpc.php", "%xml-rpc" => "http://www.xmlrpc.com/", "%site-admin" => url("admin/system"), "%drupal-settings" => url("admin/system/modules/drupal"), "%cron" => url("admin/system/help#cron"))); break; case 'admin/system/modules#description': return t("Lets users log in using a Drupal ID and can notify a central server about your site."); break; case 'admin/system/modules/drupal': - return t("Using this your Drupal site can \"call home\" and add itself to the Drupal directory. If you want it to add itself to a different directory server you can change the %xml-rpc-setting setting -- but the directory server has to be able to handle Drupal XML. To get all your site information listed go to the %site-admin page and set the site name, the e-mail address, the slogan, and the mission statement.", array("%xml-rpc-setting" => l(t("Drupal XML-RPC server"), "admin/system/modules/drupal"), "%site-admin" => l(t("site configuration"), "admin/system"))); + return t("Using this your Drupal site can \"call home\" and add itself to the Drupal directory. If you want it to add itself to a different directory server you can change the Drupal XML-RPC server setting -- but the directory server has to be able to handle Drupal XML. To get all your site information listed go to the site configuration page and set the site name, the e-mail address, the slogan, and the mission statement.", array("%xml-rpc-setting" => url("admin/system/modules/drupal"), "%site-admin" => url("admin/system"))); break; case 'user/help#drupal': - return t("%Drupal is the name of the software which powers %this-site. There are Drupal web sites all over the world, and many of them share their registration databases so that users may freely login to any Drupal site using a single Drupal ID.
-So please feel free to login to your account here at %this-site with a username from another Drupal site. The format of a Drupal ID is similar to an email address: username@server. An example of a valid Drupal ID is mwlily@www.drupal.org.
", array("%Drupal" => "Drupal", "%this-site" => "".variable_get("site_name", "this web site")."")); + return t("Drupal is the name of the software which powers %this-site. There are Drupal web sites all over the world, and many of them share their registration databases so that users may freely login to any Drupal site using a single Drupal ID.
+So please feel free to login to your account here at %this-site with a username from another Drupal site. The format of a Drupal ID is similar to an email address: username@server. An example of a valid Drupal ID is mwlily@www.drupal.org.
", array("%Drupal" => "http://www.drupal.org", "%this-site" => "". variable_get("site_name", "this web site") ."")); break; } @@ -38,7 +38,7 @@ function drupal_settings() { $error["drupal_directory"] = theme("error", t("You must set your site's mission at the site configuration.", array("%url" => url("admin/system")))); $output = form_textfield(t("Drupal XML-RPC server"), "drupal_server", variable_get("drupal_server", "http://www.drupal.org/xmlrpc.php"), 55, 128, t("The URL of your root Drupal XML-RPC server.")); - $output .= form_radios(t("Drupal directory"), "drupal_directory", variable_get("drupal_directory", 0), array(t("Disabled"), t("Enabled")), t("If enabled, your Drupal site will make itself known to the Drupal directory at the specified Drupal XML-RPC server. For this to work properly, you must set your site's name, e-mail address, slogan and mission statement. When the \"%xml-rpc-server\" field is set to \"%drupal-xml-rpc\", your web site will get listed on the %drupal-sites page. Requires the cron feature to be enabled.", array("%xml-rpc-server" => t("Drupal XML-RPC server"), "%drupal-xml-rpc" => "http://www.drupal.org/xmlrpc.php", "%drupal-sites" => "".t("Drupal sites")."")) . $error["drupal_directory"]); + $output .= form_radios(t("Drupal directory"), "drupal_directory", variable_get("drupal_directory", 0), array(t("Disabled"), t("Enabled")), t("If enabled, your Drupal site will make itself known to the Drupal directory at the specified Drupal XML-RPC server. For this to work properly, you must set your site's name, e-mail address, slogan and mission statement. When the \"Drupal XML-RPC server\" field is set to \"%drupal-xml-rpc\", your web site will get listed on the Drupal sites page. Requires the cron feature to be enabled.", array("%drupal-xml-rpc" => "http://www.drupal.org/xmlrpc.php")) . $error["drupal_directory"]); return $output; } diff --git a/modules/drupal/drupal.module b/modules/drupal/drupal.module index 61c73f8ab90..7975c412efd 100644 --- a/modules/drupal/drupal.module +++ b/modules/drupal/drupal.module @@ -6,20 +6,20 @@ function drupal_help($section = "admin/help#drupal") { switch ($section) { case 'admin/help#drupal': return t("The \"Drupal\" module features a capability whereby other drupal sites may call home to report their existence. In turn, this enables a pod of Drupal sites to find, cooperate and advertise each other.
-Currently, the main application of this feature is the %drupal-sites page. By default, fresh Drupal installations can use %Drupal as their directory server and report their existence. This reporting occurs via scheduled %xml-rpc pings.
-Drupal administrators should simply enable this feature to get listed on the %drupal-sites page. Just set your site's name, e-mail address, slogan and mission statement on the %site-admin page. Then make sure that the field called %xml-rpc-server on the %drupal-settings page is set to %drupal-xml-rpc, and enable this feature using the dropdown directly below.
-The listing of your site will occur shortly after your site's next %cron-run. Note that cron.php should be called using the domain name which you want to have listed at %Drupal. For example, don't kick off cron by requesting http://127.0.0.1/cron.php. Instead, use a publicly accessible domain name such as http://www.example.com/cron.php.
-Also note that your installation need not use drupal.org as its directory server. For example, this feature is perfectly capable of aggregating pings from all of your departmental drupal installations sites within an enterprise.
", array("%drupal-sites" => "".t("Drupal sites")."", "%Drupal" => "drupal.org", "%xml-rpc" => "XLM-RPC", "%site-admin" => l(t("site administration"), "admin/system"), "%xml-rpc-server" => t("Drupal XML-RPC server"), "%drupal-settings" => l(t("administer") ." » ". t("configuration") ." » ". t("modules") ." » ". t("drupal"), "admin/system/modules/drupal"), "%drupal-xml-rpc" => "http://www.drupal.org/xmlrpc.php", "%cron" => l(t("cron run"), "admin/system/help#cron"))); +Currently, the main application of this feature is the Drupal sites page. By default, fresh Drupal installations can use drupal.org as their directory server and report their existence. This reporting occurs via scheduled XML-RPC pings.
+Drupal administrators should simply enable this feature to get listed on the Drupal sites page. Just set your site's name, e-mail address, slogan and mission statement on the site administration page. Then make sure that the field called Drupal XML-RPC server on the administer » configuration » modules » drupal page is set to %drupal-xml-rpc, and enable this feature using the dropdown directly below.
+The listing of your site will occur shortly after your site's next cron run. Note that cron.php should be called using the domain name which you want to have listed at drupal.org. For example, don't kick off cron by requesting http://127.0.0.1/cron.php. Instead, use a publicly accessible domain name such as http://www.example.com/cron.php.
+Also note that your installation need not use drupal.org as its directory server. For example, this feature is perfectly capable of aggregating pings from all of your departmental drupal installations sites within an enterprise.
", array("%drupal-sites" => "http://www.drupal.org/sites", "%Drupal" => "http://www.drupal.org", "%drupal-xml-rpc" => "http://www.drupal.org/xmlrpc.php", "%xml-rpc" => "http://www.xmlrpc.com/", "%site-admin" => url("admin/system"), "%drupal-settings" => url("admin/system/modules/drupal"), "%cron" => url("admin/system/help#cron"))); break; case 'admin/system/modules#description': return t("Lets users log in using a Drupal ID and can notify a central server about your site."); break; case 'admin/system/modules/drupal': - return t("Using this your Drupal site can \"call home\" and add itself to the Drupal directory. If you want it to add itself to a different directory server you can change the %xml-rpc-setting setting -- but the directory server has to be able to handle Drupal XML. To get all your site information listed go to the %site-admin page and set the site name, the e-mail address, the slogan, and the mission statement.", array("%xml-rpc-setting" => l(t("Drupal XML-RPC server"), "admin/system/modules/drupal"), "%site-admin" => l(t("site configuration"), "admin/system"))); + return t("Using this your Drupal site can \"call home\" and add itself to the Drupal directory. If you want it to add itself to a different directory server you can change the Drupal XML-RPC server setting -- but the directory server has to be able to handle Drupal XML. To get all your site information listed go to the site configuration page and set the site name, the e-mail address, the slogan, and the mission statement.", array("%xml-rpc-setting" => url("admin/system/modules/drupal"), "%site-admin" => url("admin/system"))); break; case 'user/help#drupal': - return t("%Drupal is the name of the software which powers %this-site. There are Drupal web sites all over the world, and many of them share their registration databases so that users may freely login to any Drupal site using a single Drupal ID.
-So please feel free to login to your account here at %this-site with a username from another Drupal site. The format of a Drupal ID is similar to an email address: username@server. An example of a valid Drupal ID is mwlily@www.drupal.org.
", array("%Drupal" => "Drupal", "%this-site" => "".variable_get("site_name", "this web site")."")); + return t("Drupal is the name of the software which powers %this-site. There are Drupal web sites all over the world, and many of them share their registration databases so that users may freely login to any Drupal site using a single Drupal ID.
+So please feel free to login to your account here at %this-site with a username from another Drupal site. The format of a Drupal ID is similar to an email address: username@server. An example of a valid Drupal ID is mwlily@www.drupal.org.
", array("%Drupal" => "http://www.drupal.org", "%this-site" => "". variable_get("site_name", "this web site") ."")); break; } @@ -38,7 +38,7 @@ function drupal_settings() { $error["drupal_directory"] = theme("error", t("You must set your site's mission at the site configuration.", array("%url" => url("admin/system")))); $output = form_textfield(t("Drupal XML-RPC server"), "drupal_server", variable_get("drupal_server", "http://www.drupal.org/xmlrpc.php"), 55, 128, t("The URL of your root Drupal XML-RPC server.")); - $output .= form_radios(t("Drupal directory"), "drupal_directory", variable_get("drupal_directory", 0), array(t("Disabled"), t("Enabled")), t("If enabled, your Drupal site will make itself known to the Drupal directory at the specified Drupal XML-RPC server. For this to work properly, you must set your site's name, e-mail address, slogan and mission statement. When the \"%xml-rpc-server\" field is set to \"%drupal-xml-rpc\", your web site will get listed on the %drupal-sites page. Requires the cron feature to be enabled.", array("%xml-rpc-server" => t("Drupal XML-RPC server"), "%drupal-xml-rpc" => "http://www.drupal.org/xmlrpc.php", "%drupal-sites" => "".t("Drupal sites")."")) . $error["drupal_directory"]); + $output .= form_radios(t("Drupal directory"), "drupal_directory", variable_get("drupal_directory", 0), array(t("Disabled"), t("Enabled")), t("If enabled, your Drupal site will make itself known to the Drupal directory at the specified Drupal XML-RPC server. For this to work properly, you must set your site's name, e-mail address, slogan and mission statement. When the \"Drupal XML-RPC server\" field is set to \"%drupal-xml-rpc\", your web site will get listed on the Drupal sites page. Requires the cron feature to be enabled.", array("%drupal-xml-rpc" => "http://www.drupal.org/xmlrpc.php")) . $error["drupal_directory"]); return $output; } diff --git a/modules/forum.module b/modules/forum.module index c2c20ee13af..2e18afe041a 100644 --- a/modules/forum.module +++ b/modules/forum.module @@ -397,7 +397,7 @@ function _forum_new($tid) { } function _forum_message_taxonomy() { - return t("Forums are threaded discussions based on the taxonomy system. For the forums to work, the taxonomy module has to be installed and enabled. When activated, a taxonomy vocabulary (eg. \"forums\") needs to be %created and bound to the node type \"forum topic\".", array('%created' => l(t('created'), 'admin/taxonomy/add/vocabulary'))); + return t("Forums are threaded discussions based on the taxonomy system. For the forums to work, the taxonomy module has to be installed and enabled. When activated, a taxonomy vocabulary (eg. \"forums\") needs to be created and bound to the node type \"forum topic\".", array('%created' => url('admin/taxonomy/add/vocabulary'))); } function forum_page() { @@ -680,12 +680,12 @@ function forum_help($section = "admin/help#forum") { switch ($section) { case 'admin/help#forum': $output .= "The forum module uses taxonomy to organize itself. To create a forum you first have to create a %taxonomy. When doing this, choose a sensible name for it (such as \"fora\") and make sure under \"Types\" that \"forum\" is selected. Once you have done this, %taxo-terms to it. Each term will become a forum. If you fill in the description field, users will be given additonal information about the forum on the main forum page. For example: \"troubleshooting\" - \"Please ask your questions here.\"
"; - $output .= "When you are happy with your vocabulary, go to %forums and set Forum vocabulary to the one you have just created. There will now be fora active on the site. For users to access them they must have the \"access content\" %permission and to create a topic they must have the \"create forum topics\" %permission. These permissions can be set in the %permission pages.
"; + $output .= "The forum module uses taxonomy to organize itself. To create a forum you first have to create a taxonomy vocabulary. When doing this, choose a sensible name for it (such as \"fora\") and make sure under \"Types\" that \"forum\" is selected. Once you have done this, add some terms to it. Each term will become a forum. If you fill in the description field, users will be given additonal information about the forum on the main forum page. For example: \"troubleshooting\" - \"Please ask your questions here.\"
"; + $output .= "When you are happy with your vocabulary, go to administer » configutation » modules » forum and set Forum vocabulary to the one you have just created. There will now be fora active on the site. For users to access them they must have the \"access content\" permission and to create a topic they must have the \"create forum topics\" permission. These permissions can be set in the permission pages.
"; $output .= "To disable icons, set the icon path as blank in %forums.
"; + $output .= "To disable icons, set the icon path as blank in administer » configutation » modules » forum.
"; $output .= "All files in the icon directory are assumed to be images. You may use images of whatever size you wish, but it is recommended to use 15x15 or 16x16.
"; - $output = t($output, array("%taxonomy" => l(t("taxonomy vocabulary"), "admin/taxonomy/add/vocabulary"), "%taxo-terms" => l(t("add some terms"), "admin/taxonomy"), "%forums" => l(t("administer") ." » ". t("configutation") ." » ". t("modules") ." » ". t("forum"), "admin/system/modules/forum"), "%permission" => l(t("permission"), "admin/user/permission"))); + $output = t($output, array("%taxonomy" => url("admin/taxonomy/add/vocabulary"), "%taxo-terms" => url("admin/taxonomy"), "%forums" => url("admin/system/modules/forum"), "%permission" => url("admin/user/permission"))); break; case 'admin/system/modules#description': $output = t("Enable threaded discussions about general topics."); diff --git a/modules/forum/forum.module b/modules/forum/forum.module index c2c20ee13af..2e18afe041a 100644 --- a/modules/forum/forum.module +++ b/modules/forum/forum.module @@ -397,7 +397,7 @@ function _forum_new($tid) { } function _forum_message_taxonomy() { - return t("Forums are threaded discussions based on the taxonomy system. For the forums to work, the taxonomy module has to be installed and enabled. When activated, a taxonomy vocabulary (eg. \"forums\") needs to be %created and bound to the node type \"forum topic\".", array('%created' => l(t('created'), 'admin/taxonomy/add/vocabulary'))); + return t("Forums are threaded discussions based on the taxonomy system. For the forums to work, the taxonomy module has to be installed and enabled. When activated, a taxonomy vocabulary (eg. \"forums\") needs to be created and bound to the node type \"forum topic\".", array('%created' => url('admin/taxonomy/add/vocabulary'))); } function forum_page() { @@ -680,12 +680,12 @@ function forum_help($section = "admin/help#forum") { switch ($section) { case 'admin/help#forum': $output .= "The forum module uses taxonomy to organize itself. To create a forum you first have to create a %taxonomy. When doing this, choose a sensible name for it (such as \"fora\") and make sure under \"Types\" that \"forum\" is selected. Once you have done this, %taxo-terms to it. Each term will become a forum. If you fill in the description field, users will be given additonal information about the forum on the main forum page. For example: \"troubleshooting\" - \"Please ask your questions here.\"
"; - $output .= "When you are happy with your vocabulary, go to %forums and set Forum vocabulary to the one you have just created. There will now be fora active on the site. For users to access them they must have the \"access content\" %permission and to create a topic they must have the \"create forum topics\" %permission. These permissions can be set in the %permission pages.
"; + $output .= "The forum module uses taxonomy to organize itself. To create a forum you first have to create a taxonomy vocabulary. When doing this, choose a sensible name for it (such as \"fora\") and make sure under \"Types\" that \"forum\" is selected. Once you have done this, add some terms to it. Each term will become a forum. If you fill in the description field, users will be given additonal information about the forum on the main forum page. For example: \"troubleshooting\" - \"Please ask your questions here.\"
"; + $output .= "When you are happy with your vocabulary, go to administer » configutation » modules » forum and set Forum vocabulary to the one you have just created. There will now be fora active on the site. For users to access them they must have the \"access content\" permission and to create a topic they must have the \"create forum topics\" permission. These permissions can be set in the permission pages.
"; $output .= "To disable icons, set the icon path as blank in %forums.
"; + $output .= "To disable icons, set the icon path as blank in administer » configutation » modules » forum.
"; $output .= "All files in the icon directory are assumed to be images. You may use images of whatever size you wish, but it is recommended to use 15x15 or 16x16.
"; - $output = t($output, array("%taxonomy" => l(t("taxonomy vocabulary"), "admin/taxonomy/add/vocabulary"), "%taxo-terms" => l(t("add some terms"), "admin/taxonomy"), "%forums" => l(t("administer") ." » ". t("configutation") ." » ". t("modules") ." » ". t("forum"), "admin/system/modules/forum"), "%permission" => l(t("permission"), "admin/user/permission"))); + $output = t($output, array("%taxonomy" => url("admin/taxonomy/add/vocabulary"), "%taxo-terms" => url("admin/taxonomy"), "%forums" => url("admin/system/modules/forum"), "%permission" => url("admin/user/permission"))); break; case 'admin/system/modules#description': $output = t("Enable threaded discussions about general topics."); diff --git a/modules/help.module b/modules/help.module index d8a11cfeb66..5020ab59000 100644 --- a/modules/help.module +++ b/modules/help.module @@ -21,12 +21,12 @@ function help_glossary() { $output .= "Most programs are written and documented in English, and use English to interact with users. This is also true for a great deal of web sites. However, most people are less comfortable with English than with their native language, and would prefer to use their mother tongue as much as possible. Many people love see their web site showing a lot less English, and far more of their own language.
"; $output .= "Therefore Drupal provides a framework to setup a multi-lingual web site, or to overwrite the default English texts. We explored the various alternatives to support internationalization (I18N) and decided to design the framework in such a way that the impact of internationalization on drupal's sources is minimized, modular and doesn't require a HTML or PHP wizard to maintain translations. Maintaining translations had to be simple so it became as easy as filling out forms on the administration page.
"; $output .= "The actual translation starts at the %overview page of the locale section in the administration pages. In the menu on the left under \"localization\" you will see a list of the languages you have configured. Click on the name of the language to start translating. Looking at a page full of all the strings in the site can be a bit overwhelming, so Drupal allows you to limit the strings you are working on. If you want to limit based on translated strings click \"translated strings\", if you want to limit the string based on the untranslated strings click \"untranslated strings\". Both will take you to the same page. Once there enter the string pattern to limit on, choose the language to search for, and the status, weather translated, untranslated or both, finally where you want to look, modules, specific modules, or pages.
"; + $output .= "The actual translation starts at the overview page of the locale section in the administration pages. In the menu on the left under \"localization\" you will see a list of the languages you have configured. Click on the name of the language to start translating. Looking at a page full of all the strings in the site can be a bit overwhelming, so Drupal allows you to limit the strings you are working on. If you want to limit based on translated strings click \"translated strings\", if you want to limit the string based on the untranslated strings click \"untranslated strings\". Both will take you to the same page. Once there enter the string pattern to limit on, choose the language to search for, and the status, weather translated, untranslated or both, finally where you want to look, modules, specific modules, or pages.
"; $output .= "At the locale page, users with the proper access rights will see the various texts that need translation on the left column of the table.
"; $output .= "Below the text you can see an example URI where this text shows up one your site. Chances are most of these texts will be used and displayed on more than one page, though only one example URI is presented.
"; $output .= "The second column displays the supported languages as defined in the configuration file. See below for more information on how to support new languages. If the symbol for a language is seen like this, it means that this entry still needs to be translated into that language. If not, it has been translated already.
Most programs are written and documented in English, and use English to interact with users. This is also true for a great deal of web sites. However, most people are less comfortable with English than with their native language, and would prefer to use their mother tongue as much as possible. Many people love see their web site showing a lot less English, and far more of their own language.
"; $output .= "Therefore Drupal provides a framework to setup a multi-lingual web site, or to overwrite the default English texts. We explored the various alternatives to support internationalization (I18N) and decided to design the framework in such a way that the impact of internationalization on drupal's sources is minimized, modular and doesn't require a HTML or PHP wizard to maintain translations. Maintaining translations had to be simple so it became as easy as filling out forms on the administration page.
"; $output .= "The actual translation starts at the %overview page of the locale section in the administration pages. In the menu on the left under \"localization\" you will see a list of the languages you have configured. Click on the name of the language to start translating. Looking at a page full of all the strings in the site can be a bit overwhelming, so Drupal allows you to limit the strings you are working on. If you want to limit based on translated strings click \"translated strings\", if you want to limit the string based on the untranslated strings click \"untranslated strings\". Both will take you to the same page. Once there enter the string pattern to limit on, choose the language to search for, and the status, weather translated, untranslated or both, finally where you want to look, modules, specific modules, or pages.
"; + $output .= "The actual translation starts at the overview page of the locale section in the administration pages. In the menu on the left under \"localization\" you will see a list of the languages you have configured. Click on the name of the language to start translating. Looking at a page full of all the strings in the site can be a bit overwhelming, so Drupal allows you to limit the strings you are working on. If you want to limit based on translated strings click \"translated strings\", if you want to limit the string based on the untranslated strings click \"untranslated strings\". Both will take you to the same page. Once there enter the string pattern to limit on, choose the language to search for, and the status, weather translated, untranslated or both, finally where you want to look, modules, specific modules, or pages.
"; $output .= "At the locale page, users with the proper access rights will see the various texts that need translation on the left column of the table.
"; $output .= "Below the text you can see an example URI where this text shows up one your site. Chances are most of these texts will be used and displayed on more than one page, though only one example URI is presented.
"; $output .= "The second column displays the supported languages as defined in the configuration file. See below for more information on how to support new languages. If the symbol for a language is seen like this, it means that this entry still needs to be translated into that language. If not, it has been translated already.
The core of the Drupal system is the node. All of the contents of the system are placed in nodes, or extensions of nodes."; $output .= "A base node contains:
Now that you know what is in a node, here are some of the types of nodes available.
"; - $output = t($output, array("%teaser" => l(t("click here"), "admin/system/modules/node"))); + $output = t($output, array("%teaser" => url("admin/system/modules/node"))); if ($mod == "admin") { foreach (module_list() as $name) { @@ -49,7 +49,7 @@ function node_help($section = "admin/help#node") { $output = t("Settings for the core of Drupal. Almost everything is a node so these settings will affect most of the site."); break; case 'admin/node': - $output = t("Below is a list of all of the nodes in your site. Other forms of content are listed elsewhere (e.g. %comments).The core of the Drupal system is the node. All of the contents of the system are placed in nodes, or extensions of nodes."; $output .= "A base node contains:
Now that you know what is in a node, here are some of the types of nodes available.
"; - $output = t($output, array("%teaser" => l(t("click here"), "admin/system/modules/node"))); + $output = t($output, array("%teaser" => url("admin/system/modules/node"))); if ($mod == "admin") { foreach (module_list() as $name) { @@ -49,7 +49,7 @@ function node_help($section = "admin/help#node") { $output = t("Settings for the core of Drupal. Almost everything is a node so these settings will affect most of the site."); break; case 'admin/node': - $output = t("Below is a list of all of the nodes in your site. Other forms of content are listed elsewhere (e.g. %comments).Users with the correct %permissions can create and/or vote on polls.
"; + $output .= "Users with the correct permissions can create and/or vote on polls.
"; $output .= "Creating a poll is much like creating any other node. Click \"create poll\" in your user box. The title of the poll should be the question, then enter the answers and the \"base\" vote counts. You can also choose the time period over which the vote will run.
The %poll item in the navigation links will take you to a page where you can see all the current polls, vote on them (if you haven't already) and view the results.
"; - $output = t($output, array("%permissions" => l(t("permissions"), "admin/user/permission"), "%poll" => l(t("Poll"), "poll"))); + $output .= "Creating a poll is much like creating any other node. Click \"create poll\" in your user box. The title of the poll should be the question, then enter the answers and the \"base\" vote counts. You can also choose the time period over which the vote will run.
The Poll item in the navigation links will take you to a page where you can see all the current polls, vote on them (if you haven't already) and view the results.
"; + $output = t($output, array("%permissions" => url("admin/user/permission"), "%poll" => url("poll"))); break; case 'admin/system/modules#description': $output = t("Enables your site to capture votes on different topics in the form of multiple choice questions."); diff --git a/modules/poll/poll.module b/modules/poll/poll.module index ac1b798bad9..edab210b430 100644 --- a/modules/poll/poll.module +++ b/modules/poll/poll.module @@ -143,15 +143,15 @@ function poll_help($section = "admin/help#poll") { switch ($section) { case 'admin/help#poll': - $output .= "Users with the correct %permissions can create and/or vote on polls.
"; + $output .= "Users with the correct permissions can create and/or vote on polls.
"; $output .= "Creating a poll is much like creating any other node. Click \"create poll\" in your user box. The title of the poll should be the question, then enter the answers and the \"base\" vote counts. You can also choose the time period over which the vote will run.
The %poll item in the navigation links will take you to a page where you can see all the current polls, vote on them (if you haven't already) and view the results.
"; - $output = t($output, array("%permissions" => l(t("permissions"), "admin/user/permission"), "%poll" => l(t("Poll"), "poll"))); + $output .= "Creating a poll is much like creating any other node. Click \"create poll\" in your user box. The title of the poll should be the question, then enter the answers and the \"base\" vote counts. You can also choose the time period over which the vote will run.
The Poll item in the navigation links will take you to a page where you can see all the current polls, vote on them (if you haven't already) and view the results.
"; + $output = t($output, array("%permissions" => url("admin/user/permission"), "%poll" => url("poll"))); break; case 'admin/system/modules#description': $output = t("Enables your site to capture votes on different topics in the form of multiple choice questions."); diff --git a/modules/profile.module b/modules/profile.module index eca4a3e75d7..adf8af224c7 100644 --- a/modules/profile.module +++ b/modules/profile.module @@ -45,7 +45,7 @@ function profile_help($section) { $output = t("Support for configurable user profiles."); break; case 'admin/system/modules/profile': - $output = t("When a user creates an account you can ask for some extra information, as well as letting the user have a small picture, called an avatar.As with any new module, the statistics module needs to be %modules before you can use it. Also refer to the %permissions, as this module supports four separate permissions.
"; - $output .= "This admin page shows you site-wide referrer statistics. You can see 'all' statistics, 'external' statistics or 'internal' statistics. Default is 'all'.
"; - $output .= "This admin page gives you an at-a-glance look at your most popular content. It is useful for understanding what content on your Drupal site is the most popular. Also on this page are links to the referrer statistics for each listed node.
"; - $output .= "There are some configuration options added to the main %configuration section:
"; + $output .= "As with any new module, the statistics module needs to be enabled before you can use it. Also refer to the permissions section, as this module supports four separate permissions.
"; + $output .= "This admin page shows you site-wide referrer statistics. You can see 'all' statistics, 'external' statistics or 'internal' statistics. Default is 'all'.
"; + $output .= "This admin page gives you an at-a-glance look at your most popular content. It is useful for understanding what content on your Drupal site is the most popular. Also on this page are links to the referrer statistics for each listed node.
"; + $output .= "There are some configuration options added to the main administer » configuration section:
"; $output .= "This module creates a block that can display the day's top viewed content, the all time top viewed content, and the last content viewed. Each of these links can be enabled or disabled individually, and the number of posts displayed for each can be configured with a drop down menu. If you disable all sections of this block, it will not appear.
"; - $output .= "Don't forget to enable the block %here-block.
"; + $output .= "Don't forget to enable the block.
"; $output .= "This module creates a user page that can display summaries of the day's most popular viewed content, the all time most popular content, and the last content viewed. Each of these summaries can be enabled or disabled individually, and the number of posts displayed for each can be configured with a drop down menu. You can also assign a name for the automatically generated link to the user page. If no name is set, the link will not be displayed.
"; - $output .= "This module has four permissions that need to be configured in %permissions.
"; + $output .= "This module has four permissions that need to be configured in the permissions section.
"; $output .= "statistics_title_list(\"timestamp\",\"5\");\$dbrows is the number or rows you want returned in your array.
"; - $output = t($output, array("%modules" => l(t("enabled"), "admin/system/modules"), "%permissions" => l(t("permissions section"), "admin/user/permission"), "%referers" => l(t("referrers log"), "admin/statistics/referrers"), "%access" => l(t("access log"), "admin/statistics/log"), "%configuration" => l(t("administer") ." » ". t("configuration"), "admin/system/modules/statistics"), "%here-block" => l(t("here"), "admin/system/block"))); + $output = t($output, array("%modules" => url("admin/system/modules"), "%permissions" => url("admin/user/permission"), "%referers" => url("admin/statistics/referrers"), "%access" => url("admin/statistics/log"), "%configuration" => url("admin/system/modules/statistics"), "%block" => url("admin/system/block"))); break; case 'admin/system/modules#description': $output = t("Logs access statistics for your site."); break; case 'admin/system/modules/statistics': - $output = t("Settings for the statistical information that Drupal will keep about the site. See %statistics for the actual information.", array("%statistics" => l(t("site statistics"), "admin/statistics"))); + $output = t("Settings for the statistical information that Drupal will keep about the site. See site statistics for the actual information.", array("%statistics" => url("admin/statistics"))); break; case 'admin/statistics': $output = t("This page gives you an at-a-glance look at your most popular content."); diff --git a/modules/statistics/statistics.module b/modules/statistics/statistics.module index 8879d69f88b..23ae79d2d40 100644 --- a/modules/statistics/statistics.module +++ b/modules/statistics/statistics.module @@ -112,10 +112,10 @@ function statistics_help($section = "admin/help#statistics") { $output .= "As with any new module, the statistics module needs to be %modules before you can use it. Also refer to the %permissions, as this module supports four separate permissions.
"; - $output .= "This admin page shows you site-wide referrer statistics. You can see 'all' statistics, 'external' statistics or 'internal' statistics. Default is 'all'.
"; - $output .= "This admin page gives you an at-a-glance look at your most popular content. It is useful for understanding what content on your Drupal site is the most popular. Also on this page are links to the referrer statistics for each listed node.
"; - $output .= "There are some configuration options added to the main %configuration section:
"; + $output .= "As with any new module, the statistics module needs to be enabled before you can use it. Also refer to the permissions section, as this module supports four separate permissions.
"; + $output .= "This admin page shows you site-wide referrer statistics. You can see 'all' statistics, 'external' statistics or 'internal' statistics. Default is 'all'.
"; + $output .= "This admin page gives you an at-a-glance look at your most popular content. It is useful for understanding what content on your Drupal site is the most popular. Also on this page are links to the referrer statistics for each listed node.
"; + $output .= "There are some configuration options added to the main administer » configuration section:
"; $output .= "This module creates a block that can display the day's top viewed content, the all time top viewed content, and the last content viewed. Each of these links can be enabled or disabled individually, and the number of posts displayed for each can be configured with a drop down menu. If you disable all sections of this block, it will not appear.
"; - $output .= "Don't forget to enable the block %here-block.
"; + $output .= "Don't forget to enable the block.
"; $output .= "This module creates a user page that can display summaries of the day's most popular viewed content, the all time most popular content, and the last content viewed. Each of these summaries can be enabled or disabled individually, and the number of posts displayed for each can be configured with a drop down menu. You can also assign a name for the automatically generated link to the user page. If no name is set, the link will not be displayed.
"; - $output .= "This module has four permissions that need to be configured in %permissions.
"; + $output .= "This module has four permissions that need to be configured in the permissions section.
"; $output .= "statistics_title_list(\"timestamp\",\"5\");\$dbrows is the number or rows you want returned in your array.
"; - $output = t($output, array("%modules" => l(t("enabled"), "admin/system/modules"), "%permissions" => l(t("permissions section"), "admin/user/permission"), "%referers" => l(t("referrers log"), "admin/statistics/referrers"), "%access" => l(t("access log"), "admin/statistics/log"), "%configuration" => l(t("administer") ." » ". t("configuration"), "admin/system/modules/statistics"), "%here-block" => l(t("here"), "admin/system/block"))); + $output = t($output, array("%modules" => url("admin/system/modules"), "%permissions" => url("admin/user/permission"), "%referers" => url("admin/statistics/referrers"), "%access" => url("admin/statistics/log"), "%configuration" => url("admin/system/modules/statistics"), "%block" => url("admin/system/block"))); break; case 'admin/system/modules#description': $output = t("Logs access statistics for your site."); break; case 'admin/system/modules/statistics': - $output = t("Settings for the statistical information that Drupal will keep about the site. See %statistics for the actual information.", array("%statistics" => l(t("site statistics"), "admin/statistics"))); + $output = t("Settings for the statistical information that Drupal will keep about the site. See site statistics for the actual information.", array("%statistics" => url("admin/statistics"))); break; case 'admin/statistics': $output = t("This page gives you an at-a-glance look at your most popular content."); diff --git a/modules/story.module b/modules/story.module index d50b3b61d36..b441b1667d2 100644 --- a/modules/story.module +++ b/modules/story.module @@ -13,8 +13,8 @@ function story_help($section = "admin/help#story") { break; case 'admin/help#story': $output = "The story module lets your users submit articles for consideration by the rest of the community, who can vote on them if moderation is enabled. Stories usually follow a publishing flow of submit -> moderate -> post to the main page -> comments. Administrators are able to shortcut this flow as desired.
"; - $output .= "In %story-config you can set up an introductory text for story authors, and a floor on the number of words which may be included in a story. This is designed to help discourage the submission of trivially short stories."; - $output = t($output, array("%story-config" => l(t("administer") ." » ". t("configuration") ." » ". t("modules") ." » ". t("story"), "admin/system/modules/story"))); + $output .= "In administer » configuration » modules » story you can set up an introductory text for story authors, and a floor on the number of words which may be included in a story. This is designed to help discourage the submission of trivially short stories."; + $output = t($output, array("%story-config" => url("admin/system/modules/story"))); break; } diff --git a/modules/story/story.module b/modules/story/story.module index d50b3b61d36..b441b1667d2 100644 --- a/modules/story/story.module +++ b/modules/story/story.module @@ -13,8 +13,8 @@ function story_help($section = "admin/help#story") { break; case 'admin/help#story': $output = "The story module lets your users submit articles for consideration by the rest of the community, who can vote on them if moderation is enabled. Stories usually follow a publishing flow of submit -> moderate -> post to the main page -> comments. Administrators are able to shortcut this flow as desired.
"; - $output .= "In %story-config you can set up an introductory text for story authors, and a floor on the number of words which may be included in a story. This is designed to help discourage the submission of trivially short stories."; - $output = t($output, array("%story-config" => l(t("administer") ." » ". t("configuration") ." » ". t("modules") ." » ". t("story"), "admin/system/modules/story"))); + $output .= "In administer » configuration » modules » story you can set up an introductory text for story authors, and a floor on the number of words which may be included in a story. This is designed to help discourage the submission of trivially short stories."; + $output = t($output, array("%story-config" => url("admin/system/modules/story"))); break; } diff --git a/modules/system.module b/modules/system.module index bce1ad06f8f..a8325329deb 100644 --- a/modules/system.module +++ b/modules/system.module @@ -13,10 +13,9 @@ function system_help($section = "admin/help#system") { $output = t("Select which themes are available to your users and specify the default theme."); break; case 'admin/system/modules': - $output = t("Modules are plugins for Drupal that extend its core functionality. Here you can select which modules are enabled. Click on the name of the module in the navigation menu for their individual configuration pages. Once a module is enabled, new %permissions might be made available. Modules 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 after having enabled the throttle module.", array("%permissions" => l(t("permissions"), "admin/user/permission"), "%throttle" => l(t("throttle configuration page"), "admin/system/modules/throttle"))); + $output = t("Modules are plugins for Drupal that extend its core functionality. Here you can select which modules are enabled. Click on the name of the module in the navigation menu for their individual configuration pages. Once a module is enabled, new permissions might be made available. Modules 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("%permissions" => url("admin/user/permission"), "%throttle" => url("admin/system/modules/throttle"))); break; case 'admin/help#system': - case 'admin/system/help': $output .= "Drupal comes with system-wide defaults but the setting-module provides control over many Drupal preferences, behaviours including visual and operational settings.
"; $output .= "Whenever %cron-link is accessed, cron will run: it calls the _cron hook in each module allowing the module to run tasks if they have not been executed in the last n seconds, where n is the period of that task. When all the tasks are finished, cron is done.
"; $output .= "The recommended way to set up your cron system is to set up a Unix/Linux crontab entry (see \"man crontab\") that frequently visits %cron-link. Note that cron does not guarantee the commands will be executed at the specified interval. However, Drupal will try its best to run the tasks as close to the specified intervals as possible. The more you visit cron.php, the more accurate cron will be.
"; $output .= "If your hosting company does not allow you to set up crontab entries, you can always ask someone else to set up an entry for you. After all, virtually any Unix/Linux machine with access to the internet can set up a crontab entry to frequently visit %cron-link.
"; - $output .= "For the Unix/Linux crontab itself, use a browser like %lynx or %wget but make sure the process terminates: either use /usr/bin/lynx -source %base_url/cron.php or /usr/bin/wget -o /dev/null -O /dev/null %cron-link. Take a look at the example scripts in the scripts-directory. Make sure to adjust them to fit your needs. A good crontab line to run the cron script once every hour would be:";
+ $output .= "
For the Unix/Linux crontab itself, use a browser like lynx or wget but make sure the process terminates: either use /usr/bin/lynx -source %base_url/cron.php or /usr/bin/wget -o /dev/null -O /dev/null %cron-link. Take a look at the example scripts in the scripts-directory. Make sure to adjust them to fit your needs. A good crontab line to run the cron script once every hour would be:";
$output .= "
00 * * * * /home/www/drupal/scripts/cron-lynx.sh"; $output .= "Note that it is essential to access
cron.php using a browser on the web site's domain; do not run it using command line PHP and avoid using localhost or 127.0.0.1 or some of the environment varibles will not be set correctly and features may not work as expected.";
// End of system_help_cron
@@ -32,7 +31,7 @@ function system_help($section = "admin/help#system") {
// Start of system_help_cache
$output .= "Drupal has a caching mechanism which stores dynamically generated web pages in a database. By caching a web page, Drupal does not have to create the page each time someone wants to view it, instead it takes only one SQL query to display it, reducing response time and the server's load. Only pages requested by \"anonymous\" users are cached.
"; // End of system_help_cache - $output = t($output, array("%base_url" => $base_url, "%cron-link" => "$base_url/cron.php", "%lynx" => "lynx", "%wget" => "wget" )); + $output = t($output, array("%base_url" => $base_url, "%cron-link" => "$base_url/cron.php", "%lynx" => "http://lynx.browser.org", "%wget" => "http://www.gnu.org/software/wget/wget.html" )); break; case 'admin/system/modules#description': $output = t("Configuration system that lets administrators modify the workings of the site."); @@ -118,7 +117,7 @@ function system_view_general() { $output = form_group(t("General settings"), $group); // caching: - $group = form_radios(t("Cache support"), "cache", variable_get("cache", 0), array(t("Disabled"), t("Enabled")), t("Enable or disable the caching of rendered pages. When caching is enabled, Drupal will flush the cache when required to make sure updates take effect immediately. Check the %documentation for information on Drupal's cache system.", array("%documentation" => l(t("cache documentation"), "admin/system/help", NULL, NULL, "cache")))); + $group = form_radios(t("Cache support"), "cache", variable_get("cache", 0), array(t("Disabled"), t("Enabled")), t("Enable or disable the caching of rendered pages. When caching is enabled, Drupal will flush the cache when required to make sure updates take effect immediately. Check the cache documentation for information on Drupal's cache system.", array("%documentation" => url("admin/system/help", NULL, NULL, "cache")))); $output .= form_group(t("Cache settings"), $group); diff --git a/modules/system/system.module b/modules/system/system.module index bce1ad06f8f..a8325329deb 100644 --- a/modules/system/system.module +++ b/modules/system/system.module @@ -13,10 +13,9 @@ function system_help($section = "admin/help#system") { $output = t("Select which themes are available to your users and specify the default theme."); break; case 'admin/system/modules': - $output = t("Modules are plugins for Drupal that extend its core functionality. Here you can select which modules are enabled. Click on the name of the module in the navigation menu for their individual configuration pages. Once a module is enabled, new %permissions might be made available. Modules 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 after having enabled the throttle module.", array("%permissions" => l(t("permissions"), "admin/user/permission"), "%throttle" => l(t("throttle configuration page"), "admin/system/modules/throttle"))); + $output = t("Modules are plugins for Drupal that extend its core functionality. Here you can select which modules are enabled. Click on the name of the module in the navigation menu for their individual configuration pages. Once a module is enabled, new permissions might be made available. Modules 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("%permissions" => url("admin/user/permission"), "%throttle" => url("admin/system/modules/throttle"))); break; case 'admin/help#system': - case 'admin/system/help': $output .= "Drupal comes with system-wide defaults but the setting-module provides control over many Drupal preferences, behaviours including visual and operational settings.
"; $output .= "Whenever %cron-link is accessed, cron will run: it calls the _cron hook in each module allowing the module to run tasks if they have not been executed in the last n seconds, where n is the period of that task. When all the tasks are finished, cron is done.
"; $output .= "The recommended way to set up your cron system is to set up a Unix/Linux crontab entry (see \"man crontab\") that frequently visits %cron-link. Note that cron does not guarantee the commands will be executed at the specified interval. However, Drupal will try its best to run the tasks as close to the specified intervals as possible. The more you visit cron.php, the more accurate cron will be.
"; $output .= "If your hosting company does not allow you to set up crontab entries, you can always ask someone else to set up an entry for you. After all, virtually any Unix/Linux machine with access to the internet can set up a crontab entry to frequently visit %cron-link.
"; - $output .= "For the Unix/Linux crontab itself, use a browser like %lynx or %wget but make sure the process terminates: either use /usr/bin/lynx -source %base_url/cron.php or /usr/bin/wget -o /dev/null -O /dev/null %cron-link. Take a look at the example scripts in the scripts-directory. Make sure to adjust them to fit your needs. A good crontab line to run the cron script once every hour would be:";
+ $output .= "
For the Unix/Linux crontab itself, use a browser like lynx or wget but make sure the process terminates: either use /usr/bin/lynx -source %base_url/cron.php or /usr/bin/wget -o /dev/null -O /dev/null %cron-link. Take a look at the example scripts in the scripts-directory. Make sure to adjust them to fit your needs. A good crontab line to run the cron script once every hour would be:";
$output .= "
00 * * * * /home/www/drupal/scripts/cron-lynx.sh"; $output .= "Note that it is essential to access
cron.php using a browser on the web site's domain; do not run it using command line PHP and avoid using localhost or 127.0.0.1 or some of the environment varibles will not be set correctly and features may not work as expected.";
// End of system_help_cron
@@ -32,7 +31,7 @@ function system_help($section = "admin/help#system") {
// Start of system_help_cache
$output .= "Drupal has a caching mechanism which stores dynamically generated web pages in a database. By caching a web page, Drupal does not have to create the page each time someone wants to view it, instead it takes only one SQL query to display it, reducing response time and the server's load. Only pages requested by \"anonymous\" users are cached.
"; // End of system_help_cache - $output = t($output, array("%base_url" => $base_url, "%cron-link" => "$base_url/cron.php", "%lynx" => "lynx", "%wget" => "wget" )); + $output = t($output, array("%base_url" => $base_url, "%cron-link" => "$base_url/cron.php", "%lynx" => "http://lynx.browser.org", "%wget" => "http://www.gnu.org/software/wget/wget.html" )); break; case 'admin/system/modules#description': $output = t("Configuration system that lets administrators modify the workings of the site."); @@ -118,7 +117,7 @@ function system_view_general() { $output = form_group(t("General settings"), $group); // caching: - $group = form_radios(t("Cache support"), "cache", variable_get("cache", 0), array(t("Disabled"), t("Enabled")), t("Enable or disable the caching of rendered pages. When caching is enabled, Drupal will flush the cache when required to make sure updates take effect immediately. Check the %documentation for information on Drupal's cache system.", array("%documentation" => l(t("cache documentation"), "admin/system/help", NULL, NULL, "cache")))); + $group = form_radios(t("Cache support"), "cache", variable_get("cache", 0), array(t("Disabled"), t("Enabled")), t("Enable or disable the caching of rendered pages. When caching is enabled, Drupal will flush the cache when required to make sure updates take effect immediately. Check the cache documentation for information on Drupal's cache system.", array("%documentation" => url("admin/system/help", NULL, NULL, "cache")))); $output .= form_group(t("Cache settings"), $group); diff --git a/modules/taxonomy.module b/modules/taxonomy.module index 62bb9b5dbcc..cc6f92ec57f 100644 --- a/modules/taxonomy.module +++ b/modules/taxonomy.module @@ -846,10 +846,10 @@ function taxonomy_help($section = "admin/help#taxonomy") { $output = t("When you create a controlled vocabulary you are creating a set of terms to use for describing content (known as descriptors in indexing lingo). Drupal allows you to describe each node type (blog, story, etc.) using one or many of these terms. For simple implementations, you might create a set of categories without subcategories, similar to Slashdot.org's or Kuro5hin.org's sections. For more complex implementations, you might create a hierarchical list of categories."); break; case 'admin/help#taxonomy': - $output .= "Taxonomy is the study of classification. Drupal's taxonomy module allows you to define categories which are used to classify content. The module supports hierarchical classification and association between terms, allowing for truly flexible information retrieval and classification. For more details about %classification-types and insight into the development of the taxonomy.module, see this %drupal-dis.
"; + $output .= "Taxonomy is the study of classification. Drupal's taxonomy module allows you to define categories which are used to classify content. The module supports hierarchical classification and association between terms, allowing for truly flexible information retrieval and classification. For more details about classification types and insight into the development of the taxonomy.module, see this drupal.org discussion.
"; $output .= "Notes
When you create a controlled vocabulary you are creating a set of terms to use for describing content (known as descriptors in indexing lingo). Drupal allows you to describe each node of content (blog, story, etc.) using one or many of these terms. For simple implementations, you might create a set of categories without subcategories, similar to %slashdot's sections. For more complex implementations, you might create a hierarchical list of categories such as Food taxonomy shown above.
"; + $output .= "When you create a controlled vocabulary you are creating a set of terms to use for describing content (known as descriptors in indexing lingo). Drupal allows you to describe each node of content (blog, story, etc.) using one or many of these terms. For simple implementations, you might create a set of categories without subcategories, similar to Slashdot's sections. For more complex implementations, you might create a hierarchical list of categories such as Food taxonomy shown above.
"; $output .= "When setting up a controlled vocabulary, if you select the hierarchy option, you will be defining a taxonomy or a thesaurus. If you select the related terms option, you are allowing the definition of related terms, think see also, as in a thesaurus. Selecting multiple select will allow you to describe a node using more than one term. That node will then appear in each term's page, thus increasing the chance that a user will find it.
"; $output .= "When setting up a controlled vocabulary you are asked for:
In order to view the nodes associated with a term or a collection of terms, you should browse to a properly formed Taxonomy URL. For example, %taxo-example. Taxonomy URLs always contain one or more term IDs (tid) at the end of the URL (a.k.a the querystring). You may learn the term ID for a given term by hovering over that term in the %taxo-overview page and noting the number at the end or the URL. To build a Taxonomy URL start with \"taxonomy/page\". Now add the querystring parameter, either or, which chooses nodes tagged with any of the given term IDs, or and, which chooses nodes tagged with all of the given Term IDs. Thus or is less specific than and. Finally add a comma seperated list of term IDs.
"; - $output .= "Every term, or collection of terms, provides an %userland-rss feed to which interested users may subscribe. The URL format for a sample RSS feed is %sample-rss. Built like a Taxonomy URL, %taxo-help it starts with \"node/feed\", then has the querystring parameter, and finally the Term IDs.
"; - $output = t($output, array("%classification-types" => "classification types", "%drupal-dis" => "drupal.org discussion", "%slashdot" => "Slashdot", "%taxo-example" => l("taxonomy/page/or/1,2", "taxonomy/page/or/1,2"), "%taxo-overview" => l(t("taxonomy overview"), "admin/taxonomy"), "%userland-rss" => "RSS", "%sample-rss" => l("node/feed/or/1,2", "node/feed/or/1,2"), "%taxo-help" => l(t("see above"), "admin/taxonomy/help", NULL, NULL, "taxonomy-url") )); + $output .= "In order to view the nodes associated with a term or a collection of terms, you should browse to a properly formed Taxonomy URL. For example, taxonomy/page/or/1,2. Taxonomy URLs always contain one or more term IDs (tid) at the end of the URL (a.k.a the querystring). You may learn the term ID for a given term by hovering over that term in the taxonomy overview page and noting the number at the end or the URL. To build a Taxonomy URL start with \"taxonomy/page\". Now add the querystring parameter, either or, which chooses nodes tagged with any of the given term IDs, or and, which chooses nodes tagged with all of the given Term IDs. Thus or is less specific than and. Finally add a comma seperated list of term IDs.
"; + $output .= "Every term, or collection of terms, provides an RSS feed to which interested users may subscribe. The URL format for a sample RSS feed is node/feed/or/1,2. Built like a Taxonomy URL, see above it starts with \"node/feed\", then has the querystring parameter, and finally the Term IDs.
"; + $output = t($output, array("%classification-types" => "http://www.eleganthack.com/archives/002165.html#002165", "%drupal-dis" => "http://www.drupal.org/node/view/55", "%slashdot" => "http://www.slashdot.com/", "%taxo-example" => url("taxonomy/page/or/1,2"), "%taxo-overview" => url("admin/taxonomy"), "%userland-rss" => "http://backend.userland.com/stories/rss", "%sample-rss" => url("node/feed/or/1,2"), "%taxo-help" => url("admin/taxonomy/help", NULL, "taxonomy-url") )); break; } diff --git a/modules/taxonomy/taxonomy.module b/modules/taxonomy/taxonomy.module index 62bb9b5dbcc..cc6f92ec57f 100644 --- a/modules/taxonomy/taxonomy.module +++ b/modules/taxonomy/taxonomy.module @@ -846,10 +846,10 @@ function taxonomy_help($section = "admin/help#taxonomy") { $output = t("When you create a controlled vocabulary you are creating a set of terms to use for describing content (known as descriptors in indexing lingo). Drupal allows you to describe each node type (blog, story, etc.) using one or many of these terms. For simple implementations, you might create a set of categories without subcategories, similar to Slashdot.org's or Kuro5hin.org's sections. For more complex implementations, you might create a hierarchical list of categories."); break; case 'admin/help#taxonomy': - $output .= "Taxonomy is the study of classification. Drupal's taxonomy module allows you to define categories which are used to classify content. The module supports hierarchical classification and association between terms, allowing for truly flexible information retrieval and classification. For more details about %classification-types and insight into the development of the taxonomy.module, see this %drupal-dis.
"; + $output .= "Taxonomy is the study of classification. Drupal's taxonomy module allows you to define categories which are used to classify content. The module supports hierarchical classification and association between terms, allowing for truly flexible information retrieval and classification. For more details about classification types and insight into the development of the taxonomy.module, see this drupal.org discussion.
"; $output .= "Notes
When you create a controlled vocabulary you are creating a set of terms to use for describing content (known as descriptors in indexing lingo). Drupal allows you to describe each node of content (blog, story, etc.) using one or many of these terms. For simple implementations, you might create a set of categories without subcategories, similar to %slashdot's sections. For more complex implementations, you might create a hierarchical list of categories such as Food taxonomy shown above.
"; + $output .= "When you create a controlled vocabulary you are creating a set of terms to use for describing content (known as descriptors in indexing lingo). Drupal allows you to describe each node of content (blog, story, etc.) using one or many of these terms. For simple implementations, you might create a set of categories without subcategories, similar to Slashdot's sections. For more complex implementations, you might create a hierarchical list of categories such as Food taxonomy shown above.
"; $output .= "When setting up a controlled vocabulary, if you select the hierarchy option, you will be defining a taxonomy or a thesaurus. If you select the related terms option, you are allowing the definition of related terms, think see also, as in a thesaurus. Selecting multiple select will allow you to describe a node using more than one term. That node will then appear in each term's page, thus increasing the chance that a user will find it.
"; $output .= "When setting up a controlled vocabulary you are asked for:
In order to view the nodes associated with a term or a collection of terms, you should browse to a properly formed Taxonomy URL. For example, %taxo-example. Taxonomy URLs always contain one or more term IDs (tid) at the end of the URL (a.k.a the querystring). You may learn the term ID for a given term by hovering over that term in the %taxo-overview page and noting the number at the end or the URL. To build a Taxonomy URL start with \"taxonomy/page\". Now add the querystring parameter, either or, which chooses nodes tagged with any of the given term IDs, or and, which chooses nodes tagged with all of the given Term IDs. Thus or is less specific than and. Finally add a comma seperated list of term IDs.
"; - $output .= "Every term, or collection of terms, provides an %userland-rss feed to which interested users may subscribe. The URL format for a sample RSS feed is %sample-rss. Built like a Taxonomy URL, %taxo-help it starts with \"node/feed\", then has the querystring parameter, and finally the Term IDs.
"; - $output = t($output, array("%classification-types" => "classification types", "%drupal-dis" => "drupal.org discussion", "%slashdot" => "Slashdot", "%taxo-example" => l("taxonomy/page/or/1,2", "taxonomy/page/or/1,2"), "%taxo-overview" => l(t("taxonomy overview"), "admin/taxonomy"), "%userland-rss" => "RSS", "%sample-rss" => l("node/feed/or/1,2", "node/feed/or/1,2"), "%taxo-help" => l(t("see above"), "admin/taxonomy/help", NULL, NULL, "taxonomy-url") )); + $output .= "In order to view the nodes associated with a term or a collection of terms, you should browse to a properly formed Taxonomy URL. For example, taxonomy/page/or/1,2. Taxonomy URLs always contain one or more term IDs (tid) at the end of the URL (a.k.a the querystring). You may learn the term ID for a given term by hovering over that term in the taxonomy overview page and noting the number at the end or the URL. To build a Taxonomy URL start with \"taxonomy/page\". Now add the querystring parameter, either or, which chooses nodes tagged with any of the given term IDs, or and, which chooses nodes tagged with all of the given Term IDs. Thus or is less specific than and. Finally add a comma seperated list of term IDs.
"; + $output .= "Every term, or collection of terms, provides an RSS feed to which interested users may subscribe. The URL format for a sample RSS feed is node/feed/or/1,2. Built like a Taxonomy URL, see above it starts with \"node/feed\", then has the querystring parameter, and finally the Term IDs.
"; + $output = t($output, array("%classification-types" => "http://www.eleganthack.com/archives/002165.html#002165", "%drupal-dis" => "http://www.drupal.org/node/view/55", "%slashdot" => "http://www.slashdot.com/", "%taxo-example" => url("taxonomy/page/or/1,2"), "%taxo-overview" => url("admin/taxonomy"), "%userland-rss" => "http://backend.userland.com/stories/rss", "%sample-rss" => url("node/feed/or/1,2"), "%taxo-help" => url("admin/taxonomy/help", NULL, "taxonomy-url") )); break; } diff --git a/modules/throttle.module b/modules/throttle.module index 772fdcd9f45..05cb91d303b 100644 --- a/modules/throttle.module +++ b/modules/throttle.module @@ -65,21 +65,21 @@ function throttle_help($section = "admin/help#throttle") { $output = t("Allows configuration of congestion control auto-throttle mechanism."); break; case "admin/system/modules/throttle": - return t("If your site gets linked to by a popular website, or otherwise comes under a \"Denial of Service\" (DoS) attack, your webserver might become overwhelmed. This module provides a mechanism for automatically detecting a surge in incoming traffic. This mechanism is utilized by other Drupal models to automatically optimize their performance by temporarily disabling CPU-intensive functionality. To use the auto-throttle, the %access must be enabled. It is advised that you carefully read the explainations below and then properly tune this module based on your site's requirements and your webserver's capabilities.", array("%access" => l(t("access log"), "admin/system/modules/statistics"))); + return t("If your site gets linked to by a popular website, or otherwise comes under a \"Denial of Service\" (DoS) attack, your webserver might become overwhelmed. This module provides a mechanism for automatically detecting a surge in incoming traffic. This mechanism is utilized by other Drupal models to automatically optimize their performance by temporarily disabling CPU-intensive functionality. To use the auto-throttle, the access log must be enabled. It is advised that you carefully read the explainations below and then properly tune this module based on your site's requirements and your webserver's capabilities.", array("%access" => url("admin/system/modules/statistics"))); case "admin/help#throttle": - $output .= "This Drupal module allows you to enable and configure the auto-throttle congestion control mechanism offered by the %statistics-module. The auto-throttle mechanism allows your site to automatically adapt to different server levels.
"; - $output .= "This module also adds a block that displays the current status of the throttle. You must have \"%throttle-block\" privileges to view the block. As a general rule of thumb, only site administrators should be granted access to this block.
"; + $output .= "This Drupal module allows you to enable and configure the auto-throttle congestion control mechanism offered by the statistics module. The auto-throttle mechanism allows your site to automatically adapt to different server levels.
"; + $output .= "This module also adds a block that displays the current status of the throttle. You must have \"access throttle block\" privileges to view the block. As a general rule of thumb, only site administrators should be granted access to this block.
"; $output .= "The auto-throttle mechanism performs an extra database query in order to determine what the current throttle level should be. Fortunately the throttle can be tuned so these database queries only occur on a fraction of all pages generated by your site, reducing the overhead to an insignificant amount. Additionally, when the top-most throttle level is reached, all throttle queries are suspended for a configurable period of time. More detail follows.
"; - $output .= "As with any module, the throttle module needs to be %modules-enable before you can use it. Also refer to the permissions section below if you wish to access the throttle statistics block.
"; - $output .= "The %throttle-config for the throttle allows you to turn it on and off, as well as to fine-tune how sensitive it is.
"; - $output .= "This first option on the throttle module configuration screen allows you to enable or disable the auto-throttling mechanism. Note that the access-log must also be enabled via the %statistics-config for the auto-throttling mechanism to have any effect."; + $output .= "
As with any module, the throttle module needs to be enabled before you can use it. Also refer to the permissions section below if you wish to access the throttle statistics block.
"; + $output .= "The configuration section for the throttle allows you to turn it on and off, as well as to fine-tune how sensitive it is.
"; + $output .= "This first option on the throttle module configuration screen allows you to enable or disable the auto-throttling mechanism. Note that the access-log must also be enabled via the statistics module for the auto-throttling mechanism to have any effect."; $output .= "
"; $output .= "This second option allows you to tune the auto-throttle mechanism. The auto-throttle mechanism supports six throttle levels, from 0 (off) to 5 (maximum). The current throttle level is based upon how many pages have been accessed on your site in the past 60 seconds - the more pages being displayed, the higher the throttle level. This multiplier defines how many hits are required to switch from one throttle level to the next.
"; $output .= "For example, with a throttle multiplier of 20: Once 20 pages have been accessed on your site within a period of 60 seconds, the throttle level will be incremented to a level of 1. Once 40 pages have been accessed on your site within a period of 60 seconds, the throttle level will be incremented to a level of 2. And so on, until 100 pages are accessed on your site within a period of 60 seconds, at which time the throttle level will be set to a maximum level of 5.
"; - $output .= "This option allows you to minimize the performance impact of the auto-throttle. If we refer to the probability limiter as P, then P% of all pages generated by your site will perform an extra database query to verify that the current throttle level is appropriate to the current server load.
"; $output .= "As a rule of thumb, the higher your multiplier, the lower your probability limiter should be. For example, if you have a multiplier of 100, then you logically don't need to check the throttle level more than once out of every 100 page views, so the probability limiter should be set to 1%. As database queries are \"expensive\", it's recommended that you keep the probability limiter to the smallest percentage possible, while still high enough to react quickly to a change in server load.
This block displays some statistics regarding the current throttle and its configuration. It is recommended that only site administrators receive the \"%throttle-access\" permission bit required to view this block. It does not display information that would interest a normal site end-user.
"; - $output .= "Don't forget to enable the block %throttle-block-enable.
"; - $output .= "This module has one permission that needs to be configured in %permissions.
"; + $output .= "This block displays some statistics regarding the current throttle and its configuration. It is recommended that only site administrators receive the \"access throttle block\" permission bit required to view this block. It does not display information that would interest a normal site end-user.
"; + $output .= "Don't forget to enable the block.
"; + $output .= "This module has one permission that needs to be configured in user permissions.
"; $output .= "The function throttle_status() will return a number from 0 to 5. 0 means that there is no throttle enabled at this time. Each number above that is a progressively more throttled system... To disable a feature when a site first begins to get busy, disable it at a throttle of 2 or 3. To hold on to the bitter end, wait until 4 or 5.
To implement the throttle, you should do something like this:"; @@ -90,7 +90,7 @@ function throttle_help($section = "admin/help#throttle") { else { // throttle limit not reached, execute normally }
"; - $output = t($output, array("%statistics-module" => l(t("statistics module"), "admin/statistics"), "%throttle-block" => l(t("access throttle block"), "admin/user/permission"), "%modules-enable" => l(t("enabled"), "admin/system/modules"), "%throttle-config" => l(t("configuration section"), "admin/system/modules/throttle"), "%statistics-config" => l(t("statistics module"), "admin/system/modules/statistics"), "%throttle-access" => l(t("access throttle block"), "admin/user/permission"), "%throttle-block-enable" => l(t("here"), "admin/block"), "%permissions" => l(t("user permissions"), "admin/user/permission"))); + $output = t($output, array("%statistics-module" => url("admin/statistics"), "%throttle-block" => url("admin/user/permission"), "%modules-enable" => url("admin/system/modules"), "%throttle-config" => url("admin/system/modules/throttle"), "%statistics-config" => url("admin/system/modules/statistics"), "%throttle-access" => url("admin/user/permission"), "%throttle-block-enable" => url("admin/block"), "%permissions" => url("admin/user/permission"))); break; } @@ -101,7 +101,7 @@ function throttle_help($section = "admin/help#throttle") { // throttle module configuration options function throttle_settings() { // enable/disable auto-throttle - $group = form_radios(t("Enable auto-throttle"), "throttle_enable", variable_get("throttle_enable", 0), array("1" => t("enabled"), "0" => t("disabled")), t("Enable auto-throttling congestion control mechanism. Allows your site to adapt under extreme user loads, such as being linked by Slashdot. To use the auto-throttle you must also enable the '%access_log' from the statistics module.", array("%access_log" => l(t("access log"), "admin/system/modules/statistics")))); + $group = form_radios(t("Enable auto-throttle"), "throttle_enable", variable_get("throttle_enable", 0), array("1" => t("enabled"), "0" => t("disabled")), t("Enable auto-throttling congestion control mechanism. Allows your site to adapt under extreme user loads, such as being linked by Slashdot. To use the auto-throttle you must also enable the 'access log' from the statistics module.", array("%access_log" => url("admin/system/modules/statistics")))); $output = form_group(t("Auto-throttle status"), $group); // tune auto-throttle @@ -142,7 +142,7 @@ function throttle_display_throttle_block() { } } else { - $output .= t("Throttle: %status", array("%status" => l(t("disabled"), "admin/system/modules/throttle"))) ."This Drupal module allows you to enable and configure the auto-throttle congestion control mechanism offered by the %statistics-module. The auto-throttle mechanism allows your site to automatically adapt to different server levels.
"; - $output .= "This module also adds a block that displays the current status of the throttle. You must have \"%throttle-block\" privileges to view the block. As a general rule of thumb, only site administrators should be granted access to this block.
"; + $output .= "This Drupal module allows you to enable and configure the auto-throttle congestion control mechanism offered by the statistics module. The auto-throttle mechanism allows your site to automatically adapt to different server levels.
"; + $output .= "This module also adds a block that displays the current status of the throttle. You must have \"access throttle block\" privileges to view the block. As a general rule of thumb, only site administrators should be granted access to this block.
"; $output .= "The auto-throttle mechanism performs an extra database query in order to determine what the current throttle level should be. Fortunately the throttle can be tuned so these database queries only occur on a fraction of all pages generated by your site, reducing the overhead to an insignificant amount. Additionally, when the top-most throttle level is reached, all throttle queries are suspended for a configurable period of time. More detail follows.
"; - $output .= "As with any module, the throttle module needs to be %modules-enable before you can use it. Also refer to the permissions section below if you wish to access the throttle statistics block.
"; - $output .= "The %throttle-config for the throttle allows you to turn it on and off, as well as to fine-tune how sensitive it is.
"; - $output .= "This first option on the throttle module configuration screen allows you to enable or disable the auto-throttling mechanism. Note that the access-log must also be enabled via the %statistics-config for the auto-throttling mechanism to have any effect."; + $output .= "
As with any module, the throttle module needs to be enabled before you can use it. Also refer to the permissions section below if you wish to access the throttle statistics block.
"; + $output .= "The configuration section for the throttle allows you to turn it on and off, as well as to fine-tune how sensitive it is.
"; + $output .= "This first option on the throttle module configuration screen allows you to enable or disable the auto-throttling mechanism. Note that the access-log must also be enabled via the statistics module for the auto-throttling mechanism to have any effect."; $output .= "
"; $output .= "This second option allows you to tune the auto-throttle mechanism. The auto-throttle mechanism supports six throttle levels, from 0 (off) to 5 (maximum). The current throttle level is based upon how many pages have been accessed on your site in the past 60 seconds - the more pages being displayed, the higher the throttle level. This multiplier defines how many hits are required to switch from one throttle level to the next.
"; $output .= "For example, with a throttle multiplier of 20: Once 20 pages have been accessed on your site within a period of 60 seconds, the throttle level will be incremented to a level of 1. Once 40 pages have been accessed on your site within a period of 60 seconds, the throttle level will be incremented to a level of 2. And so on, until 100 pages are accessed on your site within a period of 60 seconds, at which time the throttle level will be set to a maximum level of 5.
"; - $output .= "This option allows you to minimize the performance impact of the auto-throttle. If we refer to the probability limiter as P, then P% of all pages generated by your site will perform an extra database query to verify that the current throttle level is appropriate to the current server load.
"; $output .= "As a rule of thumb, the higher your multiplier, the lower your probability limiter should be. For example, if you have a multiplier of 100, then you logically don't need to check the throttle level more than once out of every 100 page views, so the probability limiter should be set to 1%. As database queries are \"expensive\", it's recommended that you keep the probability limiter to the smallest percentage possible, while still high enough to react quickly to a change in server load.
This block displays some statistics regarding the current throttle and its configuration. It is recommended that only site administrators receive the \"%throttle-access\" permission bit required to view this block. It does not display information that would interest a normal site end-user.
"; - $output .= "Don't forget to enable the block %throttle-block-enable.
"; - $output .= "This module has one permission that needs to be configured in %permissions.
"; + $output .= "This block displays some statistics regarding the current throttle and its configuration. It is recommended that only site administrators receive the \"access throttle block\" permission bit required to view this block. It does not display information that would interest a normal site end-user.
"; + $output .= "Don't forget to enable the block.
"; + $output .= "This module has one permission that needs to be configured in user permissions.
"; $output .= "The function throttle_status() will return a number from 0 to 5. 0 means that there is no throttle enabled at this time. Each number above that is a progressively more throttled system... To disable a feature when a site first begins to get busy, disable it at a throttle of 2 or 3. To hold on to the bitter end, wait until 4 or 5.
To implement the throttle, you should do something like this:"; @@ -90,7 +90,7 @@ function throttle_help($section = "admin/help#throttle") { else { // throttle limit not reached, execute normally }
"; - $output = t($output, array("%statistics-module" => l(t("statistics module"), "admin/statistics"), "%throttle-block" => l(t("access throttle block"), "admin/user/permission"), "%modules-enable" => l(t("enabled"), "admin/system/modules"), "%throttle-config" => l(t("configuration section"), "admin/system/modules/throttle"), "%statistics-config" => l(t("statistics module"), "admin/system/modules/statistics"), "%throttle-access" => l(t("access throttle block"), "admin/user/permission"), "%throttle-block-enable" => l(t("here"), "admin/block"), "%permissions" => l(t("user permissions"), "admin/user/permission"))); + $output = t($output, array("%statistics-module" => url("admin/statistics"), "%throttle-block" => url("admin/user/permission"), "%modules-enable" => url("admin/system/modules"), "%throttle-config" => url("admin/system/modules/throttle"), "%statistics-config" => url("admin/system/modules/statistics"), "%throttle-access" => url("admin/user/permission"), "%throttle-block-enable" => url("admin/block"), "%permissions" => url("admin/user/permission"))); break; } @@ -101,7 +101,7 @@ function throttle_help($section = "admin/help#throttle") { // throttle module configuration options function throttle_settings() { // enable/disable auto-throttle - $group = form_radios(t("Enable auto-throttle"), "throttle_enable", variable_get("throttle_enable", 0), array("1" => t("enabled"), "0" => t("disabled")), t("Enable auto-throttling congestion control mechanism. Allows your site to adapt under extreme user loads, such as being linked by Slashdot. To use the auto-throttle you must also enable the '%access_log' from the statistics module.", array("%access_log" => l(t("access log"), "admin/system/modules/statistics")))); + $group = form_radios(t("Enable auto-throttle"), "throttle_enable", variable_get("throttle_enable", 0), array("1" => t("enabled"), "0" => t("disabled")), t("Enable auto-throttling congestion control mechanism. Allows your site to adapt under extreme user loads, such as being linked by Slashdot. To use the auto-throttle you must also enable the 'access log' from the statistics module.", array("%access_log" => url("admin/system/modules/statistics")))); $output = form_group(t("Auto-throttle status"), $group); // tune auto-throttle @@ -142,7 +142,7 @@ function throttle_display_throttle_block() { } } else { - $output .= t("Throttle: %status", array("%status" => l(t("disabled"), "admin/system/modules/throttle"))) ."One of the more tedious moments in visiting a new website is filling out the registration form. Here at %site, you do not have to fill out a registration form if you are already a member of %help-links. This capability is called Distributed Authentication, and is unique to %drupal, the software which powers %site.
"; - $output .= "Distributed authentication enables a new user to input a username and password into the login box, and immediately be recognized, even if that user never registered at %site. This works because Drupal knows how to communicate with external registration databases. For example, lets say that new user 'Joe' is already a registered member of %delphi-forums. Drupal informs Joe on registration and login screens that he may login with his Delphi ID instead of registering with %site. Joe likes that idea, and logs in with a username of joe@remote.delphiforums.com and his usual Delphi password. Drupal then contacts the remote.delphiforums.com server behind the scenes (usually using %xml, %http-post, or %soap) and asks: \"Is the password for user Joe correct?\". If Delphi replies yes, then we create a new %site account for Joe and log him into it. Joe may keep on logging into %site in the same manner, and he will always be logged into the same account.
"; + $output .= "One of the more tedious moments in visiting a new website is filling out the registration form. Here at %site, you do not have to fill out a registration form if you are already a member of %help-links. This capability is called distributed authentication, and is unique to Drupal, the software which powers %site.
"; + $output .= "Distributed authentication enables a new user to input a username and password into the login box, and immediately be recognized, even if that user never registered at %site. This works because Drupal knows how to communicate with external registration databases. For example, lets say that new user 'Joe' is already a registered member of Delphi Forums. Drupal informs Joe on registration and login screens that he may login with his Delphi ID instead of registering with %site. Joe likes that idea, and logs in with a username of joe@remote.delphiforums.com and his usual Delphi password. Drupal then contacts the remote.delphiforums.com server behind the scenes (usually using XML-RPC, HTTP POST, or SOAP) and asks: \"Is the password for user Joe correct?\". If Delphi replies yes, then we create a new %site account for Joe and log him into it. Joe may keep on logging into %site in the same manner, and he will always be logged into the same account.
"; - $output = t($output, array("%help-links" => (implode(", ", user_auth_help_links())), "%site" => "$site", "%drupal" => "Drupal", "%delphi-forums" => "Delphi Forums", "%xml" => "XML-RPC", "%http-post" => "HTTP POST", "%soap" => "SOAP")); + $output = t($output, array("%help-links" => (implode(", ", user_auth_help_links())), "%site" => "$site", "%drupal" => "http://www.drupal.org", "%delphi-forums" => "http://www.delphiforums.com", "%xml" => "http://www.xmlrpc.com", "%http-post" => "http://www.w3.org/Protocols/", "%soap" => "http://www.soapware.org")); foreach (module_list() as $module) { if (module_hook($module, "auth")) { @@ -1687,8 +1687,8 @@ function user_help($section = "admin/help#user") { }"; $output .= "The _auth function is the heart of any authentication module. This function is called whenever a user is attempting to login using your authentication module. For successful authentications, this function returns TRUE. Otherwise, it returns FALSE. This function always accepts 3 parameters, as shown above. These parameters are passed by the user system (user module). The user system parses the username as typed by the user into 2 substrings - \$name and \$server. The parsing rules are:
"; $output .= "| _auth function parameters | |
|---|---|
| \$name | The substring before the final '@' character in the username field |
| \$pass | The whole string submitted by the user in the password field |
| \$server | The substring after the final '@' symbol in the username field |
So now lets use that \$name, \$pass, and \$server which was passed to our _auth function. Blogger authenticates users via %xml. Your module may authenticate using a different technique. Drupal doesn't reallly care how your module communicates with its registration source. It just trusts the module.
"; - $output .= "The lines above illustrate a typical %xml method call. Here we build up a message and send it to Blogger, storing the response in a variable called \$response. The message we pass conforms to the published %blogger-api. Your module will no doubt implement a different API. One peculiarity of this module is that we don't actually use the \$server parameter. Blogger only accepts authentication at plant.blogger.com, so we hard-code that value into the xmlrpc_client() function. A more typical example might be the jabber module, which uses the \$server parameter to determine where to send the authentication request. Also of note is the '5'th parameter in the \$client->send\(\) call. This is a timeout value in seconds. All authentication modules should implement a timeout on their external calls. This makes sure to return control to the user module if your registration database has become inoperable or unreachable.
"; + $output .= "So now lets use that \$name, \$pass, and \$server which was passed to our _auth function. Blogger authenticates users via XML-RPC. Your module may authenticate using a different technique. Drupal doesn't reallly care how your module communicates with its registration source. It just trusts the module.
"; + $output .= "The lines above illustrate a typical XML-RPC method call. Here we build up a message and send it to Blogger, storing the response in a variable called \$response. The message we pass conforms to the published Blogger XML-RPC Application Programmers Interface (API). Your module will no doubt implement a different API. One peculiarity of this module is that we don't actually use the \$server parameter. Blogger only accepts authentication at plant.blogger.com, so we hard-code that value into the xmlrpc_client() function. A more typical example might be the jabber module, which uses the \$server parameter to determine where to send the authentication request. Also of note is the '5'th parameter in the \$client->send() call. This is a timeout value in seconds. All authentication modules should implement a timeout on their external calls. This makes sure to return control to the user module if your registration database has become inoperable or unreachable.
"; $output .= "
if (\$result && !stristr(\$result->serialize(), "fault")) {
// watchdog(\"user\", \"Success Blogger Auth. Response: \" . \$result->serialize());
@@ -1717,19 +1717,23 @@ function user_help($section = "admin/help#user") {
switch (\$section) {
case 'user/help':
\$site = variable_get("site_name", "this web site");
- \$output .= "<p>You may login to %site using a <b>Blogger ID</b> and password. A Blogger ID consists of your Blogger username followed by <i>@blogger.com</i>. So a valid blogger ID is <i>mwlily</i>@<b>blogger.com</b>. If you are a Blogger member, go ahead and login now.</p>";
- \$output .= "<p>Blogger offers you instant communication power by letting you post your thoughts to the web whenever the urge strikes. Blogger will publish to your current web site or help you create one. <a href=\"http://www.blogger.com/about.pyra\">Learn more about it</a>.";
+ \$output .= "<p>You may login to %site using a <b>Blogger ID</b> and password. ";
+ \$output .= "A Blogger ID consists of your Blogger username followed by <i>@blogger.com</i>. ";
+ \$output .= "So a valid blogger ID is <i>mwlily</i>@<b>blogger.com</b>. If you are a Blogger member, go ahead and login now.</p>";
+ \$output .= "<p>Blogger offers you instant communication power by letting you post your thoughts to the web whenever the urge strikes. ";
+ \$output .= "Blogger will publish to your current web site or help you create one. ";
+ \$output .= "<a href=\"http://www.blogger.com/about.pyra\">Learn more about it</a>.";
\$output = t(\$output, array(\"%site\" => \"<i>\$site</i>\"));
}
return output;
}";
$output .= "The _help function is prominently linked within Drupal, so you'll want to write the best possible user help here. You'll want to tell users what a proper username looks like and you may also want to advertise a bit about your service at the end. Note that your help text is passed through a t() function in the last line. This is Drupal's localization function. Translators may localize your help text just like any other text in Drupal.
"; - $output .= "Once you've written and tested your authentication module, you'll usually want to share it with the world. The best way to do this is to add the module to the %contrib-cvs. You'll need to request priveleges to this repository - see %cvs for the details. Then you should announce your contribution on the %drupal-lists. You might also want to post a story on %drupal-org.
"; + $output .= "Once you've written and tested your authentication module, you'll usually want to share it with the world. The best way to do this is to add the module to the Drupal contributions CVS repository. You'll need to request priveleges to this repository - see the CVS README file for the details. Then you should announce your contribution on the drupal-devel and drupal-support mailing lists. You might also want to post a story on Drupal.org.
"; // end of user_help_devel_da // start of user_help_devel_userhook - $output .= "The _user() hook provides a mechanism for inserting text and form fields into the %registration, %user-acct, and %user-admin pages. This is useful if you want to add a custom field for your particular community. This is best illustrated by the %profile-module. The profile module is meant to be customized for your needs. Please download it and hack away until it does what you need.
"; + $output .= "The _user() hook provides a mechanism for inserting text and form fields into the registration, user account view/edit, and administer » accounts pages. This is useful if you want to add a custom field for your particular community. This is best illustrated by the profile module. The profile module is meant to be customized for your needs. Please download it and hack away until it does what you need.
"; $output .= "Consider this simpler example from a fictional recipe community web site called Julia's Kitchen. Julia customizes her Drupal powered site by creating a new file called julia.module. That file does the following:
One of the more tedious moments in visiting a new website is filling out the registration form. Here at %site, you do not have to fill out a registration form if you are already a member of %help-links. This capability is called Distributed Authentication, and is unique to %drupal, the software which powers %site.
"; - $output .= "Distributed authentication enables a new user to input a username and password into the login box, and immediately be recognized, even if that user never registered at %site. This works because Drupal knows how to communicate with external registration databases. For example, lets say that new user 'Joe' is already a registered member of %delphi-forums. Drupal informs Joe on registration and login screens that he may login with his Delphi ID instead of registering with %site. Joe likes that idea, and logs in with a username of joe@remote.delphiforums.com and his usual Delphi password. Drupal then contacts the remote.delphiforums.com server behind the scenes (usually using %xml, %http-post, or %soap) and asks: \"Is the password for user Joe correct?\". If Delphi replies yes, then we create a new %site account for Joe and log him into it. Joe may keep on logging into %site in the same manner, and he will always be logged into the same account.
"; + $output .= "One of the more tedious moments in visiting a new website is filling out the registration form. Here at %site, you do not have to fill out a registration form if you are already a member of %help-links. This capability is called distributed authentication, and is unique to Drupal, the software which powers %site.
"; + $output .= "Distributed authentication enables a new user to input a username and password into the login box, and immediately be recognized, even if that user never registered at %site. This works because Drupal knows how to communicate with external registration databases. For example, lets say that new user 'Joe' is already a registered member of Delphi Forums. Drupal informs Joe on registration and login screens that he may login with his Delphi ID instead of registering with %site. Joe likes that idea, and logs in with a username of joe@remote.delphiforums.com and his usual Delphi password. Drupal then contacts the remote.delphiforums.com server behind the scenes (usually using XML-RPC, HTTP POST, or SOAP) and asks: \"Is the password for user Joe correct?\". If Delphi replies yes, then we create a new %site account for Joe and log him into it. Joe may keep on logging into %site in the same manner, and he will always be logged into the same account.
"; - $output = t($output, array("%help-links" => (implode(", ", user_auth_help_links())), "%site" => "$site", "%drupal" => "Drupal", "%delphi-forums" => "Delphi Forums", "%xml" => "XML-RPC", "%http-post" => "HTTP POST", "%soap" => "SOAP")); + $output = t($output, array("%help-links" => (implode(", ", user_auth_help_links())), "%site" => "$site", "%drupal" => "http://www.drupal.org", "%delphi-forums" => "http://www.delphiforums.com", "%xml" => "http://www.xmlrpc.com", "%http-post" => "http://www.w3.org/Protocols/", "%soap" => "http://www.soapware.org")); foreach (module_list() as $module) { if (module_hook($module, "auth")) { @@ -1687,8 +1687,8 @@ function user_help($section = "admin/help#user") { }"; $output .= "The _auth function is the heart of any authentication module. This function is called whenever a user is attempting to login using your authentication module. For successful authentications, this function returns TRUE. Otherwise, it returns FALSE. This function always accepts 3 parameters, as shown above. These parameters are passed by the user system (user module). The user system parses the username as typed by the user into 2 substrings - \$name and \$server. The parsing rules are:
"; $output .= "| _auth function parameters | |
|---|---|
| \$name | The substring before the final '@' character in the username field |
| \$pass | The whole string submitted by the user in the password field |
| \$server | The substring after the final '@' symbol in the username field |
So now lets use that \$name, \$pass, and \$server which was passed to our _auth function. Blogger authenticates users via %xml. Your module may authenticate using a different technique. Drupal doesn't reallly care how your module communicates with its registration source. It just trusts the module.
"; - $output .= "The lines above illustrate a typical %xml method call. Here we build up a message and send it to Blogger, storing the response in a variable called \$response. The message we pass conforms to the published %blogger-api. Your module will no doubt implement a different API. One peculiarity of this module is that we don't actually use the \$server parameter. Blogger only accepts authentication at plant.blogger.com, so we hard-code that value into the xmlrpc_client() function. A more typical example might be the jabber module, which uses the \$server parameter to determine where to send the authentication request. Also of note is the '5'th parameter in the \$client->send\(\) call. This is a timeout value in seconds. All authentication modules should implement a timeout on their external calls. This makes sure to return control to the user module if your registration database has become inoperable or unreachable.
"; + $output .= "So now lets use that \$name, \$pass, and \$server which was passed to our _auth function. Blogger authenticates users via XML-RPC. Your module may authenticate using a different technique. Drupal doesn't reallly care how your module communicates with its registration source. It just trusts the module.
"; + $output .= "The lines above illustrate a typical XML-RPC method call. Here we build up a message and send it to Blogger, storing the response in a variable called \$response. The message we pass conforms to the published Blogger XML-RPC Application Programmers Interface (API). Your module will no doubt implement a different API. One peculiarity of this module is that we don't actually use the \$server parameter. Blogger only accepts authentication at plant.blogger.com, so we hard-code that value into the xmlrpc_client() function. A more typical example might be the jabber module, which uses the \$server parameter to determine where to send the authentication request. Also of note is the '5'th parameter in the \$client->send() call. This is a timeout value in seconds. All authentication modules should implement a timeout on their external calls. This makes sure to return control to the user module if your registration database has become inoperable or unreachable.
"; $output .= "
if (\$result && !stristr(\$result->serialize(), "fault")) {
// watchdog(\"user\", \"Success Blogger Auth. Response: \" . \$result->serialize());
@@ -1717,19 +1717,23 @@ function user_help($section = "admin/help#user") {
switch (\$section) {
case 'user/help':
\$site = variable_get("site_name", "this web site");
- \$output .= "<p>You may login to %site using a <b>Blogger ID</b> and password. A Blogger ID consists of your Blogger username followed by <i>@blogger.com</i>. So a valid blogger ID is <i>mwlily</i>@<b>blogger.com</b>. If you are a Blogger member, go ahead and login now.</p>";
- \$output .= "<p>Blogger offers you instant communication power by letting you post your thoughts to the web whenever the urge strikes. Blogger will publish to your current web site or help you create one. <a href=\"http://www.blogger.com/about.pyra\">Learn more about it</a>.";
+ \$output .= "<p>You may login to %site using a <b>Blogger ID</b> and password. ";
+ \$output .= "A Blogger ID consists of your Blogger username followed by <i>@blogger.com</i>. ";
+ \$output .= "So a valid blogger ID is <i>mwlily</i>@<b>blogger.com</b>. If you are a Blogger member, go ahead and login now.</p>";
+ \$output .= "<p>Blogger offers you instant communication power by letting you post your thoughts to the web whenever the urge strikes. ";
+ \$output .= "Blogger will publish to your current web site or help you create one. ";
+ \$output .= "<a href=\"http://www.blogger.com/about.pyra\">Learn more about it</a>.";
\$output = t(\$output, array(\"%site\" => \"<i>\$site</i>\"));
}
return output;
}";
$output .= "The _help function is prominently linked within Drupal, so you'll want to write the best possible user help here. You'll want to tell users what a proper username looks like and you may also want to advertise a bit about your service at the end. Note that your help text is passed through a t() function in the last line. This is Drupal's localization function. Translators may localize your help text just like any other text in Drupal.
"; - $output .= "Once you've written and tested your authentication module, you'll usually want to share it with the world. The best way to do this is to add the module to the %contrib-cvs. You'll need to request priveleges to this repository - see %cvs for the details. Then you should announce your contribution on the %drupal-lists. You might also want to post a story on %drupal-org.
"; + $output .= "Once you've written and tested your authentication module, you'll usually want to share it with the world. The best way to do this is to add the module to the Drupal contributions CVS repository. You'll need to request priveleges to this repository - see the CVS README file for the details. Then you should announce your contribution on the drupal-devel and drupal-support mailing lists. You might also want to post a story on Drupal.org.
"; // end of user_help_devel_da // start of user_help_devel_userhook - $output .= "The _user() hook provides a mechanism for inserting text and form fields into the %registration, %user-acct, and %user-admin pages. This is useful if you want to add a custom field for your particular community. This is best illustrated by the %profile-module. The profile module is meant to be customized for your needs. Please download it and hack away until it does what you need.
"; + $output .= "The _user() hook provides a mechanism for inserting text and form fields into the registration, user account view/edit, and administer » accounts pages. This is useful if you want to add a custom field for your particular community. This is best illustrated by the profile module. The profile module is meant to be customized for your needs. Please download it and hack away until it does what you need.
"; $output .= "Consider this simpler example from a fictional recipe community web site called Julia's Kitchen. Julia customizes her Drupal powered site by creating a new file called julia.module. That file does the following:
Watchdog module monitors your web site, capturing system events in a log to be reviewed by an authorized individual at a later time. The watchdog log is simply a list of recorded events containing usage data, performance data, errors, warnings and operational information. It is vital to %watchdog on a regular basis as it is often the only way to tell what is going on.
"; - $output .= "To ease administration, the watchdog will automatically discard old log entries, %log-entry. Needs \"cron.php\" to discard the entries.
"; - $output = t($output, array("%watchdog" => l(t("check the watchdog report"), "admin/watchdog"), "%log-entry" => l(t("as configured"), "admin/system/modules/watchdog"))); + $output .= "Watchdog module monitors your web site, capturing system events in a log to be reviewed by an authorized individual at a later time. The watchdog log is simply a list of recorded events containing usage data, performance data, errors, warnings and operational information. It is vital to check the watchdog report on a regular basis as it is often the only way to tell what is going on.
"; + $output .= "To ease administration, the watchdog will automatically discard old log entries, as configured. Needs \"cron.php\" to discard the entries.
"; + $output = t($output, array("%watchdog" => url("admin/watchdog"), "%log-entry" => url("admin/system/modules/watchdog"))); break; case 'admin/watchdog': $output = t("The watchdog module monitors your web site, captures system events in a log and records them to be reviewed by an authorized individual at a later time. The watchdog log is simply a list of events recorded during operation and contains usage data, performance data, errors, warnings and operational information. It is vital to check the watchdog report on a regular basis as it is often the only way to tell what is going on."); @@ -38,7 +38,7 @@ function watchdog_help($section = "admin/help#watchdog") { $output = t("Logs and records system events."); break; case 'admin/system/modules/watchdog': - $output = t("Watchdog logs your system events. To see these logs go to %watchdog. Since these logs can grow out of control if kept around forever, below set how long an item should be kept in the log. Note that to discard entries as set below you must run \"cron.php\" regularly.", array("%watchdog" => l(t("messages"), "admin/watchdog"))); + $output = t("Watchdog logs your system events. To see these logs go to messages. Since these logs can grow out of control if kept around forever, below set how long an item should be kept in the log. Note that to discard entries as set below you must run \"cron.php\" regularly.", array("%watchdog" => url("admin/watchdog"))); break; } diff --git a/modules/watchdog/watchdog.module b/modules/watchdog/watchdog.module index f1f27a84959..ab51af98411 100644 --- a/modules/watchdog/watchdog.module +++ b/modules/watchdog/watchdog.module @@ -6,9 +6,9 @@ function watchdog_help($section = "admin/help#watchdog") { switch ($section) { case 'admin/help#watchdog': - $output .= "Watchdog module monitors your web site, capturing system events in a log to be reviewed by an authorized individual at a later time. The watchdog log is simply a list of recorded events containing usage data, performance data, errors, warnings and operational information. It is vital to %watchdog on a regular basis as it is often the only way to tell what is going on.
"; - $output .= "To ease administration, the watchdog will automatically discard old log entries, %log-entry. Needs \"cron.php\" to discard the entries.
"; - $output = t($output, array("%watchdog" => l(t("check the watchdog report"), "admin/watchdog"), "%log-entry" => l(t("as configured"), "admin/system/modules/watchdog"))); + $output .= "Watchdog module monitors your web site, capturing system events in a log to be reviewed by an authorized individual at a later time. The watchdog log is simply a list of recorded events containing usage data, performance data, errors, warnings and operational information. It is vital to check the watchdog report on a regular basis as it is often the only way to tell what is going on.
"; + $output .= "To ease administration, the watchdog will automatically discard old log entries, as configured. Needs \"cron.php\" to discard the entries.
"; + $output = t($output, array("%watchdog" => url("admin/watchdog"), "%log-entry" => url("admin/system/modules/watchdog"))); break; case 'admin/watchdog': $output = t("The watchdog module monitors your web site, captures system events in a log and records them to be reviewed by an authorized individual at a later time. The watchdog log is simply a list of events recorded during operation and contains usage data, performance data, errors, warnings and operational information. It is vital to check the watchdog report on a regular basis as it is often the only way to tell what is going on."); @@ -38,7 +38,7 @@ function watchdog_help($section = "admin/help#watchdog") { $output = t("Logs and records system events."); break; case 'admin/system/modules/watchdog': - $output = t("Watchdog logs your system events. To see these logs go to %watchdog. Since these logs can grow out of control if kept around forever, below set how long an item should be kept in the log. Note that to discard entries as set below you must run \"cron.php\" regularly.", array("%watchdog" => l(t("messages"), "admin/watchdog"))); + $output = t("Watchdog logs your system events. To see these logs go to messages. Since these logs can grow out of control if kept around forever, below set how long an item should be kept in the log. Note that to discard entries as set below you must run \"cron.php\" regularly.", array("%watchdog" => url("admin/watchdog"))); break; }