SurVis 项目教程

SurVis 项目教程

survis Visual Literature Database 项目地址: https://gitcode.com/gh_mirrors/su/survis

1. 项目目录结构及介绍

SurVis 项目的目录结构如下：

survis/
├── bib/
│   └── references.bib
├── doc/
├── electron/
├── release/
├── src/
│   ├── data/
│   │   ├── generated/
│   │   ├── authorized_tags.js
│   │   ├── papers_img/
│   │   ├── papers_pdf/
│   │   ├── search_stopwords.js
│   │   └── tag_categories.js
│   ├── index.html
│   └── properties.js
├── test/
├── .gitignore
├── LICENSE
├── README.md
└── update_data.py

目录介绍

• bib/: 包含项目的 BibTeX 文件 references.bib，用于存储文献数据。
• doc/: 存放项目文档的目录。
• electron/: 可能用于 Electron 打包的目录。
• release/: 存放项目发布版本的目录。
• src/: 项目的主要源代码目录，包含以下子目录和文件：
  • data/: 存放项目的数据文件，包括生成的数据文件和配置文件。
    • generated/: 自动生成的数据文件目录，不建议手动编辑。
    • authorized_tags.js: 定义了带有描述的标签。
    • papers_img/: 存放文献的 PNG 缩略图。
    • papers_pdf/: 存放文献的 PDF 文件。
    • search_stopwords.js: 定义了搜索时排除的停用词。
    • tag_categories.js: 定义了标签类别。
  • index.html: 项目的启动文件。
  • properties.js: 项目的配置文件。
• test/: 存放测试代码的目录。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目的许可证文件。
• README.md: 项目的说明文档。
• update_data.py: 用于更新数据文件的 Python 脚本。

2. 项目启动文件介绍

项目的启动文件是 src/index.html。该文件是 SurVis 项目的入口，用户可以通过在浏览器中打开此文件来启动 SurVis 应用。启动文件负责加载项目的核心功能和界面。

3. 项目的配置文件介绍

项目的配置文件是 src/properties.js。该文件包含了 SurVis 项目的各种配置选项，例如页面标题、编辑模式等。以下是配置文件中可能包含的一些关键配置项：

// src/properties.js

// 页面标题
const pageTitle = "SurVis - Visual Literature Browser";

// 编辑模式
const editable = true;

// 其他配置项...

通过修改 properties.js 文件中的配置项，用户可以自定义 SurVis 的行为和外观。例如，可以通过设置 editable 为 false 来禁用编辑模式，以防止用户在生产环境中修改文献数据。

survis Visual Literature Database 项目地址: https://gitcode.com/gh_mirrors/su/survis