Skip to content

Commit

Permalink
[v0.5.0] update docs
Browse files Browse the repository at this point in the history
- Added the `My Favorites`
- Added `pintia.searchIndex.ignoreLockedProblemSets`
- Show `viewWelcome` component when user is not logged in
  • Loading branch information
jinzcdev committed Feb 28, 2023
1 parent 04300b1 commit 96c63f4
Show file tree
Hide file tree
Showing 6 changed files with 51 additions and 8 deletions.
16 changes: 15 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,20 @@

---

## [0.5.0] - 2023/02/28

### 新增

- 增加了 **题目收藏夹** 的功能,可以在题目右侧点击按钮将题目加入收藏夹(仅存储在本地)
- 增加配置项 `pintia.searchIndex.ignoreLockedProblemSets`:是否在搜索题目时过滤未解锁的题集

### 更新

- 用户未登录时,显示 `viewWelcome` 组件以指导用户使用插件
- 当已有用户登录时,点击登录弹出 `确认` 提示

---

## [0.4.0] - 2023/02/15

### 新增
Expand All @@ -28,7 +42,7 @@
- 增加题目搜索功能,及其对应命令 `Pintia: Search Problem`
- 根据 VS Code 的使用语言自动切换中英文
- 在代码编辑器中添加 `Preview` 快捷命令以重新预览题目
- 添加 Java 语言的常用模板(BufferReader、Scanner)
- 添加 Java 语言的常用模板(BufferReader、Scanner)
- 在题目预览中,增加搜索引擎与题解入口以快速搜索题目

### 更新
Expand Down
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,13 @@
---

### 1.7 代码片段
### 1.7 题目收藏

你可以在题目集中点击右侧的按钮收藏题目。该功能不依赖于官方的服务,因此只能将收藏的题目存储在本地。后续会考虑使用其他方式实现数据的同步。

---

### 1.8 代码片段

你可以在代码编辑器中输入以下前缀来快速生成相应的代码块,如下所示。

Expand Down Expand Up @@ -150,6 +156,7 @@
| `pintia.paging.pageSize` | 当问题集过大时,是否对问题列表进行分页。当pageSize为0表示不分页 | `100` |
| `pintia.autoCheckIn` | 指定当 Pintia 插件被激活时,是否自动签到 Pintia 的教育商店 | `false` |
| `pintia.searchIndex.ignoreZOJ` | 指定搜索题目时,是否忽略 `ZOJ Problem Set` | `true` |
| `pintia.searchIndex.ignoreLockedProblemSets` | 指定搜索题目时,是否忽略未解锁的题集 | `true` |
| `pintia.searchIndex.autoRefresh` | 指定是否在插件被激活时,自动刷新题目搜索索引 | `false` |
| `pintia.autoCreateProblemSetFolder` | 指定创建题目源文件时是否自动创建其习题集文件夹并将源代码文件放入相应的文件夹中 | `true` |

Expand Down
18 changes: 16 additions & 2 deletions docs/CHANGELOG_en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,20 @@

---

## [0.5.0] - 2023/02/28

### Added

- Added the **My Favorites**. You can click the button on the right side of the problem to add it to your favorites (only stored locally)
- Added configuration item `pintia.searchIndex.ignoreLockedProblemSets`: whether to filter unlocked problem sets when searching for problems

### Changed

- Show `viewWelcome` component when user is not logged in to guide user to use the plugin
- When a user is already logged in, clicking Login will bring up a `Confirm` prompt

---

## [0.4.0] - 2023/02/15

### Added
Expand All @@ -14,7 +28,7 @@

## [0.3.1] - 2023/01/25

### Change
### Changed

- When creating a problem source file, the problem set folder is automatically created in the workspace directory and the corresponding configuration is added to settings

Expand All @@ -31,7 +45,7 @@
- Common templates for Java (BufferReader, Scanner)
- Add search engine and `Solution` link for quick search in problem preview

### Change
### Changed

- Fix bug when submitting tests
- Change `Line Comment` to `Block Comment`, when adding custom test samples
Expand Down
10 changes: 9 additions & 1 deletion docs/README_en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,14 @@ you can type `ptanote` in the code editor to generate a **note block**, where yo
> :star: **Note:** Your notes are submitted to PTA along with the code, not stored locally. After submitting the code, re-click `Preview` in the editor, or the next time you preview problems, your notes will be displayed on the preview page of the problem.
---
### 1.7 Snippets

### 1.7 Collect Problems

You can add the problem to the `My Favorites` list by clicking the button on the right side of the problem. This feature does not depend on the official service, so you can only store the collected topics locally. The synchronization of data will be considered later using other methods.

---

### 1.8 Snippets

You can enter the following prefixs in code editor to generate the corresponding code blocks quickly, as follows:

Expand Down Expand Up @@ -148,6 +155,7 @@ Use `Ctrl+Shift+P` (in Windows) or `Command+Shift+P` (in Mac) to open the comman
| `pintia.paging.pageSize` | Whether to page the problem list when the problem set is too large. It is not paged when pageSize is 0. | `100` |
| `pintia.autoCheckIn` | Specify whether to check in Pintia's education supermarket or not when the Pintia Extension is activated. | `false` |
| `pintia.searchIndex.ignoreZOJ` | Specify whether to ignore the problem set *ZOJ Problem Set* in problem search index | `true` |
| `pintia.searchIndex.ignoreLockedProblemSets` | Specify whether to ignore locked problem sets in the problem search index | `true` |
| `pintia.searchIndex.autoRefresh` | Specify whether to automatically refresh problem search index when the Pintia Extension is activated | `false` |
| `pintia.autoCreateProblemSetFolder` | Specify whether to automatically create a problem set folder and place source code files in this directory when coding a problem | `true` |

Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "vscode-pintia",
"displayName": "Pintia",
"description": "%description%",
"version": "0.4.0",
"version": "0.5.0",
"author": "Zhichao Jin",
"publisher": "jinzcdev",
"license": "MIT",
Expand Down

0 comments on commit 96c63f4

Please sign in to comment.