跳转到主要内容

Plone的一个简单的帮助台风格文档产品。

项目描述

如果您正在升级现有的PHC安装,您必须阅读INSTALL.txt。

概述

Plone帮助中心是一个旨在辅助Plone文档的应用程序,它被用于plone.org来分类和保持文档更新。它应该可以用于其他开源产品(如Plone产品插件)或甚至用于其他文档项目。

用法

Plone帮助中心具有内联文档,只需添加一个帮助中心。

3.0版本的新功能

PHC先前版本的底层架构基本上是Plone 2.0。它建立在Archetypes之上,没有ATContentTypes。诸如下一页/上一页导航和自动目录等功能都是内置的。在许多方面,PHC是新Plone功能的测试中心。

然而,Plone进步了,而PHC没有。

PHC 3的目标要小得多。而不是试图向Plone添加新功能,这个版本试图通过重新实现PHC内容类型的大多数作为自动实现Plone 3行为的ATCT派生类来继承Plone 3功能。通过子类化或接口/适配器添加PHC特定功能。

要求

PloneHelpCenter需要

  • Plone 3.0或更高版本

安装

有关更详细的产品安装说明,请参阅安装附加产品教程。

升级

如果您正在将先前3.0版本的帮助中心升级到Plone站点,您必须运行升级配置文件。

逐步按以下顺序执行

不要一步从Plone 3.x上的PHC 1.6.x升级到Plone 4.x上的PHC 4.x。

首先更新到Plone 3.3.5+

Products.PloneHelpCenter = 1.6.2
Products.AddRemoveWidget = 1.4.2

检查是否存在示例内容!然后更新buildout

Products.PloneHelpCenter = 3.0b3

运行

bin/buildout -v

* restart instance and

* deinstall Products.PloneHelpCenter 3.0b3

* install Products.PloneHelpCenter 3.0b3

* in the ZMI go to:  Generic Setup Tool at  /acsr/portal_setup  Tab "Upgrades"

* after selecting: "Products.PloneHelpCenter:default" and clicking "Choose Profile" you get first::

    Upgrades

    The profile "Products.PloneHelpCenter:default" is currently upgraded to version 3.0b3.

    The filesystem version for the "Products.PloneHelpCenter:default" profile is currently 3.0b3.

    No upgrade available.

* Now click at -> Show old upgrades: "show" an see::

    Available upgrades:
    Upgrade Step Group
    ->              Upgrading the types
    (0.0 → 3.0)

* select the item and run the upgrade

* you get::

    Upgrades

    The profile "Products.PloneHelpCenter:default" is currently upgraded to version 3.0.

    The filesystem version for the "Products.PloneHelpCenter:default" profile is currently 3.0b3.

    No upgrade available.

内容应再次恢复!

可选

AddRemoveWidget - 请注意:如果AddRemoveWidget作为Zope产品安装,您必须在Plone中也安装它。如果没有安装而存在,将发生错误。

使用buildout安装

如果您正在使用buildout来管理实例,则安装Plone帮助中心非常简单。您可以通过将其添加到实例的eggs行来安装它

[instance]
eggs = Products.PloneHelpCenter

如果另一个egg包依赖于Products.PloneHelpCenter,您不需要在buildout配置中指定任何内容:buildout将自动检测这一点。

更新配置后,您需要运行“bin/buildout”,它将负责更新您的系统。

不使用buildout安装

将此项目(Products.PloneHelpCenter/Products/PloneHelpCenter)的PloneHelpCenter文件夹(或符号链接)移动到要安装的Zope实例的Products目录中,并重新启动服务器。

您还可以从http://plone.org/products/PloneHelpCenter 下载传统的tarball,并将其解压缩到Products中。

历史

4.0 (2013-09-21)

  • 兼容Plone 4.2和4.3。应该仍然在4.0和4.1上工作。[maurits]

  • 类型:从content_icon切换到icon_expr。[maurits]

  • 将示例手册文本切换到html。这样就可以使用TinyMCE正确地编辑它。它以前是结构化文本,默认不接受为mimetext,因此编辑时实际上会丢失布局。[maurits]

  • 为HelpCenterHowToFolder和HelpCenterLinkFolder注册了标准Plone的png图标。添加升级步骤以应用类型信息和重新编目这两个portal_types。否则在Plone 4.3中,这些项目在列表中缺少图标。[maurits]

  • 通过检查在请求getSections时项目大脑返回值来修复faqfolder_view错误。[ichim-david]

  • 删除了用于CMFCore 1.4.7或更低版本的旧补丁,该补丁最后用于Plone 2.0.5。[maurits]

  • 修复知识库类型无法全局添加的测试。[ale-rt]

  • 将 rss.gif 替换为 rss.png。[ale-rt]

  • 移除未使用的代码以从 zope.app.publisher 中删除依赖。[ale-rt]

  • 通过 tempfolder 使 ManualPage 可添加。[tiberiuichim]

  • 使知识库类型不可全局添加。[davisagli]

  • 使通过 getVersions 过滤 phc_search 成为可能。[davisagli @ cioppino]

  • 改进了 portlet_phc_about 的样式。[davisagli, hennaheto @ cioppino]

PloneHelpCenter 4.0b3 (2011-05-12)

  • 清理包和发布。[aclark]

  • 更新 discussion_reply.cpy 以与 Plone 保持同步。[davisagli]

  • 向大多数模板添加子导航。[smcmahon]

  • 重新设计 helpcenter_topicview_main 以显示“从这里开始”项、主题计数。[davisagli]

  • 为 PloneHelpCenter 添加 getPHCSubNav 方法以创建子导航。[stevem]

  • 添加 metadata.xml 文件,QuickInstaller 升级时使用。[afd]

PloneHelpCenter 4.0b2 (2010-12-28)

  • 修复 Plone 4 中的 phc_stats 模板。[davisagli]

  • 修复 Plone 3 中的导入错误。[miohtama]

  • 使用包含获取链获取 ReferenceManualSection 类型中的父属性。[dukebody]

  • 使列表遵守 HelpCenter 或类型文件夹中设置的子主题顺序,而不是按字母顺序排序。修复了 http://plone.org/products/plonehelpcenter/issues/127。[dukebody]

PloneHelpCenter 4.0b1 (2010-12-09)

PloneHelpCenter 4.0a1 (2010-12-07)

  • 使用 lxml 将手册的单页版本的图像相对链接转换为绝对链接。这引入了一个新的安装依赖项 lxml。修复了 http://plone.org/products/plonehelpcenter/issues/136。[dukebody]

  • 在部分标题中包含编号。修复了 http://plone.org/products/plonehelpcenter/issues/137。[dukebody]

  • 重命名类型标题:“页面”到“教程页面”和“链接”到“帮助中心链接”。修复了 http://plone.org/products/plonehelpcenter/issues/140。[dukebody]

  • 使通过 XML-RPC 查询 contentIds 成为可能,以用于 collective.developermanual 上传。[miohtama]

  • 使用 aq_parent 函数而不是属性,以避免在未使用获取包装器时出现 AttributeError(新版本的 Zope)。[dukebody]

  • 修复 next/previous 自定义适配器以访问导航下拉菜单中出现的相同项。同时确保此适配器用于旧版本的 ReferenceManuals。修复了 http://plone.org/products/plonehelpcenter/issues/152/。[dukebody, davisagli]

  • 当不在包含当前版本 schemas 的容器中时,尝试获取 getCurrentVersions 不会失败。[davisagli]

  • 修复导入,以始终使用 Zope 3 风格接口,使代码同时在 Plone 3 和 4 中工作。[dukebody,感谢 davisagli]

  • 合并 Fabio Rizzo 的 Plone 4 迁移分支中的相关更改。[dukebody]

  • 撤销 referencemanual_view.pt 修复中的过时代码。[acsr]

  • 更新了 INSTALL.txt,其中包含了与问题 #142 “升级步骤顺序不明确” 和问题 #132 “提到 Ploneboard 的勘误” 相关的逐步升级指南。[acsr]

  • 修复了当参考资料手册中存在文件时无法显示 referencemanual_view 的问题。[acsr,感谢 dukebody]

  • 将整个产品更新为与 Plone 4.0a2 兼容。[dukebody]

  • 删除了参考资料手册的“全局允许”设置。这关闭了 http://plone.org/products/plonehelpcenter/issues/150。[keul]

  • 更新了 INSTALL.txt,其中包含了与问题 #142 “升级步骤顺序不明确” 和问题 #132 “提到 Ploneboard 的勘误” 相关的逐步升级指南。[acsr]

  • 在参考资料手册目录生成中尊重 exclude_from_nav 设置。[miohtama]

有关更早的历史,请参阅 docs/HISTORY.txt

致谢

项目架构、开发、内容类型、Archetypes、工作流:Joel Burton

开发、用户界面、项目架构、质量保证:Alexander Limi

开发、持久性和全面性:Martin “optilude” Aspeli

开发、协助:Christian “Tiran” Heimes

原始 FAQ 代码:Tim Terlegard,Edward Muller - Zest Software 的 Jean-Paul Ladage 和 Ahmad Hadi 进一步改进

修复各种问题,文档:Sprinters:Christian Heimes,Dorneles Treméa,Daniel Nouri,Nate Aune

添加了对其他基于 Archetypes 的类型的可选“也见”引用:Jens “jensens” Klein

i18n 改进:Jean Ferri 在一些模板和巴西翻译中的通用修复

错误修复和偶尔的质量保证:Geir Baekholt

主题、起始页和 1.0 搜索选项:2007 年文档冲刺参与者,尤其是 aclark,joelburton,magnon 和 stevem。Plone.Org 视觉皮肤由 vedawms 提供。

许多 1.0 展示修复:Servilio Afre Puentes。

版本 3.0 重构:Steve McMahon

Plone 4.0 迁移:Liberiun.com 的 Fabio Rizzo 和 Israel Saeta Pérez。

项目详情


下载文件

下载适用于您平台的文件。如果您不确定要选择哪个,请了解更多关于 安装包 的信息。

源代码发行版

Products.PloneHelpCenter-4.0.zip (507.3 kB 查看哈希值)

上传时间: 源代码

支持者