Welcome to TiddlyWiki, a non-linear personal web notebook that anyone can use and keep forever, independently of any corporation.

欢迎来到 TiddlyWiki，一个非线性的个人网络笔记本，任何人都可以使用和永远保持，独立于任何公司。

TiddlyWiki is a complete interactive wiki in JavaScript. It can be used as a single HTML file in the browser or as a powerful Node.js application. It is highly customisable: the entire user interface is itself implemented in hackable WikiText.

是一个完整的 JavaScript 交互式 wiki。它可以在浏览器中作为一个 HTML 文件使用，也可以作为一个强大的 Node.js 应用程序使用。它是高度可定制的: 整个用户界面本身就是在可删除的 WikiText 中实现的。

Learn more and see it in action at https://tiddlywiki.com/

了解更多信息，并在 https://tiddlywiki.com / 实践中看到它

Developer documentation is in progress at https://tiddlywiki.com/dev/

开发者文档正在 https://tiddlywiki.com/dev / 进行中

Join the Community 加入社区

Users 用户

The TiddlyWiki discussion groups are mailing lists for talking about TiddlyWiki: requests for help, announcements of new releases and plugins, debating new features, or just sharing experiences. You can participate via the associated website, or subscribe via email.

讨论组是谈论 TiddlyWiki 的邮件列表: 请求帮助、发布新版本和插件、辩论新特性或者仅仅分享经验。你可以通过相关网站参与，或者通过电子邮件订阅。

The main TiddlyWiki group: 主要的 TiddlyWiki 组:http://groups.google.com/group/TiddlyWiki

Note that you do not need a Google Account to join the discussion groups. Subscribe by sending an email to 请注意，您不需要谷歌帐户就可以加入讨论组mailto:tiddlywiki+subscribe@googlegroups.com or 或mailto:tiddlywikidev+subscribe@googlegroups.com.
- An enhanced group search facility is available on 一个增强的群组搜索功能可以在mail-archive.com
Watch recordings of our regular 观看我们常客的录音TiddlyWiki Hangouts 视频群聊
Follow 跟着@TiddlyWiki on Twitter @ tiddlywiki on Twitter for the latest news 了解最新消息
New: Join us on our live chat at 新: 加入我们的在线聊天https://gitter.im/TiddlyWiki/public !
There is also a discord available at 也有一个不和谐可在https://discord.gg/HFFZVQ8

Developers 开发者

The 这个TiddlyWikiDev group for developers: 开发者小组:http://groups.google.com/group/TiddlyWikiDev

Note that you do not need a Google Account to join the discussion groups. Subscribe by sending an email to 请注意，您不需要谷歌帐户就可以加入讨论组mailto:tiddlywiki+subscribe@googlegroups.com or 或mailto:tiddlywikidev+subscribe@googlegroups.com.
- An enhanced group search facility is available on 你可透过以下连结，浏览网页mail-archive.com
Follow 跟着@TiddlyWiki on Twitter @ tiddlywiki on Twitter for the latest news 了解最新消息
Get involved in the 参与到这个项目中development on GitHub 在 GitHub 上的开发
Chat at 网址:https://gitter.im/TiddlyWiki/public (development room coming soon) (开发室即将推出)

New releases of TiddlyWiki, TiddlyDesktop and TiddlyFox are announced via the discussion groups and Twitter (you can also subscribe to an Atom/RSS feed of TiddlyWiki releases from GitHub)

TiddlyWiki、 TiddlyDesktop 和 TiddlyFox 的新版本将通过讨论组和 Twitter 发布 (您也可以订阅来自 GitHub 的 TiddlyWiki 版本的 Atom/RSS feed)

Documentation 文件

There is also a discussion group specifically for discussing TiddlyWiki documentation improvement initiatives: http://groups.google.com/group/tiddlywikidocs

还有一个专门讨论 TiddlyWiki 文档改进倡议的讨论小组: http://groups.google.com/group/tiddlywikidocs

Installing 安装TiddlyWiki on Node.js

Install 安装Node.js
- either from your favourite package manager: typically 要么是你最喜欢的包裹管理员apt-get install nodejs on Debian/Ubuntu Linux or 在 Debian/Ubuntu Linux 或Termux for Android 安卓系统的 Termux, or ，或brew install node on a Mac 在 Mac 电脑上
- or directly from 或者直接来自http://nodejs.org
Open a command line terminal and type: 打开一个命令行终端并输入:

npm install -g tiddlywiki

If it fails with an error you may need to re-run the command as an administrator: 如果出现错误而失败，您可能需要作为管理员重新运行该命令:

sudo npm install -g tiddlywiki (Mac/Linux)
Check 将军TiddlyWiki is installed by typing: 是通过输入:

tiddlywiki --version
In response, you should see 作为回应，你应该看到TiddlyWiki report its current version (eg "5.1.22"; you may also see other debugging information reported) 报告其当前版本 (例如 “5.1.22” ; 您还可以看到报告的其他调试信息)
Try it out: 尝试一下:
1. tiddlywiki mynewwiki --init server to create a folder for a new wiki that includes server-related components 为包含服务器相关组件的新 wiki 创建一个文件夹
2. tiddlywiki mynewwiki --listen to start 开始TiddlyWiki
3. Visit 参观http://127.0.0.1:8080/ in your browser 在你的浏览器里
4. Try editing and creating tiddlers 尝试编辑和创建 tiddlers
Optionally, make an offline copy: 可以选择离线拷贝:
- click the 点击 save changes 保存改变 button in the sidebar, 边栏上的按钮,OR 或者
- tiddlywiki mynewwiki --build index

The -g flag causes TiddlyWiki to be installed globally. Without it, TiddlyWiki will only be available in the directory where you installed it.

G 标志导致 TiddlyWiki 在全球范围内安装。如果没有它，TiddlyWiki 将只能在您安装它的目录中使用。

If you are using Debian or Debian-based Linux and you are receiving a node: command not found error though node.js package is installed, you may need to create a symbolic link between nodejs and node. Consult your distro's manual and whereis to correctly create a link. See github issue 1434

如果您正在使用 Debian 或基于 Debian 的 Linux，并且您正在收到一个 node: command not found error，尽管已经安装了 node.js 包，您可能需要在 node.js 和 node 之间创建一个符号链接。参考你的发行版手册，正确地创建一个链接。参见 github issue 1434

Example Debian v8.0: sudo ln -s /usr/bin/nodejs /usr/bin/node

示例 Debian v8.0: sudo ln-s/usr/bin/node.js/usr/bin/node

You can also install prior versions like this:

你也可以像这样安装以前的版本:

npm install -g tiddlywiki@5.1.13 Npm install-g tiddlywiki@5.1.13

Using 使用TiddlyWiki on Node.js

TiddlyWiki5 includes a set of Commands for use on the command line to perform an extensive set of operations based on TiddlyWikiFolders, TiddlerFiles and TiddlyWikiFiles.

5 包含一组命令，用于在命令行上执行基于 TiddlyWikiFolders、 TiddlerFiles 和 TiddlyWikiFiles 的大量操作。

For example, the following command loads the tiddlers from a TiddlyWiki HTML file and then saves one of them in static HTML:

例如，下面的命令从一个 TiddlyWiki HTML 文件中加载 tiddlers，然后将其中一个保存为静态 HTML:

tiddlywiki --verbose --load mywiki.html --rendertiddler ReadMe ./readme.html

Running tiddlywiki from the command line boots the TiddlyWiki kernel, loads the core plugins and establishes an empty wiki store. It then sequentially processes the command line arguments from left to right. The arguments are separated with spaces.

从命令行运行 TiddlyWiki 将引导 TiddlyWiki 内核，加载核心插件并建立一个空的 wiki 存储。然后按顺序从左到右处理命令行参数。参数用空格分隔。

New in: 5.1.20 First, there can be zero or more plugin references identified by the prefix + for plugin names or ++ for a path to a plugin folder. These plugins are loaded in addition to any specified in the TiddlyWikiFolder.

新特性: 5.1.20 首先，可以有零个或更多的插件引用，通过前缀 + 标识为插件名称，或者 + + 标识为一个插件文件夹的路径。除了在 TiddlyWikiFolder 中指定的任何插件之外，还加载了这些插件。

The next argument is the optional path to the TiddlyWikiFolder to be loaded. If not present, then the current directory is used.

下一个参数是要加载的 TiddlyWikiFolder 的可选路径。如果不存在，那么就使用工作目录。

The commands and their individual arguments follow, each command being identified by the prefix --.

随后是命令及其各自的参数，每个命令都由前缀 -- 标识。

tiddlywiki [+<pluginname> | ++<pluginpath>] [<wikipath>] [--<command> [<arg>[,<arg>]]]

For example:

例如:

tiddlywiki --version
tiddlywiki +plugins/tiddlywiki/filesystem +plugins/tiddlywiki/tiddlyweb mywiki --listen
tiddlywiki ++./mygreatplugin mywiki --listen

New in: 5.1.18 Commands such as the ListenCommand that support large numbers of parameters can use NamedCommandParameters to make things less unwieldy. For example:

新增: 5.1.18 命令，例如支持大量参数的 ListenCommand，可以使用 NamedCommandParameters 来减少事情的复杂性。例如:

tiddlywiki wikipath --listen username=jeremy port=8090

See Commands for a full listing of the available commands.

有关可用命令的完整清单，请参阅命令。

Upgrading 升级TiddlyWiki on Node.js

If you've installed TiddlyWiki on Node.js on the usual way, when a new version is released you can upgrade it with this command:

如果你已经按照通常的方式在 Node.js 上安装了 TiddlyWiki，那么当新版本发布时，你可以使用以下命令升级它:

npm update -g tiddlywiki

On Mac or Linux you'll need to add sudo like this:

在 Mac 或 Linux 上，你需要像这样添加 sudo:

sudo npm update -g tiddlywiki

Also see 另见

This readme file was automatically generated by TiddlyWiki

这个自述文件是由 TiddlyWiki 自动生成的 https://github.com/saqimtiaz/TiddlyWiki5

kunpeng9 / GTD2020-05-31

saqimtiaz/TiddlyWiki5: A self-contained JavaScript wiki for the browser or Node.js #82