如何设计用于浏览文本手册页的 Web 界面？答案

【问题标题】：How do I design a web interface for browsing text man pages?如何设计用于浏览文本手册页的 Web 界面？
【发布时间】：2010-10-18 05:58:27
【问题描述】：

我想设计一个 Web 应用程序，允许我对手册页集合进行排序、浏览和显示各种属性（例如标题、标签、描述）。

具体来说，这些是 R 包中的 R documentation files，其中包含一组数据集，由 SVN 存储库中的几个人维护。这些文件的格式是 .Rd，类似于 LaTeX，但不同。

R 具有将这些手册页转换为 html 或 pdf 的功能，但我希望能够有一个 Web 界面，允许用户单击特定关键字，并显示一个列表（和简短摘录）在 \keyword{} 标记中包含该关键字的那些手册页。

另外，生成的 html 有点难看，我希望能够提供自己的 CSS。

一个明显的选择是将我想要的所有元数据加载到 MySQL 之类的数据库中，并设计我的站点以运行查询并获取适当的数据。

我想避免这种情况，以尽量减少对未来维护者的维护。文件数量少（

我目前的倾向是有一个脚本，它将每个文件中所需的元数据提取到一个摘要 JSON 文件中，并在 PHP 中加载这个 summary.json 文件，对其进行解码，然后循环遍历数组以查找那些具有以下属性的项目匹配当前查询（例如所有带有关键字 1 和关键字 2 的文档）。

我是从以下方向开始的……

$contents=file_get_contents("summary.json");
$c=json_decode($contents,true);
foreach ($c as $ind=>$val ) { .... etc

另一个想法是编写一个脚本，将这些 .Rd 文件转换为 xml。在这种情况下，是否有任何轻量级框架可以轻松地对一小部分 xml 文件进行排序和搜索？

我不确定 xQuery 是不是大材小用，或者我是否有时间深入研究它......

我认为我正在遭受所有 AJAX 诱惑的过多选项综合症。任何帮助是极大的赞赏。

我正在寻找一个超级简单的解决方案。你们中的一些人可能会如何解决这个问题？

【问题讨论】：

【解决方案1】：

为什么不为每个摘要字段创建包含列的表 SUMMARIES？然后您可以使用全文索引对其进行索引，为每个字段分配不同的权重。

您不需要 MySQL，您可以使用内置 Google 全文索引 (FTS3) 的 SQLite。

【讨论】：

【解决方案2】：

我的方法是从文件中解析关键字（根据您的描述，我假设它们具有特殊符号以将它们与普通单词/文本区分开来）并将此数据存储为 searchindex 某处。不一定是 mySQL，sqlite 对你的项目来说肯定足够了。搜索将非常简单。

解析文件可以作为提交后挂钩到您的 subversion 存储库自动进行。

【讨论】：