ITADN
felixhayashi/TW5-TiddlyMap
代码 动态 Issues22 合并请求6 版本5
felixhayashi/TW5-TiddlyMap · 文件 下载 ZIP
文件最后提交记录最后更新时间
README.md
以下内容由 AI 翻译，如有问题请点此提交 issue 反馈

TiddlyMap

Tiddlymap 已不再维护。它在 TiddlyWiki v5.3.x 中仍然可用，但不会再实施任何 bug 修复或新功能。但请随意查看 TiddlyMap 的精神续作，TW5-Graph。

TiddlyMap 是一个 TiddlyWiki 插件，它将您喜爱的个人笔记软件转变为 wiki-概念图混合体。是的，您将能够同时做到这两点：绘制地图以及以 wiki 方式记录知识。TiddlyMap 允许您可视化链接和创建 wiki 主题，以创建 可点击的图，例如 概念图 或 依赖图。此外，它会自动 可视化您的主题结构，以便您立即掌握主题和关系。

Demo

警告： 演示站点已不再维护。TiddlyMap 的最新版本仅在此 git 仓库中提供。请查看右侧的 "Releases"。

在项目的网站 tiddlymap.org 上可以找到包含多个示例和说明的演示。虽然 TiddlyMap 也支持移动设备，但它是为较大屏幕（宽度 >= 1440px）编写的，因为概念映射需要空间。

Motivation

TiddlyMap 的动机是在个人知识管理领域，将 wiki 和概念图的优点结合到一个应用程序中。

你是否曾经创建过思维导图或概念图，后来希望将它们转换为 wiki，因为它们变得过于复杂且难以维护？反之，你是否曾经使用过 wiki，并觉得它缺乏表达思想和关联内容的视觉手段？——如果是，那么 TiddlyMap 正是你在寻找的。

Fundaments

TiddlyMap 基于两个流行的开源项目。

TiddlyWiki，由 Jeremy Ruston 开发的个人 wiki 软件，被用作运行时环境。TiddlyWiki 是一个独特的非线性笔记本，用于捕获、组织和共享复杂信息。它是一个高度交互的应用程序，存储在一个单一文件中。

TiddlyWiki 赋予了人们前所未有的自由，让他们能够自主掌控自己宝贵的信息。 – tiddlywiki.com

Vis.js 用于图形可视化和操作。Vis.js 是一个动态的、基于浏览器的可视化库，由在 Almende B.V 工作的一支优秀开发者团队积极开发和维护。

该库旨在易于使用，处理大量动态数据，并支持对数据的操作 – visjs.org

License

TiddlyMap 依据 BSD 2-Clause License 分发。 使用此插件即表示您同意该产品的 License Terms。

Installation

安装 TiddlyMap 和 TiddlyWiki 有两种方式。如果您是初学者或非技术人员，您可能应该选择独立安装。

Option 1 – Drag & drop installation of the plugin

这是最简单且最常用的方法，尤其是在独立模式下使用 TiddlyWiki 时。当 TiddlyWiki 在 Node.js 下运行时，您也可以使用此方法。请遵循 此处 提供的说明。也许这个 入门视频 也有帮助。

Option 2 – Include the plugin in the TiddlyWiki plugin-folder

此方法要求您使用 Node.js 以服务器模式运行 TiddlyWiki。有关如何使用 Node.js 设置 TiddlyWiki5 的一般信息，请访问 tiddlywiki.com。以这种方式安装 TiddlyMap 的好处是，同一个 TiddlyMap 插件可以包含在由 Node.js 提供的多个 wiki 中。

  1. 在您的计算机上，前往 TiddlyWiki 的安装位置。该位置可能有所不同，例如在 linux 中，如果您使用 npm -g tiddlywiki 全局安装了 TiddlyWiki，则路径为 /usr/lib/node_modules/tiddlywiki/。确保文件夹 tiddlywiki/plugins/ 具有写入权限。

  2. 对于下面的每个链接，访问其指向的 GitHub 仓库并点击“Download ZIP”。

  • TiddlyMap
    • 这是核心 TiddlyMap 插件。
  • tw5-vis-network
    • 此插件将安装 vis-network，这是图形渲染所必需的。
  • TW5-HotZone
    • 当您想要使用实时视图时，此插件是必需的。
  • TW5-TopStoryView
    • 除非您使用的是 zoomin 或 stacked story view，否则请安装此插件以获得更好的实时视图体验。
  1. 对于每个 zip 文件，打开该文件并将 zip 中 dist/ 路径（或 vis-network 的 plugins/ 路径）下的所有内容复制到 tiddlywiki/plugins/（或创建符号链接）。

现在，在您需要 TiddlyMap 出现的每个 wiki 中，您需要更新 wiki 根目录下的 tiddlywiki.info 文件中的插件部分，使其包含以下内容：

{
  "plugins": [
    "felixhayashi/tiddlymap",
    "felixhayashi/hotzone",
    "felixhayashi/topstoryview",
    "flibbles/vis-network"
  ]
}

请确保](http://jsonlint.com/)你的`tiddlywiki.info`文件格式正确且包含有效的 JSON，并且始终记得重启你的 tiddlywiki 服务器以反映更改。

Build

如果你想从源代码编译自己的 TiddlyMap 插件，请遵循以下步骤。

注意： 如果你想为该项目贡献代码，请确保在创建 pull request 之前阅读 Contributing to TiddlyMap 并签署 CLA。

首先，确保你已安装 Node.js 及其包管理器 (npm)。现在，打开一个终端并使用下面的命令克隆仓库。这可能需要一段时间，所以放松一下或给自己泡杯茶……

git clone git://github.com/felixhayashi/TW5-TiddlyMap.git

打开刚刚克隆的仓库的根目录……

cd TW5-TiddlyMap

……并执行下面的命令。同样，这可能需要一两分钟。所以与其盯着屏幕，不如在中间做一些运动（请注意这里的押韵，我花了一段时间才想出这个）。

npm install

现在使用以下命令之一：

# build for production (compressing files)
gulp --production

# build for testing (without compression)
gulp

# build and automatically rebuild on changes
gulp watch

构建过程会在本地仓库的根目录生成几个文件夹，即 docs、bundle、dist。要测试编译后的插件，请遵循上一节中给出的安装说明。

一些提示：

  • 若要快速测试构建结果，请将位于 bundle 文件夹中的 tiddlymap.json 文件拖放到您的某个 wiki 中以安装编译后的插件。当然，您*必须确保(!)*该 wiki 也安装了 TiddlyMap 所依赖的所有插件（最重要的是 tw5-vis-network）。因此，为了测试目的，您可以将编译后的插件拖放到 http://tiddlymap.org，该站点已满足所有依赖项。
  • 如果您需要经常构建和测试 TiddlyMap，那么考虑使用符号链接设置“选项 2”（参见安装说明）是有意义的。因此，请在您的 tiddlywiki/plugins/ 目录中创建指向本地仓库 dist 文件夹的符号链接。
  • 若要以网站形式显示源代码文档，请打开 docs 文件夹内的 index.html。请注意：文档可能已过时或不完整。