README

最新版本: 1.8.5
发布日期: 2013-06-01
联系方式: iionly@gmx.de
许可: GNU通用公共许可证版本2
版权: (c) iionly（Elgg 1.8版本），Billy Gunn

此插件将为您的网站上的某些视图添加评分小部件，例如博客、页面、书签、文件和群组讨论。默认情况下，评分小部件将显示5颗星，但您可以配置显示的星星数量。您还可以配置是否允许成员更改他们的投票。

安装

1. （如果您已安装Elggx Fivestar插件的先前版本）请在您的网站管理员部分禁用该插件，然后从Elgg安装的mod目录中删除elggx_fivestar文件夹，)
2. 将elggx_fivestar文件夹复制到您的Elgg安装的mod目录中，
3. 在您的网站管理员部分启用该插件，
4. 然后配置插件设置（部分“管理”-“工具”-“Elggx Fivestar”）。至少需要将评分小部件添加到一些视图，以便Elggx Fivestar插件可使用。通过插件设置，您可以添加评分小部件到一些预定义的默认视图。以下将详细描述如何配置更多视图的评分小部件。

如何自定义

在首次启用Elggx Fivestar插件后（或从Elggx Fivestar < 1.8.0版本升级后）您需要在网站管理员部分的Elggx Fivestar插件设置页面上设置默认视图（“管理”-“工具”-“Elggx Fivestar”）。点击“设置/重置默认视图”并保存设置。在start.php中已定义一些默认视图，其中评分小部件将包含在您的网站上，例如博客、页面和群组讨论。

您还可以配置评分小部件应出现的位置。您可以选择定义额外的视图以在其他页面上包含小部件，或从某些页面上删除评分小部件。如果您对任何默认视图不满意并希望删除它，您可以在插件设置页面上通过删除相应的视图来实现。或者，您也可以调整Elggx Fivestar的start.php中定义的默认视图（从第260行开始的函数elggx_fivestar_defaults()）然后重置设置页面的视图。

如果您想添加评分小部件到一个视图，您也可以通过在设置页面上直接添加视图或再次通过调整start.php中的默认视图来实现。您需要了解您想添加评分小部件的视图的php/html代码，以便能够定义正确的位置。已定义的默认视图应能给您一个如何工作的概念。

如果您想通过设置页面添加一个新的视图，要包含的代码必须以

elggx_fivestar_view=

开始，后跟用于标识视图的参数。

将评分小部件添加到视图中的方法，用于定义默认视图或通过设置页面/ start.php 定义的任何其他视图，需要使用独立的 HTML 或 CSS 标签来定义评分小部件在相应页面上的位置，即在标签之前或之后。有时，这种方法可能不适合定义评分小部件所需的精确位置。还有第二种方法可以将评分小部件添加到视图中，允许精确定位。您需要修改视图的代码才能使此方法生效。

只需将以下代码添加到您的插件代码中适当的位置，并根据需要进行参数调整

echo elgg_view("elggx_fivestar/voting", array(
    'entity' => $entity,
    'min' => true,
    'subclass' => 'fivestar_subclass',
    'outerId' => 'fivestar_rating_list',
    'ratingTextClass' => 'fivestar_rating_text'
));

上述代码片段包含配置投票小部件的所有可能选项。这些是

• 'entity' => $entity
  这定义了要投票的实体。在调用投票小部件之前，必须在代码中将变量 $entity 分配给正确的 Elgg 实体。
• 'min' => true
  如果设置为 true，则投票小部件将仅显示用于投票的星星，而不会显示此实体的当前投票统计信息（投票数和平均投票）。
• 'subclass' => 'fivestar_subclass', 'outerId' => 'fivestar_rating_list', 'ratingTextClass' => 'fivestar_rating_text'
  这些选项允许您通过 CSS 设置配置投票小部件的布局，例如在 Elggx Fivestar 的 css 文件（在 elggx_fivestar/views/default/css/basic.php）中定义的。这些字符串是 CSS 类的标识符，您必须在使用之前定义这些类。

在插件代码中包含投票小部件的最简单方法是通过只提供要投票的实体作为参数

echo elgg_view("elggx_fivestar/voting", array('entity' => $entity));

在这种情况下，将使用投票小部件的默认 CSS 布局。仍然，在任何情况下，您都必须将正确的实体分配给变量 $entity。