Unpaywall 拓展程序安装与使用指南
1. 项目目录结构及介绍
该项目是Unpaywall浏览器扩展程序的源代码仓库。主要目录结构如下:
-
src
: 这是核心代码所在的目录,包含了扩展程序的主要功能。background.js
: 背景脚本,处理浏览器扩展的后台逻辑。content_script.js
: 内容脚本,注入到网页中以实现页面内功能交互。popup.js
: 弹出窗口的脚本,用于用户界面交互。manifest.json
: 扩展程序的清单文件,定义了扩展的元数据和权限。
-
icons
: 存放扩展图标的各种尺寸。 -
LICENSE
: 开源许可文件。 -
README.md
: 项目说明文件。 -
.gitignore
: Git版本控制系统忽略文件列表。
2. 项目的启动文件介绍
manifest.json
manifest.json
是Unpaywall拓展程序的核心配置文件,它告诉浏览器如何运行和集成这个扩展。关键配置包括:
name
: 扩展的名字。version
: 当前版本号。description
: 对扩展的简短描述。permissions
: 需要的浏览器权限,如访问特定URL等。browser_action
: 定义浏览器动作(如点击图标)时的行为,包括弹出窗口或执行背景脚本。
例如,manifest.json
中可能有这样一段:
{
"name": "Unpaywall",
"version": "3.98",
"description": "自动获取学术文章的免费全文。",
...
"browser_action": {
"default_popup": "popup.html",
"default_icon": {
"16": "icons/icon16.png",
...
}
},
...
}
其他启动相关文件
-
content_script.js
: 在学术文章页面上运行,检测并处理Unpaywall的功能,比如查找免费全文链接。 -
popup.js
: 点击扩展图标后出现的弹出窗口的JavaScript控制逻辑。
3. 项目的配置文件介绍
Unpaywall的配置主要是通过manifest.json
来完成的,但这个项目没有单独的外部配置文件。manifest.json
中设置的参数如permissions
和background
的scripts
,控制着扩展在浏览器中的行为和访问权限。如果需要自定义行为,可以在上述提及的JavaScript文件中进行编程修改。
例如,如果你想要添加新的API请求权限,可以在manifest.json
中增加对应的permissions
字段:
"permissions": [
"activeTab",
"https://api.unpaywall.org/*"
],
请注意,更新权限后需要重新加载或打包扩展才能生效。
要使用这个扩展,你需要将其加载到支持的浏览器(如Chrome或Firefox)中,或者构建一个.crx
或.zip
包进行安装。对于开发目的,可以直接在浏览器开发者模式下加载extension
目录。具体步骤如下:
- 打开浏览器的扩展管理页面(Chrome:
chrome://extensions
,Firefox:about:debugging
)。 - 启动开发者模式。
- 点击“加载已解压的扩展程序”按钮。
- 浏览并选择
unpaywall-extension
项目的根目录。
加载完成后,Unpaywall扩展将在学术文章页面上自动工作,帮助用户找到免费全文资源。