#wikipedia #dump #search #xml #vim #offline #indexing

wiki_loader

一个用于加载和搜索维基百科多流存档的工具

4 个版本

0.1.3 2024年7月30日
0.1.2 2024年2月25日
0.1.1 2024年1月21日
0.1.0 2024年1月21日

#2846解析器实现

Download history 28/week @ 2024-04-23 160/week @ 2024-07-30

每月160 次下载
用于 wiki_reader

MIT 许可证

16KB
385

WikiTerm-rs

本项目旨在创建一个终端应用程序(主要使用 vim 动作),让您能够快速搜索离线版本的维基百科。

安装/设置

可以通过 crates.io 安装

cargo install wiki_reader
# To start (Please set the config as below first)
wiki_reader

此应用程序期望在 ~/.config/wikiterm/config.json 处存在配置文件

以下格式

{
    "wiki_bzip_path": "~/Documents/wiki/simple/base.bz2",
    "meta_directory": "~/Documents/wiki/simple/meta",
}

如果上述配置不存在,则将从上述配置创建元数据目录。

wiki_bzip_path 是下载的 bzip2(xml)存档文件的路径。它预期这是一个多流版本。

https://meta.wikimedia.org/wiki/Data_dump_torrents

请注意,更大的存档索引需要更长的时间(但这只需做一次)。

元数据目录是您希望任何索引/由本项目产生的文件的地方。

使用方法

您应该可以使用(目前是 vim 绑定的子集)进行导航

j, k
up, down

:q to quit or Ctrl-c

Esc to exit back to normal mode
/ to search

以下是一些基本绑定,要获取更多绑定,请使用 ?。

局限性/改进空间

这是一个正在进行中的项目,因此许多功能将缺失/不完美,例如

  • 目前的搜索不是很好,需要改进
  • 目前没有解析维基文本,因此输出没有格式
  • 支持本地图像,可能允许您为远程设置标志。
  • 需要改进用于索引的序列化,大型 json 文件可能导致启动变慢。

由于这是一个相当新的项目,因此可能会进行许多破坏性更改,例如更改配置路径或保存的文件名(这需要重新索引)。

贡献

如果您想进行重大更改,请首先提交一个问题以避免任何浪费时间。这是我第一个操作系统项目,也是我第一个真正的 Rust 项目,我正在使用它来学习 Rust,所以这可能不是真正的 Rust 风格,这里可能有一些捷径。

依赖项

约 10–13MB
约 198K SLoC