Django-wiki文档

备注

构建时间: 2025 年 06 月 23 日

Django维基

Docs 构建状态 覆盖状态 PyPi 下载 IRC

Django支持

下表解释了支持哪些Django版本。

释放

Django

升级从

0.12.x

4.0、4.1、4.2 5.0、5.1、5.2

0.10或0.11

0.11.x

3.2、4.0、4.1、4.2、5.0、5.1

0.10

0.10.x

2.2、3.0、3.1、3.2、4.0、4.1、4.2

0.7

0.9.x

2.2、3.0、3.1、3.2、4.0

0.7

0.8.x

2.2、3.0、3.1、3.2、4.0

0.7

0.7.x

2.2、3.0、3.1、3.2

0.5或0.6

0.6.x

2.1、2.2、3.0

0.5

0.5.x

2.1、2.2

0.4

0.4.x

1.11、2.0、2.1

0.3

0.3.x

1.8、1.9、1.10、1.11

0.2

0.2.x

1.8、1.9、1.10

0.1

0.1.x

1.5,1.6,1.7

0.0.24

0.0.24

1.4、1.5、1.6 1.7(不稳定)

0.0.?

有关升级说明,请参阅 Release Notes

翻译(Transifex)

Django-wiki已被完全翻译成13种语言,除了默认语言(英语)外,还有一些其他语言正在进行中。

但请添加更多语言来帮忙!这非常简单,而且你不需要成为程序员。

一些语言.

  • ...只需要一点推动,因为它们几乎完全完成

  • ...被发起并需要一个新的煽动者来延续野心

  • ...目前还不存在-但您可以请求它们并成为协调员

Visit the django-wiki project on Transifex

演示

运行最新的演示 main 分支机构可在此处找到:

https://demo.django-wiki.org

注册帐户查看通知系统,也可以使用现有帐户登录:

  • 用户: admin

  • 密码:“管理员”

社区

请使用我们的IRC或邮件列表(谷歌群组)联系开发和支持。请不要向开发人员发送电子邮件请求个人支持。

Always a work in progr...

从多种因素来看,该项目已证明自己有用且稳定。

  • 如果没有正确的升级路径,预计不会发生会导致数据丢失的更改。

  • 模型API非常稳定,只会发生较小的变化。

  • 插件API看起来很稳定。

  • 您可以通过PyPi维护最新版本的django-wiki(包名称: wiki), using SemVer 版本化模式。

我应该定制什么?什么可以打破?

你需要学习一些关于Django的知识来定制django-wiki。

最简单的是覆盖模板并创建您自己的模板标签。不要为了摆弄维基的内部部分而制作此存储库自己的硬副本,这种策略将导致您失去未来具有高度改进的功能、插件和安全修复程序的更新。

您也可以覆盖整个Bootstrap主题。目前,你最好维护自己的Bootstrap SCSS和硬拷贝,然后覆盖django-wiki的规则。

所有Python视图都基于类。然而,在大多数情况下,重写视图和URL不应该是最好的开始位置,因为大多数定制可以通过插件、模板和SCSS实现。

贡献

欢迎捐款!❤️

请阅读我们 Developer Guide

宣言

Django需要一个成熟的维基系统来吸引各种大大小小的需求:

  • Be pluggable and lightweight. 不要在核心中集成可选功能。

  • Be open. 创建一个扩展API,允许wiki生态以结构化的方式增长。Wikipedia包含超过 1100 extension projects 为MediaWiki编写。我们应该从中吸取教训。

  • Be smart. This is MediaWiki中的表格地图-我们将了解其他维基项目的选择并做出我们自己的选择。毕竟,这是一个Django项目。

  • Be simple. 源代码应该 almost 解释自己。

  • Be structured. Markdown是一种简单的可读性语法。功能应该通过内容字段中的简单编码模式来实现,而是以结构化的方式存储(在数据库中)并通过友好的界面进行管理。这将控制权交还给网站开发人员,并使知识更可用。问问:为什么维基百科从未改变?答:因为它的知识是以一种复杂的方式存储的,所以它变得非常静态。

Docs

查看文档/文件夹,或在以下网址阅读:

https://django-wiki.readthedocs.io/en/latest/

如果您想添加一些内容,请在Google群组中询问,或者如果您怀疑某些内容是否可能发生变化,请提出问题。

背景

Django-wiki重写了 django-simplewiki ,一个2009年的项目,旨在成为维基的基本系统。它建议用户应该通过收件箱模板自定义维基,但很快了解到真正发生的唯一定制是人们为整个项目提供了叉。我们不希望django-wiki如此,我们希望它是模块化和可扩展的。

到目前为止,Django已经存在了太长时间,没有合适的维基应用程序。Django-wiki的梦想是与Mediawiki一起成为竞争者,这样Django开发人员即使面临实施wiki等严峻挑战,也可以坚持使用Django平台。

Q&A

  • Why is the module named just wiki ? Because when we tried pip install wiki, it returned "No distributions at all found for wiki", so we had to make up for that! ...oh, and django-wiki was occupied.

  • What markup language will you use? Markdown .标记渲染器不是可插入的部分,而是已内化为核心部分。讨论应在此处进行:https://github.com/django-wiki/django-wiki/issues/76

  • Why not use django-reversion? 这是一个很棒的项目,但如果维基必须变得雄心勃勃,就必须有人优化其行为,而在这方面,使用第三方应用程序来处理像修订系统这样重要的事情是不可取的。

  • Any support for multiple wikis? 是的,从某种意义上说,您可以想象您总是拥有多个维基,因为您总是有层次结构并完全控制其权限。请参阅此讨论:https://github.com/django-wiki/django-wiki/issues/63

Docker tt;博士

这里有一个docker容器:https://github.com/riotkit-org/docker-django-wiki

确认

早在2009年,灵感的最初来源是Django-cms,从那时起,Wagtail还做了大量工作来推广Django模型作为应用程序设计的基本结构和使能器。

指数和表格