README

这是一个为jTpl或Castor（Jelix使用的模板引擎）编写的插件。

此插件允许在模板中渲染wiki内容。它使用jWiki类（见lib/），基于WikiRenderer库。

此插件适用于Jelix 1.7.x及以上版本。要查看Jelix 1.7之前的版本的历史，请查看jelix/jelix存储库。

安装

像其他Jelix插件一样手动安装它，或者如果您使用Composer安装了Jelix 1.7+，则可以使用Composer。

在您的项目中

composer require "jelix/wikirenderer-plugin"

在模板中的使用

 <div>
    {$mywikicontent|wiki}
 </div>

jWiki使用

jWiki是一个将wiki文本转换为其他格式的类。例如XHTML。此类继承自Wikirenderer版本3.1。

为了转换，Wikirenderer需要一些精确的对象，这些对象组合在一起成为//转换规则//。

WikiRenderer已经捆绑了许多//转换规则//。例如，wr3_to_xhtml允许将wiki（wr3语法）转换为XHTML。还可以将dokuwiki代码转换为XHTML，或将mediawiki转换为docbook。所有组合都是可能的。您只需要提供或开发合适的转换规则集。

要使用jWiki，只需用//转换规则//名称实例化它。如果您想将wiki wr3转换为XHTML，只需这样做

   $wr = new jWiki('wr3_to_xhtml');
   $xhtml = $wr->render($wiki_text);

您可以在your_app/plugins/wr_rules/中添加自己的集合。注意：如果您打算这样做，请记住在您的配置中激活app:plugins存储库。

如果您将您自己的//转换规则//存储到your_app/plugins/wr_rules/中，则每个//转换规则//都应该在其自己的目录中，就像任何jelix插件一样。因此，如果您有一个“superwiki_to_xhtml”规则，您必须将它的源代码存储在文件your_app/plugins/wr_rules/superwiki_to_xhtml/superwiki_to_xhtml.rule.php中。

在此文件中，您应该有一个继承自WikiRendererConfig或另一个规则类的superwiki_to_xhtml类。

有关更多信息，请浏览Wikirenderer文档。

jelix / wikirenderer-plugin

维护者

详细信息

README

安装

在模板中的使用

jWiki使用